Skip to content

Commit

Permalink
Fixing broken links (#1014)
Browse files Browse the repository at this point in the history
  • Loading branch information
boyamurthy authored Mar 1, 2024
1 parent 5f012ef commit 5e2b7a0
Show file tree
Hide file tree
Showing 51 changed files with 96 additions and 83 deletions.
6 changes: 3 additions & 3 deletions content/docs/authorization/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](../../csidriver/upgradation/drivers/powerflex/)
- [Upgrade PowerMax CSI driver](../../csidriver/upgradation/drivers/powermax/)
- [Upgrade PowerScale CSI driver](../../csidriver/upgradation/drivers/isilon/)
- [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/)

## Rollback

Expand Down
4 changes: 2 additions & 2 deletions content/docs/csidriver/features/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Description: Code features for PowerMax Driver

Starting with v1.7, the CSI PowerMax driver can communicate with multiple Unisphere for PowerMax servers to manage multiple PowerMax arrays.
In order to use this feature, you must install CSI PowerMax ReverseProxy in `StandAlone` mode with the driver. For more details on how
to configure the driver and ReverseProxy, see the relevant section [here](../../installation/helm/powermax/#sample-values-file)
to configure the driver and ReverseProxy, see the relevant section [here](../../../deployment/helm/drivers/installation/powermax#sample-values-file)

## Volume Snapshot Feature

Expand Down Expand Up @@ -581,7 +581,7 @@ It will be supported only on new/freshly installed clusters where the cluster is

To use this feature
- Set `vSphere.enabled` to true.
- Create a secret which contains vCenter privileges. Follow the steps [here](../../installation/helm/powermax/#auto-rdm-for-vsphere-over-fc-requirements) to create it. Update `vCenterCredSecret` with the secret name created.
- Create a secret which contains vCenter privileges. Follow the steps [here](../../../deployment/helm/drivers/installation/powermax#auto-rdm-for-vsphere-over-fc-requirements) to create it. Update `vCenterCredSecret` with the secret name created.

```yaml
VMware/vSphere virtualization support
Expand Down
4 changes: 2 additions & 2 deletions content/docs/csidriver/test/certcsi.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,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](../../../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](../../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 <path-to-config> --vsc <volume-snapshot-class>
Expand Down Expand Up @@ -525,7 +525,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](../../../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](../../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 <storage class>
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/troubleshooting/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ description: Troubleshooting PowerFlex Driver
| 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: <br /> 1. Force delete the pod running on the node that went down <br /> 2. Delete the volumeattachment to the node that went down. <br /> 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: <br/> 1. Remove any multipath mapping involving a powerflex volume with `multipath -f <powerflex volume>` <br/> 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](../../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/upgradation/drivers/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.<br/><br/>securityContext:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;runAsUser: 0<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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. |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/troubleshooting/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Troubleshooting PowerMax Driver
| `kubectl logs powermax-controller-<xyz> –n <namespace> 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 <br /> 2. Delete the volumeattachment to the node that went down. <br /> 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](../../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/upgradation/drivers/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 |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/deployment/csminstallationwizard/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a
3. Look over all the fields in the generated `values.yaml` and fill in/adjust any as needed.
>NOTE: The CSM Installation Wizard generates `values.yaml` with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, you can follow the steps outlined in [PowerStore](../../csidriver/installation/helm/powerstore/#install-the-driver), [PowerMax](../../csidriver/installation/helm/powermax/#install-the-driver), [PowerScale](../../csidriver/installation/helm/isilon/#install-the-driver), [PowerFlex](../../csidriver/installation/helm/powerflex/#install-the-driver), [Unity XT](../../csidriver/installation/helm/unity/#install-csi-driver), [Observability](../../observability/), [Replication](../../replication/), [Resiliency](../../resiliency/).
>NOTE: The CSM Installation Wizard generates `values.yaml` with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, you can follow the steps outlined in [PowerStore](../helm/drivers/installation/powerstore/#install-the-driver), [PowerMax](../helm/drivers/installation/powermax#install-the-driver), [PowerScale](../helm/drivers/installation/isilon#install-the-driver), [PowerFlex](../helm/drivers/installation/powerflex#install-the-driver), [Unity XT](../helm/drivers/installation/unity#install-csi-driver), [Observability](../csmoperator/modules/observability/), [Replication](../csmoperator/modules/replication/), [Resiliency](../csmoperator/modules/resiliency/).
4. When the PowerFlex driver is installed using values generated by installation wizard, the user needs to update the secret for driver by patching the MDM keys, as follows:
Expand All @@ -88,7 +88,7 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a
`kubectl patch secret vxflexos-config -n vxflexos -p "{\"data\": { \"MDM\": \"<GENERATED_BASE64>\"}}"`
```
5. If Observability is checked in the wizard, refer to [Observability](../../observability/deployment/#post-installation-dependencies) to export metrics to Prometheus and load the Grafana dashboards.
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.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/deployment/csmoperator/drivers/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ kubectl create secret -n <namespace> tls csirevproxy-tls-secret --cert=tls.crt -
## Installation

### (Optional) Create secret for client-side TLS verification
Create a secret named powermax-certs in the namespace where the CSI PowerMax driver will be installed. This is an optional step and is only required if you are setting the env variable X_CSI_POWERMAX_SKIP_CERTIFICATE_VALIDATION to false. See the detailed documentation on how to create this secret [here](../../../../csidriver/installation/helm/powermax#certificate-validation-for-unisphere-rest-api-calls).
Create a secret named powermax-certs in the namespace where the CSI PowerMax driver will be installed. This is an optional step and is only required if you are setting the env variable X_CSI_POWERMAX_SKIP_CERTIFICATE_VALIDATION to false. See the detailed documentation on how to create this secret [here](../../../helm/drivers/installation/powermax#certificate-validation-for-unisphere-rest-api-calls).


### Install Driver
Expand Down
2 changes: 1 addition & 1 deletion content/docs/deployment/csmoperator/operator_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ description: >
## Testing

To test that the new installation is working, please follow the steps outlined [here](../../test) for your specific driver.
To test that the new installation is working, please follow the steps outlined [here](../../../csidriver/test) for your specific driver.
2 changes: 1 addition & 1 deletion content/docs/deployment/helm/drivers/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CSI Drivers"
linkTitle: "CSI Drivers"
description: Installation of Dell CSI Drivers using helm
description: Deployment of Dell CSI Drivers using helm
weight: 1
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: "Upgrade"
tags:
- upgrade
- csi-driver
weight: 3
Description: Upgrade Dell CSI Drivers
Description: Upgrading Dell CSI Drivers
---

2 changes: 1 addition & 1 deletion content/docs/deployment/helm/modules/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CSM modules"
linkTitle: "CSM modules"
description: Installation of Dell CSM modules using helm
description: Deployment of Dell CSM modules using helm
weight: 1
---
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
6 changes: 6 additions & 0 deletions content/docs/deployment/helm/modules/uninstall/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "CSM modules"
linkTitle: "CSM modules"
description: Installation of Dell CSM modules using helm
weight: 1
---
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
---
title: "Uninstallation"
linkTitle: "Uninstallation"
weight: 2
Description: >
Uninstallation
---

## Cleanup Kubernetes Worker Hosts

Login to each worker host and perform these steps:

__Remove directory */root/.driver-sec*__

This directory was created when a CSI driver with Encryption first ran on the host.

__Remove entry from */root/.ssh/authorized_keys*__

This is an entry added when a CSI driver with Encryption first ran on the host.
It ends with `driver-sec`, similarly to:

```
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDGvSWmTL7NORRDPAvtbMbvoHUBLnen9bRtJePbGk1boJ4XK39Qdvo2zFHZ/6t2+dSL7xKo2kcxX3ovj3RyOPuqNCob
5CLYyuIqduooy+eSP8S1i0FbiDHvH/52yHglnGkBb8g8fmoMolYGW7k35mKOEItKlXruP5/hpP0rBDfBfrxe/K4aHicxv6GylP+uTSBjdj7bZrdgRAIlmDyIdvU4oU6L
K9PDW5rufArlrZHaToHXLMbXbqswD08rgFt3tLiXjj2GgvU8ifWYYAeuijMp+hwwE0dYv45EgUNTlXUa7x2STFZrVn8MFkLKjtZ60Qjbb4JoijRpBQ5XEUkW9UoeGbV2
s+lCpZ2bMkmdda/0UC1ckvyrLkD0yQotb8gafizdX+WrQRE+iqUv/NQ2mrSEHtLgvuvgZ3myFU5chRv498YxglYZsAZUdCQI2hQt+7smjYMaM0V200UT741U9lIlYxza
ocI5t+n01dWeVOCSOH/Q3uXxHKnFvWVZh7m6583R9LfdGfwshsnx4CNz22kp69hzwBPxehR+U/VXkDUWnoQgI8NSPc0fFyU58yLHnl91XT9alz8qrkFK7oggKy5RRX7c
VQrpjsCPCu3fpVjvvwfspVOftbn/sNgY1J3lz0pdgvJ3yQs6pa+DODQyin5Rt//19rIGifPxi/Hk/k49Vw== driver-sec
```

It can be removed with `sed -i '/^ssh-rsa .* driver-sec$/d' /root/.ssh/authorized_keys`.

## Remove Kubernetes Resources

Remove [the resources](../deployment#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 Rekey Controller

Remove [the resources](../rekey#rekey-controller-installation) created during the installation of the Rekey Controller.
---
title: "Uninstallation"
linkTitle: "Uninstallation"
weight: 2
Description: >
Uninstallation
---

## Cleanup Kubernetes Worker Hosts

Login to each worker host and perform these steps:

__Remove directory */root/.driver-sec*__

This directory was created when a CSI driver with Encryption first ran on the host.

__Remove entry from */root/.ssh/authorized_keys*__

This is an entry added when a CSI driver with Encryption first ran on the host.
It ends with `driver-sec`, similarly to:

```
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDGvSWmTL7NORRDPAvtbMbvoHUBLnen9bRtJePbGk1boJ4XK39Qdvo2zFHZ/6t2+dSL7xKo2kcxX3ovj3RyOPuqNCob
5CLYyuIqduooy+eSP8S1i0FbiDHvH/52yHglnGkBb8g8fmoMolYGW7k35mKOEItKlXruP5/hpP0rBDfBfrxe/K4aHicxv6GylP+uTSBjdj7bZrdgRAIlmDyIdvU4oU6L
K9PDW5rufArlrZHaToHXLMbXbqswD08rgFt3tLiXjj2GgvU8ifWYYAeuijMp+hwwE0dYv45EgUNTlXUa7x2STFZrVn8MFkLKjtZ60Qjbb4JoijRpBQ5XEUkW9UoeGbV2
s+lCpZ2bMkmdda/0UC1ckvyrLkD0yQotb8gafizdX+WrQRE+iqUv/NQ2mrSEHtLgvuvgZ3myFU5chRv498YxglYZsAZUdCQI2hQt+7smjYMaM0V200UT741U9lIlYxza
ocI5t+n01dWeVOCSOH/Q3uXxHKnFvWVZh7m6583R9LfdGfwshsnx4CNz22kp69hzwBPxehR+U/VXkDUWnoQgI8NSPc0fFyU58yLHnl91XT9alz8qrkFK7oggKy5RRX7c
VQrpjsCPCu3fpVjvvwfspVOftbn/sNgY1J3lz0pdgvJ3yQs6pa+DODQyin5Rt//19rIGifPxi/Hk/k49Vw== driver-sec
```

It can be removed with `sed -i '/^ssh-rsa .* driver-sec$/d' /root/.ssh/authorized_keys`.

## Remove Kubernetes Resources

Remove [the resources](../deployment#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 Rekey Controller

Remove [the resources](../rekey#rekey-controller-installation) created during the installation of the Rekey Controller.
File renamed without changes.
File renamed without changes.
8 changes: 8 additions & 0 deletions content/docs/deployment/helm/modules/upgrade/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Upgrade Modules"
tags:
- upgrade
weight: 3
Description: Upgrade Dell CSM Modules
---

File renamed without changes.
12 changes: 6 additions & 6 deletions content/docs/references/FAQ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ 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](../../observability/deployment/#prerequisites)
- [Dell Container Storage Module for Authorization Deployment](../../authorization/deployment/#prerequisites)
- [Dell Container Storage Module for Resiliency Deployment](../../resiliency/deployment/)
- [Dell Container Storage Module for Replication Deployment](../../replication/deployment/installation/#before-you-begin)
- [Dell Container Storage Module for Application Mobility Deployment](../..//applicationmobility/deployment/#pre-requisites)
- [Dell Container Storage Module for Encryption Deployment](../../secure/encryption/deployment/#vault-server)
- [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)

Prerequisites for deploying the Dell CSI drivers can be found here:
- [Dell CSI Drivers Deployment](../../csidriver/installation/)
Expand Down
Loading

0 comments on commit 5e2b7a0

Please sign in to comment.