From 68d07cef548f4e5cab19770d664c6879b7a51ef4 Mon Sep 17 00:00:00 2001 From: Chiman Jain Date: Thu, 6 Jun 2024 14:49:39 +0530 Subject: [PATCH 1/7] restructure observability module upgrade docs --- content/docs/deployment/csmoperator/_index.md | 41 +------------------ .../csmoperator/modules/observability.md | 38 ++++++++++++++++- 2 files changed, 39 insertions(+), 40 deletions(-) diff --git a/content/docs/deployment/csmoperator/_index.md b/content/docs/deployment/csmoperator/_index.md index fb482693af..04b1b242fb 100644 --- a/content/docs/deployment/csmoperator/_index.md +++ b/content/docs/deployment/csmoperator/_index.md @@ -363,46 +363,9 @@ The following notes explain some of the general items to take care of. configVersion: v2.10.0 ``` -### Upgrade Observability module using Dell CSM Operator +### Upgrade Modules using Dell CSM Operator -The Observability module installed by the Dell CSM Operator can be updated like any Kubernetes resource. - -* Modifying the existing driver and module installation directly via `kubectl edit` - - ```sh - $ kubectl get -n - ``` - - For example - If the CSI PowerScale driver is installed then run this command to get the object name - - ```sh - # Replace driver-namespace with the namespace where the CSI PowerScale driver is installed - $ kubectl get csm -n - ``` - - use the object name in `kubectl edit` command. - - ```sh - $ kubectl edit csm / -n - ``` - - For example - If the object name is isilon then use the name as isilon - - ```sh - # Replace object-name with the isilon - $ kubectl edit csm isilon -n - ``` - -* Modify the installation - - * Update the driver config version and image tag - - * Update the Observability config version, csm-topology image and the driver metrics images(e.g. for CSI PowerScale driver, the metrics driver image would be `csm-metrics-powerscale`) - ->NOTE: - -* In observability module upgrade, only `n-1` to `n` upgrade is supported, e.g. if the current observability version is `v1.7.x`, it can be upgraded to `1.8.x`. -* Upgrade to csm-operator and csi-driver first which support the corresponding observability module version. +* Refer [Upgrade Obsevability Module](./modules/observability/#upgrade-observability) to upgrade the Observability Module via Operator ## Custom Resource Definitions As part of the Dell CSM Operator installation, a CRD representing configuration for the CSI Driver and CSM Modules is also installed. diff --git a/content/docs/deployment/csmoperator/modules/observability.md b/content/docs/deployment/csmoperator/modules/observability.md index c26586255a..2e03727bd0 100644 --- a/content/docs/deployment/csmoperator/modules/observability.md +++ b/content/docs/deployment/csmoperator/modules/observability.md @@ -59,4 +59,40 @@ The CSM Observability module for supported Dell CSI Drivers can be installed via ## Upgrade Observability -- To upgrade observability module, please check the following section: [Upgrade Observability module using Dell CSM Operator](../../#upgrade-observability-module-using-dell-csm-operator) +The Observability module installed by the Dell CSM Operator can be updated like any Kubernetes resource. + +- Modifying the existing driver and module installation directly via `kubectl edit` + + ```sh + kubectl get -n + ``` + + For example - If the CSI PowerScale driver is installed then run this command to get the object name + + ```sh + # Replace driver-namespace with the namespace where the CSI PowerScale driver is installed + $ kubectl get csm -n + ``` + + use the object name in `kubectl edit` command. + + ```sh + kubectl edit csm / -n + ``` + + For example - If the object name is isilon then use the name as isilon + + ```sh + # Replace object-name with the isilon + kubectl edit csm isilon -n + ``` + +- Modify the installation + + - Update the driver config version and image tag + - Update the Observability config version, csm-topology image and the driver metrics images(e.g. for CSI PowerScale driver, the metrics driver image would be `csm-metrics-powerscale`) + +>NOTE: + +- In observability module upgrade, only `n-1` to `n` upgrade is supported, e.g. if the current observability version is `v1.7.x`, it can be upgraded to `1.8.x`. +- Upgrade to csm-operator and csi-driver first which support the corresponding observability module version. From e988117f669ad89f6d7b8853d7ad6857869bb9e7 Mon Sep 17 00:00:00 2001 From: Kakde Date: Fri, 7 Jun 2024 12:55:22 +0530 Subject: [PATCH 2/7] steps for Authorization upgrade added --- .../csmoperator/modules/authorization.md | 73 +++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/content/docs/deployment/csmoperator/modules/authorization.md b/content/docs/deployment/csmoperator/modules/authorization.md index 2db1d421a4..cb737d7b9e 100644 --- a/content/docs/deployment/csmoperator/modules/authorization.md +++ b/content/docs/deployment/csmoperator/modules/authorization.md @@ -144,3 +144,76 @@ Follow the instructions available in CSM Authorization for [Configuring the CSM ### Configure a Dell CSI Driver with CSM Authorization Follow the instructions available in CSM Authorization for [Configuring a Dell CSI Driver with CSM for Authorization](../../../helm/modules/installation/authorization/#configuring-a-dell-csi-driver-with-csm-for-authorization). + +### Upgrade CSM Authorization + +This section outlines the upgrade steps for Container Storage Modules (CSM) for Authorization. The upgrade of CSM for Authorization is handled in 2 parts: +1) Upgrading the Authorization proxy server +2) Upgrading CSI Driver , Authorization sidecar with Authorization module enabled + + +- Upgrading the Authorization Proxy Server + + Modifying the existing Authorization Proxy Server installation directly via `kubectl edit` + kubectl get -n + ``` + + For example - If the Authorization Proxy Server is installed then run this command to get the object name + + ```sh + # Replace module-namespace with the namespace where the Authorization Proxy Server is installed + $ kubectl get csm -n + ``` + + use the object name in `kubectl edit` command. + + ```sh + kubectl edit csm -n + ``` + + For example - If the object name is authorization then use the name as authorization + + ```sh + # Replace object-name with the authorization + kubectl edit csm authorization -n + + - Update the CSM Authorization Proxy Server configVersion + - Update the images for proxyService, tenantService, roleService and storageService + + +- Upgrading CSI Driver , Authorization sidecar with Authorization module enabled + + Modifying the existing driver and module installation directly via `kubectl edit` + + ```sh + kubectl get -n + ``` + + For example - If the CSI PowerFlex driver is installed then run this command to get the object name + + ```sh + # Replace driver-namespace with the namespace where the CSI PowerFlex driver is installed + $ kubectl get csm -n + ``` + + use the object name in `kubectl edit` command. + + ```sh + kubectl edit csm / -n + ``` + + For example - If the object name is vxflexos then use the name as vxflexos + + ```sh + # Replace object-name with the vxflexos + kubectl edit csm vxflexos -n + ``` + +- Modify the installation + + - Update the driver config version and image tag + - Update the Authorization config version and karavi-authorization-proxy image. + +>NOTE: + +- In Authorization module upgrade, only `n-1` to `n` upgrade is supported, e.g. if the current observability version is `v1.8.x`, it can be upgraded to `1.9.x`. From b5aa8b14f8404559614477efba3de5706ab51fea Mon Sep 17 00:00:00 2001 From: Kakde Date: Fri, 7 Jun 2024 13:06:59 +0530 Subject: [PATCH 3/7] steps for Authorization upgrade added --- .../docs/deployment/csmoperator/modules/authorization.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/content/docs/deployment/csmoperator/modules/authorization.md b/content/docs/deployment/csmoperator/modules/authorization.md index cb737d7b9e..b8ce4060ec 100644 --- a/content/docs/deployment/csmoperator/modules/authorization.md +++ b/content/docs/deployment/csmoperator/modules/authorization.md @@ -154,7 +154,9 @@ This section outlines the upgrade steps for Container Storage Modules (CSM) for - Upgrading the Authorization Proxy Server - Modifying the existing Authorization Proxy Server installation directly via `kubectl edit` + Modifying the existing Authorization Proxy Server installation directly via `kubectl edit` + + ```sh kubectl get -n ``` @@ -177,6 +179,8 @@ This section outlines the upgrade steps for Container Storage Modules (CSM) for # Replace object-name with the authorization kubectl edit csm authorization -n +- Modify the installation + - Update the CSM Authorization Proxy Server configVersion - Update the images for proxyService, tenantService, roleService and storageService From 71186fee920d07262fd38d7b002b01e7e02ae317 Mon Sep 17 00:00:00 2001 From: Kakde Date: Fri, 7 Jun 2024 13:18:47 +0530 Subject: [PATCH 4/7] link to authorization module added --- content/docs/deployment/csmoperator/_index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/deployment/csmoperator/_index.md b/content/docs/deployment/csmoperator/_index.md index 04b1b242fb..12692bd810 100644 --- a/content/docs/deployment/csmoperator/_index.md +++ b/content/docs/deployment/csmoperator/_index.md @@ -367,6 +367,8 @@ The following notes explain some of the general items to take care of. * Refer [Upgrade Obsevability Module](./modules/observability/#upgrade-observability) to upgrade the Observability Module via Operator +* Refer [Upgrade Authorization Module](./modules/authorization/#upgrade-csm-authorization) to upgrade the Authorization Module via Operator + ## Custom Resource Definitions As part of the Dell CSM Operator installation, a CRD representing configuration for the CSI Driver and CSM Modules is also installed. `containerstoragemodule` CRD is installed in API Group `storage.dell.com`. From 53195396cee2a4afb1607b3189208c97d6382126 Mon Sep 17 00:00:00 2001 From: Kakde Date: Fri, 7 Jun 2024 17:50:00 +0530 Subject: [PATCH 5/7] review comments addressed --- .../csmoperator/modules/authorization.md | 87 +++++++++---------- 1 file changed, 42 insertions(+), 45 deletions(-) diff --git a/content/docs/deployment/csmoperator/modules/authorization.md b/content/docs/deployment/csmoperator/modules/authorization.md index b8ce4060ec..c8b831286a 100644 --- a/content/docs/deployment/csmoperator/modules/authorization.md +++ b/content/docs/deployment/csmoperator/modules/authorization.md @@ -149,74 +149,71 @@ Follow the instructions available in CSM Authorization for [Configuring a Dell C This section outlines the upgrade steps for Container Storage Modules (CSM) for Authorization. The upgrade of CSM for Authorization is handled in 2 parts: 1) Upgrading the Authorization proxy server -2) Upgrading CSI Driver , Authorization sidecar with Authorization module enabled +2) Upgrading CSI Driver, Authorization sidecar with Authorization module enabled -- Upgrading the Authorization Proxy Server +## Upgrading the Authorization Proxy Server - Modifying the existing Authorization Proxy Server installation directly via `kubectl edit` - - ```sh - kubectl get -n - ``` + 1. Modifying the existing Authorization Proxy Server installation directly via `kubectl edit` + + ```sh + kubectl get csm -n + ``` - For example - If the Authorization Proxy Server is installed then run this command to get the object name + For example - If the Authorization Proxy Server is installed in authorization namespace then run this command to get the object name - ```sh - # Replace module-namespace with the namespace where the Authorization Proxy Server is installed - $ kubectl get csm -n - ``` + ```sh + $ kubectl get csm -n authorization + ``` - use the object name in `kubectl edit` command. + use the object name in `kubectl edit` command. - ```sh - kubectl edit csm -n - ``` + ```sh + kubectl edit csm -n + ``` - For example - If the object name is authorization then use the name as authorization + For example - If the object name is authorization then use the name as authorization and if the namespace is authorization, then run this command to edit the object - ```sh - # Replace object-name with the authorization - kubectl edit csm authorization -n + ```sh + kubectl edit csm authorization -n authorization + ``` -- Modify the installation + 2. Modify the installation - - Update the CSM Authorization Proxy Server configVersion - - Update the images for proxyService, tenantService, roleService and storageService + - Update the CSM Authorization Proxy Server configVersion + - Update the images for proxyService, tenantService, roleService and storageService -- Upgrading CSI Driver , Authorization sidecar with Authorization module enabled +## Upgrading CSI Driver, Authorization sidecar with Authorization module enabled - Modifying the existing driver and module installation directly via `kubectl edit` + 1. Modifying the existing driver and module installation directly via `kubectl edit` - ```sh - kubectl get -n - ``` + ```sh + kubectl get -n + ``` - For example - If the CSI PowerFlex driver is installed then run this command to get the object name + For example - If the CSI PowerFlex driver is installed in vxflexos namepace then run this command to get the object name - ```sh - # Replace driver-namespace with the namespace where the CSI PowerFlex driver is installed - $ kubectl get csm -n - ``` + ```sh + kubectl get csm -n vxflexos + ``` - use the object name in `kubectl edit` command. + use the object name in `kubectl edit` command. - ```sh - kubectl edit csm / -n - ``` + ```sh + kubectl edit csm / -n + ``` - For example - If the object name is vxflexos then use the name as vxflexos + For example - If the object name is vxflexos then use the name as vxflexos and if the driver is installed in vxflexos namespace, then run this command to edit the object - ```sh - # Replace object-name with the vxflexos - kubectl edit csm vxflexos -n - ``` + ```sh + kubectl edit csm vxflexos -n vxflexos + ``` -- Modify the installation + 2. Modify the installation - - Update the driver config version and image tag - - Update the Authorization config version and karavi-authorization-proxy image. + - Update the driver config version and image tag + - Update the Authorization config version and karavi-authorization-proxy image. >NOTE: From 681b0a1f68b7e71f5eb39a2df48567e89d82f574 Mon Sep 17 00:00:00 2001 From: Kakde Date: Mon, 10 Jun 2024 14:49:36 +0530 Subject: [PATCH 6/7] sign commit --- config.toml | 2 +- .../csm-versions/default-values.properties | 2 +- .../csminstallationwizard/src/index.html | 8 +- .../src/static/js/constants.js | 6 +- .../src/static/js/tests/generate-yaml.test.js | 6 +- .../src/static/js/tests/ui-functions.test.js | 10 +- .../src/static/js/tests/utility.test.js | 6 +- .../src/static/js/ui-functions.js | 16 +-- .../templates/helm/csm-1.11.0-values.template | 76 +++++++-------- .../operator/csm-isilon-1.11.0.template | 20 ++-- .../operator/csm-powermax-1.11.0.template | 14 +-- .../operator/csm-powerstore-1.11.0.template | 6 +- content/docs/deployment/csmoperator/_index.md | 21 ++-- .../csmoperator/modules/authorization.md | 97 ++++++++++--------- .../csmoperator/modules/observability.md | 26 ++--- 15 files changed, 163 insertions(+), 153 deletions(-) diff --git a/config.toml b/config.toml index ad977d6d2a..919f68ed82 100644 --- a/config.toml +++ b/config.toml @@ -176,7 +176,7 @@ enable = false url = "https://dell.github.io/csm-docs/docs/" [[params.versions]] - version = "v1.10.0" + version = "v1.10.2" url = "https://dell.github.io/csm-docs/v1" [[params.versions]] diff --git a/content/docs/deployment/csminstallationwizard/src/csm-versions/default-values.properties b/content/docs/deployment/csminstallationwizard/src/csm-versions/default-values.properties index 61fd4afa52..7ec130a487 100644 --- a/content/docs/deployment/csminstallationwizard/src/csm-versions/default-values.properties +++ b/content/docs/deployment/csminstallationwizard/src/csm-versions/default-values.properties @@ -1,4 +1,4 @@ -csmVersion=1.10.1 +csmVersion=1.11.0 imageRepository=dellemc controllerCount=1 nodeSelectorLabel=node-role.kubernetes.io/control-plane: diff --git a/content/docs/deployment/csminstallationwizard/src/index.html b/content/docs/deployment/csminstallationwizard/src/index.html index 6cebdb07d0..df2597bfd4 100644 --- a/content/docs/deployment/csminstallationwizard/src/index.html +++ b/content/docs/deployment/csminstallationwizard/src/index.html @@ -90,10 +90,10 @@
diff --git a/content/docs/deployment/csminstallationwizard/src/static/js/constants.js b/content/docs/deployment/csminstallationwizard/src/static/js/constants.js index b4975024fd..c11ae18901 100644 --- a/content/docs/deployment/csminstallationwizard/src/static/js/constants.js +++ b/content/docs/deployment/csminstallationwizard/src/static/js/constants.js @@ -40,10 +40,10 @@ const CONSTANTS = { PROPERTIES: ".properties", HELM: "helm", OPERATOR: "operator", - CSM_HELM_V170: "1.0.0", CSM_HELM_V180: "1.1.0", - CSM_HELM_V190: "1.2.1", - CSM_HELM_V1101: "1.3.1", + CSM_HELM_V190: "1.2.2", + CSM_HELM_V1102: "1.3.2", + CSM_HELM_V1110: "1.4.0", HELM_TAINTS: ` - key: "$KEY" operator: "Exists" diff --git a/content/docs/deployment/csminstallationwizard/src/static/js/tests/generate-yaml.test.js b/content/docs/deployment/csminstallationwizard/src/static/js/tests/generate-yaml.test.js index d3f86ca24f..44164efc64 100644 --- a/content/docs/deployment/csminstallationwizard/src/static/js/tests/generate-yaml.test.js +++ b/content/docs/deployment/csminstallationwizard/src/static/js/tests/generate-yaml.test.js @@ -42,10 +42,10 @@ const CONSTANTS = { PROPERTIES: ".properties", HELM: "helm", OPERATOR: "operator", - CSM_HELM_V170: "1.0.0", CSM_HELM_V180: "1.1.0", - CSM_HELM_V190: "1.2.0", - CSM_HELM_V1100: "1.3.0", + CSM_HELM_V190: "1.2.2", + CSM_HELM_V1102: "1.3.2", + CSM_HELM_V1110: "1.4.0", HELM_TAINTS: ` - key: "$KEY" operator: "Exists" diff --git a/content/docs/deployment/csminstallationwizard/src/static/js/tests/ui-functions.test.js b/content/docs/deployment/csminstallationwizard/src/static/js/tests/ui-functions.test.js index eb6e90a452..d4096b888c 100644 --- a/content/docs/deployment/csminstallationwizard/src/static/js/tests/ui-functions.test.js +++ b/content/docs/deployment/csminstallationwizard/src/static/js/tests/ui-functions.test.js @@ -68,10 +68,10 @@ const CONSTANTS = { PROPERTIES: ".properties", HELM: "helm", OPERATOR: "operator", - CSM_HELM_V170: "1.0.0", CSM_HELM_V180: "1.1.0", - CSM_HELM_V190: "1.2.0", - CSM_HELM_V1100: "1.3.0", + CSM_HELM_V190: "1.2.2", + CSM_HELM_V1102: "1.3.2", + CSM_HELM_V1110: "1.4.0", }; describe("GIVEN onAuthorizationChange function", () => { @@ -718,7 +718,7 @@ describe("GIVEN displayCommands function", () => { - +