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.

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

Updating-Copy-Buttons #676

Merged
merged 1 commit into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 16 additions & 20 deletions content/docs/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ Create isilon-creds secret using the following command:

8. Install the driver using `csi-install.sh` bash script by running
```bash

cd ../dell-csi-helm-installer && ./csi-install.sh --namespace isilon --values ../helm/my-isilon-settings.yaml
```
(assuming that the current working directory is 'helm' and my-isilon-settings.yaml is also present under 'helm' directory)
Expand All @@ -240,17 +239,14 @@ If the 'skipCertificateValidation' parameter is set to false and a previous inst

1. To fetch the certificate, run
```bash

openssl s_client -showcerts -connect [OneFS IP] </dev/null 2>/dev/null | openssl x509 -outform PEM > ca_cert_0.pem
```
2. To create the certs secret, run
```bash

kubectl create secret generic isilon-certs-0 --from-file=cert-0=ca_cert_0.pem -n isilon
```
3. Use the following command to replace the secret <br/>
```bash

kubectl create secret generic isilon-certs-0 -n isilon --from-file=cert-0=ca_cert_0.pem -o yaml --dry-run | kubectl replace -f -
```

Expand All @@ -266,7 +262,6 @@ kubectl create secret generic isilon-certs-0 -n isilon --from-file=cert-0=ca_cer
CSI Driver for Dell PowerScale now provides supports for Multi cluster. Now users can link the single CSI Driver to multiple OneFS Clusters by updating *secret.yaml*. Users can now update the isilon-creds secret by editing the *secret.yaml* and executing the following command

```bash

kubectl create secret generic isilon-creds -n isilon --from-file=config=secret.yaml -o yaml --dry-run=client | kubectl replace -f -
```

Expand Down Expand Up @@ -302,28 +297,29 @@ There are samples storage class yaml files available under `samples/storageclass
1. Copy the `storageclass.yaml` to `second_storageclass.yaml` ( This is just an example, you can rename to file you require. )
2. Edit the `second_storageclass.yaml` yaml file and update following parameters:
- Update the `name` parameter to you require
````yaml
```yaml
metadata:
name: isilon-new
````
```
- Cluster name of 2nd array looks like this in the secret file.( Under `/samples/secret/secret.yaml`)
````yaml
- clusterName: "cluster2"
username: "user name"
password: "Password"
endpoint: "10.X.X.X"
endpointPort: "8080

```yaml
- clusterName: "cluster2"
username: "user name"
password: "Password"
endpoint: "10.X.X.X"
endpointPort: "8080
```
- Use same clusterName &#8593; in the `second_storageclass.yaml`
````yaml
# Optional: true
ClusterName: "cluster2"
```yaml
# Optional: true
ClusterName: "cluster2"
```
- *Note*: These are two essential parameters that you need to change in the "second_storageclass.yaml" file and other parameters that you change as required.
3. Save the `second_storageclass.yaml` file
4. Create your 2nd storage class by using `kubectl`:
````bash
kubectl create -f <path_to_second_storageclass_file>
````
```bash
kubectl create -f <path_to_second_storageclass_file>
```
5. Use newly created storage class `isilon-new` for volumes to spin up on `cluster2`

PVC example
Expand Down
1 change: 0 additions & 1 deletion content/docs/csidriver/installation/helm/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ Install Helm 3.0 on the master node before you install the CSI Driver for Dell P

Run the command to install Helm 3.0.
```bash

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
```
### Enable Zero Padding on PowerFlex
Expand Down
21 changes: 12 additions & 9 deletions content/docs/csidriver/installation/helm/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ Install Helm 3 on the master node before you install CSI Driver for Dell PowerMa

Run the command to install Helm 3.
```bash

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
```

Expand Down Expand Up @@ -127,15 +126,13 @@ If the `skipCertificateValidation` parameter is set to _false_ and a previous in
If the Unisphere certificate is self-signed or if you are using an embedded Unisphere, then perform the following steps:
1. To fetch the certificate, run
```bash

openssl s_client -showcerts -connect [Unisphere IP]:8443 </dev/null 2> /dev/null | openssl x509 -outform PEM > ca_cert.pem
```

*NOTE*: The IP address varies for each user.

2. To create the secret, run
```bash

kubectl create secret generic powermax-certs --from-file=ca_cert.pem -n powermax
```

Expand Down Expand Up @@ -174,7 +171,6 @@ Set up the PowerPath for Linux as follows:
- All the nodes must have the PowerPath package installed . Download the PowerPath archive for the environment from [Dell Online Support](https://www.dell.com/support/home/en-in/product-support/product/powerpath-for-linux/drivers).
- `Untar` the PowerPath archive, Copy the RPM package into a temporary folder and Install PowerPath using
```bash

rpm -ivh DellEMCPower.LINUX-<version>-<build>.<platform>.x86_64.rpm
```
- Start the PowerPath service using
Expand Down Expand Up @@ -212,10 +208,19 @@ CRDs should be configured during replication prepare stage with repctl as descri
echo -n "mypassword" | base64
```
where *myusername* and *mypassword* are credentials for a user with PowerMax privileges.
4. Create the secret by running `kubectl create -f samples/secret/secret.yaml`.
5. Copy the default values.yaml file `cd helm && cp csi-powermax/values.yaml my-powermax-settings.yaml`
4. Create the secret by running
```bash
kubectl create -f samples/secret/secret.yaml
```
5. Copy the default values.yaml file
```bash
cd helm && cp csi-powermax/values.yaml my-powermax-settings.yaml
```
6. Ensure the unisphere have 10.0 REST endpoint support by clicking on Unisphere -> Help (?) -> About in Unisphere for PowerMax GUI.
7. Edit the newly created file and provide values for the following parameters `vi my-powermax-settings.yaml`
7. Edit the newly created file and provide values for the following parameters
```bash
vi my-powermax-settings.yaml
```

| Parameter | Description | Required | Default |
|-----------|--------------|------------|----------|
Expand Down Expand Up @@ -303,12 +308,10 @@ CRDs should be configured during replication prepare stage with repctl as descri

8. Install the driver using `csi-install.sh` bash script by running
```bash

cd ../dell-csi-helm-installer && ./csi-install.sh --namespace powermax --values ../helm/my-powermax-settings.yaml
```
9. Or you can also install the driver using standalone helm chart using the command
```bash

helm install --values my-powermax-settings.yaml --namespace powermax powermax ./csi-powermax
```

Expand Down
29 changes: 12 additions & 17 deletions content/docs/csidriver/installation/helm/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ Install Helm 3.0 on the master node before you install the CSI Driver for Dell P

Run the command to install Helm 3.0.
```bash

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
```
### Fibre Channel requirements
Expand Down Expand Up @@ -174,15 +173,13 @@ CRDs should be configured during replication prepare stage with repctl as descri

4. Create the secret by running
```bash

kubectl create secret generic powerstore-config -n csi-powerstore --from-file=config=secret.yaml
```
5. Create storage classes using ones from `samples/storageclass` folder as an example and apply them to the Kubernetes cluster by running `kubectl create -f <path_to_storageclass_file>`

> If you do not specify `arrayID` parameter in the storage class then the array that was specified as the default would be used for provisioning volumes.
6. Copy the default values.yaml file
```bash

cd dell-csi-helm-installer && cp ../helm/csi-powerstore/values.yaml ./my-powerstore-settings.yaml
```
7. Edit the newly created values file and provide values for the following parameters `vi my-powerstore-settings.yaml`:
Expand Down Expand Up @@ -222,7 +219,6 @@ CRDs should be configured during replication prepare stage with repctl as descri

8. Install the driver using `csi-install.sh` bash script by running
```bash

./csi-install.sh --namespace csi-powerstore --values ./my-powerstore-settings.yaml
```
- After that the driver should be installed, you can check the condition of driver pods by running `kubectl get all -n csi-powerstore`
Expand Down Expand Up @@ -255,20 +251,20 @@ There are samples storage class yaml files available under `samples/storageclass
- *csi.storage.k8s.io/fstype*: specifies what filesystem type driver should use, possible variants `ext3`, `ext4`, `xfs`, `nfs`, if not specified driver will use `ext4` by default.
- *nfsAcls* (Optional): defines permissions - POSIX mode bits or NFSv4 ACLs, to be set on NFS target mount directory.
- *allowedTopologies* (Optional): If you want you can also add topology constraints.
```yaml
allowedTopologies:
- matchLabelExpressions:
- key: csi-powerstore.dellemc.com/12.34.56.78-iscsi
# replace "-iscsi" with "-fc", "-nvmetcp" or "-nvmefc" or "-nfs" at the end to use FC, NVMeTCP, NVMeFC or NFS enabled hosts
# replace "12.34.56.78" with PowerStore endpoint IP
values:
- "true"
```
```yaml
allowedTopologies:
- matchLabelExpressions:
- key: csi-powerstore.dellemc.com/12.34.56.78-iscsi
# replace "-iscsi" with "-fc", "-nvmetcp" or "-nvmefc" or "-nfs" at the end to use FC, NVMeTCP, NVMeFC or NFS enabled hosts
# replace "12.34.56.78" with PowerStore endpoint IP
values:
- "true"
```

2. Create your storage class by using `kubectl`:
```bash
kubectl create -f <path_to_storageclass_file>
```
```bash
kubectl create -f <path_to_storageclass_file>
```

*NOTE:* Deleting a storage class has no impact on a running Pod with mounted PVCs. You cannot provision new PVCs until at least one storage class is newly created.

Expand All @@ -280,7 +276,6 @@ Starting CSI PowerStore v1.4.0, `dell-csi-helm-installer` will not create any Vo

Users can dynamically add delete array information from secret. Whenever an update happens the driver updates the “Host” information in an array. User can update secret using the following command:
```bash

kubectl create secret generic powerstore-config -n csi-powerstore --from-file=config=secret.yaml -o yaml --dry-run=client | kubectl replace -f -
```
## Dynamic Logging Configuration
Expand Down
18 changes: 3 additions & 15 deletions content/docs/csidriver/installation/helm/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ Install Helm 3.0 on the master node before you install the CSI Driver for Dell U

Run the command to install Helm 3.0.
```bash

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash
```

Expand Down Expand Up @@ -214,14 +213,12 @@ Procedure
Use the following command to create a new secret unity-creds from `secret.yaml` file.

```bash

kubectl create secret generic unity-creds -n unity --from-file=config=secret.yaml
```

Use the following command to replace or update the secret:

```bash

kubectl create secret generic unity-creds -n unity --from-file=config=secret.yaml -o yaml --dry-run | kubectl replace -f -
```

Expand All @@ -232,7 +229,7 @@ Procedure
Alternatively, users can configure and use `secret.yaml` for driver configuration. The parameters remain the same as in the above table and below is a sample of `secret.yaml`. Samples of `secret.yaml` is available in the directory `csi-unity/samples/secret/ `.

Example: secret.yaml
```yaml
```yaml
storageArrayList:
- arrayId: "APM00******1"
username: "user"
Expand All @@ -246,10 +243,9 @@ Procedure
password: "password"
endpoint: "https://10.1.1.2/"
skipCertificateValidation: true
```
```

**Note:**
* Parameters "allowRWOMultiPodAccess" and "syncNodeInfoInterval" have been enabled for configuration in values.yaml and this helps users to dynamically change these values without the need for driver re-installation.
**Note:** Parameters "allowRWOMultiPodAccess" and "syncNodeInfoInterval" have been enabled for configuration in values.yaml and this helps users to dynamically change these values without the need for driver re-installation.

6. If you want to leverage snapshotting feature, the pre-requisite is to install external-snapshotter. Installation of external-snapshotter is required only for Kubernetes and is available by default with OpenShift installations. [Click here](../../../../snapshots/#optional-volume-snapshot-requirements) to follow the procedure to install external-snapshotter.

Expand Down Expand Up @@ -330,7 +326,6 @@ Procedure
**Note**:
To install nightly or latest csi driver build using bash script use this command:
```bash

/csi-install.sh --namespace unity --values ./myvalues.yaml --version latest
```

Expand All @@ -340,15 +335,13 @@ Procedure

**Syntax**:
```bash

helm install --dry-run --values <myvalues.yaml location> --namespace <namespace> <name of secret> <helmPath>
```
`<namespace>` - namespace of the driver installation. <br/>
`<name of secret>` - unity in case of unity-creds and unity-certs-0 secrets. <br/>
`<helmPath>` - Path of the helm directory. <br/>
e.g:
```bash

helm install --dry-run --values ./csi-unity/myvalues.yaml --namespace unity unity ./csi-unity
```

Expand All @@ -371,22 +364,18 @@ If the Unisphere certificate is self-signed or if you are using an embedded Unis

1. To fetch the certificate, run the following command.
```bash

openssl s_client -showcerts -connect <Unisphere IP:Port> </dev/null 2>/dev/null | openssl x509 -outform PEM > ca_cert_0.pem
```
Example:
```bash

openssl s_client -showcerts -connect 1.1.1.1:443 </dev/null 2>/dev/null | openssl x509 -outform PEM > ca_cert_0.pem
```
2. Run the following command to create the cert secret with index '0':
```bash

kubectl create secret generic unity-certs-0 --from-file=cert-0=ca_cert_0.pem -n unity
```
Use the following command to replace the secret:
```bash

kubectl create secret generic unity-certs-0 -n unity --from-file=cert-0=ca_cert_0.pem -o yaml --dry-run | kubectl replace -f -
```
3. Repeat step 1 and 2 to create multiple cert secrets with incremental index (example: unity-certs-1, unity-certs-2, etc)
Expand Down Expand Up @@ -449,7 +438,6 @@ Deleting a storage class has no impact on a running Pod with mounted PVCs. You c
Users can dynamically add delete array information from secret. Whenever an update happens the driver updates the "Host" information in an array.
User can update secret using the following command:
```bash

kubectl create secret generic unity-creds -n unity --from-file=config=secret.yaml -o yaml --dry-run=client | kubectl replace -f -
```
**Note**: Updating unity-certs-x secrets is a manual process, unlike unity-creds. Users have to re-install the driver in case of updating/adding the SSL certificates or changing the certSecretCount parameter.
Expand Down
3 changes: 0 additions & 3 deletions content/docs/csidriver/installation/operator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,6 @@ The CSI Drivers installed by the Dell CSI Operator can be updated like any Kuber
```
use the object name in `kubectl edit` command.
```bash

kubectl edit <driver-object>/<object-name> -n <driver-namespace>
```
For example - If the object name is CSIUnity.
Expand All @@ -287,13 +286,11 @@ The CSI Drivers installed by the Dell CSI Operator can be updated like any Kuber
to patch the deployment with your patch object inline run this command.
#Replace deployment with the name of the deployment
```bash

kubectl patch deploy/<deployment> -n <driver-namespace> -p '{"spec":{"replicas": 2}}'
```
to patch the deployment with your patch file run this command.
#Replace deployment with the name of the deployment
```bash

kubectl patch deployment <deployment> --patch-file patch-file.yaml
```

Expand Down