From 5ac246d33a1b767742c2e15dbfeda0883e700a45 Mon Sep 17 00:00:00 2001 From: lugangee Date: Mon, 16 Mar 2026 17:24:36 +0100 Subject: [PATCH 1/5] docs: update guide for nats --- docs/admin/update/nats-upgrade.md | 65 +++++++++++++++++++++++++++++++ sidebars.ts | 1 + 2 files changed, 66 insertions(+) create mode 100644 docs/admin/update/nats-upgrade.md diff --git a/docs/admin/update/nats-upgrade.md b/docs/admin/update/nats-upgrade.md new file mode 100644 index 0000000..6bfda3e --- /dev/null +++ b/docs/admin/update/nats-upgrade.md @@ -0,0 +1,65 @@ +--- +id: nats-upgrade +sidebar_position: 1 +title: NATS Upgrade +description: NATS upgrade guide +pagination_next: null +pagination_prev: admin/update/update-overview +--- + +import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; + +# NATS Upgrade + +## Pre-Upgrade Requirements + +**Before proceeding with any upgrade, ensure you have:** + +- Planned for potential downtime +- Tested the upgrade process in a non-production environment + +## Upgrade Procedure + +**Objective: Update the NATS Reloader image to a version without critical vulnerabilities.** + +- Add the following reloader image tag to `codemie-nats/values-.yaml` + +```yaml + reloader: + tag: 0.22.3 +``` + +## Enterprise Edition + + + +- Change the NATS version in `helm-charts.sh` + +```shell + helm upgrade --install codemie-nats nats/nats \ + --version \ + --namespace $namespace \ + --values "./codemie-nats/values-.yaml" \ + --wait --timeout 900s > /dev/null +``` + +- Apply changes by running `helm-charts.sh` script or manually using the following command: + +```shell + helm upgrade --install codemie-nats nats/nats + --version \ + --namespace codemie \ + --values ./codemie-nats/values-.yaml \ + --wait --timeout 900s +``` + +> Replace `` with the desired NATS chart version. + +## Troubleshooting + +If you encounter issues during the upgrade: + +1. Check pod logs for error messages +2. Verify resource availability (CPU, memory, storage) +3. Ensure network connectivity between components +4. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues diff --git a/sidebars.ts b/sidebars.ts index 4f467c5..79e2362 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -740,6 +740,7 @@ const sidebars: SidebarsConfig = { 'admin/update/oauth2-proxy-upgrade', 'admin/update/elasticsearch-kibana-upgrade', 'admin/update/fluent-bit-upgrade', + 'admin/update/nats-upgrade', ], }, { From fd1400b27caf6994a0eecd1f9dbc05a09a62242c Mon Sep 17 00:00:00 2001 From: lugangee Date: Thu, 19 Mar 2026 12:49:45 +0100 Subject: [PATCH 2/5] docs: update guide for nats --- docs/admin/update/nats-upgrade.md | 35 +++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/docs/admin/update/nats-upgrade.md b/docs/admin/update/nats-upgrade.md index 6bfda3e..c1af61d 100644 --- a/docs/admin/update/nats-upgrade.md +++ b/docs/admin/update/nats-upgrade.md @@ -11,6 +11,10 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; # NATS Upgrade +## Enterprise Edition + + + ## Pre-Upgrade Requirements **Before proceeding with any upgrade, ensure you have:** @@ -18,20 +22,30 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; - Planned for potential downtime - Tested the upgrade process in a non-production environment -## Upgrade Procedure +**Before starting the upgrade** + +- Check the list of available chart versions: -**Objective: Update the NATS Reloader image to a version without critical vulnerabilities.** +```bash + helm search repo nats/nats --versions +``` -- Add the following reloader image tag to `codemie-nats/values-.yaml` +- Once you identify the target version, you can inspect which container image tags are used by that release: + +```bash + helm show values nats/nats --version | grep -A 3 image: +``` + +> This helps verify the underlying images before proceeding with the upgrade. + +- If you want to use a custom NATS-Reloader image tag, add the following to `codemie-nats/values-.yaml`: ```yaml reloader: tag: 0.22.3 ``` -## Enterprise Edition - - +## Upgrade Procedure - Change the NATS version in `helm-charts.sh` @@ -55,11 +69,10 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; > Replace `` with the desired NATS chart version. -## Troubleshooting +## Post-upgrade verification -If you encounter issues during the upgrade: +After the upgrade completes, verify the deployment: 1. Check pod logs for error messages -2. Verify resource availability (CPU, memory, storage) -3. Ensure network connectivity between components -4. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues +2. Ensure network connectivity between components +3. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues From 0ac4097fc54a7ee3d8828653e139b93d19bd7289 Mon Sep 17 00:00:00 2001 From: lugangee Date: Thu, 19 Mar 2026 15:22:38 +0100 Subject: [PATCH 3/5] docs: update guide for nats --- docs/admin/update/nats-upgrade.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/admin/update/nats-upgrade.md b/docs/admin/update/nats-upgrade.md index c1af61d..dadfc36 100644 --- a/docs/admin/update/nats-upgrade.md +++ b/docs/admin/update/nats-upgrade.md @@ -30,7 +30,19 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; helm search repo nats/nats --versions ``` -- Once you identify the target version, you can inspect which container image tags are used by that release: +:::info +> The Helm chart version and the application version may differ. +> All the component's versions (eg. nats-server-config-reloader) included in the helm chart might be different from **APP VERSION**. +> Always rely on the **Chart version** when determining compatibility and deployment behavior. +::: + +| NAME | CHART VERSION | APP VERSION | DESCRIPTION | +| -------------| ---------------|-------------|--------------------------------------------------| +| `nats/nats` | `2.12.5` | `2.12.5` |A Helm chart for the NATS.io High Speed Cloud N...| +| `nats/nats` | `1.3.16` | `2.11.10` |A Helm chart for the NATS.io High Speed Cloud N...| + + +- Once you identify the target chart version, you can inspect the container image tags (nats, nats-server-config-reloader, etc.) used in that release: ```bash helm show values nats/nats --version | grep -A 3 image: @@ -38,7 +50,7 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; > This helps verify the underlying images before proceeding with the upgrade. -- If you want to use a custom NATS-Reloader image tag, add the following to `codemie-nats/values-.yaml`: +- If you want to use a custom NATS-Reloader image tag, add the following configuration to the `codemie-nats/values-.yaml` file: ```yaml reloader: @@ -57,15 +69,7 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; --wait --timeout 900s > /dev/null ``` -- Apply changes by running `helm-charts.sh` script or manually using the following command: - -```shell - helm upgrade --install codemie-nats nats/nats - --version \ - --namespace codemie \ - --values ./codemie-nats/values-.yaml \ - --wait --timeout 900s -``` +- Now you have to execute `helm-charts.sh` script or manually run the command above with namespace (```$namespace```) in which CodeMie is deployed > Replace `` with the desired NATS chart version. @@ -73,6 +77,5 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; After the upgrade completes, verify the deployment: -1. Check pod logs for error messages -2. Ensure network connectivity between components -3. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues +1. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues +2. Check pod logs for error messages \ No newline at end of file From d67e1babed1dcc863a286de88287ef935ad6c7bf Mon Sep 17 00:00:00 2001 From: lugangee Date: Thu, 19 Mar 2026 15:36:59 +0100 Subject: [PATCH 4/5] docs: update guide for nats --- docs/admin/update/nats-upgrade.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/admin/update/nats-upgrade.md b/docs/admin/update/nats-upgrade.md index dadfc36..86330d1 100644 --- a/docs/admin/update/nats-upgrade.md +++ b/docs/admin/update/nats-upgrade.md @@ -31,16 +31,16 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; ``` :::info + > The Helm chart version and the application version may differ. > All the component's versions (eg. nats-server-config-reloader) included in the helm chart might be different from **APP VERSION**. > Always rely on the **Chart version** when determining compatibility and deployment behavior. -::: - -| NAME | CHART VERSION | APP VERSION | DESCRIPTION | -| -------------| ---------------|-------------|--------------------------------------------------| -| `nats/nats` | `2.12.5` | `2.12.5` |A Helm chart for the NATS.io High Speed Cloud N...| -| `nats/nats` | `1.3.16` | `2.11.10` |A Helm chart for the NATS.io High Speed Cloud N...| +> ::: +| NAME | CHART VERSION | APP VERSION | DESCRIPTION | +| ----------- | ------------- | ----------- | -------------------------------------------------- | +| `nats/nats` | `2.12.5` | `2.12.5` | A Helm chart for the NATS.io High Speed Cloud N... | +| `nats/nats` | `1.3.16` | `2.11.10` | A Helm chart for the NATS.io High Speed Cloud N... | - Once you identify the target chart version, you can inspect the container image tags (nats, nats-server-config-reloader, etc.) used in that release: @@ -69,7 +69,7 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; --wait --timeout 900s > /dev/null ``` -- Now you have to execute `helm-charts.sh` script or manually run the command above with namespace (```$namespace```) in which CodeMie is deployed +- Now you have to execute `helm-charts.sh` script or manually run the command above with namespace (`$namespace`) in which CodeMie is deployed > Replace `` with the desired NATS chart version. @@ -78,4 +78,4 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; After the upgrade completes, verify the deployment: 1. Run the [codemie-plugins](https://pypi.org/project/codemie-plugins/) to ensure that you can successfully connect without any issues -2. Check pod logs for error messages \ No newline at end of file +2. Check pod logs for error messages From d6af4ee295c8b7f73640f5c72d57f7e654bd8b37 Mon Sep 17 00:00:00 2001 From: lugangee Date: Thu, 19 Mar 2026 15:47:29 +0100 Subject: [PATCH 5/5] docs: update guide for nats --- docs/admin/update/nats-upgrade.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/admin/update/nats-upgrade.md b/docs/admin/update/nats-upgrade.md index 86330d1..9e39e90 100644 --- a/docs/admin/update/nats-upgrade.md +++ b/docs/admin/update/nats-upgrade.md @@ -11,8 +11,6 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; # NATS Upgrade -## Enterprise Edition - ## Pre-Upgrade Requirements @@ -35,7 +33,8 @@ import EnterpriseFeature from '@site/src/components/EnterpriseFeature'; > The Helm chart version and the application version may differ. > All the component's versions (eg. nats-server-config-reloader) included in the helm chart might be different from **APP VERSION**. > Always rely on the **Chart version** when determining compatibility and deployment behavior. -> ::: + +::: | NAME | CHART VERSION | APP VERSION | DESCRIPTION | | ----------- | ------------- | ----------- | -------------------------------------------------- |