sign commit

dell · Jun 10, 2024 · aab286f · aab286f
1 parent 681b0a1
commit aab286f
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 77 deletions.
diff --git a/content/docs/deployment/csmoperator/_index.md b/content/docs/deployment/csmoperator/_index.md
@@ -337,22 +337,21 @@ git clone -b v1.5.0 https://github.com/dell/csm-operator.git
 The CSI Drivers installed by the Dell CSM Operator can be updated like any Kubernetes resource.
 * Modifying the installation directly via `kubectl edit`
     ```
-    $ kubectl get csm -n <driver-namespace>
+    $ kubectl get <driver-object> -n <driver-namespace>
     ```
-    For example - If the CSI PowerStore driver is installed in powerstore namespace, then run this command to get the object name
+    For example - If the CSI PowerStore driver is installed then run this command to get the object name
     ```
-    
-    $ kubectl get csm -n powerstore
+    # Replace driver-namespace with the namespace where the CSI PowerStore driver is installed
+    $ kubectl get csm -n <driver-namespace>
     ```
     use the object name in `kubectl edit` command.
     ```
-    
-    $ kubectl edit csm <object-name> -n <driver-namespace>
+    $ kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
     ```
-    For example - If the object name is powerstore and the driver is installed in powerstore namespace, then run this command to edit the object name
+    For example - If the object name is powerstore then use the name as powerstore
     ```
-    
-    $ kubectl edit csm powerstore -n powerstore
+    # Replace object-name with the powerstore
+    $ kubectl edit csm powerstore -n <driver-namespace>
     ```
     and modify the installation. The usual fields to edit are the version of drivers, sidecars and the environment variables.
 The following notes explain some of the general items to take care of.
@@ -366,9 +365,9 @@ The following notes explain some of the general items to take care of.
 
 ### Upgrade Modules using Dell CSM Operator
 
-* Refer [Upgrade Obsevability Module](modules/observability/#upgrade-observability) to upgrade the Observability Module via Operator
+* 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
+* 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.

diff --git a/content/docs/deployment/csmoperator/modules/authorization.md b/content/docs/deployment/csmoperator/modules/authorization.md
@@ -145,83 +145,76 @@ Follow the instructions available in CSM Authorization for [Configuring the CSM
 
 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
+### 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
+1) Upgrading the Authorization proxy server
+2) Upgrading CSI Driver, Authorization sidecar with Authorization module enabled
 
-### Upgrading the Authorization Proxy Server
 
-1. Modifying the existing Authorization Proxy Server installation directly via `kubectl edit`
-
-   ```sh
-
-   kubectl get csm -n <module-namespace>
-   ```
-
-   For example - If the Authorization Proxy Server is installed in authorization namespace, then run this command to get the object name
-
-   ```sh
-    
-   kubectl get csm -n authorization
-   ```
+## Upgrading the Authorization Proxy Server
 
-   use the object name in `kubectl edit` command.
-
-   ```sh
-
-   kubectl edit csm <object-name> -n <module-namespace>
-   ```
-
-   If the object name is authorization and the proxy server is installed in authorization namespace, then run this command to edit the object
+  1. Modifying the existing Authorization Proxy Server installation directly via `kubectl edit`
+
+    ```sh
+    kubectl get csm -n <module-namespace>
+    ```
 
-   ```sh
+    For example - If the Authorization Proxy Server is installed in authorization namespace then run this command to get the object name
 
-   kubectl edit csm authorization -n authorization
-   ```
+    ```sh
+    $ kubectl get csm -n authorization
+    ```
 
-2. Modify the installation
+    use the object name in `kubectl edit` command.
 
-   - Update the CSM Authorization Proxy Server configVersion  
-   - Update the images for proxyService, tenantService, roleService and storageService
+    ```sh
+    kubectl edit csm <object-name> -n <module-namespace>
+    ```
 
+    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
 
-### Upgrading CSI Driver, Authorization sidecar with Authorization module enabled
+    ```sh
+    kubectl edit csm authorization -n authorization
+    ```
 
-1. Modifying the existing driver and module installation directly via `kubectl edit`
+  2. Modify the installation
 
-   ```sh
+    - Update the CSM Authorization Proxy Server configVersion  
+    - Update the images for proxyService, tenantService, roleService and storageService
 
-   kubectl get csm -n <driver-namespace>
-   ```
 
-   For example - If the CSI PowerFlex driver is installed in vxflexos namepace, then run this command to get the object name
+## Upgrading CSI Driver, Authorization sidecar with Authorization module enabled
 
-   ```sh
+  1. Modifying the existing driver and module installation directly via `kubectl edit`
 
-   kubectl get csm -n vxflexos
-   ```
+    ```sh
+    kubectl get <driver-object> -n <driver-namespace>
+    ```
 
-   use the object name in `kubectl edit` command.
+    For example - If the CSI PowerFlex driver is installed in vxflexos namepace then run this command to get the object name
 
-   ```sh
+    ```sh
+    kubectl get csm -n vxflexos
+    ```
 
-   kubectl edit csm <object-name> -n <driver-namespace>
-   ```
+    use the object name in `kubectl edit` command.
 
-   For example - If the object name is vxflexos and the driver is installed in vxflexos namespace, then run this command to edit the object
+    ```sh
+    kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
+    ```
 
-   ```sh
+    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
 
-   kubectl edit csm vxflexos -n vxflexos
-   ```
+    ```sh
+    kubectl edit csm vxflexos -n vxflexos
+    ```
 
-2. Modify the installation
+  2. Modify the installation
 
-   - Update the driver config version and image.
-   - 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:
 
-- In Authorization module upgrade, only `n-1` to `n` upgrade is supported, e.g. if the current authorization version is `v1.8.x`, it can be upgraded to `1.9.x`.
+- 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`.
diff --git a/content/docs/deployment/csmoperator/modules/observability.md b/content/docs/deployment/csmoperator/modules/observability.md
@@ -61,38 +61,36 @@ The CSM Observability module for supported Dell CSI Drivers can be installed via
 
 The Observability module installed by the Dell CSM Operator can be updated like any Kubernetes resource.
 
-1. Modifying the existing driver and module installation directly via `kubectl edit`
+- Modifying the existing driver and module installation directly via `kubectl edit`
 
   ```sh
-
-  kubectl get csm -n <driver-namespace>
+  kubectl get <driver-object> -n <driver-namespace>
   ```
 
-  For example - If the CSI PowerScale driver is installed in isilon namespace, then run this command to get the object name
+  For example - If the CSI PowerScale driver is installed then run this command to get the object name
 
   ```sh
-
-  kubectl get csm -n isilon
+  # Replace driver-namespace with the namespace where the CSI PowerScale driver is installed
+  $ kubectl get csm -n <driver-namespace>
   ```
 
   use the object name in `kubectl edit` command.
 
   ```sh
-
-  kubectl edit csm <object-name> -n <driver-namespace>
+  kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
   ```
 
-  For example - If the object name is isilon and the driver is installed in isilon namespace, then run this command to edit the object
+  For example - If the object name is isilon then use the name as isilon
 
   ```sh
-
-  kubectl edit csm isilon -n isilon
+  # Replace object-name with the isilon
+  kubectl edit csm isilon -n <driver-namespace>
   ```
 
-2. Modify the installation
+- Modify the installation
 
-  - Update the driver config version and image.
-  - 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`).
+  - 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: