Merge pull request #8 from event-automation-ibm/main

surajcsibm · web-flow · commit 23bca9a18d0b · 2025-02-18T16:01:23.000+05:30
Updates to Connectivity Pack product versions in the Public Connectivity Pack repository 2025-02-18
diff --git a/.github/workflows/github-build-release.yml b/.github/workflows/github-build-release.yml
@@ -40,4 +40,4 @@ jobs:
           upload_url: ${{ steps.get_release.outputs.upload_url }}
           asset_path: ./ibm-connectivity-pack-${{env.CHART_VERSION}}.tgz
           asset_name: ibm-connectivity-pack-${{env.CHART_VERSION}}.tgz
-          asset_content_type: application/tgz
+          asset_content_type: application/tgz
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ helm install <RELEASE-NAME> <CONNECTIVITY-PACK-HELM-CHART-URL> --set license.lic
 Where:
 
 - `<RELEASE-NAME>` is the release name of your choice. For example, `ibm-connectivity-pack`
-- `<CONNECTIVITY-PACK-HELM-CHART-URL>` is the URL of the latest version of the Connectivity Pack Helm chart. For example: `https://github.com/ibm-messaging/connectivity-pack-kafka-connectors/releases/download/1.0.0/ibm-connectivity-pack-1.0.0.tgz`
+- `<CONNECTIVITY-PACK-HELM-CHART-URL>` is the URL of the latest version of the Connectivity Pack Helm chart. For example: `https://github.com/ibm-messaging/connectivity-pack-kafka-connectors/releases/download/1.0.1/ibm-connectivity-pack-1.0.1.tgz`
 - `license.licenseId=<LICENSE-ID>` is the license identifier (ID) for the program that you purchased. For more information, see [licensing reference](https://ibm.github.io/event-automation/support/licensing/).
 - `license.accept` determines whether the license is accepted (default is `false` if not specified).
 - `<NAMESPACE>` is the namespace where you want to install the Connectivity Pack. This must be in the same namespace where an Event Streams instance is deployed.
@@ -44,6 +44,8 @@ You can override the default configuration parameters by using the `--set` flag
 
 For more information about installing the Connectivity Pack, including a complete list of configuration parameters supported by the Helm chart, see [installing the Connectivity Pack](./ibm-connectivity-pack/README.md#configuring).
 
+After installation, you can upgrade the Connectivity Pack to the latest version. For more information, see [upgrading the Connectivity Pack](./ibm-connectivity-pack/README.md#upgrading).
+
 ## Starting Kafka Connect
 
 Configure the Kafka Connect runtime and include the configuration, certificates, and connectors for the Connectivity Pack by following these instructions.
diff --git a/ibm-connectivity-pack/Chart.yaml b/ibm-connectivity-pack/Chart.yaml
@@ -19,4 +19,4 @@ keywords:
 kubeVersion: '>=1.25.0'
 name: ibm-connectivity-pack
 type: application
-version: 1.0.0
+version: 1.0.1
diff --git a/ibm-connectivity-pack/README.md b/ibm-connectivity-pack/README.md
@@ -19,7 +19,7 @@ helm install <RELEASE-NAME> <CONNECTIVITY-PACK-HELM-CHART-URL> --set license.lic
 Where:
 
 - `<RELEASE-NAME>` is the release name of your choice. For example, `ibm-connectivity-pack`
-- `<CONNECTIVITY-PACK-HELM-CHART-URL>` is the URL of the latest version of the Connectivity Pack Helm chart. For example: `https://github.com/ibm-messaging/connectivity-pack-kafka-connectors/releases/download/1.0.0/ibm-connectivity-pack-1.0.0.tgz`
+- `<CONNECTIVITY-PACK-HELM-CHART-URL>` is the URL of the latest version of the Connectivity Pack Helm chart. For example: `https://github.com/ibm-messaging/connectivity-pack-kafka-connectors/releases/download/1.0.1/ibm-connectivity-pack-1.0.1.tgz`
 - `license.licenseId=<LICENSE-ID>` is the license identifier (ID) for the program that you purchased. For more information, see [licensing reference](https://ibm.github.io/event-automation/support/licensing/).
 - `license.accept` determines whether the license is accepted (default is `false` if not specified).
 - `<NAMESPACE>` is the namespace where the Connectivity Pack is deployed.
@@ -28,6 +28,24 @@ You can override the default configuration parameters by using the `--set` flag
 
 For a complete list of configuration parameters supported by the helm chart, see [Configuring](#configuring).
 
+## Upgrading
+
+To upgrade the Connectivity Pack to the latest version, run the following command:
+
+```bash
+helm upgrade <RELEASE-NAME> <CONNECTIVITY-PACK-HELM-CHART-URL> -n <NAMESPACE>
+```
+
+Where:
+
+- `<RELEASE-NAME>` is the release name you specified when installing the Connectivity Pack. For example, `ibm-connectivity-pack`
+- `<CONNECTIVITY-PACK-HELM-CHART-URL>` is the URL of the latest version of the Connectivity Pack Helm chart. For example: `https://github.com/ibm-messaging/connectivity-pack-kafka-connectors/releases/download/1.0.1/ibm-connectivity-pack-1.0.1.tgz`
+- `<NAMESPACE>` is the namespace where the Connectivity Pack is deployed.
+
+You can override the default configuration parameters by using the `--set` flag or by using a custom YAML file. For example, to set the `replicaCount` as `3`, you can use `--set replicaCount=3`.
+
+For a complete list of configuration parameters supported by the helm chart, see [Configuring](#configuring).
+
 ## Uninstalling
 
 To uninstall the Connectivity Pack by using the Helm chart, run the following command:
@@ -54,7 +72,7 @@ The following table lists the configurable parameters of the Connectivity Pack H
 | replicaCount                           | Number of replicas of the pod                                                                                                                                                                                           | 1                                                                                            |
 | bunyan                                 | Log configuration for the system                                                                                                                                                                                   | See [Logging](#logging) and the sample [values.yaml](values.yaml) file for more information. |
 | annotations                            | Override with product specific annotations                                                                                                                                                                              | See [values.yaml](values.yaml) for more information.                                         |
-| environmentVariables                   | Yaml object of environment variables to be added in action and event services                                                                                                                                           |
+| environmentVariables                   | Yaml object of environment variables to be added in action and event services                                                                                                                                           | SCARF_ANALYTICS: 'false' - To opt out scarf analytics by deafult
 | image.registry                         | Image registry URL                                                                                                                                                                                                      | cp.icr.io                                                                                    |
 | image.path                             | Image namespace or the path under image registry before image name and digest                                                                                                                                           | cp/ibm-eventstreams                                                                          |
 | image.imagePullSecretName              | Kubernetes image pull secret if it already exists in the namespace, if not add the following image pull details to create new secret                                                                                    | ibm-entitlement-key                                                                          |
diff --git a/ibm-connectivity-pack/values.yaml b/ibm-connectivity-pack/values.yaml
@@ -11,7 +11,8 @@ license:
   accept: false
 replicaCount: 1 # Replica of the POD
 bunyan: "'{\"loglevel\" : \"info\", \"logsrc\" : true, \"logstdouttext\" : {}}'" # Override Log configuration
-environmentVariables: {} # Yaml object ENV to be added on action and event pods
+environmentVariables: # Yaml object ENV to be added on action and event pods
+  SCARF_ANALYTICS: 'false' # To opt out scarf analytics by default
 annotations:
   productName: IBM Connectivity pack
 image:
