From 23706009c62d3155716426647b5838514a72af0c Mon Sep 17 00:00:00 2001 From: root Date: Tue, 15 Oct 2024 02:04:07 +0000 Subject: [PATCH] PR feedback --- .../deployment/csmoperator/modules/observability.md | 2 +- .../installation/authorization v2.0/_index.md | 2 +- .../modules/installation/observability/deployment.md | 12 ++++++------ content/docs/deployment/offline/modules/_index.md | 6 +++--- content/docs/prerequisites/_index.md | 2 -- 5 files changed, 11 insertions(+), 13 deletions(-) diff --git a/content/docs/deployment/csmoperator/modules/observability.md b/content/docs/deployment/csmoperator/modules/observability.md index a4d4ce309e..b2f25b3db1 100644 --- a/content/docs/deployment/csmoperator/modules/observability.md +++ b/content/docs/deployment/csmoperator/modules/observability.md @@ -16,7 +16,7 @@ The CSM Observability module for supported Dell CSI Drivers can be installed via ``` - Enable Observability module and components in [sample manifests](https://github.com/dell/csm-operator/tree/main/samples). If cert-manager has already been installed, don't enable it. -- To use Observablity with CSM Authorization, the [Authorization Proxy Server](../authorization-v1.x/) should be installed and configured first. Then, enable the Authorization module along with the Observability module in the sample manifest. +- To use Observablity with CSM Authorization, the [Authorization Proxy Server](../authorization-v2.x/) should be installed and configured first. Then, enable the Authorization module along with the Observability module in the sample manifest. - Observability will deploy with self-signed certificates by default. If you want to have custom certificates created instead, please generate certificates and private keys, encode them in base64, and insert them into the sample file as shown below for whichever components you are enabling: ```yaml diff --git a/content/docs/deployment/helm/modules/installation/authorization v2.0/_index.md b/content/docs/deployment/helm/modules/installation/authorization v2.0/_index.md index 909d29f52a..1474a4b02c 100644 --- a/content/docs/deployment/helm/modules/installation/authorization v2.0/_index.md +++ b/content/docs/deployment/helm/modules/installation/authorization v2.0/_index.md @@ -139,7 +139,7 @@ Follow the instructions available in CSM Authorization for [Configuring the CSM Follow the instructions available in CSM Authorization for - [Configuring PowerFlex with Authorization](../../../../../authorization/v2.x/configuration/powerflex). - [Configuring PowerMax with Authorization](../../../../../authorization/v2.x/configuration/powermax). -- [Configuring PowerScale with Authorization](../../../../../authorization/v2.x/configuration/powermax). +- [Configuring PowerScale with Authorization](../../../../../authorization/v2.x/configuration/powerscale). ## Updating CSM for Authorization Proxy Server Configuration diff --git a/content/docs/deployment/helm/modules/installation/observability/deployment.md b/content/docs/deployment/helm/modules/installation/observability/deployment.md index d09ec2f92e..d868bd5306 100644 --- a/content/docs/deployment/helm/modules/installation/observability/deployment.md +++ b/content/docs/deployment/helm/modules/installation/observability/deployment.md @@ -49,7 +49,7 @@ The Container Storage Modules (CSM) for Observability Helm chart bootstraps an O kubectl get secret [VXFLEXOS-CONFIG] -n [CSI_DRIVER_NAMESPACE] -o yaml | sed 's/name: [VXFLEXOS-CONFIG]/name: vxflexos-config/' | sed 's/namespace: [CSI_DRIVER_NAMESPACE]/namespace: [CSM_NAMESPACE]/' | kubectl create -f - ``` - If [CSM for Authorization is enabled](../../authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerFlex, perform the following steps: + If [CSM for Authorization is enabled](../../authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerFlex, perform the following steps: 2. Copy the driver configuration parameters ConfigMap from the CSI PowerFlex namespace into the CSM for Observability namespace: @@ -104,7 +104,7 @@ The Container Storage Modules (CSM) for Observability Helm chart bootstraps an O kubectl get secret [ISILON-CREDS] -n [CSI_DRIVER_NAMESPACE] -o yaml | sed 's/name: [ISILON-CREDS]/name: isilon-creds/' | sed 's/namespace: [CSI_DRIVER_NAMESPACE]/namespace: [CSM_NAMESPACE]/' | kubectl create -f - ``` - If [CSM for Authorization is enabled](../../authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerScale, perform these steps: + If [CSM for Authorization is enabled](../../authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerScale, perform these steps: 2. Copy the driver configuration parameters ConfigMap from the CSI PowerScale namespace into the CSM for Observability namespace: @@ -161,7 +161,7 @@ The Container Storage Modules (CSM) for Observability Helm chart bootstraps an O done ``` - If [CSM for Authorization is enabled](../../authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerMax, perform these steps: + If [CSM for Authorization is enabled](../../authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerMax, perform these steps: 3. Copy the driver configuration parameters ConfigMap from the CSI PowerMax namespace into the CSM for Observability namespace: @@ -236,7 +236,7 @@ The following table lists the configurable parameters of the CSM for Observabili | `karaviMetricsPowerflex.volumePollFrequencySeconds` | The polling frequency (in seconds) to gather volume metrics | `10` | | `karaviMetricsPowerflex.storageClassPoolPollFrequencySeconds` | The polling frequency (in seconds) to gather storage class/pool metrics | `10` | | `karaviMetricsPowerflex.concurrentPowerflexQueries` | The number of simultaneous metrics queries to make to Powerflex(MUST be less than 10; otherwise, several request errors from Powerflex will ensue. | `10` | -| `karaviMetricsPowerflex.authorization.enabled` | [Authorization](../../authorization-v1.x) is an optional feature to apply credential shielding of the backend PowerFlex. | `false` | +| `karaviMetricsPowerflex.authorization.enabled` | [Authorization](../../authorization-v2.x) is an optional feature to apply credential shielding of the backend PowerFlex. | `false` | | `karaviMetricsPowerflex.authorization.proxyHost` | Hostname of the csm-authorization server. | | | `karaviMetricsPowerflex.authorization.skipCertificateValidation` | A boolean that enables/disables certificate validation of the csm-authorization server. | | | `karaviMetricsPowerflex.sdcMetricsEnabled` | Enable PowerFlex SDC Metrics Collection | `true` | @@ -277,7 +277,7 @@ The following table lists the configurable parameters of the CSM for Observabili | `karaviMetricsPowerscale.isiClientOptions.isiSkipCertificateValidation` | Skip OneFS API server's certificates | `true` | | `karaviMetricsPowerscale.isiClientOptions.isiAuthType` | 0 to enable session-based Authentication; 1 to enables basic Authentication | `1` | | `karaviMetricsPowerscale.isiClientOptions.isiLogVerbose` | Decide High/Medium/Low content of the OneFS REST API message | `0` | -| `karaviMetricsPowerscale.authorization.enabled` | [Authorization](../../authorization-v1.x) is an optional feature to apply credential shielding of the backend PowerScale. | `false` | +| `karaviMetricsPowerscale.authorization.enabled` | [Authorization](../../authorization-v2.x) is an optional feature to apply credential shielding of the backend PowerScale. | `false` | | `karaviMetricsPowerscale.authorization.proxyHost` | Hostname of the csm-authorization server. | | | `karaviMetricsPowerscale.authorization.skipCertificateValidation` | A boolean that enables/disables certificate validation of the csm-authorization server. | | | `karaviMetricsPowerMax.capacityMetricsEnabled` | Enable PowerMax capacity metric Collection | `true` | @@ -285,6 +285,6 @@ The following table lists the configurable parameters of the CSM for Observabili | `karaviMetricsPowerMax.capacityPollFrequencySeconds` | The polling frequency (in seconds) to gather capacity metrics | `20` | | `karaviMetricsPowerMax.performancePollFrequencySeconds` | The polling frequency (in seconds) to gather performance metrics | `20` | | `karaviMetricsPowerMax.concurrentPowerMaxQueries` | The number of simultaneous metrics queries to make to PowerMax (MUST be less than 10; otherwise, several request errors from PowerMax will ensue.) | `10` | -| `karaviMetricsPowerMax.authorization.enabled` | [Authorization](../../authorization-v1.x) is an optional feature to apply credential shielding of the backend PowerMax. | `false` | +| `karaviMetricsPowerMax.authorization.enabled` | [Authorization](../../authorization-v2.x) is an optional feature to apply credential shielding of the backend PowerMax. | `false` | | `karaviMetricsPowerMax.authorization.proxyHost` | Hostname of the csm-authorization server. | | | `karaviMetricsPowerMax.authorization.skipCertificateValidation` | A boolean that enables/disables certificate validation of the csm-authorization server. | | diff --git a/content/docs/deployment/offline/modules/_index.md b/content/docs/deployment/offline/modules/_index.md index 6108efd9e8..83d39e437f 100644 --- a/content/docs/deployment/offline/modules/_index.md +++ b/content/docs/deployment/offline/modules/_index.md @@ -148,7 +148,7 @@ To perform an offline installation of a Helm chart, the following steps should b kubectl get secret [VXFLEXOS-CONFIG] -n [CSI_DRIVER_NAMESPACE] -o yaml | sed 's/name: [VXFLEXOS-CONFIG]/name: vxflexos-config/' | sed 's/namespace: [CSI_DRIVER_NAMESPACE]/namespace: [CSM_NAMESPACE]/' | kubectl create -f - ``` - If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerFlex, perform these steps: + If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerFlex, perform these steps: ```bash @@ -191,7 +191,7 @@ To perform an offline installation of a Helm chart, the following steps should b kubectl get secret [ISILON-CREDS] -n [CSI_DRIVER_NAMESPACE] -o yaml | sed 's/name: [ISILON-CREDS]/name: isilon-creds/' | sed 's/namespace: [CSI_DRIVER_NAMESPACE]/namespace: [CSM_NAMESPACE]/' | kubectl create -f - ``` - If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerScale, perform these steps: + If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerScale, perform these steps: ```bash @@ -242,7 +242,7 @@ To perform an offline installation of a Helm chart, the following steps should b done ``` - If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v1.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerMax, perform these steps: + If [CSM for Authorization is enabled](../../../deployment/helm/modules/installation/authorization-v2.x/#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerMax, perform these steps: ```bash diff --git a/content/docs/prerequisites/_index.md b/content/docs/prerequisites/_index.md index b08d958f55..c3a44bfe29 100644 --- a/content/docs/prerequisites/_index.md +++ b/content/docs/prerequisites/_index.md @@ -80,7 +80,6 @@ The table below lists the driver and modules versions installable with the CSM O | CSI PowerScale | 2.12.0 | ✔ 1.12.0, 2.0.0 | ✔ 1.9.0 | ✔ 1.9.0 | ✔ 1.10.0 | | CSI PowerScale | 2.11.0 | ✔ 1.11.0 | ✔ 1.9.0 | ✔ 1.9.0 | ✔ 1.10.0 | | CSI PowerScale | 2.10.1 | ✔ 1.10.1 | ✔ 1.8.1 | ✔ 1.8.1 | ✔ 1.9.1 | -| CSI PowerScale | 2.9.1 | ✔ 1.9.1 | ✔ 1.7.1 | ✔ 1.7.0 | ✔ 1.8.1 | | CSI PowerFlex | 2.12.0 | ✔ 1.12.0, 2.0.0 | ✔ 1.10.0 | ✔ 1.10.0 | ✔ 1.11.0 | | CSI PowerFlex | 2.11.0 | ✔ 1.11.0 | ✔ 1.9.0 | ✔ 1.9.0 | ✔ 1.10.0 | | CSI PowerFlex | 2.10.1 | ✔ 1.10.1 | ✔ 1.8.1 | ✔ 1.8.1 | ✔ 1.9.1 | @@ -90,7 +89,6 @@ The table below lists the driver and modules versions installable with the CSM O | CSI PowerMax | 2.12.0 | ✔ 1.12.0, 2.0.0 | ✔ 1.9.0 | ✔ 1.9.0 | ✔ 1.10.0 | | CSI PowerMax | 2.11.0 | ✔ 1.11.0 | ✔ 1.9.0 | ✔ 1.9.0 | ✔ 1.10.0 | | CSI PowerMax | 2.10.1 | ✔ 1.10.1 | ✔ 1.8.1 | ✔ 1.8.1 | ❌ | -| CSI PowerMax | 2.9.1 | ✔ 1.9.1 | ✔ 1.7.1 | ✔ 1.7.0 | ❌ | | CSI Unity XT | 2.12.0 | ❌ | ❌ | ❌ | ❌ | | CSI Unity XT | 2.11.0 | ❌ | ❌ | ❌ | ❌ | | CSI Unity XT | 2.10.1 | ❌ | ❌ | ❌ | ❌ |