Merge pull request #574 from PasanT9/4.1.0-2-release

Update Charts and READMEs for 4.1.0-2 release.

CHANGELOG.md

@@ -18,3 +18,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 - Ingress API version to networking.k8s.io/v1.
 - Readiness and liveness probe endpoints.
+
+## [v4.1.0.2] - 2023-03-16
+
+### Added
+
+- Add ingress to handle WebSocket traffic
+
+### Modified
+
+- Update latest APIM configurations

README.md

@@ -23,7 +23,7 @@ The JWKS endpoint of the API Manager has an external facing hostname by default.
 
 1. Log into Admin portal - https://am.wso2.com/admin/
 2. Navigate to Key Managers section and select the Resident Key Manager.
-3. Change the JWKS URL in the Certificates section to https://<cp-lb-service-name>:9443/oauth2/jwks.
+3. Change the JWKS URL in the Certificates section to `https://<cp-lb-service-name>:9443/oauth2/jwks`.
 
 
 ### Update certificate domain names

advanced/am-pattern-1/Chart.yaml

@@ -16,5 +16,5 @@ apiVersion: v1
 appVersion: "4.1.0"
 description: A Helm chart for the deployment of WSO2 API Manager Pattern 1 (HA All-In-One Deployment)
 name: am-pattern-1
-version: 4.1.0-1
+version: 4.1.0-2
 icon: https://wso2.cachefly.net/wso2/sites/all/images/wso2logo.svg

advanced/am-pattern-1/README.md

@@ -59,13 +59,13 @@ Deploy the Kubernetes resources using the Helm Chart
 - Helm version 2
 
      ```
-     helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> 
+     helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> 
      ```
 
 - Helm version 3
 
     ```
-    helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --create-namespace
+    helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --create-namespace
     ```
 
 The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
@@ -76,7 +76,7 @@ please provide your WSO2 Subscription credentials via input values (using `--set
 Please see the following example.
 
 ```
- helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
+ helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
 ```
 
 #### Install Chart From Source
@@ -99,13 +99,13 @@ Deploy the Kubernetes resources using the Helm Chart
 - Helm version 2
 
      ```
-     helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE>
+     helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE>
      ```
 
 - Helm version 3
 
     ```
-    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --dependency-update --create-namespace
+    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --dependency-update --create-namespace
     ```
 
 The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
@@ -116,7 +116,7 @@ please provide your WSO2 Subscription credentials via input values (using `--set
 Please see the following example.
 
 ```
- helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
+ helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-2 --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.
@@ -132,7 +132,7 @@ From the above Helm commands, base image of a Micro Integrator is deployed (with
     - `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.1.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>
+>   helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --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>
 >   ```     
 
 ### Choreo Analytics
@@ -144,13 +144,13 @@ The following example shows how to enable Analytics with the helm charts.
 Helm v2
 
 ```
-helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY>
+helm install --name <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY>
 ```
 
 Helm v3
 
 ```
-helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY> --create-namespace
+helm install <RELEASE_NAME> wso2/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY> --create-namespace
 ```
 
 You will be able to see the Analytics data when you log into Choreo Analytics Portal.
@@ -186,6 +186,13 @@ API Manager Websub
 - ADDRESS: External IP (`EXTERNAL-IP`) exposing the API Manager's Websub service to outside of the Kubernetes environment
 - PORTS: Externally exposed service ports of the API Manager' Websub service
 
+API Manager WebSocket
+
+- NAME: Metadata name of the Kubernetes Ingress resource (defaults to `wso2am-pattern-1-am-websocket-ingress`)
+- HOSTS: Hostname of the WSO2 API Manager's WebSocket service (`<wso2.deployment.am.ingress.websocket.hostname>`)
+- ADDRESS: External IP (`EXTERNAL-IP`) exposing the API Manager's WebSocket service to outside of the Kubernetes environment
+- PORTS: Externally exposed service ports of the API Manager' WebSocket service
+
 Micro Integrator Management APIs
 
 - NAME: Metadata name of the Kubernetes Ingress resource (defaults to `wso2am-pattern-1-mi-1-management-ingress`)
@@ -202,7 +209,7 @@ If the defined hostnames are not backed by a DNS service, for the purpose of eva
 hostnames and the external IP in the `/etc/hosts` file at the client-side.
 
 ```
-<EXTERNAL-IP> <wso2.deployment.am.ingress.management.hostname> <wso2.deployment.am.ingress.gateway.hostname> <wso2.deployment.am.ingress.websub.hostname> <wso2.deployment.mi.ingress.management.hostname>
+<EXTERNAL-IP> <wso2.deployment.am.ingress.management.hostname> <wso2.deployment.am.ingress.gateway.hostname> <wso2.deployment.am.ingress.websub.hostname> <wso2.deployment.am.ingress.websocket.hostname> <wso2.deployment.mi.ingress.management.hostname>
 ```
 
 ### 4. Access Management Consoles
@@ -270,6 +277,9 @@ If you do not have an active WSO2 subscription, **do not change** the parameters
 | `wso2.deployment.am.ingress.websub.enabled`                            | If enabled, create ingress resource for WebSub service  | true          |
 | `wso2.deployment.am.ingress.websub.hostname`                                | Hostname for API Manager Websub services                                                  | `websub.am.wso2.com`        |
 | `wso2.deployment.am.ingress.websub.annotations`                             | Ingress resource annotations for API Manager Websub                                       | Community NGINX Ingress controller annotations         |
+| `wso2.deployment.am.ingress.websocket.enabled`                            | If enabled, create ingress resource for WebSocket service  | true          |
+| `wso2.deployment.am.ingress.websocket.hostname`                                | Hostname for API Manager WebSocket services                                                  | `websocket.am.wso2.com`        |
+| `wso2.deployment.am.ingress.websocket.annotations`                             | Ingress resource annotations for API Manager WebSocket                                       | Community NGINX Ingress controller annotations         |
 
 ###### Micro Integrator Server Configurations
 
@@ -338,5 +348,5 @@ If you want to setup API Manager only without Micro Integrator, you have to inst
 * Deploy Helm charts
 
     ```helm
-    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-1 --namespace <NAMESPACE> --dependency-update --create-namespace
+    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-1 --version 4.1.0-2 --namespace <NAMESPACE> --dependency-update --create-namespace
     ```

advanced/am-pattern-1/requirements.yaml

@@ -14,7 +14,7 @@
 
 dependencies:
   - name: mysql-am
-    version: "4.1.0-1"
+    version: "4.1.0-2"
     repository: "https://helm.wso2.com"
     condition: wso2.deployment.dependencies.cluster_mysql
   - name: nfs-server-provisioner

advanced/am-pattern-2/Chart.yaml

@@ -16,5 +16,5 @@ apiVersion: v1
 appVersion: "4.1.0"
 description: A Helm chart for the deployment of WSO2 API Management deployment pattern 2
 name: am-pattern-2
-version: 4.1.0-1
+version: 4.1.0-2
 icon: https://wso2.cachefly.net/wso2/sites/all/images/wso2logo.svg

advanced/am-pattern-2/README.md

@@ -59,13 +59,13 @@ Deploy the Kubernetes resources using the Helm Chart
 - Helm version 2
 
      ```
-     helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE>
+     helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE>
      ```
 
 - Helm version 3
 
     ```
-    helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --create-namespace
+    helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --create-namespace
     ```
 
 The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
@@ -91,7 +91,7 @@ Below example is to provide WSO2 Subscription credentials for all WSO2 API Manag
 export SUBSCRIPTION_USERNAME=<SUBSCRIPTION_USERNAME>
 export SUBSCRIPTION_PASSWORD=<SUBSCRIPTION_PASSWORD>
 
-helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=$SUBSCRIPTION_USERNAME --set wso2.subscription.password=$SUBSCRIPTION_PASSWORD --set am-pattern-1.wso2.subscription.username=$SUBSCRIPTION_USERNAME --set am-pattern-1.wso2.subscription.password=$SUBSCRIPTION_PASSWORD
+helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.subscription.username=$SUBSCRIPTION_USERNAME --set wso2.subscription.password=$SUBSCRIPTION_PASSWORD --set am-pattern-1.wso2.subscription.username=$SUBSCRIPTION_USERNAME --set am-pattern-1.wso2.subscription.password=$SUBSCRIPTION_PASSWORD
 ```
 
 #### Install Chart From Source
@@ -114,13 +114,13 @@ Deploy the Kubernetes resources using the Helm Chart
 - Helm version 2
 
      ```
-     helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE>
+     helm install --dep-up --name <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE>
      ```
 
 - Helm version 3
 
     ```
-    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --dependency-update --create-namespace
+    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --dependency-update --create-namespace
     ```
 
 The above steps will deploy the deployment pattern using WSO2 product Docker images available at DockerHub.
@@ -131,7 +131,7 @@ please provide your WSO2 Subscription credentials via input values (using `--set
 Please see the following example.
 
 ```
- helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.subscription.username=<SUBSCRIPTION_USERNAME> --set wso2.subscription.password=<SUBSCRIPTION_PASSWORD>
+ helm install --name <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-2 --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.
@@ -147,7 +147,7 @@ From the above Helm commands, base image of a Micro Integrator is deployed (with
     - `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.1.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>
+>   helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --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>
 >   ```     
 
 ### Choreo Analytics
@@ -159,13 +159,13 @@ The following example shows how to enable Analytics with the helm charts.
 Helm v2
 
 ```
-helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY>
+helm install --name <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY>
 ```
 
 Helm v3
 
 ```
-helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY> --create-namespace
+helm install <RELEASE_NAME> wso2/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --set wso2.choreoAnalytics.enabled=true --set wso2.choreoAnalytics.endpoint=<CHOREO_ANALYTICS_ENDPOINT> --set wso2.choreoAnalytics.onpremKey=<ONPREM_KEY> --create-namespace
 ```
 
 You will be able to see the Analytics data when you log into Choreo Analytics Portal.
@@ -201,6 +201,13 @@ API Manager Websub
 - ADDRESS: External IP (`EXTERNAL-IP`) exposing the API Manager's Websub service to outside of the Kubernetes environment
 - PORTS: Externally exposed service ports of the API Manager' Websub service
 
+API Manager WebSocket
+
+- NAME: Metadata name of the Kubernetes Ingress resource (defaults to `wso2am-pattern-1-am-websocket-ingress`)
+- HOSTS: Hostname of the WSO2 API Manager's WebSocket service (`<wso2.deployment.am.ingress.websocket.hostname>`)
+- ADDRESS: External IP (`EXTERNAL-IP`) exposing the API Manager's WebSocket service to outside of the Kubernetes environment
+- PORTS: Externally exposed service ports of the API Manager' WebSocket service
+
 Micro Integrator Management APIs of Tenant 1
 
 - NAME: Metadata name of the Kubernetes Ingress resource (defaults to `wso2am-pattern-1-mi-1-management-ingress`)
@@ -224,7 +231,7 @@ If the defined hostnames are not backed by a DNS service, for the purpose of eva
 hostnames and the external IP in the `/etc/hosts` file at the client-side.
 
 ```
-<EXTERNAL-IP> <wso2.deployment.am.ingress.management.hostname> <wso2.deployment.am.ingress.gateway.hostname> <wso2.deployment.am.ingress.websub.hostname> <wso2.deployment.mi.ingress.management.hostname> <wso2.deployment.mi.ingress.management.hostname>
+<EXTERNAL-IP> <wso2.deployment.am.ingress.management.hostname> <wso2.deployment.am.ingress.gateway.hostname> <wso2.deployment.am.ingress.websub.hostname> <wso2.deployment.am.ingress.websocket.hostname> <wso2.deployment.mi.ingress.management.hostname> <wso2.deployment.mi.ingress.management.hostname>
 ```
 
 ### 4. Access Management Consoles
@@ -302,6 +309,9 @@ If you do not have an active WSO2 subscription, **do not change** the parameters
 | `am-pattern-1.wso2.deployment.am.ingress.websub.enabled`                            | If enabled, create ingress resource for WebSub service  | true          |
 | `am-pattern-1.wso2.deployment.am.ingress.websub.hostname`                                | Hostname for API Manager Websub services                                                  | `websub.am.wso2.com`        |
 | `am-pattern-1.wso2.deployment.am.ingress.websub.annotations`                             | Ingress resource annotations for API Manager Websub                                       | Community NGINX Ingress controller annotations         |
+| `am-pattern-1.wso2.deployment.am.ingress.websocket.enabled`                            | If enabled, create ingress resource for WebSocket service  | true          |
+| `am-pattern-1.wso2.deployment.am.ingress.websocket.hostname`                                | Hostname for API Manager WebSocket services                                                  | `websocket.am.wso2.com`        |
+| `am-pattern-1.wso2.deployment.am.ingress.websocket.annotations`                             | Ingress resource annotations for API Manager WebSocket                                       | Community NGINX Ingress controller annotations         |
 
 #### Micro Integrator Server Configurations for Tenant 1
 
@@ -391,5 +401,5 @@ If you want to setup API Manager only without Micro Integrator, you have to inst
 * Deploy Helm charts
 
     ```helm
-    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-1 --namespace <NAMESPACE> --dependency-update --create-namespace
+    helm install <RELEASE_NAME> <HELM_HOME>/am-pattern-2 --version 4.1.0-2 --namespace <NAMESPACE> --dependency-update --create-namespace
     ```

advanced/am-pattern-2/requirements.yaml

@@ -14,5 +14,5 @@
 
 dependencies:
   - name: am-pattern-1
-    version: "4.1.0-1"
+    version: "4.1.0-2"
     repository: "https://helm.wso2.com"

advanced/am-pattern-3/Chart.yaml

@@ -16,5 +16,5 @@ apiVersion: v1
 appVersion: "4.1.0"
 description: A Helm chart for the deployment of WSO2 API Management deployment pattern 3
 name: am-pattern-3
-version: 4.1.0-1
+version: 4.1.0-2
 icon: https://wso2.cachefly.net/wso2/sites/all/images/wso2logo.svg