Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rephrase the CSM Wizard steps #787

Merged
merged 3 commits into from
Sep 20, 2023
Merged

Rephrase the CSM Wizard steps #787

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aceb39e
Rephrase the CSM Wizard steps
coulof Aug 28, 2023
23d2360
Address comments on the phrasing
coulof Aug 30, 2023
265713b
Merge branch 'release-1.8.0' into deploy-snaps
coulof Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions content/docs/deployment/csminstallationwizard/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,25 +65,25 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a
helm repo update
```

2. Copy the downloaded values.yaml file.
2. Copy the downloaded `values.yaml` file.

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/).

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:

**Steps**
* `echo -n '<MDM_IPS>' | base64`
* `kubectl patch secret vxflexos-config -n vxflexos -p "{\"data\": { \"MDM\": \"<GENERATED_BASE64>\"}}"`

5. If Observability is enabled, refer to [Observability](../../observability/deployment/#post-installation-dependencies) for post installation dependencies.

6. If Authorization is enabled, refer to [Authorization](../../authorization/deployment/helm/) for installation and configuration of the Proxy Server.
5. If Observability is checked in the wizard, only the sidecar is enabled. Refer to [Observability](../../observability/deployment/#post-installation-dependencies) to export metrics to Prometheus and load the Grafana dashboards.

>NOTE: Only the Authorization sidecar is enabled by the CSM Installation Wizard. The Proxy Server has to be installed and configured separately.
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.

7. If Replication is enabled, refer to [Replication](../../replication/deployment/) on how to configure communication between Kubernetes clusters.
7. If your Kubernetes distribution doesn't have Volume Snapshot feature enabled, Refer to [this section](../../snapshots) to install the Volume Snapshot CRDs and the default snapshot controller.

8. If the Volume Snapshot feature is enabled, refer to [Volume Snapshot for PowerStore](../../csidriver/installation/helm/powerstore/#optional-volume-snapshot-requirements) and [Volume Snapshot for PowerMax](../../csidriver/installation/helm/powermax/#optional-volume-snapshot-requirements) for installing the Volume Snapshot CRDs and the default snapshot controller.
8. If Replication is checked in the wizard, only the sidecar is enabled. Refer to [Replication](../../replication/deployment/) on how to configure communication between Kubernetes clusters and the replication controller.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coulof : only the sidecar is enabled -- this is incorrect. Both driver and replication module controller pods gets installed when user installs helm-charts with the help of Wizard. Please check for other modules too.


>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, 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/).

Expand All @@ -100,19 +100,19 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a

**Steps**

>NOTE: Ensure that the csm-operator is installed and that the namespace, secrets, and config.yaml are created as prerequisites.
>NOTE: Ensure that the csm-operator is installed and that the namespace, secrets, and `config.yaml` are created as prerequisites.

1. Copy the downloaded values.yaml file.
1. Copy the downloaded `values.yaml` file.

2. Look over all the fields in the generated `values.yaml` and fill in/adjust any as needed.

3. If Observability is enabled, refer to [Observability](../csmoperator/modules/observability) for post installation dependencies.
>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/).

4. If Authorization is enabled, refer to [Authorization](../csmoperator/modules/authorization) for installation and configuration of the Proxy Server.
3. If Observability is checked in the wizard, only the sidecar is enabled. Refer to [Observability](../../observability/deployment/#post-installation-dependencies) to export metrics to Prometheus and load the Grafana dashboards.

>NOTE: Only the Authorization sidecar is enabled by the CSM Installation Wizard. The Proxy Server has to be installed and configured separately.
4. 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.

5. If Replication is enabled, refer to [Replication](../csmoperator/modules/replication) for the necessary prerequisites required for this module.
5. If Replication is checked in the wizard, only the sidecar is enabled. Refer to [Replication](../../replication/deployment/) on how to configure communication between Kubernetes clusters and the replication controller.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. Module gets installed too. Please check the behavior of other modules.
I also see the change in reference link. It should point to the module info from CSM Operator like before.


>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, follow the steps outlined in [PowerStore](../csmoperator/drivers/powerstore), [PowerMax](../csmoperator/drivers/powermax), [PowerScale](../csmoperator/drivers/powerscale), [Resiliency](../csmoperator/modules/resiliency).

Expand Down