Add observability and authorization upgrade support in documentation (#…

…1137)

* restructure observability module upgrade docs

* steps for Authorization upgrade added

* steps for Authorization upgrade added

* link to authorization module added

* review comments addressed

* sign commit

* sign commit

---------

Co-authored-by: Chiman Jain <chimanjain15@gmail.com>

content/docs/deployment/csmoperator/_index.md

@@ -363,46 +363,11 @@ 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.
+* Refer [Upgrade Obsevability Module](./modules/observability/#upgrade-observability) to upgrade the Observability Module via Operator
 
-* Modifying the existing driver and module installation directly via `kubectl edit`
-
-  ```sh
-  $ kubectl get <driver-object> -n <driver-namespace>
-  ```
-
-  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 <driver-namespace>
-  ```
-
-  use the object name in `kubectl edit` command.
-
-  ```sh
-  $ kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
-  ```
-
-  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 <driver-namespace>
-  ```
-
-* 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 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.

content/docs/deployment/csmoperator/modules/authorization.md

@@ -144,3 +144,77 @@ 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
+
+  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
+    ```
+
+    use the object name in `kubectl edit` command.
+
+    ```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
+
+    ```sh
+    kubectl edit csm authorization -n authorization
+    ```
+
+  2. Modify the installation
+
+    - 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
+
+  1. Modifying the existing driver and module installation directly via `kubectl edit`
+
+    ```sh
+    kubectl get <driver-object> -n <driver-namespace>
+    ```
+
+    For example - If the CSI PowerFlex driver is installed in vxflexos namepace then run this command to get the object name
+
+    ```sh
+    kubectl get csm -n vxflexos
+    ```
+
+    use the object name in `kubectl edit` command.
+
+    ```sh
+    kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
+    ```
+
+    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
+    kubectl edit csm vxflexos -n vxflexos
+    ```
+
+  2. 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`.

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 <driver-object> -n <driver-namespace>
+  ```
+
+  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 <driver-namespace>
+  ```
+
+  use the object name in `kubectl edit` command.
+
+  ```sh
+  kubectl edit csm <driver-object>/<object-name> -n <driver-namespace>
+  ```
+
+  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 <driver-namespace>
+  ```
+
+- 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.