From 7259b68e6f4a2ee324e4a683d915a4cd0c2ece06 Mon Sep 17 00:00:00 2001 From: Sajitha Liyanage Date: Thu, 6 May 2021 19:54:51 +0530 Subject: [PATCH] update patterns README.md files --- advanced/am-pattern-1/README.md | 45 +++++++++++++++++++++++---------- advanced/am-pattern-2/README.md | 17 +++++++++++++ advanced/am-pattern-3/README.md | 17 +++++++++++++ 3 files changed, 65 insertions(+), 14 deletions(-) diff --git a/advanced/am-pattern-1/README.md b/advanced/am-pattern-1/README.md index 73296a0b..09ce1ca1 100644 --- 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).

* Install [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx/deploy/).

- + * 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 wso2/am-pattern-1 --version 4.0.0-1 --namespace - ``` +Deploy the Kubernetes resources using the Helm Chart + +- Helm version 2 - Helm version 3 + ``` + helm install --name wso2/am-pattern-1 --version 4.0.0-1 --namespace + ``` - - Deploy the Kubernetes resources using the Helm Chart +- Helm version 3 ``` helm install wso2/am-pattern-1 --version 4.0.0-1 --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 /am-pattern-1 --version 4.0.0-1 --namespace - ``` +- Helm version 2 - Helm version 3 + ``` + helm install --dep-up --name /am-pattern-1 --version 4.0.0-1 --namespace + ``` - - Deploy the Kubernetes resources using the Helm Chart +- Helm version 3 ``` helm install /am-pattern-1 --version 4.0.0-1 --namespace --dependency-update --create-namespace @@ -119,6 +119,23 @@ Please see the following example. helm install --name /am-pattern-1 --version 4.0.0-1 --namespace --set wso2.subscription.username= --set wso2.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:**
+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.

+>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.

+ - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed
+ - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image
+ - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image

+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).

+ - `IMAGE_PULL_SECRET` will refer to the created image pull secret

+>3. Deploy the helm resource using following command.

+> ``` +> helm install wso2/am-pattern-1 --version 4.0.0-1 --namespace --set wso2.deployment.mi.dockerRegistry= --set wso2.deployment.mi.imageName= --set wso2.deployment.mi.imageTag= --set wso2.deployment.mi.imagePullSecrets= +> ``` + + ### 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 index 3b507523..54671a48 100644 --- 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 /am-pattern-2 --version 4.0.0-1 --namespace --set wso2.subscription.username= --set wso2.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:**
+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.

+>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.

+ - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed
+ - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image
+ - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image

+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).

+ - `IMAGE_PULL_SECRET` will refer to the created image pull secret

+>3. Deploy the helm resource using following command.

+> ``` +> helm install wso2/am-pattern-2 --version 4.0.0-1 --namespace --set wso2.deployment.mi.dockerRegistry= --set wso2.deployment.mi.imageName= --set wso2.deployment.mi.imageTag= --set wso2.deployment.mi.imagePullSecrets= +> ``` + + ### 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 index ef6ff7e8..ee5acba7 100644 --- 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 /am-pattern-3 --version 4.0.0-1 --namespace --set wso2.subscription.username= --set wso2.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:**
+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.

+>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.

+ - `INTEGRATION_IMAGE_REGISTRY` will refer to the Docker registry that created Docker image has been pushed
+ - `INTEGRATION_IMAGE_NAME` will refer to the name of the created Docker image
+ - `INTEGRATION_IMAGE_TAG` will refer to the tag of the created Docker image

+>2. If your Docker registry is a private registry, [create an imagePullSecret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).

+ - `IMAGE_PULL_SECRET` will refer to the created image pull secret

+>3. Deploy the helm resource using following command.

+> ``` +> helm install wso2/am-pattern-3 --version 4.0.0-1 --namespace --set wso2.deployment.mi.dockerRegistry= --set wso2.deployment.mi.imageName= --set wso2.deployment.mi.imageTag= --set wso2.deployment.mi.imagePullSecrets= +> ``` + + ### 2. Obtain the external IP Obtain the external IP (`EXTERNAL-IP`) of the API Manager Ingress resources, by listing down the Kubernetes Ingresses.