Skip to content

Commit

Permalink
Broken link fixes (#1193)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
mjsdell authored Jul 23, 2024
1 parent 5c18fc9 commit 96e3e8e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 36 deletions.
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
21 changes: 4 additions & 17 deletions content/docs/deployment/csmoperator/operator_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,6 @@ description: >
Migrating from CSI Operator to CSM Operator
---

## CR Sample Files

{{<table "table table-striped table-bordered table-sm">}}
| | 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) |
{{</table>}}
>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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
17 changes: 2 additions & 15 deletions content/v2/csidriver/installation/operator/operator_migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,6 @@ description: >
Migrating from CSI Operator to CSM Operator
---

## CR Sample Files

{{<table "table table-striped table-bordered table-sm">}}
| | 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) |
{{</table>}}
>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:
Expand All @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion content/v3/deployment/csmoperator/drivers/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 96e3e8e

Please sign in to comment.