update patterns README.md files

wso2 · May 7, 2021 · 7259b68 · 7259b68
1 parent 16e5c79
commit 7259b68
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 14 deletions.
diff --git a/advanced/am-pattern-1/README.md b/advanced/am-pattern-1/README.md
@@ -35,7 +35,7 @@ For advanced details on the deployment pattern, please refer to the official
 * An already setup [Kubernetes cluster](https://kubernetes.io/docs/setup).<br><br>
 
 * Install [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/).<br><br>
-
+    
 * Add the WSO2 Helm chart repository.
 
     ```
@@ -54,15 +54,15 @@ You can install the relevant Helm chart either from [WSO2 Helm Chart Repository]
 
 #### Install Chart From [WSO2 Helm Chart Repository](https://hub.helm.sh/charts/wso2)
 
- Helm version 2
-
- ```
- helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE>
- ```
+Deploy the Kubernetes resources using the Helm Chart
+ 
+- Helm version 2
 
- Helm version 3
+     ```
+     helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE> 
+     ```
 
- - Deploy the Kubernetes resources using the Helm Chart
+- Helm version 3
  
     ```
     helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE> --create-namespace
@@ -94,15 +94,15 @@ git clone https://github.com/wso2/kubernetes-apim.git
 
 ##### Deploy Helm chart for WSO2 API Manager Pattern 1 deployment.
 
- Helm version 2
+Deploy the Kubernetes resources using the Helm Chart
 
- ```
- helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE>
- ```
+- Helm version 2
 
- Helm version 3
+     ```
+     helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE>
+     ```
 
- - Deploy the Kubernetes resources using the Helm Chart
+- Helm version 3
  
     ```
     helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE> --dependency-update --create-namespace
@@ -119,6 +119,23 @@ Please see the following example.
  helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
 ```
 
+Or else, you can configure the default configurations inside the am-pattern-1 helm chart [values.yaml](https://github.com/wso2/kubernetes-apim/blob/master/advanced/am-pattern-1/values.yaml) file. Refer [this](https://helm.sh/docs/chart_template_guide/values_files/) for to learn more details about the `values.yaml` file.
+    
+
+> **Note:** <br>
+From the above Helm commands, base image of a Micro Integrator is deployed (without any integration solution). To deploy your integration solution with the Helm charts follow the below steps. <br><br>
+>1. [Create an integration service using WSO2 Integration Studio and expose it as a Managed API](https://apim.docs.wso2.com/en/latest/tutorials/integration-tutorials/service-catalog-tutorial/#exposing-an-integration-service-as-a-managed-api). Then [create a Docker image](https://apim.docs.wso2.com/en/latest/integrate/develop/create-docker-project/#creating-docker-exporter) and push it to your private or public Docker registry. <br><br>
+    - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed <br>
+    - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image <br>
+    - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image <br><br>
+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).<br><br>
+    - `IMAGE_PULL_SECRET` will refer to the created image pull secret <br><br>
+>3. Deploy the helm resource using following command.<br><br>
+>   ```
+>   helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.deployment.mi.dockerRegistry=<INTEGRATION_IMAGE_REGISTRY> --set wso2.deployment.mi.imageName=<INTEGRATION_IMAGE_NAME> --set wso2.deployment.mi.imageTag=<INTEGRATION_IMAGE_TAG> --set wso2.deployment.mi.imagePullSecrets=<IMAGE_PULL_SECRET>
+>   ```     
+
+
 ### 2. Obtain the external IP
 
 Obtain the external IP (`EXTERNAL-IP`) of the API Manager Ingress resources, by listing down the Kubernetes Ingresses.

diff --git a/advanced/am-pattern-2/README.md b/advanced/am-pattern-2/README.md
@@ -122,6 +122,23 @@ Please see the following example.
  helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
 ```
 
+Or else, you can configure the default configurations inside the am-pattern-1 helm chart [values.yaml](https://github.com/wso2/kubernetes-apim/blob/master/advanced/am-pattern-1/values.yaml) file. Refer [this](https://helm.sh/docs/chart_template_guide/values_files/) for to learn more details about the `values.yaml` file.
+
+
+> **Note:** <br>
+From the above Helm commands, base image of a Micro Integrator is deployed (without any integration solution). To deploy your integration solution with the Helm charts follow the below steps. <br><br>
+>1. [Create an integration service using WSO2 Integration Studio and expose it as a Managed API](https://apim.docs.wso2.com/en/latest/tutorials/integration-tutorials/service-catalog-tutorial/#exposing-an-integration-service-as-a-managed-api). Then [create a Docker image](https://apim.docs.wso2.com/en/latest/integrate/develop/create-docker-project/#creating-docker-exporter) and push it to your private or public Docker registry. <br><br>
+    - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed <br>
+    - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image <br>
+    - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image <br><br>
+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).<br><br>
+    - `IMAGE_PULL_SECRET` will refer to the created image pull secret <br><br>
+>3. Deploy the helm resource using following command.<br><br>
+>   ```
+>   helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.deployment.mi.dockerRegistry=<INTEGRATION_IMAGE_REGISTRY> --set wso2.deployment.mi.imageName=<INTEGRATION_IMAGE_NAME> --set wso2.deployment.mi.imageTag=<INTEGRATION_IMAGE_TAG> --set wso2.deployment.mi.imagePullSecrets=<IMAGE_PULL_SECRET>
+>   ```     
+
+
 ### 2. Obtain the external IP
 
 Obtain the external IP (`EXTERNAL-IP`) of the API Manager Ingress resources, by listing down the Kubernetes Ingresses.

diff --git a/advanced/am-pattern-3/README.md b/advanced/am-pattern-3/README.md
@@ -119,6 +119,23 @@ Please see the following example.
  helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-3 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
 ```
 
+Or else, you can configure the default configurations inside the am-pattern-1 helm chart [values.yaml](https://github.com/wso2/kubernetes-apim/blob/master/advanced/am-pattern-1/values.yaml) file. Refer [this](https://helm.sh/docs/chart_template_guide/values_files/) for to learn more details about the `values.yaml` file.
+
+
+> **Note:** <br>
+From the above Helm commands, base image of a Micro Integrator is deployed (without any integration solution). To deploy your integration solution with the Helm charts follow the below steps. <br><br>
+>1. [Create an integration service using WSO2 Integration Studio and expose it as a Managed API](https://apim.docs.wso2.com/en/latest/tutorials/integration-tutorials/service-catalog-tutorial/#exposing-an-integration-service-as-a-managed-api). Then [create a Docker image](https://apim.docs.wso2.com/en/latest/integrate/develop/create-docker-project/#creating-docker-exporter) and push it to your private or public Docker registry. <br><br>
+    - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed <br>
+    - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image <br>
+    - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image <br><br>
+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).<br><br>
+    - `IMAGE_PULL_SECRET` will refer to the created image pull secret <br><br>
+>3. Deploy the helm resource using following command.<br><br>
+>   ```
+>   helm install <RELEASE_NAME> wso2/am-pattern-3 --version 4.0.0-1 --namespace <NAMESPACE> --set wso2.deployment.mi.dockerRegistry=<INTEGRATION_IMAGE_REGISTRY> --set wso2.deployment.mi.imageName=<INTEGRATION_IMAGE_NAME> --set wso2.deployment.mi.imageTag=<INTEGRATION_IMAGE_TAG> --set wso2.deployment.mi.imagePullSecrets=<IMAGE_PULL_SECRET>
+>   ```     
+
+
 ### 2. Obtain the external IP
 
 Obtain the external IP (`EXTERNAL-IP`) of the API Manager Ingress resources, by listing down the Kubernetes Ingresses.