From a2a123304d974ac0d2b376cfaa044742f2343d61 Mon Sep 17 00:00:00 2001 From: boyamurthy <92081029+boyamurthy@users.noreply.github.com> Date: Tue, 5 Mar 2024 18:40:31 +0530 Subject: [PATCH] Fixing broken links (#1016) Co-authored-by: Yamunadevi N Shanmugam --- content/docs/applicationmobility/_index.md | 2 +- .../applicationmobility/troubleshooting.md | 2 +- .../csidriver/troubleshooting/powerflex.md | 6 ++--- .../csidriver/troubleshooting/powermax.md | 2 +- .../csidriver/troubleshooting/powerstore.md | 2 +- content/docs/deployment/_index.md | 24 ++++++++--------- .../csminstallationwizard/_index.md | 4 +-- .../csmoperator/drivers/powerscale.md | 2 +- .../csmoperator/modules/authorization.md | 6 ++--- .../csmoperator/operator_migration.md | 4 +-- .../helm/drivers/installation/isilon.md | 16 ++++++------ .../helm/drivers/installation/powerflex.md | 6 ++--- .../helm/drivers/installation/powermax.md | 8 +++--- .../helm/drivers/installation/powerstore.md | 4 +-- .../helm/modules/installation/_index.md | 6 +++++ .../applicationmobility/_index.md | 2 +- .../installation/authorization/_index.md | 8 +++--- .../modules/installation/encryption/_index.md | 4 +-- .../modules/installation/encryption/vault.md | 2 +- .../installation/replication/powerflex.md | 2 +- .../helm/modules/uninstall/_index.md | 6 ++--- .../modules/uninstall/applicationmobility.md | 4 +-- .../helm/modules/uninstall/authorization.md | 6 ++--- .../helm/modules/uninstall/encryption.md | 10 +++---- .../helm/modules/uninstall/observability.md | 4 +-- .../helm/modules/uninstall/replication.md | 6 ++--- .../helm/modules/uninstall/resiliency.md | 16 ++++++------ .../deployment/helm/modules/upgrade/_index.md | 2 +- .../helm/modules/upgrade/authorization.md} | 12 ++++----- .../helm/modules/upgrade/observability.md | 24 ++++++++--------- .../helm/modules/upgrade/replication.md | 8 +++--- .../helm/modules/upgrade/resiliency.md} | 12 ++++----- .../docs/deployment/offline/modules/_index.md | 6 ++--- .../docs/deployment/offline/upgrade/_index.md | 4 +-- content/docs/observability/_index.md | 4 +-- .../observability/troubleshooting/_index.md | 6 ++--- content/docs/references/FAQ/_index.md | 26 +++++++++---------- .../docs/replication/cluster-topologies.md | 8 +++--- content/docs/replication/high-availability.md | 4 +-- .../migration/migrating-volumes-diff-array.md | 2 +- content/docs/resiliency/_index.md | 2 +- content/docs/secure/encryption/_index.md | 4 +-- .../docs/secure/encryption/troubleshooting.md | 16 ++++++------ 43 files changed, 155 insertions(+), 149 deletions(-) create mode 100644 content/docs/deployment/helm/modules/installation/_index.md rename content/docs/{authorization/upgrade.md => deployment/helm/modules/upgrade/authorization.md} (84%) rename content/docs/{resiliency/upgrade.md => deployment/helm/modules/upgrade/resiliency.md} (75%) diff --git a/content/docs/applicationmobility/_index.md b/content/docs/applicationmobility/_index.md index e49eb68d40..930c02792a 100644 --- a/content/docs/applicationmobility/_index.md +++ b/content/docs/applicationmobility/_index.md @@ -8,7 +8,7 @@ Description: > >> NOTE: This tech-preview release is not intended for use in production environment. ->> NOTE: Application Mobility requires a time-based license. See [Deployment](./deployment) for instructions. +>> NOTE: Application Mobility requires a time-based license. See [Deployment](../deployment/helm/modules/installation/applicationmobility/) for instructions. Container Storage Modules for Application Mobility provide Kubernetes administrators the ability to clone their stateful application workloads and application data to other clusters, either on-premise or in the cloud. diff --git a/content/docs/applicationmobility/troubleshooting.md b/content/docs/applicationmobility/troubleshooting.md index b015781524..93bea855d0 100644 --- a/content/docs/applicationmobility/troubleshooting.md +++ b/content/docs/applicationmobility/troubleshooting.md @@ -40,7 +40,7 @@ kubectl logs -n $namespace $pod $container > $logFileName ### Why are there error logs about a license? -Application Mobility requires a license in order to function. See the [Deployment](../deployment) instructions for steps to request a license. +Application Mobility requires a license in order to function. See the [Deployment](../../deployment/helm/modules/installation/applicationmobility/) instructions for steps to request a license. There will be errors in the logs about the license for these cases: - License does not exist diff --git a/content/docs/csidriver/troubleshooting/powerflex.md b/content/docs/csidriver/troubleshooting/powerflex.md index ef0d2e016f..ed578ca377 100644 --- a/content/docs/csidriver/troubleshooting/powerflex.md +++ b/content/docs/csidriver/troubleshooting/powerflex.md @@ -14,15 +14,15 @@ description: Troubleshooting PowerFlex Driver |CreateVolume error System is not configured in the driver | Powerflex name if used for systemID in StorageClass ensure same name is also used in array config systemID | |Defcontext mount option seems to be ignored, volumes still are not being labeled correctly.|Ensure SElinux is enabled on a worker node, and ensure your container run time manager is properly configured to be utilized with SElinux.| |Mount options that interact with SElinux are not working (like defcontext).|Check that your container orchestrator is properly configured to work with SElinux.| -|Installation of the driver on Kubernetes v1.25/v1.26/v1.27 fails with the following error:
```Error: unable to build kubernetes objects from release manifest: unable to recognize "": no matches for kind "VolumeSnapshotClass" in version "snapshot.storage.k8s.io/v1"```|Kubernetes v1.23/v1.24/v1.25 requires v1 version of snapshot CRDs to be created in cluster, see the [Volume Snapshot Requirements](../../installation/helm/powerflex/#optional-volume-snapshot-requirements)| -| The `kubectl logs -n vxflexos vxflexos-controller-* driver` logs show `x509: certificate signed by unknown authority` |A self assigned certificate is used for PowerFlex array. See [certificate validation for PowerFlex Gateway](../../installation/helm/powerflex/#certificate-validation-for-powerflex-gateway-rest-api-calls)| +|Installation of the driver on Kubernetes v1.25/v1.26/v1.27 fails with the following error:
```Error: unable to build kubernetes objects from release manifest: unable to recognize "": no matches for kind "VolumeSnapshotClass" in version "snapshot.storage.k8s.io/v1"```|Kubernetes v1.23/v1.24/v1.25 requires v1 version of snapshot CRDs to be created in cluster, see the [Volume Snapshot Requirements](../../../deployment/helm/drivers/installation/powerflex/#optional-volume-snapshot-requirements)| +| The `kubectl logs -n vxflexos vxflexos-controller-* driver` logs show `x509: certificate signed by unknown authority` |A self assigned certificate is used for PowerFlex array. See [certificate validation for PowerFlex Gateway](../../../deployment/helm/drivers/installation/powerflex/#certificate-validation-for-powerflex-gateway-rest-api-calls)| | When you run the command `kubectl apply -f snapclass-v1.yaml`, you get the error `error: unable to recognize "snapclass-v1.yaml": no matches for kind "VolumeSnapshotClass" in version "snapshot.storage.k8s.io/v1"` | Check to make sure that the v1 snapshotter CRDs are installed, and not the v1beta1 CRDs, which are no longer supported. | | The controller pod is stuck and producing errors such as" `Failed to watch *v1.VolumeSnapshotContent: failed to list *v1.VolumeSnapshotContent: the server could not find the requested resource (get volumesnapshotcontents.snapshot.storage.k8s.io)` | Make sure that v1 snapshotter CRDs and v1 snapclass are installed, and not v1beta1, which is no longer supported. | | Driver install or upgrade fails because of an incompatible Kubernetes version, even though the version seems to be within the range of compatibility. For example: `Error: UPGRADE FAILED: chart requires kubeVersion: >= 1.21.0 <= 1.28.0 which is incompatible with Kubernetes V1.21.11-mirantis-1` | If you are using an extended Kubernetes version, see the helm Chart at `helm/csi-vxflexos/Chart.yaml` and use the alternate `kubeVersion` check that is provided in the comments. Note: this is not meant to be used to enable the use of pre-release alpha and beta versions, which is not supported. | | Volume metrics are missing | Enable [Volume Health Monitoring](../../features/powerflex#volume-health-monitoring) | | When a node goes down, the block volumes attached to the node cannot be attached to another node | This is a known issue and has been reported at https://github.com/kubernetes-csi/external-attacher/issues/215. Workaround:
1. Force delete the pod running on the node that went down
2. Delete the volumeattachment to the node that went down.
Now the volume can be attached to the new node. | | CSI-PowerFlex volumes cannot mount; are being recognized as multipath devices | CSI-PowerFlex does not support multipath; to fix:
1. Remove any multipath mapping involving a powerflex volume with `multipath -f `
2. Blacklist CSI-PowerFlex volumes in multipath config file | - | When attempting a driver upgrade, you see: ```spec.fsGroupPolicy: Invalid value: "xxx": field is immutable``` | You cannot upgrade between drivers with different fsGroupPolicies. See [upgrade documentation](../../deployment/helm/drivers/upgradation/drivers/powerflex) for more details | + | When attempting a driver upgrade, you see: ```spec.fsGroupPolicy: Invalid value: "xxx": field is immutable``` | You cannot upgrade between drivers with different fsGroupPolicies. See [upgrade documentation](../../../deployment/helm/drivers/upgrade/powerflex) for more details | | When accessing ROX mode PVC in OpenShift where the worker nodes are non-root user, you see: ```Permission denied``` while accesing the PVC mount location from the pod. | Set the ```securityContext``` for ROX mode PVC pod as below, as it defines privileges for the pods or containers.

securityContext:
       runAsUser: 0
       runAsGroup: 0 | | After installing version v2.6.0 of the driver using the default `powerflexSdc` image, sdc:3.6.0.6, the vxflexos-node pods are in an `Init:CrashLoopBackOff` state. This issue can happen on hosts that require the SDC to be installed manually. Automatic SDC is only supported on Red Hat CoreOS (RHCOS), RHEL 7.9, RHEL 8.4, RHEL 8.6. | The SDC is already installed. Change the `images.powerflexSdc` value to an empty value in the [values](https://github.com/dell/csi-powerflex/blob/72b27acee7553006cc09df97f85405f58478d2e4/helm/csi-vxflexos/values.yaml#L13) and re-install. | | After installing version v2.8.0 of the driver using the default `powerflexSdc` image, sdc:3.6.1, the vxflexos-node pods are in an `Init:CrashLoopBackOff` state. This issue can happen on hosts that require the SDC to be installed manually. Automatic SDC is only supported on Red Hat CoreOS (RHCOS), RHEL 7.9, RHEL 8.4, RHEL 8.6. | The SDC is already installed. Change the `images.powerflexSdc` value to an empty value in the [values](https://github.com/dell/csi-powerflex/blob/72b27acee7553006cc09df97f85405f58478d2e4/helm/csi-vxflexos/values.yaml#L13) and re-install. | diff --git a/content/docs/csidriver/troubleshooting/powermax.md b/content/docs/csidriver/troubleshooting/powermax.md index f9e846d1a0..cd1f9984cb 100644 --- a/content/docs/csidriver/troubleshooting/powermax.md +++ b/content/docs/csidriver/troubleshooting/powermax.md @@ -10,7 +10,7 @@ description: Troubleshooting PowerMax Driver | `kubectl logs powermax-controller- –n driver` logs show that the driver failed to connect to the U4P because it could not verify the certificates | Check the powermax-certs secret and ensure it is not empty or it has the valid certificates| |Driver install or upgrade fails because of an incompatible Kubernetes version, even though the version seems to be within the range of compatibility. For example: Error: UPGRADE FAILED: chart requires kubeVersion: >= 1.23.0 < 1.27.0 which is incompatible with Kubernetes V1.23.11-mirantis-1 | If you are using an extended Kubernetes version, please see the [helm Chart](https://github.com/dell/helm-charts/blob/main/charts/csi-powermax/Chart.yaml) and use the alternate kubeVersion check that is provided in the comments. Please note that this is not meant to be used to enable the use of pre-release alpha and beta versions, which are not supported.| | When a node goes down, the block volumes attached to the node cannot be attached to another node | 1. Force delete the pod running on the node that went down
2. Delete the volumeattachment to the node that went down.
Now the volume can be attached to the new node. | -| When attempting a driver upgrade, you see: ```spec.fsGroupPolicy: Invalid value: "xxx": field is immutable``` | You cannot upgrade between drivers with different fsGroupPolicies. See [upgrade documentation](../../deployment/helm/drivers/upgradation/drivers/powermax) for more details | +| When attempting a driver upgrade, you see: ```spec.fsGroupPolicy: Invalid value: "xxx": field is immutable``` | You cannot upgrade between drivers with different fsGroupPolicies. See [upgrade documentation](../../../deployment/helm/drivers/upgrade/powermax) for more details | | Ater the migration group is in “migrated” state but unable to move to “commit ready” state because the new paths are not being discovered on the cluster nodes.| Run the following commands manually on the cluster nodes `rescan-scsi-bus.sh  -i` `rescan-scsi-bus.sh  -a`| | `Failed to fetch details for array: 000000000000. [Unauthorized]`" | Please make sure that correct encrypted username and password in secret files are used, also ensure whether the RBAC is enabled for the user | | `Error looking up volume for idempotence check: Not Found` or `Get Volume step fails for: (000000000000) symID with error (Invalid Response from API)`| Make sure that Unisphere endpoint doesn't end with front slash | diff --git a/content/docs/csidriver/troubleshooting/powerstore.md b/content/docs/csidriver/troubleshooting/powerstore.md index a771648075..6cadaeb356 100644 --- a/content/docs/csidriver/troubleshooting/powerstore.md +++ b/content/docs/csidriver/troubleshooting/powerstore.md @@ -7,7 +7,7 @@ description: Troubleshooting PowerStore Driver | --- | --- | | When you run the command `kubectl describe pods powerstore-controller- –n csi-powerstore`, the system indicates that the driver image could not be loaded. | - If on Kubernetes, edit the daemon.json file found in the registry location and add `{ "insecure-registries" :[ "hostname.cloudapp.net:5000" ] }`
- If on OpenShift, run the command `oc edit image.config.openshift.io/cluster` and add registries to yaml file that is displayed when you run the command.| | The `kubectl logs -n csi-powerstore powerstore-node-` driver logs show that the driver can't connect to PowerStore API. | Check if you've created a secret with correct credentials | -|Installation of the driver on Kubernetes supported versions fails with the following error:
```Error: unable to build kubernetes objects from release manifest: unable to recognize "": no matches for kind "VolumeSnapshotClass" in version "snapshot.storage.k8s.io/v1"```|Kubernetes v1.21/v1.22/v1.23 requires v1 version of snapshot CRDs to be created in cluster, see the [Volume Snapshot Requirements](../../installation/helm/powerstore/#optional-volume-snapshot-requirements)| +|Installation of the driver on Kubernetes supported versions fails with the following error:
```Error: unable to build kubernetes objects from release manifest: unable to recognize "": no matches for kind "VolumeSnapshotClass" in version "snapshot.storage.k8s.io/v1"```|Kubernetes v1.21/v1.22/v1.23 requires v1 version of snapshot CRDs to be created in cluster, see the [Volume Snapshot Requirements](../../../deployment/helm/drivers/installation/powerstore/#optional-volume-snapshot-requirements)| | If PVC is not getting created and getting the following error in PVC description:
```failed to provision volume with StorageClass "powerstore-iscsi": rpc error: code = Internal desc = : Unknown error:```| Check if you've created a secret with correct credentials | | If the NVMeFC pod is not getting created and the host looses the ssh connection, causing the driver pods to go to error state | remove the nvme_tcp module from the host incase of NVMeFC connection | | When a node goes down, the block volumes attached to the node cannot be attached to another node | 1. Force delete the pod running on the node that went down
2. Delete the volumeattachment to the node that went down.
Now the volume can be attached to the new node. | diff --git a/content/docs/deployment/_index.md b/content/docs/deployment/_index.md index 9691b5a084..fea74b27e2 100644 --- a/content/docs/deployment/_index.md +++ b/content/docs/deployment/_index.md @@ -36,38 +36,38 @@ The Container Storage Modules and the required CSI Drivers can each be deployed {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="[Dell Container Storage Module for Observability](helm/modules/observability/)" + {{< card header="[Dell Container Storage Module for Observability](helm/modules/installation/observability/)" footer="Installs Observability Module">}} CSM for Observability can be deployed either via Helm/CSM operator/CSM for Observability Installer/CSM for Observability Offline Installer - [...More on installation instructions](helm/modules/observability/) + [...More on installation instructions](helm/modules/installation/observability/) {{< /card >}} - {{< card header="[Dell Container Storage Module for Authorization](helm/modules/authorization/)" + {{< card header="[Dell Container Storage Module for Authorization](helm/modules/installation/authorization/)" footer="Installs Authorization Module">}} CSM Authorization can be installed by using the provided Helm v3 charts on Kubernetes platforms or CSM operator. - [...More on installation instructions](helm/modules/authorization/) + [...More on installation instructions](helm/modules/installation/authorization/) {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="[Dell Container Storage Module for Resiliency](helm/modules/resiliency)" + {{< card header="[Dell Container Storage Module for Resiliency](helm/modules/installation/resiliency)" footer="Installs Resiliency Module">}} CSI drivers that support Helm chart installation allow CSM for Resiliency to be _optionally_ installed by variables in the chart. It can be updated via _podmon_ block specified in the _values.yaml_. It can be installed via CSM operator as well. - [...More on installation instructions](helm/modules/resiliency) + [...More on installation instructions](helm/modules/installation/resiliency) {{< /card >}} - {{< card header="[Dell Container Storage Module for Replication](helm/modules/replication)" + {{< card header="[Dell Container Storage Module for Replication](helm/modules/installation/replication)" footer="Installs Replication Module">}} Replication module can be installed by installing repctl,Container Storage Modules (CSM) for Replication Controller,CSI driver after enabling replication. It can be installed via CSM operator as well. - [...More on installation instructions](helm/modules/replication) + [...More on installation instructions](helm/modules/installation/replication) {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="[Dell Container Storage Module for Application Mobility](helm/modules/applicationmobility)" + {{< card header="[Dell Container Storage Module for Application Mobility](helm/modules/installation/applicationmobility)" footer="Installs Application Mobility Module">}} Application mobility module can be installed via helm charts. This is a tech preview release and it requires a license for installation. - [...More on installation instructions](helm/modules/applicationmobility) + [...More on installation instructions](helm/modules/installation/applicationmobility) {{< /card >}} - {{< card header="[Dell Container Storage Module for Encryption](helm/modules/encryption)" + {{< card header="[Dell Container Storage Module for Encryption](helm/modules/installation/encryption)" footer="Installs Encryption Module">}} Encryption can be optionally installed via the PowerScale CSI driver Helm chart. - [...More on installation instructions](helm/modules/encryption) + [...More on installation instructions](helm/modules/installation/encryption) {{< /card >}} {{< /cardpane >}} \ No newline at end of file diff --git a/content/docs/deployment/csminstallationwizard/_index.md b/content/docs/deployment/csminstallationwizard/_index.md index 03d802a060..ab39bf5d9a 100644 --- a/content/docs/deployment/csminstallationwizard/_index.md +++ b/content/docs/deployment/csminstallationwizard/_index.md @@ -90,9 +90,9 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a 5. If Observability is checked in the wizard, refer to [Observability](../csmoperator/modules/observability#post-installation-dependencies) to export metrics to Prometheus and load the Grafana dashboards. -6. If Authorization is checked in the wizard, only the sidecar is enabled. Refer to [Authorization](../../authorization/deployment/helm/) to install and configure the CSM Authorization Proxy Server. +6. If Authorization is checked in the wizard, only the sidecar is enabled. Refer to [Authorization](../../deployment/helm/modules/installation/authorization/) to install and configure the CSM Authorization Proxy Server. -7. If Replication is checked in the wizard, refer to [Replication](../../replication/deployment/) on configuring communication between Kubernetes clusters. +7. If Replication is checked in the wizard, refer to [Replication](../../deployment/helm/modules/installation/replication/) on configuring communication between Kubernetes clusters. 8. If your Kubernetes distribution doesn't have the Volume Snapshot feature enabled, refer to [this section](../../snapshots) to install the Volume Snapshot CRDs and the default snapshot controller. diff --git a/content/docs/deployment/csmoperator/drivers/powerscale.md b/content/docs/deployment/csmoperator/drivers/powerscale.md index 89fdb05646..315a4090f0 100644 --- a/content/docs/deployment/csmoperator/drivers/powerscale.md +++ b/content/docs/deployment/csmoperator/drivers/powerscale.md @@ -100,7 +100,7 @@ kubectl get csm --all-namespaces The driver will continue to use previous values in case of an error found in the YAML file. 3. Create isilon-certs-n secret. - Please refer [this section](../../../../csidriver/installation/helm/isilon/#certificate-validation-for-onefs-rest-api-calls) for creating cert-secrets. + Please refer [this section](../../../../deployment/helm/drivers/installation/isilon/#certificate-validation-for-onefs-rest-api-calls) for creating cert-secrets. If certificate validation is skipped, empty secret must be created. To create an empty secret. Ex: empty-secret.yaml diff --git a/content/docs/deployment/csmoperator/modules/authorization.md b/content/docs/deployment/csmoperator/modules/authorization.md index e342c07040..6aaddeb2e3 100644 --- a/content/docs/deployment/csmoperator/modules/authorization.md +++ b/content/docs/deployment/csmoperator/modules/authorization.md @@ -128,12 +128,12 @@ Once the Authorization CR is created, you can verify the installation as mention ### Install Karavictl -Follow the instructions available in CSM Authorization for [Installing karavictl](../../../helm/modules/authorization/#install-karavictl). +Follow the instructions available in CSM Authorization for [Installing karavictl](../../../helm/modules/installation/authorization/#install-karavictl). ### Configure the CSM Authorization Proxy Server -Follow the instructions available in CSM Authorization for [Configuring the CSM Authorization Proxy Server](../../../helm/modules/authorization/#configuring-the-csm-authorization-proxy-server). +Follow the instructions available in CSM Authorization for [Configuring the CSM Authorization Proxy Server](../../../helm/modules/installation/authorization/#configuring-the-csm-authorization-proxy-server). ### 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/authorization/#configuring-a-dell-csi-driver-with-csm-for-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). diff --git a/content/docs/deployment/csmoperator/operator_migration.md b/content/docs/deployment/csmoperator/operator_migration.md index cb15c37f0c..d37f94d328 100644 --- a/content/docs/deployment/csmoperator/operator_migration.md +++ b/content/docs/deployment/csmoperator/operator_migration.md @@ -38,9 +38,9 @@ description: > kubectl delete / -n ``` 5. Uninstall the CSI Operator itself - - Instructions can be found [here](../../../../deployment/csmoperator/#uninstall) + - Instructions can be found [here](../../../deployment/csmoperator/#uninstall) 6. Install the CSM Operator - - Instructions can be found [here](../../../../deployment/csmoperator/#installation) + - Instructions can be found [here](../../../deployment/csmoperator/#installation) 7. Install the CR updated in step 2 - Instructions can be found [here](../#installing-csi-driver-via-operator) >NOTE: Uninstallation of the driver and the Operator is non-disruptive for mounted volumes. Nonetheless you can not create new volume, snapshot or move a Pod. diff --git a/content/docs/deployment/helm/drivers/installation/isilon.md b/content/docs/deployment/helm/drivers/installation/isilon.md index eccfa4a39d..81c865aec6 100644 --- a/content/docs/deployment/helm/drivers/installation/isilon.md +++ b/content/docs/deployment/helm/drivers/installation/isilon.md @@ -14,10 +14,10 @@ The following are requirements to be met before installing the CSI Driver for De - Mount propagation is enabled on container runtime that is being used - `nfs-utils` package must be installed on nodes that will mount volumes - If using Snapshot feature, satisfy all Volume Snapshot requirements -- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/authorization/) first -- If enabling CSM for Replication, please refer to the [Replication deployment steps](../../../../../deployment/helm/modules/replication/) first -- If enabling CSM for Resiliency, please refer to the [Resiliency deployment steps](../../../../../deployment/helm/modules/resiliency/) first -- If enabling Encryption, please refer to the [Encryption deployment steps](../../../../../deployment/helm/modules/encryption/) first +- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/installation/authorization/) first +- If enabling CSM for Replication, please refer to the [Replication deployment steps](../../../../../deployment/helm/modules/installation/replication/) first +- If enabling CSM for Resiliency, please refer to the [Resiliency deployment steps](../../../../../deployment/helm/modules/installation/resiliency/) first +- If enabling Encryption, please refer to the [Encryption deployment steps](../../../../../deployment/helm/modules/installation/encryption/) first ### Install Helm 3.0 @@ -88,7 +88,7 @@ replication: The CRDs for replication can be obtained and installed from the csm-replication project on Github. Use `csm-replication/deploy/replicationcrds.all.yaml` located in the csm-replication git repo for the installation. -CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../helm/modules/replication/install-repctl) +CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../helm/modules/installation/replication/install-repctl) ## Install the Driver @@ -146,13 +146,13 @@ CRDs should be configured during replication prepare stage with repctl as descri | ignoreUnresolvableHosts | Allows new host to add to existing export list though any of the existing hosts from the same exports are unresolvable/doesn't exist anymore. | No | false | | noProbeOnStart | Define whether the controller/node plugin should probe all the PowerScale clusters during driver initialization | No | false | | autoProbe | Specify if automatically probe the PowerScale cluster if not done already during CSI calls | No | true | - | **authorization** | [Authorization](../../../../../deployment/helm/modules/authorization/) is an optional feature to apply credential shielding of the backend PowerScale. | - | - | + | **authorization** | [Authorization](../../../../../deployment/helm/modules/installation/authorization/) is an optional feature to apply credential shielding of the backend PowerScale. | - | - | | enabled | A boolean that enables/disables authorization feature. If enabled, isiAuthType must be set to 1. | No | false | | proxyHost | Hostname of the csm-authorization server. | No | Empty | | skipCertificateValidation | A boolean that enables/disables certificate validation of the csm-authorization proxy server. | No | true | - | **podmon** | [Podmon](../../../../../deployment/helm/modules/resiliency/) is an optional feature to enable application pods to be resilient to node failure. | - | - | + | **podmon** | [Podmon](../../../../../deployment/helm/modules/installation/resiliency/) is an optional feature to enable application pods to be resilient to node failure. | - | - | | enabled | A boolean that enables/disables podmon feature. | No | false | - | **encryption** | [Encryption](.../../../../../modules/encryption/) is an optional feature to apply encryption to CSI volumes. | - | - | + | **encryption** | [Encryption](.../../../../../modules/installation/encryption/) is an optional feature to apply encryption to CSI volumes. | - | - | | enabled | A boolean that enables/disables Encryption feature. | No | false | *NOTE:* diff --git a/content/docs/deployment/helm/drivers/installation/powerflex.md b/content/docs/deployment/helm/drivers/installation/powerflex.md index bacd97b555..b799930851 100644 --- a/content/docs/deployment/helm/drivers/installation/powerflex.md +++ b/content/docs/deployment/helm/drivers/installation/powerflex.md @@ -17,7 +17,7 @@ The following are requirements that must be met before installing the CSI Driver - Install PowerFlex Storage Data Client - If using Snapshot feature, satisfy all Volume Snapshot requirements - A user must exist on the array with a role _>= FrontEndConfigure_ -- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/authorization/) first +- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/installation/authorization/) first - If multipath is configured, ensure CSI-PowerFlex volumes are blacklisted by multipathd. See [troubleshooting section](../../../../../csidriver/troubleshooting/powerflex) for details - Secure boot is not supported; ensure that secure boot is disabled in the BIOS. @@ -205,9 +205,9 @@ Use the below command to replace or update the secret: | **vgsnapshotter** | This section allows the configuration of the volume group snapshotter(vgsnapshotter) pod. | - | - | | enabled | A boolean that enable/disable vg snapshotter feature. | No | false | | image | Image for vg snapshotter. | No | " " | -| **podmon** | [Podmon](../../../../../deployment/helm/modules/resiliency/) is an optional feature to enable application pods to be resilient to node failure. | - | - | +| **podmon** | [Podmon](../../../../../deployment/helm/modules/installation/resiliency/) is an optional feature to enable application pods to be resilient to node failure. | - | - | | enabled | A boolean that enables/disables podmon feature. | No | false | -| **authorization** | [Authorization](./../../../../deployment/helm/modules/authorization/) is an optional feature to apply credential shielding of the backend PowerFlex. | - | - | +| **authorization** | [Authorization](../../../../../deployment/helm/modules/installation/authorization/) is an optional feature to apply credential shielding of the backend PowerFlex. | - | - | | enabled | A boolean that enables/disables authorization feature. | No | false | | proxyHost | Hostname of the csm-authorization server. | No | Empty | | skipCertificateValidation | A boolean that enables/disables certificate validation of the csm-authorization proxy server. | No | true | diff --git a/content/docs/deployment/helm/drivers/installation/powermax.md b/content/docs/deployment/helm/drivers/installation/powermax.md index 5d2009ea4b..c9f4cb84dc 100644 --- a/content/docs/deployment/helm/drivers/installation/powermax.md +++ b/content/docs/deployment/helm/drivers/installation/powermax.md @@ -20,7 +20,7 @@ The following requirements must be met before installing CSI Driver for Dell Pow - Mount propagation is enabled on container runtime that is being used - Linux multipathing requirements - If using Snapshot feature, satisfy all Volume Snapshot requirements -- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/authorization/) first +- If enabling CSM for Authorization, please refer to the [Authorization deployment steps](../../../../../deployment/helm/modules/installation/authorization/) first - If using Powerpath , install the PowerPath for Linux requirements ### Prerequisite for CSI Reverse Proxy @@ -185,7 +185,7 @@ replication: The CRDs for replication can be obtained and installed from the csm-replication project on Github. Use `csm-replication/deploy/replicationcrds.all.yaml` located in the csm-replication git repo for the installation. -CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../../deployment/helm/modules/replication/install-repctl) +CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../../deployment/helm/modules/installation/replication/install-repctl) ## Install the Driver @@ -273,7 +273,7 @@ CRDs should be configured during replication prepare stage with repctl as descri | selfSignedCert | Set selfSignedCert to use a self-signed certificate | No | true | | certificateFile | certificateFile has tls.key content in encoded format | No | tls.crt.encoded64 | | privateKeyFile | privateKeyFile has tls.key content in encoded format | No | tls.key.encoded64 | -| **authorization** | [Authorization](../../../../../deployment/helm/modules/authorization/) is an optional feature to apply credential shielding of the backend PowerMax. | - | - | +| **authorization** | [Authorization](../../../../../deployment/helm/modules/installation/authorization/) is an optional feature to apply credential shielding of the backend PowerMax. | - | - | | enabled | A boolean that enables/disables authorization feature. | No | false | | proxyHost | Hostname of the csm-authorization server. | No | Empty | | skipCertificateValidation | A boolean that enables/disables certificate validation of the csm-authorization proxy server. | No | true | @@ -282,7 +282,7 @@ CRDs should be configured during replication prepare stage with repctl as descri | image | Image for dell-csi-migrator sidecar. | No | " " | | nodeRescanSidecarImage | Image for node rescan sidecar which rescans nodes for identifying new paths. | No | " " | | migrationPrefix | enables migration sidecar to read required information from the storage class fields | No | migration.storage.dell.com | -| **replication** | [Replication](../../../../../deployment/helm/modules/replication/) is an optional feature to enable replication & disaster recovery capabilities of PowerMax to Kubernetes clusters.| - | - | +| **replication** | [Replication](../../../../../deployment/helm/modules/installation/replication/) is an optional feature to enable replication & disaster recovery capabilities of PowerMax to Kubernetes clusters.| - | - | | enabled | A boolean that enables/disables replication feature. | No | false | | replicationContextPrefix | enables side cars to read required information from the volume context | No | powermax | | replicationPrefix | Determine if replication is enabled | No | replication.storage.dell.com | diff --git a/content/docs/deployment/helm/drivers/installation/powerstore.md b/content/docs/deployment/helm/drivers/installation/powerstore.md index fddf2e52f3..2f4ee96efe 100644 --- a/content/docs/deployment/helm/drivers/installation/powerstore.md +++ b/content/docs/deployment/helm/drivers/installation/powerstore.md @@ -131,7 +131,7 @@ replication: The CRDs for replication can be obtained and installed from the csm-replication project on Github. Use `csm-replication/deploy/replicationcrds.all.yaml` located in csm-replication git repo for the installation. -CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../../deployment/helm/modules/replication/install-repctl) +CRDs should be configured during replication prepare stage with repctl as described in [install-repctl](../../../../../deployment/helm/modules/installation/replication/install-repctl) ## Install the Driver @@ -198,7 +198,7 @@ CRDs should be configured during replication prepare stage with repctl as descri | allowAutoRoundOffFilesystemSize | Allows the controller to round off filesystem to 3Gi which is the minimum supported value | No | false | | storageCapacity.enabled | Allows to enable/disable storage capacity tracking feature | No | true | storageCapacity.pollInterval | Configure how often the driver checks for changed capacity | No | 5m -| podmon.enabled | Allows to enable/disable [Resiliency](../../../../../deployment/helm/modules/resiliency#powerstore-specific-recommendations) feature | No | false +| podmon.enabled | Allows to enable/disable [Resiliency](../../../../../deployment/helm/modules/installation/resiliency#powerstore-specific-recommendations) feature | No | false 8. Install the driver using `csi-install.sh` bash script by running ```bash diff --git a/content/docs/deployment/helm/modules/installation/_index.md b/content/docs/deployment/helm/modules/installation/_index.md new file mode 100644 index 0000000000..2ac5c65f62 --- /dev/null +++ b/content/docs/deployment/helm/modules/installation/_index.md @@ -0,0 +1,6 @@ +--- +title: "Installation" +linkTitle: "Installation" +description: Deployment of Dell CSM modules using helm +weight: 1 +--- \ No newline at end of file diff --git a/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md b/content/docs/deployment/helm/modules/installation/applicationmobility/_index.md index 6bc7257bbc..68c07a9e6a 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](../../../../../license/) - Object store bucket accessible by both the source and target clusters ## Installation diff --git a/content/docs/deployment/helm/modules/installation/authorization/_index.md b/content/docs/deployment/helm/modules/installation/authorization/_index.md index 03123b3b4e..1a6149d2bb 100644 --- a/content/docs/deployment/helm/modules/installation/authorization/_index.md +++ b/content/docs/deployment/helm/modules/installation/authorization/_index.md @@ -136,7 +136,7 @@ mv ./karavictl ~/.local/bin/karavictl # and then append (or prepend) ~/.local/bin to $PATH ``` -Karavictl commands and intended use can be found [here](../../../../authorization/cli/). +Karavictl commands and intended use can be found [here](../../../../../authorization/cli/). ## Configuring the CSM Authorization Proxy Server @@ -176,13 +176,13 @@ On the machine running `karavictl`, the `/etc/hosts` file needs to be updated wi csm-authorization.com ``` -Please continue following the steps outlined in the [proxy server](../../../../authorization/configuration/proxy-server) configuration. +Please continue following 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](../../../../authorization#supported-csi-drivers) CSI drivers. This is controlled by the Kubernetes tenant admin. +The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../authorization#supported-csi-drivers) CSI drivers. This is controlled by the Kubernetes tenant admin. -Please continue following the configuration steps for a specific CSI Driver [here](../../../../authorization/configuration/). +Please continue following the configuration steps for a specific CSI Driver [here](../../../../../authorization/configuration/). ## Updating CSM for Authorization Proxy Server Configuration diff --git a/content/docs/deployment/helm/modules/installation/encryption/_index.md b/content/docs/deployment/helm/modules/installation/encryption/_index.md index 98cf5768aa..f4b44dfaf2 100644 --- a/content/docs/deployment/helm/modules/installation/encryption/_index.md +++ b/content/docs/deployment/helm/modules/installation/encryption/_index.md @@ -9,7 +9,7 @@ Encryption for Dell Container Storage Modules is enabled via the Dell CSI driver In the tech preview release, Encryption can only be enabled via Helm chart installation. Except for additional Encryption related configuration outlined on this page, -the rest of the deployment process is described in the correspondent [CSI driver documentation](../../../helm/drivers/installation/). +the rest of the deployment process is described in the correspondent [CSI driver documentation](../../../drivers/installation/). ## Vault Server @@ -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](../../../../../license). You will be provided with a YAML file similar to: ```yaml apiVersion: v1 diff --git a/content/docs/deployment/helm/modules/installation/encryption/vault.md b/content/docs/deployment/helm/modules/installation/encryption/vault.md index 27fe355e3a..086960a6cc 100644 --- a/content/docs/deployment/helm/modules/installation/encryption/vault.md +++ b/content/docs/deployment/helm/modules/installation/encryption/vault.md @@ -224,7 +224,7 @@ vault write auth/approle/role/dea-role/role-id role_id=demo-role-id vault write auth/approle/role/dea-role/custom-secret-id secret_id=demo-secret-id ``` -> Secret ID has an expiration time after which it becomes invalid resulting in [authorization failure](../../../../../secure/encryption/troubleshooting#expired-approle-secret-id). +> Secret ID has an expiration time after which it becomes invalid resulting in [authorization failure](../../../../../../secure/encryption/troubleshooting#expired-approle-secret-id). > The expiration time for new secret IDs can be set in `secret_id_ttl` parameter when [the role is created](#create-a-role) or later on using > `vault write auth/approle/role/dea-role/secret-id-ttl secret_id_ttl=24h`. diff --git a/content/docs/deployment/helm/modules/installation/replication/powerflex.md b/content/docs/deployment/helm/modules/installation/replication/powerflex.md index 2ca0b44e1e..2f8b64c5be 100644 --- a/content/docs/deployment/helm/modules/installation/replication/powerflex.md +++ b/content/docs/deployment/helm/modules/installation/replication/powerflex.md @@ -67,7 +67,7 @@ You can leave other parameters like `replicationContextPrefix`, and `replication After enabling the replication module you can continue to install the CSI driver for PowerFlex following the usual installation procedure, just ensure you've added the array information for all of the arrays being used in the -[secret](../../../drivers/installation/powerflex#install-the-driver). +[secret](../../../../drivers/installation/powerflex#install-the-driver). > **_NOTE:_** You need to install your driver on all clusters where you want to use replication. Both arrays must be accessible from each cluster. diff --git a/content/docs/deployment/helm/modules/uninstall/_index.md b/content/docs/deployment/helm/modules/uninstall/_index.md index 1e11e306b6..de68ea70fd 100644 --- a/content/docs/deployment/helm/modules/uninstall/_index.md +++ b/content/docs/deployment/helm/modules/uninstall/_index.md @@ -1,6 +1,6 @@ --- -title: "CSM modules" -linkTitle: "CSM modules" -description: Installation of Dell CSM modules using helm +title: "Uninstallation" +linkTitle: "Uninstallation" +description: Uninstallation of Dell CSM modules using helm weight: 1 --- \ No newline at end of file diff --git a/content/docs/deployment/helm/modules/uninstall/applicationmobility.md b/content/docs/deployment/helm/modules/uninstall/applicationmobility.md index f98f8e8f5a..79e065076e 100644 --- a/content/docs/deployment/helm/modules/uninstall/applicationmobility.md +++ b/content/docs/deployment/helm/modules/uninstall/applicationmobility.md @@ -1,6 +1,6 @@ --- -title: Uninstallation -linktitle: Uninstallation +title: Application mobility +linktitle: Application mobility weight: 2 description: > Uninstallation diff --git a/content/docs/deployment/helm/modules/uninstall/authorization.md b/content/docs/deployment/helm/modules/uninstall/authorization.md index 0200e9d51d..0c8bb62789 100644 --- a/content/docs/deployment/helm/modules/uninstall/authorization.md +++ b/content/docs/deployment/helm/modules/uninstall/authorization.md @@ -1,6 +1,6 @@ --- -title: Uninstallation -linktitle: Uninstallation +title: Authorization +linktitle: Authorization weight: 2 description: > Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization Uninstallation @@ -28,4 +28,4 @@ rpm -e ## Uninstalling the sidecar-proxy in the CSI Driver -To uninstall the sidecar-proxy in the CSI Driver, [uninstall](../../csidriver/uninstall) the driver and [reinstall](../../deployment) the driver using the original configuration secret. +To uninstall the sidecar-proxy in the CSI Driver, [uninstall](../../../drivers/uninstall) the driver and [reinstall](../../../drivers/installation) the driver using the original configuration secret. diff --git a/content/docs/deployment/helm/modules/uninstall/encryption.md b/content/docs/deployment/helm/modules/uninstall/encryption.md index 9d0997b42e..4c66ac0324 100644 --- a/content/docs/deployment/helm/modules/uninstall/encryption.md +++ b/content/docs/deployment/helm/modules/uninstall/encryption.md @@ -1,6 +1,6 @@ --- -title: "Uninstallation" -linkTitle: "Uninstallation" +title: "Encryption" +linkTitle: "Encryption" weight: 2 Description: > Uninstallation @@ -32,12 +32,12 @@ It can be removed with `sed -i '/^ssh-rsa .* driver-sec$/d' /root/.ssh/authorize ## Remove Kubernetes Resources -Remove [the resources](../deployment#secrets-and-config-maps) created in Kubernetes cluster for Encryption. +Remove [the resources](../../installation/encryption#secrets-and-config-maps) created in Kubernetes cluster for Encryption. ## Remove Vault Server Configuration -Remove [the configuration](../vault#minimum-server-configuration) created in the Vault server for Encryption. +Remove [the configuration](../../installation/encryption/vault#minimum-server-configuration) created in the Vault server for Encryption. ## Remove Rekey Controller -Remove [the resources](../rekey#rekey-controller-installation) created during the installation of the Rekey Controller. +Remove [the resources](../../installation/encryption/rekey#rekey-controller-installation) created during the installation of the Rekey Controller. diff --git a/content/docs/deployment/helm/modules/uninstall/observability.md b/content/docs/deployment/helm/modules/uninstall/observability.md index d5930ccb2c..21095c0a46 100644 --- a/content/docs/deployment/helm/modules/uninstall/observability.md +++ b/content/docs/deployment/helm/modules/uninstall/observability.md @@ -1,6 +1,6 @@ --- -title: Uninstallation -linktitle: Uninstallation +title: Observability +linktitle: Observability weight: 3 description: > Dell Container Storage Modules (CSM) for Observability Uninstallation diff --git a/content/docs/deployment/helm/modules/uninstall/replication.md b/content/docs/deployment/helm/modules/uninstall/replication.md index 450fedd38f..6e8f7bafba 100644 --- a/content/docs/deployment/helm/modules/uninstall/replication.md +++ b/content/docs/deployment/helm/modules/uninstall/replication.md @@ -1,6 +1,6 @@ --- -title: Uninstall -linktitle: Uninstall +title: Replication +linktitle: Replication weight: 10 description: > Dell Container Storage Modules (CSM) for Replication Uninstallation @@ -43,4 +43,4 @@ All replication groups should be deleted before deleting the replication group C ## Uninstalling the replication sidecar -To uninstall the replication sidecar, you need to uninstall the CSI Driver. Please view the [uninstall](../../csidriver/uninstall) page for the driver itself. +To uninstall the replication sidecar, you need to uninstall the CSI Driver. Please view the [uninstall](../../../drivers/uninstall) page for the driver itself. diff --git a/content/docs/deployment/helm/modules/uninstall/resiliency.md b/content/docs/deployment/helm/modules/uninstall/resiliency.md index b821a79d4c..c19e2889e8 100644 --- a/content/docs/deployment/helm/modules/uninstall/resiliency.md +++ b/content/docs/deployment/helm/modules/uninstall/resiliency.md @@ -1,6 +1,6 @@ --- -title: Uninstallation -linktitle: Uninstallation +title: Resiliency +linktitle: Resiliency weight: 2 description: > Dell Container Storage Modules (CSM) for Resiliency Uninstallation @@ -15,14 +15,14 @@ To uninstall the sidecar in the CSI Driver, the following steps are required. **Steps** >NOTE: If you do not wish to uninstall the driver, please follow the steps below for Resiliency uninstallation through driver upgrade. 1. Uninstall the driver - - [Helm](../../deployment/helm/drivers/uninstall/#uninstall-a-csi-driver-installed-via-helm) - - [Operator](../../deployment/csmoperator/drivers/#uninstall-csi-driver) + - [Helm](../../../drivers/uninstall/#uninstall-a-csi-driver-installed-via-helm) + - [Operator](../../../../csmoperator/drivers/#uninstall-csi-driver) 2. Reinstall the driver with the `podmon` feature disabled - - [Helm](../../deployment/helm/drivers/installation/) - - [Operator](../../deployment/csmoperator/drivers/#installing-csi-driver-via-operator) + - [Helm](../../../drivers/installation/) + - [Operator](../../../../csmoperator/drivers/#installing-csi-driver-via-operator) ### Uninstallation through driver upgrade 1. Disable the `podmon` feature in your values file 2. Upgrade the driver - - [Helm](../../deployment/helm/drivers/upgradation/) - - [Operator](../../deployment/csmoperator/drivers/#update-csi-drivers) \ No newline at end of file + - [Helm](../../../drivers/upgrade/) + - [Operator](../../../../csmoperator/drivers/#update-csi-drivers) \ No newline at end of file diff --git a/content/docs/deployment/helm/modules/upgrade/_index.md b/content/docs/deployment/helm/modules/upgrade/_index.md index da0ec18bc7..a0674a231a 100644 --- a/content/docs/deployment/helm/modules/upgrade/_index.md +++ b/content/docs/deployment/helm/modules/upgrade/_index.md @@ -1,5 +1,5 @@ --- -title: "Upgrade Modules" +title: "Upgrade" tags: - upgrade weight: 3 diff --git a/content/docs/authorization/upgrade.md b/content/docs/deployment/helm/modules/upgrade/authorization.md similarity index 84% rename from content/docs/authorization/upgrade.md rename to content/docs/deployment/helm/modules/upgrade/authorization.md index 4b2fa8d7f6..1645c89789 100644 --- a/content/docs/authorization/upgrade.md +++ b/content/docs/deployment/helm/modules/upgrade/authorization.md @@ -1,6 +1,6 @@ --- -title: Upgrade -linktitle: Upgrade +title: Authorization +linktitle: Authorization weight: 3 description: > Upgrade Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization @@ -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](../deployment/#single-binary-installer). +Obtain the latest single binary installer RPM by following one of our two options [here](../../installation/authorization#single-binary-installer). To update the rpm package on the system, run the below command from within the extracted folder: @@ -49,9 +49,9 @@ k3s kubectl version Given a setup where the CSM for Authorization proxy server is already upgraded to the latest version, follow the upgrade instructions for the applicable CSI Driver(s) to upgrade the driver and the CSM for Authorization sidecar -- [Upgrade PowerFlex CSI driver](../../deployment/helm/drivers/upgradation/drivers/powerflex/) -- [Upgrade PowerMax CSI driver](../../deployment/helm/drivers/upgradation/drivers/powermax/) -- [Upgrade PowerScale CSI driver](../../deployment/helm/drivers/upgradation/drivers/isilon/) +- [Upgrade PowerFlex CSI driver](../../../drivers/upgrade/powerflex/) +- [Upgrade PowerMax CSI driver](../../../drivers/upgrade/powermax/) +- [Upgrade PowerScale CSI driver](../../../drivers/upgrade/isilon/) ## Rollback diff --git a/content/docs/deployment/helm/modules/upgrade/observability.md b/content/docs/deployment/helm/modules/upgrade/observability.md index b2010140bd..5189a21520 100644 --- a/content/docs/deployment/helm/modules/upgrade/observability.md +++ b/content/docs/deployment/helm/modules/upgrade/observability.md @@ -1,6 +1,6 @@ --- -title: Upgrade -linktitle: Upgrade +title: Observability +linktitle: Observability weight: 3 description: > Dell Container Storage Modules (CSM) for Observability Upgrade @@ -13,7 +13,7 @@ This section outlines the upgrade steps for Container Storage Modules (CSM) for ## Helm Chart Upgrade -CSM for Observability Helm upgrade supports [Helm](../deployment/helm), [Online Installer](../deployment/online), and [Offline Installer](../deployment/offline) deployments. +CSM for Observability Helm upgrade supports [Helm](../../installation/observability/deployment), [Online Installer](../../installation/observability/installer/), and [Offline Installer](../../../../offline/modules) deployments. To upgrade an existing Helm installation of CSM for Observability to the latest release, download the latest Helm charts. @@ -31,7 +31,7 @@ NAME CHART VERSION APP VERSION DESCRIPTION dell/karavi-observability 1.8.0 1.8.0 CSM for Observability is part of the [Container... ``` ->Note: If using cert-manager CustomResourceDefinitions older than v1.5.3, delete the old CRDs and install v1.5.3 of the CRDs prior to upgrade. See [Prerequisites](../deployment/helm#prerequisites) for location of CRDs. +>Note: If using cert-manager CustomResourceDefinitions older than v1.5.3, delete the old CRDs and install v1.5.3 of the CRDs prior to upgrade. See [Prerequisites](../../installation/observability/deployment#prerequisites) for location of CRDs. Upgrade to the latest CSM for Observability release: @@ -47,17 +47,17 @@ Upgrade Offline Installer deployment: helm upgrade --version $latest_chart_version karavi-observability dell/karavi-observability -n $namespace ``` -The [configuration](../deployment/helm#configuration) section lists all the parameters that can be configured using the `values.yaml` file. +The [configuration](../../installation/observability/deployment#configuration) section lists all the parameters that can be configured using the `values.yaml` file. ## Online Installer Upgrade -CSM for Observability online installer upgrade can be used if the initial deployment was performed using the [Online Installer](../deployment/online) or [Helm](../deployment/helm). +CSM for Observability online installer upgrade can be used if the initial deployment was performed using the [Online Installer](../../installation/observability/installer) or [Helm](../../installation/observability/deployment). 1. Change to the installer directory: ```bash cd karavi-observability/installer ``` -2. Update `values.yaml` file as needed. Configuration options are outlined in the [Helm chart deployment section](../deployment/helm#configuration). +2. Update `values.yaml` file as needed. Configuration options are outlined in the [Helm chart deployment section](../../installation/observability/deployment#configuration). 3. Execute the `./karavi-observability-install.sh` script: ```bash @@ -94,10 +94,10 @@ Assuming that you have already installed the Karavi Observability Helm Chart by These instructions can be followed when a Helm chart was installed and will be upgraded in an environment that does not have an Internet connection and will be unable to download the Helm chart and related Docker images. 1. Build the Offline Bundle - Follow [Offline Karavi Observability Helm Chart Installer](../deployment/offline) to build the latest bundle. + Follow [Offline Karavi Observability Helm Chart Installer](../../../../offline/modules) to build the latest bundle. 2. Unpack the Offline Bundle - Follow [Offline Karavi Observability Helm Chart Installer](../deployment/offline), copy and unpack the Offline Bundle to another Linux system, and push Docker images to the internal Docker registry. + Follow [Offline Karavi Observability Helm Chart Installer](../../../../offline/modules), copy and unpack the Offline Bundle to another Linux system, and push Docker images to the internal Docker registry. 3. Perform Helm upgrade 1. Change directory to `helm` which contains the updated Helm chart directory: @@ -110,13 +110,13 @@ These instructions can be followed when a Helm chart was installed and will be u kubectl apply --validate=false -f cert-manager.crds.yaml ``` 3. (Optional) Enable Karavi Observability for PowerFlex/PowerScale to use an existing instance of Karavi Authorization for accessing the REST API for the given storage systems. - **Note**: Assuming that if the Karavi Observability's Authorization has been enabled in the phase of [Offline Karavi Observability Helm Chart Installer](../deployment/offline), the Authorization Secrets/Configmap have been copied to the Karavi Observability namespace. + **Note**: Assuming that if the Karavi Observability's Authorization has been enabled in the phase of [Offline Karavi Observability Helm Chart Installer](../../../../offline/modules), the Authorization Secrets/Configmap have been copied to the Karavi Observability namespace. A sample configuration values.yaml file is located [here](https://github.com/dell/helm-charts/blob/main/charts/karavi-observability/values.yaml). In your own configuration values.yaml, you need to enable PowerFlex/PowerScale Authorization, and provide the location of the sidecar-proxy Docker image and URL of the Karavi Authorization proxyHost address. 4. After the images have been made available and the Helm chart configuration is updated, follow the instructions within the Helm chart's repository to complete the installation. - **Note**: Assuming that Your Secrets from CSI Drivers have been copied to the Karavi Observability namespace during the steps of [Offline Karavi Observability Helm Chart Installer](../deployment/offline) - Optionally, you could provide your own [configurations](../deployment/helm/#configuration). A sample values.yaml file is located [here](https://github.com/dell/helm-charts/blob/main/charts/karavi-observability/values.yaml). + **Note**: Assuming that Your Secrets from CSI Drivers have been copied to the Karavi Observability namespace during the steps of [Offline Karavi Observability Helm Chart Installer](../../../../offline/modules) + Optionally, you could provide your own [configurations](../../installation/observability/#configuration). A sample values.yaml file is located [here](https://github.com/dell/helm-charts/blob/main/charts/karavi-observability/values.yaml). ```bash helm upgrade -n install-namespace app-name karavi-observability diff --git a/content/docs/deployment/helm/modules/upgrade/replication.md b/content/docs/deployment/helm/modules/upgrade/replication.md index d71107972d..75c7a8f365 100644 --- a/content/docs/deployment/helm/modules/upgrade/replication.md +++ b/content/docs/deployment/helm/modules/upgrade/replication.md @@ -1,6 +1,6 @@ --- -title: Upgrade -linktitle: Upgrade +title: Replication +linktitle: Replication weight: 9 description: > Upgrade guide @@ -30,7 +30,7 @@ To upgrade the CSM Replication sidecar that is installed along with the driver, ``` 3. Run the same command on the second Kubernetes cluster if you use multi-cluster replication topology ->For more information on upgrading the CSI driver, please visit the [CSI driver upgrade page](../../csidriver/upgradation). +>For more information on upgrading the CSI driver, please visit the [CSI driver upgrade page](../../../drivers/upgrade). ### PowerScale @@ -71,7 +71,7 @@ This option will only work if you have previously installed replication via Helm ### Upgrading with repctl -> _**Note**_: These steps assume that you already have `repctl` configured to use correct clusters, if you don't know how to do that please refer to [installing with repctl](../deployment/install-repctl) +> _**Note**_: These steps assume that you already have `repctl` configured to use correct clusters, if you don't know how to do that please refer to [installing with repctl](../../installation/replication/install-repctl) **Steps** 1. Find a new version of deployment manifest that can be found in `deploy/controller.yaml`, with newer `image` pointing to the version of CSM Replication controller you want to upgrade to. diff --git a/content/docs/resiliency/upgrade.md b/content/docs/deployment/helm/modules/upgrade/resiliency.md similarity index 75% rename from content/docs/resiliency/upgrade.md rename to content/docs/deployment/helm/modules/upgrade/resiliency.md index 6baaa9a69a..9affb9f55c 100644 --- a/content/docs/resiliency/upgrade.md +++ b/content/docs/deployment/helm/modules/upgrade/resiliency.md @@ -1,6 +1,6 @@ --- -title: Upgrade -linktitle: Upgrade +title: Resiliency +linktitle: Resiliency weight: 3 description: > Dell Container Storage Modules (CSM) for Resiliency upgrade @@ -8,13 +8,13 @@ description: > CSM for Resiliency can be upgraded as part of the Dell CSI driver upgrade process. The drivers can be upgraded either by a _helm chart_ or by the _Dell CSM Operator_. Currently, only _Helm chart_ upgrade is supported for CSM for Resiliency. -For information on the PowerFlex CSI driver upgrade process, see [PowerFlex CSI Driver](../../csidriver/upgradation/drivers/powerflex). +For information on the PowerFlex CSI driver upgrade process, see [PowerFlex CSI Driver](../../../drivers/upgrade/powerflex). -For information on the Unity XT CSI driver upgrade process, see [Unity XT CSI Driver](../../deployment/helm/drivers/upgradation/drivers/unity). +For information on the Unity XT CSI driver upgrade process, see [Unity XT CSI Driver](../../../drivers/upgrade/unity). -For information on the PowerScale CSI driver upgrade process, see [PowerScale CSI Driver](../../deployment/helm/drivers/upgradation/drivers/isilon). +For information on the PowerScale CSI driver upgrade process, see [PowerScale CSI Driver](../../../drivers/upgrade/isilon). -For information on the PowerStore CSI driver upgrade process, see [PowerStore CSI Driver](../../deployment/helm/drivers/upgradation/drivers/powerstore). +For information on the PowerStore CSI driver upgrade process, see [PowerStore CSI Driver](../../../drivers/upgrade/powerstore). ## Helm Chart Upgrade diff --git a/content/docs/deployment/offline/modules/_index.md b/content/docs/deployment/offline/modules/_index.md index 42f33c30c1..0d42270d26 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/authorization#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#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/authorization#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#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/authorization#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#configuring-a-dell-csi-driver-with-csm-for-authorization) for CSI PowerMax, perform these steps: ```bash diff --git a/content/docs/deployment/offline/upgrade/_index.md b/content/docs/deployment/offline/upgrade/_index.md index 5d4fb2ab34..b3c9dfb90d 100644 --- a/content/docs/deployment/offline/upgrade/_index.md +++ b/content/docs/deployment/offline/upgrade/_index.md @@ -4,6 +4,6 @@ linktitle: Offline Upgrade description: Offline Upgrade of Dell CSI Storage Providers --- -1. To perform offline upgrade of the driver, please create an offline bundle as mentioned [here](../../../drivers#building-an-offline-bundle). -2. Once the bundle is created, please unpack the bundle by following the steps mentioned [here](../../../drivers#unpacking-the-offline-bundle-and-preparing-for-installation). +1. To perform offline upgrade of the driver, please create an offline bundle as mentioned [here](../drivers#building-an-offline-bundle). +2. Once the bundle is created, please unpack the bundle by following the steps mentioned [here](../drivers#unpacking-the-offline-bundle-and-preparing-for-installation). 3. Please use the driver specific upgrade steps to upgrade. \ No newline at end of file diff --git a/content/docs/observability/_index.md b/content/docs/observability/_index.md index 18dd3170ff..1daf0bee98 100644 --- a/content/docs/observability/_index.md +++ b/content/docs/observability/_index.md @@ -14,7 +14,7 @@ Description: > Metrics data is collected and pushed to the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector), so it can be processed, and exported in a format consumable by Prometheus. SSL certificates for TLS between nodes are handled by [cert-manager](https://github.com/jetstack/cert-manager). -CSM for Observability is composed of several services, each residing in its own GitHub repository, that can be installed following one of the four deployments we support [here](deployment). Contributions can be made to this repository or any of the CSM for Observability repositories listed below. +CSM for Observability is composed of several services, each residing in its own GitHub repository, that can be installed following one of the four deployments we support [here](../deployment/helm/modules/installation/observability/). Contributions can be made to this repository or any of the CSM for Observability repositories listed below. {{}} | Name | Repository | Description | @@ -94,7 +94,7 @@ CSM for Observability provides Kubernetes administrators with the topology data ## TLS Encryption -CSM for Observability deployment relies on [cert-manager](https://github.com/jetstack/cert-manager) to manage SSL certificates that are used to encrypt communication between various components. When [deploying CSM for Observability](./deployment), cert-manager is installed and configured automatically. The cert-manager components listed below will be installed alongside CSM for Observability. +CSM for Observability deployment relies on [cert-manager](https://github.com/jetstack/cert-manager) to manage SSL certificates that are used to encrypt communication between various components. When [deploying CSM for Observability](../deployment/helm/modules/installation/observability), cert-manager is installed and configured automatically. The cert-manager components listed below will be installed alongside CSM for Observability. {{
}} | Component | diff --git a/content/docs/observability/troubleshooting/_index.md b/content/docs/observability/troubleshooting/_index.md index 5d1313c6a8..be4245fff8 100644 --- a/content/docs/observability/troubleshooting/_index.md +++ b/content/docs/observability/troubleshooting/_index.md @@ -112,7 +112,7 @@ A workaround on most browsers is to accept the `karavi-topology` certificate by
Deploy certificate with new Grafana instance - Please follow the steps in Sample Grafana Deployment but attach the certificate to your `grafana-values.yaml` before deploying. The file should look like: + Please follow the steps in Sample Grafana Deployment but attach the certificate to your `grafana-values.yaml` before deploying. The file should look like: ```yaml # grafana-values.yaml @@ -222,7 +222,7 @@ More information for viewing logs can be found [here](../#viewing-logs). ### How can I create a ServiceMonitor object for Prometheus if I'm using Rancher monitoring stack? -The ServiceMonitor allows us to define how a set of services should be monitored by Prometheus. Please see our [prometheus](../deployment#prometheus) documentation for creating a ServiceMonitor. +The ServiceMonitor allows us to define how a set of services should be monitored by Prometheus. Please see our [prometheus](../../deployment/helm/modules/installation/observability#prometheus) documentation for creating a ServiceMonitor. ### How can I debug and troubleshoot issues with Kubernetes? @@ -232,7 +232,7 @@ The ServiceMonitor allows us to define how a set of services should be monitored ### How can I troubleshoot latency problems with CSM for Observability? -CSM for Observability is instrumented to report trace data to [Zipkin](https://zipkin.io/). Please see [Tracing](../deployment/#tracing) for more information on enabling tracing for CSM for Observability. +CSM for Observability is instrumented to report trace data to [Zipkin](https://zipkin.io/). Please see [Tracing](../../deployment/helm/modules/installation/observability#tracing) for more information on enabling tracing for CSM for Observability. ### Why does the Observability installation timeout with pods stuck in 'ContainerCreating'/'CrashLoopBackOff'/'Error' stage? diff --git a/content/docs/references/FAQ/_index.md b/content/docs/references/FAQ/_index.md index 9d403b1b88..19199ffd2d 100644 --- a/content/docs/references/FAQ/_index.md +++ b/content/docs/references/FAQ/_index.md @@ -30,23 +30,23 @@ The umbrella repository for every Dell Container Storage Module is: [https://git ### 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/observability/deployment#prerequisites) -- [Dell Container Storage Module for Authorization Deployment](../../deployment/helm/modules/authorization#prerequisites) -- [Dell Container Storage Module for Resiliency Deployment](../../deployment/helm/modules/resiliency) -- [Dell Container Storage Module for Replication Deployment](../../deployment/helm/modules/replication/installation/#before-you-begin) -- [Dell Container Storage Module for Application Mobility Deployment](../../deployment/helm/modules/applicationmobility#pre-requisites) -- [Dell Container Storage Module for Encryption Deployment](../../deployment/helm/modules/encryption#vault-server) +- [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](../../csidriver/installation/) +- [Dell CSI Drivers Deployment](../../deployment/helm/drivers/installation/) ### How do I uninstall or disable a module? -- [Dell Container Storage Module for Authorization](../../authorization/uninstallation/) -- [Dell Container Storage Module for Observability](../../observability/uninstall/) -- [Dell Container Storage Module for Resiliency](../../resiliency/uninstallation/) -- [Dell Container Storage Module for Replication](../../replication/uninstall/) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/uninstallation/) -- [Dell Container Storage Module for Encryption](../../secure/encryption/uninstallation/) +- [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/) diff --git a/content/docs/replication/cluster-topologies.md b/content/docs/replication/cluster-topologies.md index 07794968de..95ecb79a5c 100644 --- a/content/docs/replication/cluster-topologies.md +++ b/content/docs/replication/cluster-topologies.md @@ -38,7 +38,7 @@ Note that the `targets` parameter is left empty since we don't require any targe This also means that you don't need to create any Secrets that contain connection information to such clusters, since in this use case, we are limited to a single cluster. -You can find more info about configs and secrets for cluster communication in [configmaps-secrets](../../deployment/helm/modules/replication/configmap-secrets/). +You can find more info about configs and secrets for cluster communication in [configmaps-secrets](../../deployment/helm/modules/installation/replication/configmap-secrets/). #### Storage Class Configuration @@ -48,7 +48,7 @@ be set to `self` to indicate that we want to replicate the volume inside the cur Also, you would need to create another storage class in the same cluster that would serve as a `target` storage class. This means that all replicated volumes would be derived from it. Its `replication.storage.dell.com/remoteClusterID` parameter should be also set to `self`. -You can find out more about replication StorageClasses and replication specific parameters in [storageclasses](../../deployment/helm/modules/replication/storageclasses). +You can find out more about replication StorageClasses and replication specific parameters in [storageclasses](../../deployment/helm/modules/installation/replication/storageclasses). #### Replicated Resources @@ -95,7 +95,7 @@ metadata: ``` Note that target cluster information contains a field called `secretRef`. This field points to a secret available in the current cluster that contains connection information of `cluster-B` in the form of a kubeconfig file. -You can find more information about how to create such secrets in [configmaps-secrets](../../deployment/helm/modules/replication/configmap-secrets/#communication-between-clusters). +You can find more information about how to create such secrets in [configmaps-secrets](../../deployment/helm/modules/installation/replication/configmap-secrets/#communication-between-clusters). #### Storage Class Configuration @@ -106,7 +106,7 @@ want to replicate your volumes. For multi-cluster replication, we can choose one of the target cluster ids we specified in ConfigMap. In our example replication parameter, the target cluster id should be equal to `cluster-B`. -You can find more information about other replication parameters available in storage classes [here](../../deployment/helm/modules/replication/storageclasses#common-parameters). +You can find more information about other replication parameters available in storage classes [here](../../deployment/helm/modules/installation/replication/storageclasses#common-parameters). #### Replicated Resources diff --git a/content/docs/replication/high-availability.md b/content/docs/replication/high-availability.md index 2564ea2959..315f8d888a 100644 --- a/content/docs/replication/high-availability.md +++ b/content/docs/replication/high-availability.md @@ -17,8 +17,8 @@ In SRDF metro configurations: * R2 devices assume the same external device identity(geometry, device WWN) as the R1 devices. All the above characteristic makes SRDF metro best suited for the scenarios in which high availability of data is desired. -With respect to Kubernetes, the SRDF metro mode works in single cluster scenarios. In the metro, both the arrays—[arrays with SRDF metro link setup between them](../deployment/powermax/#on-storage-array)—involved in the replication are managed by the same `csi-powermax` driver. The replication is triggered by creating a volume using a `StorageClass` with metro-related parameters. -The driver on receiving the metro-related parameters in the `CreateVolume` call creates a metro replicated volume and the details about both the volumes are returned in the volume context to the Kubernetes cluster. So, the `PV` created in the process represents a pair of metro replicated volumes. When a `PV`, representing a pair of metro replicated volumes, is claimed by a pod, the host treats each of the volumes represented by the single `PV` as a separate data path. The switching between the paths, to read and write the data, is managed by the multipath driver. The switching happens automatically, as configured by the user—in round-robin fashion or otherwise—or it can happen if one of the paths goes down. For details on Linux multipath driver setup, [click here](../deployment/helm/drivers/installation/powermax#linux-multipathing-requirements). +With respect to Kubernetes, the SRDF metro mode works in single cluster scenarios. In the metro, both the arrays—[arrays with SRDF metro link setup between them](../../deployment/helm/modules/installation/replication/powermax/#on-storage-array)—involved in the replication are managed by the same `csi-powermax` driver. The replication is triggered by creating a volume using a `StorageClass` with metro-related parameters. +The driver on receiving the metro-related parameters in the `CreateVolume` call creates a metro replicated volume and the details about both the volumes are returned in the volume context to the Kubernetes cluster. So, the `PV` created in the process represents a pair of metro replicated volumes. When a `PV`, representing a pair of metro replicated volumes, is claimed by a pod, the host treats each of the volumes represented by the single `PV` as a separate data path. The switching between the paths, to read and write the data, is managed by the multipath driver. The switching happens automatically, as configured by the user—in round-robin fashion or otherwise—or it can happen if one of the paths goes down. For details on Linux multipath driver setup, [click here](../../deployment/helm/drivers/installation/powermax#linux-multipathing-requirements). The creation of volumes in SRDF metro mode doesn't involve the replication sidecar or the common controller, nor does it cause the creation of any replication related custom resources; it just needs a `csi-powermax` driver that implements the `CreateVolume` gRPC endpoint with SRDF metro capability for it to work. diff --git a/content/docs/replication/migration/migrating-volumes-diff-array.md b/content/docs/replication/migration/migrating-volumes-diff-array.md index a1025d2350..50d343997b 100644 --- a/content/docs/replication/migration/migrating-volumes-diff-array.md +++ b/content/docs/replication/migration/migrating-volumes-diff-array.md @@ -61,7 +61,7 @@ migration: migrationPrefix: "migration.storage.dell.com" ``` -Target array configuration and endpoint needs to be updated in the driver's [myvalues.yaml](../../deployment/helm/drivers/installation/powermax#csi-powermax-driver-with-proxy-in-standalone-mode) file as shown below: +Target array configuration and endpoint needs to be updated in the driver's [myvalues.yaml](../../../deployment/helm/drivers/installation/powermax#csi-powermax-driver-with-proxy-in-standalone-mode) file as shown below: ```yaml ########################## diff --git a/content/docs/resiliency/_index.md b/content/docs/resiliency/_index.md index 45fe4d7899..8682218523 100644 --- a/content/docs/resiliency/_index.md +++ b/content/docs/resiliency/_index.md @@ -104,7 +104,7 @@ PowerStore is a highly scalable array that is very well suited to Kubernetes dep ## Limitations and Exclusions -This file contains information on Limitations and Exclusions that users should be aware of. Additionally, there are driver specific limitations and exclusions that may be called out in the [Deploying CSM for Resiliency](deployment) page. +This file contains information on Limitations and Exclusions that users should be aware of. Additionally, there are driver specific limitations and exclusions that may be called out in the [Deploying CSM for Resiliency](../deployment/helm/modules/installation/resiliency/) page. ### Supported and Tested Operating Modes diff --git a/content/docs/secure/encryption/_index.md b/content/docs/secure/encryption/_index.md index 4720298f36..e3b007bfa2 100644 --- a/content/docs/secure/encryption/_index.md +++ b/content/docs/secure/encryption/_index.md @@ -32,7 +32,7 @@ This provisioner belongs to the storage driver and does not depend on the Encryp **Provisioner for encrypted volumes** -This provisioner belongs to Encryption and registers with the name [`encryption.pluginName`](deployment/#helm-chart-values) when Encryption is enabled. Use a storage class with this provisioner to create encrypted volumes. +This provisioner belongs to Encryption and registers with the name [`encryption.pluginName`](../../deployment/helm/modules/installation/encryption/#helm-chart-values) when Encryption is enabled. Use a storage class with this provisioner to create encrypted volumes. ## Capabilities @@ -113,7 +113,7 @@ Please refer to the Hashicorp Vault documentation regarding recommended deployme > **CAUTION:** Destroyed Vault storage back-end or the encryption key stored in it, will make it impossible to unlock the volume encrypted with Encryption. Access to the data will be lost for ever. -Refer to [Vault Configuration section](vault) for minimal configuration steps required to support Encryption and other configuration considerations. +Refer to [Vault Configuration section](../../deployment/helm/modules/installation/encryption/vault) for minimal configuration steps required to support Encryption and other configuration considerations. ## Key Rotation (rekey) This preview of Encryption includes the ability to change the KEK (Key Encryption Key) of an encrypted volume, an operation commonly known as Shallow Rekey, or diff --git a/content/docs/secure/encryption/troubleshooting.md b/content/docs/secure/encryption/troubleshooting.md index f7e374f543..addc94b034 100644 --- a/content/docs/secure/encryption/troubleshooting.md +++ b/content/docs/secure/encryption/troubleshooting.md @@ -27,7 +27,7 @@ List containers in pod `isi-node-4gtwf` with `kubectl -n logs Each pod has containers called `driver` which is the storage driver container and `driver-sec` which is the Encryption driver container. These container's logs tend to provide the most important information, but other containers may give a hint too. View the logs of `driver-sec` in `isi-node-4gtwf` with `kubectl -n logs isi-node-4gtwf driver-sec`. -The log level of this container can be changed by setting value [encryption.logLevel](../deployment#helm-chart-values) and restarting the driver. +The log level of this container can be changed by setting value [encryption.logLevel](../../../deployment/helm/modules/installation/encryption#helm-chart-values) and restarting the driver. Often it is necessary to see the logs produced on a specific Kubernetes worker host. To find which *node* pod is running on which worker host, use `kubectl -n get pods -o wide`. @@ -39,25 +39,25 @@ Some errors may be logged to the related resource events that can be viewed with ### Vault Server Logs Some errors related to communication with the Vault server and key requests may be logged on the Vault server side. -If you run a [test instance of the server in a Docker container](../../../deployment/helm/modules/encryption/vault#vault-server-installation) you can view the logs with `docker logs vault-server`. +If you run a [test instance of the server in a Docker container](../../../deployment/helm/modules/installation/encryption/vault#vault-server-installation) you can view the logs with `docker logs vault-server`. ## Typical Failure Reasons ### Incorrect Vault related configuration - check [logs](#logs-and-events) -- check [vault-auth secret](../../../deployment/helm/modules/encryption#secret-vault-auth) -- check [vault-cert secret](../../../deployment/helm/modules/encryption#secret-vault-cert) -- check [vault-client-conf config map](../../../deployment/helm/modules/encryption/#configmap-vault-client-conf) +- check [vault-auth secret](../../../deployment/helm/modules/installation/encryption#secret-vault-auth) +- check [vault-cert secret](../../../deployment/helm/modules/installation/encryption#secret-vault-cert) +- check [vault-client-conf config map](../../../deployment/helm/modules/installation/encryption/#configmap-vault-client-conf) ### Incorrect Vault server-side configuration - check [logs](#logs-and-events) -- check [Vault server configuration](../../../deployment/helm/modules/encryption/vault#minimum-server-configuration) +- check [Vault server configuration](../../../deployment/helm/modules/installation/encryption/vault#minimum-server-configuration) ### Expired AppRole secret ID -- [reset the role secret ID](../../../deployment/helm/modules/encryption/vault#set-role-id-and-secret-id-to-the-role) +- [reset the role secret ID](../../../deployment/helm/modules/installation/encryption/vault#set-role-id-and-secret-id-to-the-role) ### Incorrect CSI driver configuration @@ -83,7 +83,7 @@ This may manifest in: Resolution: - obtain a [new valid license](../../../license) - check the license is for the cluster on which the encrypted volumes are created -- check [encryption-license secret](../../../deployment/helm/modules/encryption#secret-encryption-license) +- check [encryption-license secret](../../../deployment/helm/modules/installation/encryption#secret-encryption-license) ## Typical Rekey Failure reasons If all rekeys in the cluster are failing