versioning the docs

dell · Mar 7, 2024 · 639d207 · 639d207
1 parent daaca0f
commit 639d207
Show file tree

Hide file tree

Showing 387 changed files with 16,141 additions and 7,649 deletions.
diff --git a/content/v1/_index.md b/content/v1/_index.md
@@ -1,4 +1,3 @@
-
 ---
 title: "Documentation"
 linkTitle: "Documentation"
@@ -31,7 +30,7 @@ CSM is made up of multiple components including modules (enterprise capabilities
 {{< /cardpane >}}
 {{< cardpane >}}
 {{< card header="[**Resiliency**](resiliency/)"
-          footer="Supports [PowerFlex](csidriver/features/powerflex/) [PowerScale](csidriver/features/powerscale/) [Unity](csidriver/features/unity/)">}}
+          footer="Supports [PowerFlex](csidriver/features/powerflex/) [PowerScale](csidriver/features/powerscale/) [Unity](csidriver/features/unity/) [PowerStore](csidriver/features/powerstore/)">}}
   CSM for Resiliency is designed to make Kubernetes Applications, including those that utilize persistent storage, more resilient to various failures.
 [...Learn more](resiliency/)
   {{< /card >}}
@@ -60,15 +59,4 @@ CSM is made up of multiple components including modules (enterprise capabilities
   Request a license using the [Container Storage Modules License Request](https://app.smartsheet.com/b/form/5e46fad643874d56b1f9cf4c9f3071fb) by providing the requested details.
    [...Learn more](license/)
   {{< /card >}}
-{{< /cardpane >}}
-
-## CSM Modules Support Matrix for Dell CSI Drivers
-
-| CSM Module                                                  | CSI PowerFlex v2.8.0 | CSI PowerScale v2.8.0 | CSI PowerStore v2.8.0 | CSI PowerMax v2.8.0 | CSI Unity XT v2.8.0 |
-| ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
-| [**Authorization**](authorization/) v1.8.0                  | ✔️                    | ✔️                     | ❌                     | ✔️                   | ❌                   |
-| [**Observability**](observability/) v1.6.0                  | ✔️                    | ✔️                     | ✔️                     | ✔️                   | ❌                   |
-| [**Replication**](replication/)   v1.6.0                    | ✔️                    | ✔️                     | ✔️                     | ✔️                   | ❌                   |
-| [**Resiliency**](resiliency/)     v1.7.0                    | ✔️                    | ✔️                     | ✔️                     | ❌                   | ✔️                   |
-| [**Encryption**](secure/encryption)    v0.4.0               | ❌                    | ✔️                     | ❌                     | ❌                   | ❌                   |
-| [**Application Mobility**](applicationmobility/)     v0.4.0 | ✔️                    | ✔️                     | ✔️                     | ✔️                   | ✔️                   |
+{{< /cardpane >}}
diff --git a/content/v1/applicationmobility/_index.md b/content/v1/applicationmobility/_index.md
@@ -29,12 +29,10 @@ After a backup has been created, it can be restored on the same Kubernetes clust
 | Restic           | Persistent Volume data will be stored in the provided object store bucket |
 {{</table>}}
 
-## Supported Operating Systems/Container Orchestrator Platforms
+## Supported Container Orchestrator Platforms
 {{<table "table table-striped table-bordered table-sm">}}
 | COP/OS | Supported Versions |
 |-|-|
-| Kubernetes           |    1.23, 1.24, 1.25, 1.26 |
-| Red Hat OpenShift    |    4.10, 4.11       |
-| RHEL                 |     7.x, 8.x  |
-| CentOS               |     7.8, 7.9  |
+| Kubernetes           |    1.26, 1.27. 1.28 |
+| Red Hat OpenShift    |    4.13, 4.14       |
 {{</table>}}
diff --git a/content/v1/authorization/_index.md b/content/v1/authorization/_index.md
@@ -33,17 +33,15 @@ The following diagram shows a high-level overview of CSM for Authorization with
 {{<table "table table-striped table-bordered table-sm">}}
 | COP/OS | Supported Versions |
 |-|-|
-| Kubernetes    | 1.25, 1.26, 1.27 |
-| RHEL          |     7.x, 8.x     |
-| CentOS        |     7.8, 7.9     |
+| Kubernetes    | 1.26, 1.27, 1.28 |
 {{</table>}}
 
 ## Supported Storage Platforms
 
 {{<table "table table-striped table-bordered table-sm">}}
 |               | PowerMax         | PowerFlex | PowerScale |
 |---------------|:----------------:|:-------------------:|:----------------:|
-| Storage Array |PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) <br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx,<br> Unisphere 10.0, 10.0.1|    3.5.x, 3.6.x    | OneFS 8.1, 8.2, 9.0, 9.1, 9.2, 9.3, 9.4, 9.5 |
+| Storage Array |PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx,<br> Unisphere 10.0, 10.0.1, 10.1|    3.6.x, 4.0.x, 4.5    | OneFS 9.5.0.x (x >= 5) |
 {{</table>}}
 
 ## Supported CSI Drivers
@@ -61,21 +59,8 @@ CSM for Authorization supports the following CSI drivers and versions.
 To resolve this, please refer to our [troubleshooting guide](./troubleshooting) on the topic.
 
 ## Authorization Components Support Matrix
-CSM for Authorization consists of 2 components - the Authorization sidecar and the Authorization proxy server.  It is important that the version of the Authorization sidecar image maps to a supported version of the Authorization proxy server.
+CSM for Authorization consists of 2 components - The authorization sidecar, bundled with the driver, communicates with the Authorization proxy server to validate access to Storage platforms. The authorization sidecar is backward compatible with older Authorization proxy server versions. However, it is highly recommended to have the Authorization proxy server and sidecar installed from the same release of CSM.
 
-{{<table "table table-striped table-bordered table-sm">}}
-| Authorization Sidecar Image Tag | Authorization Proxy Server Version |
-| ------------------------------- | ---------------------------------- |
-| dellemc/csm-authorization-sidecar:v1.0.0 | v1.0.0, v1.1.0 |
-| dellemc/csm-authorization-sidecar:v1.2.0 | v1.1.0, v1.2.0 |
-| dellemc/csm-authorization-sidecar:v1.3.0 | v1.1.0, v1.2.0, v1.3.0 |
-| dellemc/csm-authorization-sidecar:v1.4.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0 |
-| dellemc/csm-authorization-sidecar:v1.5.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0 |
-| dellemc/csm-authorization-sidecar:v1.5.1 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1 |
-| dellemc/csm-authorization-sidecar:v1.6.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0 |
-| dellemc/csm-authorization-sidecar:v1.7.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0, v1.7.0 |
-| dellemc/csm-authorization-sidecar:v1.8.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0, v1.7.0, v1.8.0 |
-{{</table>}}
 ## Roles and Responsibilities
 
 The CSM for Authorization CLI can be executed in the context of the following roles:

diff --git a/content/v1/authorization/cli.md b/content/v1/authorization/cli.md
@@ -247,6 +247,11 @@ Usually, you will want to pipe the output to kubectl to apply the secret
 ```bash
 karavictl generate token --tenant Alice --admin-token admintoken.yaml --addr csm-authorization.host.com | kubectl apply -f -
 ```
+The token is read once when the driver pods are started and is not dynamically updated. If you are applying a new token in an existing driver installation, restart the driver pods for the new token to take effect.
+```bash
+kubectl -n <driver-namespace> rollout restart deploy/<driver>-controller
+kubectl -n <driver-namespace> rollout restart ds/<driver>-node
+```
 
 ### karavictl role
 

diff --git a/content/v1/authorization/configuration/powerflex/_index.md b/content/v1/authorization/configuration/powerflex/_index.md
@@ -106,7 +106,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
 
     - Update `authorization.enabled` to `true`.
 
-    - Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
+    - Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
 
     - Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.
 
@@ -119,8 +119,8 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
       enabled: true
 
       # sidecarProxyImage: the container image used for the csm-authorization-sidecar.
-      # Default value: dellemc/csm-authorization-sidecar:v1.8.0
-      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
+      # Default value: dellemc/csm-authorization-sidecar:v1.9.0
+      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
 
       # proxyHost: hostname of the csm-authorization server
       # Default value: None
@@ -156,10 +156,10 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
       - name: authorization
         # enable: Enable/Disable csm-authorization
         enabled: true
-        configVersion: v1.8.0
+        configVersion: v1.9.0
         components:
         - name: karavi-authorization-proxy
-          image: dellemc/csm-authorization-sidecar:v1.8.0
+          image: dellemc/csm-authorization-sidecar:v1.9.0
           envs:
             # proxyHost: hostname of the csm-authorization server
             - name: "PROXY_HOST"

diff --git a/content/v1/authorization/configuration/powermax/_index.md b/content/v1/authorization/configuration/powermax/_index.md
@@ -65,7 +65,7 @@ Create the karavi-authorization-config secret using this command:
 
     - Update `authorization.enabled` to `true`.
 
-    - Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
+    - Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
 
     - Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.
 
@@ -85,8 +85,8 @@ Create the karavi-authorization-config secret using this command:
       enabled: true
 
       # sidecarProxyImage: the container image used for the csm-authorization-sidecar.
-      # Default value: dellemc/csm-authorization-sidecar:v1.8.0
-      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
+      # Default value: dellemc/csm-authorization-sidecar:v1.9.0
+      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
 
       # proxyHost: hostname of the csm-authorization server
       # Default value: None
@@ -100,6 +100,42 @@ Create the karavi-authorization-config secret using this command:
       skipCertificateValidation: true
     ```
 
+    **Operator**
+
+    Refer to the [Install Driver](../../../deployment/csmoperator/drivers/powermax/#install-driver) section to edit the parameters in the Custom Resource to enable CSM Authorization.
+
+    Under `modules`, enable the module named `authorization`:
+
+    - Update the `enabled` field to `true.`
+
+    - Update the `image` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
+
+    - Update the `PROXY_HOST` environment value to the hostname of the CSM Authorization Proxy Server.
+
+    - Update the `SKIP_CERTIFICATE_VALIDATION` environment value to `true` or `false` depending on if you want to disable or enable certificate validation of the CSM Authorization Proxy Server.
+
+    Example: 
+
+    ```yaml
+    modules:
+      # Authorization: enable csm-authorization for RBAC
+      - name: authorization
+        # enable: Enable/Disable csm-authorization
+        enabled: true
+        configVersion: v1.9.0
+        components:
+        - name: karavi-authorization-proxy
+          image: dellemc/csm-authorization-sidecar:v1.9.0
+          envs:
+            # proxyHost: hostname of the csm-authorization server
+            - name: "PROXY_HOST"
+              value: "csm-authorization.com"
+          
+            # skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server       
+            - name: "SKIP_CERTIFICATE_VALIDATION"
+              value: "true"
+    ```
+
 5. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.
 
 6. (Optional) Install [dellctl](../../../references/cli) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../references/cli) for the installation steps and command list.
diff --git a/content/v1/authorization/configuration/powerscale/_index.md b/content/v1/authorization/configuration/powerscale/_index.md
@@ -114,7 +114,7 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
 
     - Update `authorization.enabled` to `true`.
 
-    - Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
+    - Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
 
     - Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.
 
@@ -127,8 +127,8 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
       enabled: true
 
       # sidecarProxyImage: the container image used for the csm-authorization-sidecar.
-      # Default value: dellemc/csm-authorization-sidecar:v1.8.0
-      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
+      # Default value: dellemc/csm-authorization-sidecar:v1.9.0
+      sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
 
       # proxyHost: hostname of the csm-authorization server
       # Default value: None
@@ -162,10 +162,10 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
       - name: authorization
         # enable: Enable/Disable csm-authorization
         enabled: true
-        configVersion: v1.8.0
+        configVersion: v1.9.0
         components:
         - name: karavi-authorization-proxy
-          image: dellemc/csm-authorization-sidecar:v1.8.0
+          image: dellemc/csm-authorization-sidecar:v1.9.0
           envs:
             # proxyHost: hostname of the csm-authorization server
             - name: "PROXY_HOST"

diff --git a/content/v1/authorization/release/_index.md b/content/v1/authorization/release/_index.md
@@ -6,18 +6,25 @@ Description: >
   Dell Container Storage Modules (CSM) release notes for authorization
 ---
 
-## Release Notes - CSM Authorization 1.8.0
+## Release Notes - CSM Authorization 1.9.1
+
+
+
+
+
 
 
 
 ### New Features/Changes
 
-- [#922 - [FEATURE]: Use ubi9 micro as base image](https://github.com/dell/csm/issues/922)
+- [#947 - [FEATURE]: Support for Kubernetes 1.28](https://github.com/dell/csm/issues/947)
+- [#1066 - [FEATURE]: Support for Openshift 4.14](https://github.com/dell/csm/issues/1066)
+- [#996 - [FEATURE]: Dell CSI to Dell CSM Operator Migration Process](https://github.com/dell/csm/issues/996)
+- [#1031 - [FEATURE]: Update to the latest UBI Micro image for CSM](https://github.com/dell/csm/issues/1031)
+- [#1062 - [FEATURE]: CSM PowerMax: Support PowerMax v10.1 ](https://github.com/dell/csm/issues/1062)
 
 ### Fixed Issues
 
-- [#895 - [BUG]: Update CSM Authorization karavictl CLI flag descriptions](https://github.com/dell/csm/issues/895)
-- [#916 - [BUG]: Remove references to deprecated io/ioutil package](https://github.com/dell/csm/issues/916)
 
 ### Known Issues
 

diff --git a/content/v1/authorization/troubleshooting.md b/content/v1/authorization/troubleshooting.md
@@ -15,10 +15,7 @@ The CSM Authorization RPM will be deprecated in a future release. It is highly r
 - [Running `karavictl tenant` commands result in an HTTP 504 error](#running-karavictl-tenant-commands-result-in-an-http-504-error)
 - [Installation fails to install policies](#installation-fails-to-install-policies)
 - [After installation, the create-pvc Pod is in an Error state](#after-installation-the-create-pvc-pod-is-in-an-error-state)
-
-## Helm Deployment
-- [The CSI Driver for Dell PowerFlex v2.3.0 is in an Error or CrashLoopBackoff state due to "request denied for path" errors](#the-csi-driver-for-dell-powerflex-v230-is-in-an-error-or-crashloopbackoff-state-due-to-request-denied-for-path-errors)
-
+- [Intermittent 401 issues with generated token](#intermittent-401-issues-with-generated-token)
 ---
 
 ### The Failure of Building an Authorization RPM
@@ -97,6 +94,23 @@ Run the following commands to allow the PVC to be created:
 semanage fcontext -a -t container_file_t  "/var/lib/rancher/k3s/storage(/.*)?"
 restorecon -R  /var/lib/rancher/k3s/storage/
 ```
+### Intermittent 401 issues with generated token
+This issue occurs when a new access token is generated in an existing driver installation.
+
+__Resolution__
+
+If you are applying a new token in an existing driver installation, restart the driver pods for the new token to take effect. The token is read once when the driver pods are started and is not dynamically updated. 
+```bash
+kubectl -n <driver-namespace> rollout restart deploy/<driver>-controller
+kubectl -n <driver-namespace> rollout restart ds/<driver>-node
+```
+
+## Helm Deployment
+- [The CSI Driver for Dell PowerFlex v2.3.0 is in an Error or CrashLoopBackoff state due to "request denied for path" errors](#the-csi-driver-for-dell-powerflex-v230-is-in-an-error-or-crashloopbackoff-state-due-to-request-denied-for-path-errors)
+- [Intermittent 401 issues with generated token](#intermittent-401-issues-with-generated-token)
+
+---
+
 
 ### The CSI Driver for Dell PowerFlex v2.3.0 is in an Error or CrashLoopBackoff state due to "request denied for path" errors
 The vxflexos-controller pods will have logs similar to:
@@ -184,3 +198,14 @@ kubectl -n <namespace> rollout restart deploy/proxy-server
 kubectl -n <driver-namespace> rollout restart deploy/vxflexos-controller
 kubectl -n <driver-namespace> rollout restart daemonSet/vxflexos-node
 ```
+
+### Intermittent 401 issues with generated token
+This issue occurs when a new access token is generated in an existing driver installation.
+
+__Resolution__
+
+If you are applying a new token in an existing driver installation, restart the driver pods for the new token to take effect. The token is read once when the driver pods are started and is not dynamically updated. 
+```bash
+kubectl -n <driver-namespace> rollout restart deploy/<driver>-controller
+kubectl -n <driver-namespace> rollout restart ds/<driver>-node
+```
diff --git a/content/v1/cosidriver/features/objectscale.md b/content/v1/cosidriver/features/objectscale.md
@@ -4,11 +4,6 @@ linktitle: ObjectScale
 weight: 1
 Description: Code features for ObjectScale COSI Driver
 ---
-
-> **Notational Conventions**
->
-> The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
-
 Fields are specified by their path. Consider the following examples:
 
 1. Field specified by the following path `spec.authenticationType=IAM` is reflected in their resources YAML as the following:

diff --git a/content/v1/cosidriver/installation/configuration_file.md b/content/v1/cosidriver/installation/configuration_file.md
@@ -4,11 +4,6 @@ linktitle: Configuration File
 weight: 1
 Description: Description of configuration file for ObjectScale
 ---
-
-> **Notational Conventions**
->
-> The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
-
 ## Dell COSI Driver Configuration Schema
 
 This configuration file is used to specify the settings for the Dell COSI Driver, which is responsible for managing connections to the Dell ObjectScale platform. The configuration file is written in YAML format and based on the JSON schema and adheres to its specification.