diff --git a/.github/workflows/broken-links.yaml b/.github/workflows/broken-links.yaml new file mode 100644 index 0000000000..2aa5528dce --- /dev/null +++ b/.github/workflows/broken-links.yaml @@ -0,0 +1,53 @@ +name: Check Broken Links + +on: + push: + branches: [ main ] + pull_request: + branches: [ main, release-* ] +jobs: + check-broken-links: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: '0.120.3' + extended: true + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: '16' + - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-node- + - run: npm ci + - name: Build + run: | + npm install -D --save autoprefixer + npm install -D --save postcss-cli + npm install -D --save postcss + hugo server --bind 127.0.0.1 & + - name: Wait for Hugo server + run: curl --head -X GET --retry 5 --retry-connrefused --retry-delay 10 http://127.0.0.1:1313/csm-docs/ + - name: Scanning docs for broken links + continue-on-error: true + run: | + wget --verbose --spider -o spider.log -e robots=off -rp http://127.0.0.1:1313/csm-docs/ + - name: Getting output + continue-on-error: true + run: | + sed -i '/http:\/\/127.0.0.1:1313\/favicons\/favicon.ico/d' spider.log + sed -i '/http:\/\/127.0.0.1:1313\/css\/prism.css/d' spider.log + sed -n '/broken links/,$p' spider.log | grep 'http' > broken_links + - name: Check for broken links + run: | + wc -l broken_links + cat broken_links + wc -l broken_links | grep -Fxq "0 broken_links" diff --git a/content/docs/_index.md b/content/docs/_index.md index 3510637cbb..127367ddfd 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -58,10 +58,10 @@ CSM is made up of multiple components including modules (enterprise capabilities {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="[License](license/)" + {{< card header="[License](support/license/)" footer="Required for [Application Mobility](applicationmobility/) & [Encryption](secure/encryption/)">}} The tech-preview releases of Application Mobility and Encryption require a license. 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/) + [...Learn more](support/license/) {{< /card >}} {{< /cardpane >}} \ No newline at end of file diff --git a/content/docs/applicationmobility/use_cases.md b/content/docs/applicationmobility/use_cases.md index 91671b9e73..7ffdae38ca 100644 --- a/content/docs/applicationmobility/use_cases.md +++ b/content/docs/applicationmobility/use_cases.md @@ -6,7 +6,7 @@ Description: > Use Cases --- -After Application Mobility is installed, the [dellctl CLI](../../references/cli/) can be used to register clusters and manage backups and restores of applications. These examples also provide references for using the Application Mobility Custom Resource Definitions (CRDs) to define Custom Resources (CRs) as an alternative to using the `dellctl` CLI. +After Application Mobility is installed, the [dellctl CLI](../../support/cli) can be used to register clusters and manage backups and restores of applications. These examples also provide references for using the Application Mobility Custom Resource Definitions (CRDs) to define Custom Resources (CRs) as an alternative to using the `dellctl` CLI. ## Backup and Restore an Application This example details the steps when an application in namespace `demo1` is being backed up and then later restored to either the same cluster or another cluster. In this sample, both Application Mobility and Velero are installed in the `application-mobility` namespace. diff --git a/content/docs/authorization/configuration/powerflex/_index.md b/content/docs/authorization/configuration/powerflex/_index.md index 98d545dbd6..06c0e803cc 100644 --- a/content/docs/authorization/configuration/powerflex/_index.md +++ b/content/docs/authorization/configuration/powerflex/_index.md @@ -172,4 +172,4 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization 6. Install the Dell CSI PowerFlex driver following the appropriate documenation for your installation method. -7. (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. \ No newline at end of file +7. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list. \ No newline at end of file diff --git a/content/docs/authorization/configuration/powermax/_index.md b/content/docs/authorization/configuration/powermax/_index.md index d37ce9ff9c..4003f65efd 100644 --- a/content/docs/authorization/configuration/powermax/_index.md +++ b/content/docs/authorization/configuration/powermax/_index.md @@ -146,4 +146,4 @@ Create the karavi-authorization-config secret using this command: 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. \ No newline at end of file +6. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list. \ No newline at end of file diff --git a/content/docs/authorization/configuration/powerscale/_index.md b/content/docs/authorization/configuration/powerscale/_index.md index 87941a9c85..58c0f19c91 100644 --- a/content/docs/authorization/configuration/powerscale/_index.md +++ b/content/docs/authorization/configuration/powerscale/_index.md @@ -178,4 +178,4 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file= 6. Install the Dell CSI PowerScale driver following the appropriate documenation for your installation method. -7. (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. \ No newline at end of file +7. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list. \ No newline at end of file diff --git a/content/docs/csidriver/features/powermax.md b/content/docs/csidriver/features/powermax.md index 577d6222dc..be4d00bab7 100644 --- a/content/docs/csidriver/features/powermax.md +++ b/content/docs/csidriver/features/powermax.md @@ -547,13 +547,10 @@ kubectl edit configmap -n powermax powermax-config-params CSI Driver for Dell PowerMax 2.2.0 and above supports volume health monitoring. To enable Volume Health Monitoring from the node side, the alpha feature gate CSIVolumeHealth needs to be enabled. To use this feature, set controller.healthMonitor.enabled and node.healthMonitor.enabled to true. To change the monitor interval, set controller.healthMonitor.interval parameter. -## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod (ALPHA FEATURE) +## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod Use `ReadWriteOncePod(RWOP)` access mode if you want to ensure that only one pod across the whole cluster can read that PVC or write to it. This is only supported for CSI Driver for PowerMax 2.2.0+ and Kubernetes version 1.22+. -To use this feature, enable the ReadWriteOncePod feature gate for kube-apiserver, kube-scheduler, and kubelet, by setting command line arguments: -`--feature-gates="...,ReadWriteOncePod=true"` - ### Creating a PersistentVolumeClaim ```yaml kind: PersistentVolumeClaim @@ -570,7 +567,7 @@ spec: When this feature is enabled, the existing `ReadWriteOnce(RWO)` access mode restricts volume access to a single node and allows multiple pods on the same node to read from and write to the same volume. -To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/blog/2021/09/13/read-write-once-pod-access-mode-alpha/#migrating-existing-persistentvolumes). +To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-access-mode-readwriteoncepod/). ## Support for auto RDM for vSphere over FC diff --git a/content/docs/csidriver/features/powerscale.md b/content/docs/csidriver/features/powerscale.md index 23b02971a8..acd00e7861 100644 --- a/content/docs/csidriver/features/powerscale.md +++ b/content/docs/csidriver/features/powerscale.md @@ -660,15 +660,11 @@ For example, if a volume were to be deleted from the array, or unmounted outside 1. For controller plugin, by setting attribute `controller.healthMonitor.enabled` to `true` in `values.yaml` file. Also health monitoring interval can be changed through attribute `controller.healthMonitor.interval` in `values.yaml` file. 2. For node plugin, by setting attribute `node.healthMonitor.enabled` to `true` in `values.yaml` file and by enabling the alpha feature gate `CSIVolumeHealth`. -## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod (ALPHA FEATURE) +## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod Use `ReadWriteOncePod(RWOP)` access mode if you want to ensure that only one pod across the whole cluster can read that PVC or write to it. This is supported for CSI Driver for PowerScale 2.1.0+ and Kubernetes version 1.22+. -To use this feature, enable the ReadWriteOncePod feature gate for kube-apiserver, kube-scheduler, and kubelet, by setting command line arguments: -`--feature-gates="...,ReadWriteOncePod=true"` - ### Creating a PersistentVolumeClaim - ```yaml kind: PersistentVolumeClaim apiVersion: v1 @@ -684,4 +680,4 @@ spec: When this feature is enabled, the existing `ReadWriteOnce(RWO)` access mode restricts volume access to a single node and allows multiple pods on the same node to read from and write to the same volume. -To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/blog/2021/09/13/read-write-once-pod-access-mode-alpha/#migrating-existing-persistentvolumes). +To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-access-mode-readwriteoncepod/). diff --git a/content/docs/csidriver/features/powerstore.md b/content/docs/csidriver/features/powerstore.md index a5d2460a12..df62811796 100644 --- a/content/docs/csidriver/features/powerstore.md +++ b/content/docs/csidriver/features/powerstore.md @@ -633,18 +633,11 @@ The user will be able to install the driver and able to create pods. CSI Driver for Dell Powerstore 2.1.0 and above supports volume health monitoring. To enable Volume Health Monitoring from the node side, the alpha feature gate CSIVolumeHealth needs to be enabled. To use this feature, set controller.healthMonitor.enabled and node.healthMonitor.enabled to true. To change the monitor interval, set controller.healthMonitor.interval parameter. -## Single Pod Access Mode for PersistentVolumes +## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod -Starting from version 2.1, CSI Driver for Powerstore now supports a new access mode `ReadWriteOncePod` for PersistentVolumes and PersistentVolumeClaims. With this feature, CSI Driver for Powerstore allows restricting volume access to a single pod in the cluster and within a worker node. +Use `ReadWriteOncePod(RWOP)` access mode if you want to ensure that only one pod across the whole cluster can read that PVC or write to it. This is supported for CSI Driver for PowerStore 2.1.0+ and Kubernetes version 1.22+. -Prerequisites - -1. Enable the ReadWriteOncePod feature gate for kube-apiserver, kube-scheduler, and kubelet as ReadWriteOncePod access mode is in alpha for Kubernetes v1.22 and is supported only for CSI volumes. You can enable the feature by setting command-line argument: -```bash ---feature-gates="...,ReadWriteOncePod=true" -``` - -2. Create a PVC with access mode set to ReadWriteOncePod like shown in the sample below +### Creating a PersistentVolumeClaim ```yaml kind: PersistentVolumeClaim apiVersion: v1 @@ -660,6 +653,10 @@ spec: >Note: The access mode ReadWriteOnce allows multiple pods to access a single volume within a single worker node and the behavior is consistent across all supported Kubernetes versions. +When this feature is enabled, the existing `ReadWriteOnce(RWO)` access mode restricts volume access to a single node and allows multiple pods on the same node to read from and write to the same volume. + +To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-access-mode-readwriteoncepod/). + ## POSIX mode bits and NFSv4 ACLs CSI PowerStore driver version 2.2.0 and later allows users to set user-defined permissions on NFS target mount directory using POSIX mode bits or NFSv4 ACLs. diff --git a/content/docs/csidriver/features/unity.md b/content/docs/csidriver/features/unity.md index ec4913caae..522f464436 100644 --- a/content/docs/csidriver/features/unity.md +++ b/content/docs/csidriver/features/unity.md @@ -516,27 +516,27 @@ The user will be able to install the driver and able to create pods. **NOTE:** On Unity, management port does not support NAT. NAT needs to be disabled on the Unity array's management network. -## Single Pod Access Mode for PersistentVolumes -CSI Driver for Unity XT supports a new accessmode `ReadWriteOncePod` for PersistentVolumes and PersistentVolumeClaims. With this feature, CSI Driver for Unity XT restricts volume access to a single pod in the cluster - -Prerequisites -1. Enable the ReadWriteOncePod feature gate for kube-apiserver, kube-scheduler, and kubelet as the ReadWriteOncePod access mode is in alpha for Kubernetes v1.22 and is only supported for CSI volumes. You can enable the feature by setting command line arguments: - ```bash - --feature-gates="...,ReadWriteOncePod=true" - ``` -2. Create a PVC with access mode set to ReadWriteOncePod like shown in the sample below - ```yaml - kind: PersistentVolumeClaim - apiVersion: v1 - metadata: - name: single-writer-only - spec: - accessModes: - - ReadWriteOncePod # Allow only a single pod to access single-writer-only. - resources: - requests: - storage: 1Gi - ``` +## Single Pod Access Mode for PersistentVolumes- ReadWriteOncePod + +Use `ReadWriteOncePod(RWOP)` access mode if you want to ensure that only one pod across the whole cluster can read that PVC or write to it. This is only supported for CSI Driver for Unity 2.1.0+ and Kubernetes version 1.22+. + +### Creating a PersistentVolumeClaim +```yaml +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: +name: single-writer-only +spec: +accessModes: +- ReadWriteOncePod # Allow only a single pod to access single-writer-only. +resources: +requests: + storage: 1Gi +``` + +When this feature is enabled, the existing `ReadWriteOnce(RWO)` access mode restricts volume access to a single node and allows multiple pods on the same node to read from and write to the same volume. + +To migrate existing PersistentVolumes to use `ReadWriteOncePod`, please follow the instruction from [here](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-access-mode-readwriteoncepod/). ## Volume Health Monitoring CSI Driver for Unity XT supports volume health monitoring. This is an alpha feature and requires feature gate to be enabled by setting command line arguments diff --git a/content/docs/csidriver/release/powerflex.md b/content/docs/csidriver/release/powerflex.md index 86fa2a4eca..1a86c13149 100644 --- a/content/docs/csidriver/release/powerflex.md +++ b/content/docs/csidriver/release/powerflex.md @@ -40,7 +40,6 @@ A CSI ephemeral pod may not get created in OpenShift 4.13 and fail with the erro | If the volume limit is exhausted and there are pending pods and PVCs due to `exceed max volume count`, the pending PVCs will be bound to PVs and the pending pods will be scheduled to nodes when the driver pods are restarted. | It is advised not to have any pending pods or PVCs once the volume limit per node is exhausted on a CSI Driver. There is an open issue reported with kubenetes at https://github.com/kubernetes/kubernetes/issues/95911 with the same behavior. | | The PowerFlex Dockerfile is incorrectly labeling the version as 2.7.0 for the 2.8.0 version. | Describe the driver pod using ```kubectl describe pod $podname -n vxflexos``` to ensure v2.8.0 is installed. | | Resource quotas may not work properly with the CSI PowerFlex driver. PowerFlex is only able to assign storage in 8Gi chunks, so if a create volume call is made with a size not divisible by 8Gi, CSI-PowerFlex will round up to the next 8Gi boundary when it provisions storage -- however, the resource quota will not record this size but rather the original size in the create request. This means that, for example, if a 10Gi resource quota is set, and a user provisions 10 1Gi PVCs, 80Gi of storage will actually be allocated, which is well over the amount specified in the resource quota. | For now, users should only provision volumes in 8Gi-divisible chunks if they want to use resource quotas. | -| Helm install of CSM for PowerFlex v1.10.0 is failing due to a duplicate `mountPath: /host_opt_emc_path` being added to volumeMounts charts/csi-vxflexos/templates/node.yaml. Error message is `Error: INSTALLATION FAILED: 1 error occurred: DaemonSet.apps "vxflexos-node" is invalid: spec.template.spec.initContainers[0].volumeMounts[4].mountPath: Invalid value: "/host_opt_emc_path": must be unique` | The issue can be resolved by removing the duplicate entry in [https://github.com/dell/helm-charts/blob/main/charts/csi-vxflexos/templates/node.yaml](https://github.com/dell/helm-charts/blob/main/charts/csi-vxflexos/templates/node.yaml) | ### Note: diff --git a/content/docs/csidriver/release/powermax.md b/content/docs/csidriver/release/powermax.md index 6f689a7bbc..06b51d08c7 100644 --- a/content/docs/csidriver/release/powermax.md +++ b/content/docs/csidriver/release/powermax.md @@ -41,4 +41,4 @@ description: Release notes for PowerMax CSI driver | When the driver is installed using CSM Operator , few times, pods created using block volume are getting stuck in containercreating/terminating state or devices are not available inside the pod. | Update the daemonset with parameter `mountPropagation: "Bidirectional"` for volumedevices-path under volumeMounts section.| ### Note: -- Support for Kubernetes alpha features like Volume Health Monitoring and RWOP (ReadWriteOncePod) access mode will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. +- Support for Kubernetes alpha features like Volume Health Monitoring will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. diff --git a/content/docs/csidriver/release/powerscale.md b/content/docs/csidriver/release/powerscale.md index eb5f2a503c..c2fdff0399 100644 --- a/content/docs/csidriver/release/powerscale.md +++ b/content/docs/csidriver/release/powerscale.md @@ -42,4 +42,4 @@ description: Release notes for PowerScale CSI driver ### Note -- Support for Kubernetes alpha features like Volume Health Monitoring and RWOP (ReadWriteOncePod) access mode will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. +- Support for Kubernetes alpha features like Volume Health Monitoring will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. diff --git a/content/docs/csidriver/release/powerstore.md b/content/docs/csidriver/release/powerstore.md index fdbdf368ec..7df86c7c6d 100644 --- a/content/docs/csidriver/release/powerstore.md +++ b/content/docs/csidriver/release/powerstore.md @@ -43,4 +43,4 @@ description: Release notes for PowerStore CSI driver ### Note: -- Support for Kubernetes alpha features like Volume Health Monitoring and RWOP (ReadWriteOncePod) access mode will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. +- Support for Kubernetes alpha features like Volume Health Monitoring will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. diff --git a/content/docs/csidriver/release/unity.md b/content/docs/csidriver/release/unity.md index 85791bb64d..2d775e9939 100644 --- a/content/docs/csidriver/release/unity.md +++ b/content/docs/csidriver/release/unity.md @@ -38,4 +38,4 @@ description: Release notes for Unity XT CSI driver | fsGroupPolicy may not work as expected without root privileges for NFS only [https://github.com/kubernetes/examples/issues/260](https://github.com/kubernetes/examples/issues/260) | To get the desired behavior set “RootClientEnabled” = “true” in the storage class parameter | ### Note: -- Support for Kubernetes alpha features like Volume Health Monitoring and RWOP (ReadWriteOncePod) access mode will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. +- Support for Kubernetes alpha features like Volume Health Monitoring will not be available in Openshift environment as Openshift doesn't support enabling of alpha features for Production Grade clusters. diff --git a/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md b/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md index 68c07a9e6a..a642325d42 100644 --- a/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md +++ b/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md @@ -7,7 +7,7 @@ Description: > --- ## Pre-requisites -- [Request a License for Application Mobility](../../../../../license/) +- [Request a License for Application Mobility](../../../../../support/license/) - Object store bucket accessible by both the source and target clusters ## Installation diff --git a/content/docs/deployment/helm/modules/installation/encryption/_index.md b/content/docs/deployment/helm/modules/installation/encryption/_index.md index f4b44dfaf2..6a70cf3b31 100644 --- a/content/docs/deployment/helm/modules/installation/encryption/_index.md +++ b/content/docs/deployment/helm/modules/installation/encryption/_index.md @@ -82,7 +82,7 @@ Apart from any secrets and config maps described in the CSI driver documentation ### Secret *encryption-license* -Request a trial license following instructions on the [License page](../../../../../license). You will be provided with a YAML file similar to: +Request a trial license following instructions on the [License page](../../../../../support/license/). You will be provided with a YAML file similar to: ```yaml apiVersion: v1 diff --git a/content/docs/deployment/rpm/modules/installation/authorization/authorization.md b/content/docs/deployment/rpm/modules/installation/authorization/authorization.md index 863f160253..e4e1a55af0 100644 --- a/content/docs/deployment/rpm/modules/installation/authorization/authorization.md +++ b/content/docs/deployment/rpm/modules/installation/authorization/authorization.md @@ -11,7 +11,7 @@ The CSM Authorization RPM will be deprecated in a future release. It is highly r This section outlines the deployment steps for Container Storage Modules (CSM) for Authorization. The deployment of CSM for Authorization is handled in 2 parts: - Deploying the CSM for Authorization proxy server, to be controlled by storage administrators -- Configuring one to many [supported](../../../../../prerequisites/#supported-csm-modules) Dell CSI drivers with CSM for Authorization +- Configuring one to many [supported](../../../../../../prerequisites/#supported-csm-modules) Dell CSI drivers with CSM for Authorization ## Prerequisites @@ -123,19 +123,19 @@ A Storage Administrator can execute the shell script, install_karavi_auth.sh as 5. After installation, application data will be stored on the system under `/var/lib/rancher/k3s/storage/`. -If errors occur during installation, review the [Troubleshooting](../../../../../authorization/troubleshooting) section. +If errors occur during installation, review the [Troubleshooting](../../../../../../authorization/troubleshooting) section. ## Configuring the CSM for Authorization Proxy Server The first part of CSM for Authorization deployment is to configure the proxy server. This is controlled by the Storage Administrator. -Please follow the steps outlined in the [proxy server](../../../../../authorization/configuration/proxy-server) configuration. +Please follow the steps outlined in the [proxy server](../../../../../../authorization/configuration/proxy-server) configuration. ## Configuring a Dell CSI Driver with CSM for Authorization -The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../prerequisites/#supported-csm-modules) CSI drivers. This is controlled by the Kubernetes tenant administrator. +The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../../prerequisites/#supported-csm-modules) CSI drivers. This is controlled by the Kubernetes tenant administrator. -Please follow the steps outlined in [PowerFlex](../../../../../authorization/configuration/powerflex), [PowerMax](../../../../../authorization/configuration/powermax), or [PowerScale](../../../../../authorization/configuration/powerscale) to configure the CSI Driver to work with the Authorization sidecar. +Please follow the steps outlined in [PowerFlex](../../../../../../authorization/configuration/powerflex), [PowerMax](../../../../../../authorization/configuration/powermax), or [PowerScale](../../../../../../authorization/configuration/powerscale) to configure the CSI Driver to work with the Authorization sidecar. ## Updating CSM for Authorization Proxy Server Configuration diff --git a/content/docs/deployment/rpm/modules/upgrade/authorization.md b/content/docs/deployment/rpm/modules/upgrade/authorization.md index fa29a9fee0..af14f3404b 100644 --- a/content/docs/deployment/rpm/modules/upgrade/authorization.md +++ b/content/docs/deployment/rpm/modules/upgrade/authorization.md @@ -16,7 +16,7 @@ This section outlines the upgrade steps for Container Storage Modules (CSM) for ## Upgrading CSM for Authorization proxy server -Obtain the latest single binary installer RPM by following one of our two options [here](../../installation/authorization#single-binary-installer). +Obtain the latest single binary installer RPM by following one of our two options [here](../../installation/authorization/authorization#single-binary-installer). To update the rpm package on the system, run the below command from within the extracted folder: diff --git a/content/docs/prerequisites/_index.md b/content/docs/prerequisites/_index.md index 8457be2054..dd761bdde6 100644 --- a/content/docs/prerequisites/_index.md +++ b/content/docs/prerequisites/_index.md @@ -35,7 +35,7 @@ weight: 1 {{}} > Notes: -> * Any orchestrator platform or version that's not mentioned here must be self-certified using [Cert-CSI](../cert-csi/) in order to be supported. Although not mandatory, we recommend users to use orchestrator platforms and versions that have not met their end of life. +> * Any orchestrator platform or version that's not mentioned here must be self-certified using [Cert-CSI](../support/cert-csi/) in order to be supported. Although not mandatory, we recommend users to use orchestrator platforms and versions that have not met their end of life. ## Tested Host Operating Systems @@ -47,7 +47,7 @@ Container Storage Modules (CSM) does not officially support specific operating s > Notes: > * The host operating system/version being used must align with what each Dell Storage platform supports. Please visit [E-Lab Navigator](https://elabnavigator.dell.com/eln/modernHomeSSM) for specific Dell Storage platform host operating system level support matrices. -> * Any operating system or version that's not mentioned here must be self-certified using [Cert-CSI](../cert-csi/) in order to be supported. Although not mandatory, we recommend users to use operating systems and versions that have not met their end of life. +> * Any operating system or version that's not mentioned here must be self-certified using [Cert-CSI](../support/cert-csi/) in order to be supported. Although not mandatory, we recommend users to use operating systems and versions that have not met their end of life. ## Supported CSM Modules diff --git a/content/docs/references/FAQ/_index.md b/content/docs/references/FAQ/_index.md deleted file mode 100644 index 19199ffd2d..0000000000 --- a/content/docs/references/FAQ/_index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "CSM FAQ" -linktitle: "FAQ" -description: Frequently asked questions of Dell Technologies (Dell) Container Storage Modules -weight: 1 ---- - -- [What are Dell Container Storage Modules (CSM)? How different is it from a CSI driver?](#what-are-dell-container-storage-modules-csm-how-different-is-it-from-a-csi-driver) -- [Where do I start with Dell Container Storage Modules (CSM)?](#where-do-i-start-with-dell-container-storage-modules-csm) -- [What are the prerequisites for deploying Container Storage Modules?](#what-are-the-prerequisites-for-deploying-container-storage-modules) -- [How do I uninstall or disable a module?](#how-do-i-uninstall-or-disable-a-module) -- [How do I troubleshoot Container Storage Modules?](#how-do-i-troubleshoot-container-storage-modules) -- [Can I use the CSM functionality like Prometheus collection or Authorization quotas for my non-Kubernetes storage clients?](#can-i-use-the-csm-functionality-like-prometheus-collection-or-authorization-quotas-for-my-non-kubernetes-storage-clients) -- [Should I install the module in the same namespace as the driver or another?](#should-i-install-the-module-in-the-same-namespace-as-the-driver-or-another) -- [Which Kubernetes distributions are supported?](#which-kubernetes-distributions-are-supported) -- [How do I get a list of Container Storage Modules deployed in my cluster with their versions?](#how-do-i-get-a-list-of-container-storage-modules-deployed-in-my-cluster-with-their-versions) -- [Do all Container Storage Modules need to be the same version, or can I mix and match?](#do-all-container-storage-modules-need-to-be-the-same-version-or-can-i-mix-and-match) -- [Can I run Container Storage Modules in a production environment?](#can-i-run-container-storage-modules-in-a-production-environment) -- [Is Dell Container Storage Modules (CSM) supported by Dell Technologies?](#is-dell-container-storage-modules-csm-supported-by-dell-technologies) -- [Can I modify a module or contribute to the project?](#can-i-modify-a-module-or-contribute-to-the-project) -- [What is coming next?](#what-is-coming-next) - -### What are Dell Container Storage Modules (CSM)? How different is it from a CSI driver? -Dell **C**ontainer **S**torage **M**odules are a set of modules that aim to extend features beyond what is available in the [CSI specification](https://kubernetes-csi.github.io/docs/). - -The main goal with CSM modules is to expose storage array enterprise features directly within Kubernetes so developers are empowered to leverage them for their deployment in a seamless way. - -### Where do I start with Dell Container Storage Modules (CSM)? -The umbrella repository for every Dell Container Storage Module is: [https://github.com/dell/csm](https://github.com/dell/csm). - -### What are the prerequisites for deploying Container Storage Modules? -Prerequisites can be found on the respective module deployment pages: -- [Dell Container Storage Module for Observability Deployment](../../deployment/helm/modules/installation/observability/deployment#prerequisites) -- [Dell Container Storage Module for Authorization Deployment](../../deployment/helm/modules/installation/authorization#prerequisites) -- [Dell Container Storage Module for Resiliency Deployment](../../deployment/helm/modules/installation/resiliency) -- [Dell Container Storage Module for Replication Deployment](../../deployment/helm/modules/installation/replication/installation/#before-you-begin) -- [Dell Container Storage Module for Application Mobility Deployment](../../deployment/helm/modules/installation/applicationmobility#pre-requisites) -- [Dell Container Storage Module for Encryption Deployment](../../deployment/helm/modules/installation/encryption#vault-server) - -Prerequisites for deploying the Dell CSI drivers can be found here: -- [Dell CSI Drivers Deployment](../../deployment/helm/drivers/installation/) - -### How do I uninstall or disable a module? -- [Dell Container Storage Module for Authorization](../../deployment/helm/modules/uninstall/authorization/) -- [Dell Container Storage Module for Observability](../../deployment/helm/modules/uninstall/observability/) -- [Dell Container Storage Module for Resiliency](../../deployment/helm/modules/uninstall/resiliency/) -- [Dell Container Storage Module for Replication](../../deployment/helm/modules/uninstall/replication/) -- [Dell Container Storage Module for Application Mobility](../../deployment/helm/modules/uninstall/applicationmobility/) -- [Dell Container Storage Module for Encryption](../../deployment/helm/modules/uninstall/encryption/) - -### How do I troubleshoot Container Storage Modules? -- [Dell CSI Drivers](../../csidriver/troubleshooting/) -- [Dell Container Storage Module for Authorization](../../authorization/troubleshooting/) -- [Dell Container Storage Module for Observability](../../observability/troubleshooting/) -- [Dell Container Storage Module for Replication](../../replication/troubleshooting/) -- [Dell Container Storage Module for Resiliency](../../resiliency/troubleshooting/) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/troubleshooting/) -- [Dell Container Storage Module for Encryption](../../secure/encryption/troubleshooting/) - -### Can I use the CSM functionality like Prometheus collection or Authorization quotas for my non-Kubernetes storage clients? -No, all the modules have been designed to work inside Kubernetes with Dell CSI drivers. - -### Should I install the module in the same namespace as the driver or another? -It is recommended to install CSM for Observability in a namespace separate from the Dell CSI drivers because it works across multiple drivers. All other modules either run as standalone or with the Dell CSI driver as a sidecar. - -### Which Kubernetes distributions are supported? -The supported Kubernetes distributions for Container Storage Modules are documented: -- [Dell Container Storage Module for Authorization](../../authorization/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Observability](../../observability/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Replication](../../replication/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Resiliency](../../resiliency/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Encryption](../../secure/encryption/#supported-operating-systemscontainer-orchestrator-platforms) - -The supported distros for the Dell CSI Drivers are located [here](../../csidriver/#supported-operating-systemscontainer-orchestrator-platforms). - -### How do I get a list of Container Storage Modules deployed in my cluster with their versions? -The easiest way to find the module version is to check the image tag for the module. For all the namespaces you can execute the following: -``` -kubectl get pods -A -o jsonpath="{..image}" | tr -s '[[:space:]]' '\n' | grep 'csm\|karavi' | sort | uniq -c -``` -Or if you know the namespace: -``` -kubectl get deployment,daemonset -o wide -n {{namespace}} -``` - -### Do all Container Storage Modules need to be the same version, or can I mix and match? -It is advised to comply with the support matrices (links below) and not deviate from it with mixed versions. -- [Dell Container Storage Module for Authorization](../../authorization/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Observability](../../observability/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Replication](../../replication/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Resiliency](../../resiliency/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Encryption](../../secure/encryption/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell CSI Drivers](../../csidriver/#supported-operating-systemscontainer-orchestrator-platforms). - -### Can I run Container Storage Modules in a production environment? - -Currently, the Container Storage Modules Authorization, Observability, Replication, and Resiliency are GA and ready for production systems. The modules Encryption and Application Mobility are launched for Tech Preview Release and it is not intended to use in the Production systems. - -### Is Dell Container Storage Modules (CSM) supported by Dell Technologies? -Yes! - -If you find an issue, please follow our [support process](../../support/) - -### Can I modify a module or contribute to the project? -Yes! - -All Container Storage Modules are released as open-source projects under Apache-2.0 License. You are free to contribute directly following the [contribution guidelines](https://github.com/dell/csm/blob/main/docs/CONTRIBUTING.md), fork the projects, modify them, and of course share feedback or open tickets ;-) - -### What is coming next? -This is just the beginning of the journey for Dell Container Storage Modules, and there is a full roadmap with more to come, which you can check under the [GitHub Milestones](https://github.com/dell/csm/milestones) page. diff --git a/content/docs/references/_index.md b/content/docs/references/_index.md deleted file mode 100644 index ce3be78438..0000000000 --- a/content/docs/references/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "References" -linkTitle: "References" -weight: 14 -Description: > - Dell Technologies (Dell) Container Storage Modules (CSM) References ---- diff --git a/content/docs/references/policies/_index.md b/content/docs/references/policies/_index.md deleted file mode 100644 index a5e2875d16..0000000000 --- a/content/docs/references/policies/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Policies" -linkTitle: "Policies" -weight: 4 -Description: > - Dell Technologies (Dell) Container Storage Modules (CSM) Policies ---- diff --git a/content/docs/release/_index.md b/content/docs/release/_index.md deleted file mode 100644 index 248ba5ebae..0000000000 --- a/content/docs/release/_index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Release notes" -linkTitle: "Release notes" -weight: 12 -Description: > - Dell Container Storage Modules (CSM) release notes ---- - -Release notes for Container Storage Modules: - -[CSI Drivers](../csidriver/release) - -[CSM for Authorization](../authorization/release) - -[CSM for Observability](../observability/release) - -[CSM for Replication](../replication/release) - -[CSM for Resiliency](../resiliency/release) - -[CSM for Encryption](../secure/encryption/release) - -[CSM for Application Mobility](../applicationmobility/release) - -[CSM Operator](../deployment/csmoperator/release) - -[CSM Installation Wizard](../deployment/csminstallationwizard/release) diff --git a/content/docs/resiliency/_index.md b/content/docs/resiliency/_index.md index 8682218523..78fa586121 100644 --- a/content/docs/resiliency/_index.md +++ b/content/docs/resiliency/_index.md @@ -129,6 +129,8 @@ The following provisioning types are supported and have been tested: * Multiple instances of the same driver type (for example two CSI driver for Dell PowerFlex deployments.) +* PowerFlex with Resiliency is not supported for NFS protocol. + ## Deploying and Managing Applications Protected by CSM for Resiliency The first thing to remember about _CSM for Resiliency_ is that it only takes action on pods configured with the designated label. Both the key and the value have to match what is in the podmon helm configuration. CSM for Resiliency emits a log message at startup with the label key and value it is using to monitor pods: diff --git a/content/docs/secure/encryption/_index.md b/content/docs/secure/encryption/_index.md index e3b007bfa2..5466bd7e1c 100644 --- a/content/docs/secure/encryption/_index.md +++ b/content/docs/secure/encryption/_index.md @@ -9,7 +9,7 @@ Encryption provides the capability to encrypt user data residing on volumes crea > **NOTE:** This tech-preview release is not intended for use in production environment. -> **NOTE:** Encryption requires a time-based license to create new encrypted volumes. Request a [trial license](../../license) prior to deployment. +> **NOTE:** Encryption requires a time-based license to create new encrypted volumes. Request a [trial license](../../support/license) prior to deployment. > > After the license expiration, existing encrypted volume can still be unlocked and used, but no new encrypted volumes can be created. diff --git a/content/docs/secure/encryption/troubleshooting.md b/content/docs/secure/encryption/troubleshooting.md index addc94b034..f19fbb1bbf 100644 --- a/content/docs/secure/encryption/troubleshooting.md +++ b/content/docs/secure/encryption/troubleshooting.md @@ -81,7 +81,7 @@ This may manifest in: - failure to create a new encrypted volume Resolution: -- obtain a [new valid license](../../../license) +- obtain a [new valid license](../../../support/license) - check the license is for the cluster on which the encrypted volumes are created - check [encryption-license secret](../../../deployment/helm/modules/installation/encryption#secret-encryption-license) diff --git a/content/docs/securitypolicy/_index.md b/content/docs/securitypolicy/_index.md deleted file mode 100644 index 06223eb64f..0000000000 --- a/content/docs/securitypolicy/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Security Policy" -linkTitle: "Security Policy" -weight: 13 -Description: > - Dell Container Storage Modules (CSM) Security Policy ---- - -# Reporting Security Issues/Vulnerabilities - -The Dell Container Storage Modules team and community take security bugs seriously. We sincerely appreciate all your efforts and responsibility to disclose your findings. - -To report a security issue, please submit the security advisory form ["Report a Vulnerability"](https://github.com/dell/csm/security/advisories/new). - ->CSM recommends staying on the [latest release](https://github.com/dell/csm/releases/latest) of Dell Container Storage Modules to take advantage of new features, enhancements, bug fixes, and security fixes. diff --git a/content/docs/support/_index.md b/content/docs/support/_index.md index 54535f32f8..1cea4e05c9 100644 --- a/content/docs/support/_index.md +++ b/content/docs/support/_index.md @@ -5,7 +5,19 @@ weight: 13 Description: > Dell Container Storage Modules (CSM) support --- - +### Where can I get support ? For all your support needs or to follow the latest ongoing discussions and updates, join our Slack group. Click [Here](http://del.ly/Slack_request) to request your invite. -You can also interact with us on [GitHub](https://github.com/dell/csm) by creating a [GitHub Issue](https://github.com/dell/csm/issues). \ No newline at end of file +You can also interact with us on [GitHub](https://github.com/dell/csm) by creating a [GitHub Issue](https://github.com/dell/csm/issues). + +If you have a support contract for a Dell Storage Backend that has a CSI Driver you can open a service request on [https://dell.com/support](https://dell.com/support) and select the **CSI Driver** product. + + +### How to report Security Issues or Vulnerabilities ? + +The Dell Container Storage Modules team and community take security bugs seriously. We sincerely appreciate all your efforts and responsibility to disclose your findings. + +To report a security issue, please submit the security advisory form ["Report a Vulnerability"](https://github.com/dell/csm/security/advisories/new). + +>CSM recommends staying on the [latest release](https://github.com/dell/csm/releases/latest) of Dell Container Storage Modules to take advantage of new features, enhancements, bug fixes, and security fixes. + diff --git a/content/docs/cert-csi/_index.md b/content/docs/support/cert-csi/_index.md similarity index 98% rename from content/docs/cert-csi/_index.md rename to content/docs/support/cert-csi/_index.md index b551551ad9..73940c8791 100644 --- a/content/docs/cert-csi/_index.md +++ b/content/docs/support/cert-csi/_index.md @@ -1,7 +1,7 @@ --- title: Cert-CSI linktitle: Cert-CSI -weight: 13 +weight: 3 description: Tool to validate Dell CSI Drivers --- @@ -376,7 +376,7 @@ storageClasses: > NOTE: For testing/debugging purposes, it can be useful to use the `--no-cleanup` so resources do not get deleted. -> NOTE: If you are using CSI PowerScale with [SmartQuotas](../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. Set `storageClasses.expansion` to `false` to skip this suite. +> NOTE: If you are using CSI PowerScale with [SmartQuotas](../../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. Set `storageClasses.expansion` to `false` to skip this suite. ```bash cert-csi certify --cert-config --vsc @@ -533,7 +533,7 @@ Run `cert-csi test clone-volume -h` for more options. > Raw block volumes cannot be verified since there is no filesystem. -> If you are using CSI PowerScale with [SmartQuotas](../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. +> If you are using CSI PowerScale with [SmartQuotas](../../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. ```bash cert-csi test expansion --sc diff --git a/content/docs/cert-csi/img/HTMLReport.png b/content/docs/support/cert-csi/img/HTMLReport.png similarity index 100% rename from content/docs/cert-csi/img/HTMLReport.png rename to content/docs/support/cert-csi/img/HTMLReport.png diff --git a/content/docs/cert-csi/img/interruptTest.png b/content/docs/support/cert-csi/img/interruptTest.png similarity index 100% rename from content/docs/cert-csi/img/interruptTest.png rename to content/docs/support/cert-csi/img/interruptTest.png diff --git a/content/docs/cert-csi/img/listRuns.png b/content/docs/support/cert-csi/img/listRuns.png similarity index 100% rename from content/docs/cert-csi/img/listRuns.png rename to content/docs/support/cert-csi/img/listRuns.png diff --git a/content/docs/cert-csi/img/longevity.png b/content/docs/support/cert-csi/img/longevity.png similarity index 100% rename from content/docs/cert-csi/img/longevity.png rename to content/docs/support/cert-csi/img/longevity.png diff --git a/content/docs/cert-csi/img/multiDBTabularReport.png b/content/docs/support/cert-csi/img/multiDBTabularReport.png similarity index 100% rename from content/docs/cert-csi/img/multiDBTabularReport.png rename to content/docs/support/cert-csi/img/multiDBTabularReport.png diff --git a/content/docs/cert-csi/img/resourceUsage.png b/content/docs/support/cert-csi/img/resourceUsage.png similarity index 100% rename from content/docs/cert-csi/img/resourceUsage.png rename to content/docs/support/cert-csi/img/resourceUsage.png diff --git a/content/docs/cert-csi/img/scaling.PNG b/content/docs/support/cert-csi/img/scaling.PNG similarity index 100% rename from content/docs/cert-csi/img/scaling.PNG rename to content/docs/support/cert-csi/img/scaling.PNG diff --git a/content/docs/cert-csi/img/tabularReport.png b/content/docs/support/cert-csi/img/tabularReport.png similarity index 100% rename from content/docs/cert-csi/img/tabularReport.png rename to content/docs/support/cert-csi/img/tabularReport.png diff --git a/content/docs/cert-csi/img/textReport.png b/content/docs/support/cert-csi/img/textReport.png similarity index 100% rename from content/docs/cert-csi/img/textReport.png rename to content/docs/support/cert-csi/img/textReport.png diff --git a/content/docs/cert-csi/img/unifiedTest.png b/content/docs/support/cert-csi/img/unifiedTest.png similarity index 100% rename from content/docs/cert-csi/img/unifiedTest.png rename to content/docs/support/cert-csi/img/unifiedTest.png diff --git a/content/docs/cert-csi/qualified.md b/content/docs/support/cert-csi/qualified.md similarity index 100% rename from content/docs/cert-csi/qualified.md rename to content/docs/support/cert-csi/qualified.md diff --git a/content/docs/references/cli/_index.md b/content/docs/support/cli/_index.md similarity index 99% rename from content/docs/references/cli/_index.md rename to content/docs/support/cli/_index.md index f27b4925cf..d2dc3763e0 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/support/cli/_index.md @@ -1,7 +1,7 @@ --- title: "CLI" linkTitle: "CLI" -weight: 1 +weight: 4 Description: > CLI for Dell Container Storage Modules (CSM) --- diff --git a/content/docs/references/contributionguidelines/_index.md b/content/docs/support/contributionguidelines/_index.md similarity index 99% rename from content/docs/references/contributionguidelines/_index.md rename to content/docs/support/contributionguidelines/_index.md index 427bd231af..633c8c6977 100644 --- a/content/docs/references/contributionguidelines/_index.md +++ b/content/docs/support/contributionguidelines/_index.md @@ -1,7 +1,7 @@ --- title: "Contribution Guidelines" linkTitle: "Contribution Guidelines" -weight: 3 +weight: 5 Description: > Dell Technologies (Dell) Container Storage Modules (CSM) docs Contribution Guidelines --- diff --git a/content/docs/references/policies/deprecationpolicy/_index.md b/content/docs/support/deprecationpolicy/_index.md similarity index 99% rename from content/docs/references/policies/deprecationpolicy/_index.md rename to content/docs/support/deprecationpolicy/_index.md index 19a4783ba1..c21a1d5fab 100644 --- a/content/docs/references/policies/deprecationpolicy/_index.md +++ b/content/docs/support/deprecationpolicy/_index.md @@ -1,7 +1,7 @@ --- title: "Deprecation Policy" linkTitle: "Deprecation Policy" -weight: 1 +weight: 4 Description: > Dell Technologies (Dell) Container Storage Modules (CSM) Deprecation Policy --- diff --git a/content/docs/references/learn/_index.md b/content/docs/support/learn/_index.md similarity index 95% rename from content/docs/references/learn/_index.md rename to content/docs/support/learn/_index.md index 51dcf458c4..482e079410 100644 --- a/content/docs/references/learn/_index.md +++ b/content/docs/support/learn/_index.md @@ -1,7 +1,7 @@ --- -title: Learn +title: Learn more about CSM Description: Blogs and Youtube videos for CSM -weight: 2 +weight: 7 --- You can learn more and engage with the CSM community over different channels by: * Reading the official [blogs](https://infohub.delltechnologies.com/t/blogs-99/) and [white paper](https://infohub.delltechnologies.com/t/persistent-storage-for-containerized-applications-on-kubernetes-with-powermax-san-storage-13/) are on [https://infohub.delltechnologies.com/](https://infohub.delltechnologies.com/) diff --git a/content/docs/license/_index.md b/content/docs/support/license/_index.md similarity index 94% rename from content/docs/license/_index.md rename to content/docs/support/license/_index.md index ec7bd9d734..c12954dba9 100644 --- a/content/docs/license/_index.md +++ b/content/docs/support/license/_index.md @@ -1,9 +1,9 @@ --- title: "License" linkTitle: "License" -weight: 12 +weight: 6 Description: > - Dell Container Storage Modules (CSM) License + Obtain trial License for Tech-preview of Dell Container Storage Modules (CSM) --- The tech-preview releases of [Container Storage Modules](https://github.com/dell/csm) for Application Mobility and Encryption require a license. This section details how to request a license. diff --git a/content/docs/support/release/_index.md b/content/docs/support/release/_index.md new file mode 100644 index 0000000000..e17a6c86f0 --- /dev/null +++ b/content/docs/support/release/_index.md @@ -0,0 +1,27 @@ +--- +title: "Release notes" +linkTitle: "Release notes" +weight: 1 +Description: > + Dell Container Storage Modules (CSM) release notes +--- + +Release notes for Container Storage Modules: + +[CSI Drivers](../../csidriver/release) + +[CSM for Authorization](../../authorization/release) + +[CSM for Observability](../../observability/release) + +[CSM for Replication](../../replication/release) + +[CSM for Resiliency](../../resiliency/release) + +[CSM for Encryption](../../secure/encryption/release) + +[CSM for Application Mobility](../../applicationmobility/release) + +[CSM Operator](../../deployment/csmoperator/release) + +[CSM Installation Wizard](../../deployment/csminstallationwizard/release) diff --git a/content/docs/support/troubleshooting/_index.md b/content/docs/support/troubleshooting/_index.md new file mode 100644 index 0000000000..c987433b32 --- /dev/null +++ b/content/docs/support/troubleshooting/_index.md @@ -0,0 +1,25 @@ +--- +title: "Troubleshooting" +linkTitle: "Troubleshooting" +weight: 2 +Description: > + Dell Container Storage Modules (CSM) troubleshooting information +--- + +Troubleshooting links for Container Storage Modules: + +[CSI Drivers](../../csidriver/troubleshooting) + +[CSM for Authorization](../../authorization/troubleshooting) + +[CSM for Observability](../../observability/troubleshooting) + +[CSM for Replication](../../replication/troubleshooting) + +[CSM for Resiliency](../../resiliency/troubleshooting) + +[CSM for Encryption](../../secure/encryption/troubleshooting) + +[CSM for Application Mobility](../../applicationmobility/troubleshooting) + +[CSM Operator](../../deployment/csmoperator/troubleshooting) \ No newline at end of file diff --git a/content/docs/troubleshooting/_index.md b/content/docs/troubleshooting/_index.md deleted file mode 100644 index 07e9260af6..0000000000 --- a/content/docs/troubleshooting/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Troubleshooting" -linkTitle: "Troubleshooting" -weight: 11 -Description: > - Dell Container Storage Modules (CSM) troubleshooting information ---- - -Troubleshooting links for Container Storage Modules: - -[CSI Drivers](../csidriver/troubleshooting) - -[CSM for Authorization](../authorization/troubleshooting) - -[CSM for Observability](../observability/troubleshooting) - -[CSM for Replication](../replication/troubleshooting) - -[CSM for Resiliency](../resiliency/troubleshooting) - -[CSM for Encryption](../secure/encryption/troubleshooting) - -[CSM for Application Mobility](../applicationmobility/troubleshooting) - -[CSM Operator](../deployment/csmoperator/troubleshooting) \ No newline at end of file diff --git a/content/v1/resiliency/_index.md b/content/v1/resiliency/_index.md index a72b8b35b6..52711c75c6 100644 --- a/content/v1/resiliency/_index.md +++ b/content/v1/resiliency/_index.md @@ -129,6 +129,8 @@ The following provisioning types are supported and have been tested: * Multiple instances of the same driver type (for example two CSI driver for Dell PowerFlex deployments.) +* PowerFlex with Resiliency is not supported for NFS protocol. + ## Deploying and Managing Applications Protected by CSM for Resiliency The first thing to remember about _CSM for Resiliency_ is that it only takes action on pods configured with the designated label. Both the key and the value have to match what is in the podmon helm configuration. CSM for Resiliency emits a log message at startup with the label key and value it is using to monitor pods: diff --git a/content/v2/resiliency/_index.md b/content/v2/resiliency/_index.md index 246992cfe6..4ad6bb981f 100644 --- a/content/v2/resiliency/_index.md +++ b/content/v2/resiliency/_index.md @@ -131,6 +131,8 @@ The following provisioning types are supported and have been tested: * Multiple instances of the same driver type (for example two CSI driver for Dell PowerFlex deployments.) +* PowerFlex with Resiliency is not supported for NFS protocol. + ## Deploying and Managing Applications Protected by CSM for Resiliency The first thing to remember about _CSM for Resiliency_ is that it only takes action on pods configured with the designated label. Both the key and the value have to match what is in the podmon helm configuration. CSM for Resiliency emits a log message at startup with the label key and value it is using to monitor pods: