You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ts...@apache.org on 2022/07/27 01:57:19 UTC
[camel-k-examples] 02/02: add more infomation to ibm-mq/README.md
This is an automated email from the ASF dual-hosted git repository.
tsato pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k-examples.git
commit e4a67a6dc72d20d2447b981c0e42c7bcc2099e0b
Author: Kuthumi Pepple <ku...@gmail.com>
AuthorDate: Tue Jul 19 15:33:33 2022 +0100
add more infomation to ibm-mq/README.md
---
generic-examples/ibm-mq/README.md | 26 +++++++++++++++++-----
.../ibm-mq/ibm-mq-server-deploy/README.md | 2 +-
2 files changed, 22 insertions(+), 6 deletions(-)
diff --git a/generic-examples/ibm-mq/README.md b/generic-examples/ibm-mq/README.md
index 08bd4a5..e8c2ac7 100644
--- a/generic-examples/ibm-mq/README.md
+++ b/generic-examples/ibm-mq/README.md
@@ -1,6 +1,22 @@
# Examples showing how to use Camel K to connect to an IBM MQ Server
-* Deploy the IBM MQ Server, as describe in the ibm-mq-server-deploy/README.md
+The examples show the ways we can connect to an IBM MQ Server using Camel K
+
+You can find more information about Apache Camel and Apache Camel K on the [official Camel website](https://camel.apache.org).
+
+## Before you begin
+
+Read the general instructions in the [root README.md file](/README.md) for setting up your environment and the Kubernetes cluster before looking at this example.
+
+Make sure you've read the [installation instructions](https://camel.apache.org/camel-k/latest/installation/installation.html) for your specific
+cluster before starting the example.
+
+## Additional Requirements for running the examples
+**An IBM MQ Server**: Queue manager for providing queuing services to clients. For installation instructions, see [How to deploy an IBM MQ Server to a Kubernetes cluster](./ibm-mq-server-deploy/) for demo purposes.
+
+## Running the examples
+
+* Deploy the IBM MQ Server, as described in the [ibm-mq-server-deploy/README.md](./ibm-mq-server-deploy/README.md)
* Change the IBM MQ Server address in the MQRoute.java class file
@@ -8,7 +24,7 @@
ibmip=`kubectl get svc/ibm-mq-server -ojsonpath="{.spec.clusterIP}"`; sed -i "/mqHost/s/\".*\"/\"$ibmip\"/g" MQRoute.java
```
-For licensing reasons, the IBM MQ Java libraries are not defined in the routes themselves, but you can declare the dependency while running the integration. Alternatively you can use Kamel modeline to add the dependency in the route file as a header.
+For licensing reasons, the IBM MQ Java libraries are not defined in the routes themselves, but you can declare the dependency while running the integration. Alternatively, you can use Kamel modeline to add the dependency in the route file as a header.
* Run the MQRoute.java. It is a producer and consumer of messages.
@@ -25,10 +41,10 @@ JmsConsumer[DEV.QUEUE.1]) Exchange[ExchangePattern: InOnly, BodyType: String, Bo
* If you want to have a more streamlined declarative approach to run the integration using Kamelets, you can use the routes in YAML format.
-The following kamel commands, has three distincts configurations:
-1. Declare de dependency of IBM MQ Java library as previously mentioned.
+The kamel commands below set the following configurations:
+1. As previously mentioned, declare as a dependency, the IBM MQ Java library.
2. Use the IBM MQ Server password set in a kubernetes `Secret` object.
-3. Set the IBM MQ Server IP address as a property to run the integration, so the IBM MQ Cient can connect to the server.
+3. Set the IBM MQ Server IP address as a property to run the integration, so the IBM MQ Client can connect to the server.
Run the integration to generate messages and send them to the IBM MQ Queue (there is no output in the console)
diff --git a/generic-examples/ibm-mq/ibm-mq-server-deploy/README.md b/generic-examples/ibm-mq/ibm-mq-server-deploy/README.md
index 4a0449e..f509743 100644
--- a/generic-examples/ibm-mq/ibm-mq-server-deploy/README.md
+++ b/generic-examples/ibm-mq/ibm-mq-server-deploy/README.md
@@ -1,4 +1,4 @@
-# How to deploy a IBM MQ Server to Kubernetes cluster
+# How to deploy an IBM MQ Server to a Kubernetes cluster
This is a very simple example to show how to install an IBM MQ Server. **Note**, this is not ready for any production purpose.