From 96e3e8ef52c9942afae26e8627bffcc9fc357470 Mon Sep 17 00:00:00 2001 From: Matt Schmaelzle <51763677+mjsdell@users.noreply.github.com> Date: Tue, 23 Jul 2024 16:37:02 -0400 Subject: [PATCH] Broken link fixes (#1193) * Update operator_migration.md * Update powerflex.md Removed version specific sample file, replaced with samples directory * Update powerscale.md Removed version specific sample file, replaced with samples directory * Update unity.md Removed version specific sample file, replaced with samples directory * Update operator_migration.md removing static version, replacing with directory reference * Update powerflex.md Moved static versioned samples to directory specification --- content/docs/csidriver/features/powerflex.md | 2 +- content/docs/csidriver/features/powerscale.md | 2 +- content/docs/csidriver/features/unity.md | 2 +- .../csmoperator/operator_migration.md | 21 ++++--------------- .../operator/operator_migration.md | 17 ++------------- .../csmoperator/drivers/powerflex.md | 2 +- 6 files changed, 10 insertions(+), 36 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 0b2b109c74..f39156c07e 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -930,4 +930,4 @@ If such a node is not available, the pods stay in Pending state. This means pods Without storage capacity tracking, pods get scheduled on a node satisfying the topology constraints. If the required capacity is not available, volume attachment to the pods fails, and pods remain in ContainerCreating state. Storage capacity tracking eliminates unnecessary scheduling of pods when there is insufficient capacity. -The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often the driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerflex_v280.yaml) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. \ No newline at end of file +The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often the driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here](https://github.com/dell/csm-operator/blob/main/samples/) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. diff --git a/content/docs/csidriver/features/powerscale.md b/content/docs/csidriver/features/powerscale.md index 4169acdc41..ba4ddd55b1 100644 --- a/content/docs/csidriver/features/powerscale.md +++ b/content/docs/csidriver/features/powerscale.md @@ -455,7 +455,7 @@ If such a node is not available, the pods stay in Pending state. This means pods Without storage capacity tracking, pods get scheduled on a node satisfying the topology constraints. If the required capacity is not available, volume attachment to the pods fails, and pods remain in ContainerCreating state. Storage capacity tracking eliminates unnecessary scheduling of pods when there is insufficient capacity. -The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here.](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerscale_v280.yaml) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. +The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here.](https://github.com/dell/csm-operator/blob/main/samples/) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. ## Node selector in helm template diff --git a/content/docs/csidriver/features/unity.md b/content/docs/csidriver/features/unity.md index aad8844439..55436e73f7 100644 --- a/content/docs/csidriver/features/unity.md +++ b/content/docs/csidriver/features/unity.md @@ -560,7 +560,7 @@ If such a node is not available, the pods stay in Pending state. This means pods Without storage capacity tracking, pods get scheduled on a node satisfying the topology constraints. If the required capacity is not available, volume attachment to the pods fails, and pods remain in ContainerCreating state. Storage capacity tracking eliminates unnecessary scheduling of pods when there is insufficient capacity. Moreover, storage capacity tracking returns `MaximumVolumeSize` parameter, which may be used as an input to the volume creation. -The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here.](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_unity_v280.yaml) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. +The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here.](https://github.com/dell/csm-operator/blob/main/samples/) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar. ## Dynamic Logging Configuration diff --git a/content/docs/deployment/csmoperator/operator_migration.md b/content/docs/deployment/csmoperator/operator_migration.md index 68d1550f72..f2546909e7 100644 --- a/content/docs/deployment/csmoperator/operator_migration.md +++ b/content/docs/deployment/csmoperator/operator_migration.md @@ -4,19 +4,6 @@ description: > Migrating from CSI Operator to CSM Operator --- -## CR Sample Files - -{{}} -| | CSI Operator | CSM Operator | -|------------|:----------:|:----------:| -| PowerScale | [isilon_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/isilon_v270_k8s_127.yaml) | [storage_csm_powerscale_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerscale_v290.yaml) | -| PowerMax | [powermax_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/powermax_v270_k8s_127.yaml) | [storage_csm_powermax_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powermax_v290.yaml) | -| PowerStore | [powerstore_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/powerstore_v270_k8s_127.yaml) | [storage_csm_powerstore_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerstore_v290.yaml) | -| Unity XT | [unity_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/unity_v270_k8s_127.yaml) | [storage_csm_unity_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_unity_v290.yaml) | -| PowerFlex | [vxflex_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/vxflex_v270_k8s_127.yaml) | [storage_csm_powerflex_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerflex_v290.yaml) | -{{
}} ->NOTE: Sample files refer to the latest version for each platform. If you do not want to upgrade, please find your preferred version in the [csm-operator repository](https://github.com/dell/csm-operator/blob/main/samples). - ## Migration Steps 1. Save the CR yaml file of the current CSI driver to preserve the settings. Use the following commands in your cluster to get the CR: @@ -29,8 +16,8 @@ description: > kubectl -n openshift-operators get CSIUnity kubectl -n openshift-operators get CSIUnity/test-unity -o yaml ``` -2. Map and update the settings from the CR in step 1 to the relevant CSM Operator CR - - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver. CR Samples table provided above can be used to compare and map the differences in attributes between Dell CSI Operator and CSM Operator CRs +2. Map and update the settings from the CR in step 1 to the relevant CSM Operator CR (found in [csm-operator repository](https://github.com/dell/csm-operator/blob/main/samples)). + - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver. CR Samples for [CSI Operator](https://github.com/dell/dell-csi-operator/tree/main/samples) and [CSM Operator](https://github.com/dell/csm-operator/tree/main/samples) can be used to compare and map the differences in attributes. - Ex: spec.driver.fsGroupPolicy in [CSI Operator](https://github.com/dell/dell-csi-operator/blob/main/samples/) maps to spec.driver.csiDriverSpec.fSGroupPolicy in [CSM Operator](https://github.com/dell/csm-operator/blob/main/samples/) 3. Retain (or do not delete) the secret, namespace, storage classes, and volume snapshot classes from the original deployment as they will be re-used in the CSM operator deployment 4. Uninstall the CR from the CSI Operator @@ -68,8 +55,8 @@ description: > 6. Install the CSI driver through the CSM Operator in the OpenShift Web Console - Select *Create instance* under the provided Container Storage Module API - Use the CR backup from step 1 to manually map desired settings to the new CSI driver - - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver - - Ex: spec.driver.fsGroupPolicy in [PowerMax 2.7 for CSI Operator](https://github.com/dell/dell-csi-operator/blob/main/samples/powermax_v270_k8s_127.yaml#L17C5-L17C18) maps to spec.driver.csiDriverSpec.fSGroupPolicy in [PowerMax 2.10 for CSM Operator](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powermax_v2100.yaml#L28C7-L28C20) + - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver. CR Samples for [CSI Operator](https://github.com/dell/dell-csi-operator/tree/main/samples) and [CSM Operator](https://github.com/dell/csm-operator/tree/main/samples) can be used to compare and map the differences in attributes. + - Ex: spec.driver.fsGroupPolicy in [CSI Operator](https://github.com/dell/dell-csi-operator/blob/main/samples/) maps to spec.driver.csiDriverSpec.fSGroupPolicy in [CSM Operator](https://github.com/dell/csm-operator/blob/main/samples/) >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. ## Testing diff --git a/content/v2/csidriver/installation/operator/operator_migration.md b/content/v2/csidriver/installation/operator/operator_migration.md index 535bfb2836..33d89b3d60 100644 --- a/content/v2/csidriver/installation/operator/operator_migration.md +++ b/content/v2/csidriver/installation/operator/operator_migration.md @@ -4,19 +4,6 @@ description: > Migrating from CSI Operator to CSM Operator --- -## CR Sample Files - -{{}} -| | CSI Operator | CSM Operator | -|------------|:----------:|:----------:| -| PowerScale | [isilon_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/isilon_v270_k8s_127.yaml) | [storage_csm_powerscale_v280.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerscale_v280.yaml) | -| PowerMax | [powermax_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/powermax_v270_k8s_127.yaml) | [storage_csm_powermax_v280.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powermax_v280.yaml) | -| PowerStore | [powerstore_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/powerstore_v270_k8s_127.yaml) | [storage_csm_powerstore_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerstore_v290.yaml) | -| Unity XT | [unity_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/unity_v270_k8s_127.yaml) | [storage_csm_unity_v280.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_unity_v280.yaml) | -| PowerFlex | [vxflex_v270_k8s_127.yaml](https://github.com/dell/dell-csi-operator/blob/main/samples/vxflex_v270_k8s_127.yaml) | [storage_csm_powerflex_v290.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerflex_v290.yaml) | -{{
}} ->NOTE: Sample files refer to the latest version for each platform. If you do not want to upgrade, please find your preferred version in the [csm-operator repository](https://github.com/dell/csm-operator/blob/main/samples). - ## Migration Steps 1. Save the CR yaml file of the current CSI driver to preserve the settings. Use the following commands in your cluster to get the CR: @@ -30,8 +17,8 @@ description: > kubectl -n openshift-operators get CSIUnity/test-unity -o yaml ``` 2. Map and update the settings from the CR in step 1 to the relevant CSM Operator CR - - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver - - Ex: spec.driver.fsGroupPolicy in [PowerMax 2.6 for CSI Operator](https://github.com/dell/dell-csi-operator/blob/main/samples/powermax_v260_k8s_126.yaml#L17C5-L17C18) maps to spec.driver.csiDriverSpec.fSGroupPolicy in [PowerMax 2.10 for CSM Operator](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powermax_v2100.yaml#L28C7-L28C20) + - As the yaml content may differ, ensure the values held in the step 1 CR backup are present in the new CR before installing the new driver. CR Samples for [CSI Operator](https://github.com/dell/dell-csi-operator/tree/main/samples) and [CSM Operator](https://github.com/dell/csm-operator/tree/main/samples) can be used to compare and map the differences in attributes. + - Ex: spec.driver.fsGroupPolicy in [CSI Operator](https://github.com/dell/dell-csi-operator/blob/main/samples/) maps to spec.driver.csiDriverSpec.fSGroupPolicy in [CSM Operator](https://github.com/dell/csm-operator/blob/main/samples/) 3. Retain (or do not delete) the secret, namespace, storage classes, and volume snapshot classes from the original deployment as they will be re-used in the CSM operator deployment 4. Uninstall the CR from the CSI Operator ``` diff --git a/content/v3/deployment/csmoperator/drivers/powerflex.md b/content/v3/deployment/csmoperator/drivers/powerflex.md index a923ba52d9..eef408ef7d 100644 --- a/content/v3/deployment/csmoperator/drivers/powerflex.md +++ b/content/v3/deployment/csmoperator/drivers/powerflex.md @@ -34,7 +34,7 @@ kubectl get csm --all-namespaces - Optionally, enable sdc monitor by setting the enable flag for the sdc-monitor to true. Please note: - **If using sidecar**, you will need to edit the value fields under the HOST_PID and MDM fields by filling the empty quotes with host PID and the MDM IPs. - **If not using sidecar**, leave the enabled field set to false. -##### Example CR: [samples/storage_csm_powerflex_v2100.yaml](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_powerflex_v2100.yaml) +##### Example CR: [(See samples directory)](https://github.com/dell/csm-operator/blob/main/samples/) ```yaml sideCars: # sdc-monitor is disabled by default, due to high CPU usage