Skip to content

Commit

Permalink
Adding a note for 'clusterName' for CSI-PowerScale (#1062)
Browse files Browse the repository at this point in the history
  • Loading branch information
KshitijaKakde authored Apr 10, 2024
1 parent 9f81d88 commit 4b16fc2
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 4 deletions.
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can use existing volumes from the PowerScale array as Persistent Volumes in

1. Open your volume in One FS, and take a note of volume-id.
2. Create PersistentVolume and use this volume-id as a volumeHandle in the manifest. Modify other parameters according to your needs.
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name>`
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name_from_secret>`
4. If Quotas are enabled in the driver, it is required to add the Quota ID to the description of the NFS export in this format:
`CSI_QUOTA_ID:sC-kAAEAAAAAAAAAAAAAQEpVAAAAAAAA`
5. Quota ID can be identified by querying the PowerScale system.
Expand Down
3 changes: 3 additions & 0 deletions content/docs/deployment/helm/drivers/installation/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ CRDs should be configured during replication prepare stage with repctl as descri
1. Run `git clone -b v2.10.0 https://github.com/dell/csi-powerscale.git` to clone the git repository.
2. Ensure that you have created the namespace where you want to install the driver. You can run `kubectl create namespace isilon` to create a new one. The use of "isilon" as the namespace is just an example. You can choose any name for the namespace.
3. Collect information from the PowerScale Systems like IP address, IsiPath, username, and password. Make a note of the value for these parameters as they must be entered in the *secret.yaml*.

**Note**: The 'clusterName' serves as a logical, unique identifier for the array that should remain unchanged once it is included in the volume handle. Altering this identifier is not advisable, as it would result in the failure of all operations associated with the volume that was created earlier.

4. Download `wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.10.0/charts/csi-isilon/values.yaml` into `cd ../dell-csi-helm-installer` to customize settings for installation.
5. Edit *my-isilon-settings.yaml* to set the following parameters for your installation:
The following table lists the primary configurable parameters of the PowerScale driver Helm chart and their default values. More detailed information can be
Expand Down
2 changes: 1 addition & 1 deletion content/v1/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can use existing volumes from the PowerScale array as Persistent Volumes in

1. Open your volume in One FS, and take a note of volume-id.
2. Create PersistentVolume and use this volume-id as a volumeHandle in the manifest. Modify other parameters according to your needs.
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name>`
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name_from_secret>`
4. If Quotas are enabled in the driver, it is required to add the Quota ID to the description of the NFS export in this format:
`CSI_QUOTA_ID:sC-kAAEAAAAAAAAAAAAAQEpVAAAAAAAA`
5. Quota ID can be identified by querying the PowerScale system.
Expand Down
3 changes: 3 additions & 0 deletions content/v1/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ CRDs should be configured during replication prepare stage with repctl as descri
1. Run `git clone -b v2.9.1 https://github.com/dell/csi-powerscale.git` to clone the git repository.
2. Ensure that you have created the namespace where you want to install the driver. You can run `kubectl create namespace isilon` to create a new one. The use of "isilon" as the namespace is just an example. You can choose any name for the namespace.
3. Collect information from the PowerScale Systems like IP address, IsiPath, username, and password. Make a note of the value for these parameters as they must be entered in the *secret.yaml*.

**Note**: The 'clusterName' serves as a logical, unique identifier for the array that should remain unchanged once it is included in the volume handle. Altering this identifier is not advisable, as it would result in the failure of all operations associated with the volume that was created earlier.

4. Download `wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.9.1/charts/csi-isilon/values.yaml` into `cd ../dell-csi-helm-installer` to customize settings for installation.
5. Edit *my-isilon-settings.yaml* to set the following parameters for your installation:
The following table lists the primary configurable parameters of the PowerScale driver Helm chart and their default values. More detailed information can be
Expand Down
2 changes: 1 addition & 1 deletion content/v2/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can use existing volumes from the PowerScale array as Persistent Volumes in

1. Open your volume in One FS, and take a note of volume-id.
2. Create PersistentVolume and use this volume-id as a volumeHandle in the manifest. Modify other parameters according to your needs.
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name>`
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of `<volume_name>=_=_=<export_id>=_=_=<access_zone_name>=_=_=<cluster_name_from_secret>`
4. If Quotas are enabled in the driver, it is required to add the Quota ID to the description of the NFS export in this format:
`CSI_QUOTA_ID:sC-kAAEAAAAAAAAAAAAAQEpVAAAAAAAA`
5. Quota ID can be identified by querying the PowerScale system.
Expand Down
3 changes: 3 additions & 0 deletions content/v2/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ CRDs should be configured during replication prepare stage with repctl as descri
1. Run `git clone -b v2.8.0 https://github.com/dell/csi-powerscale.git` to clone the git repository.
2. Ensure that you have created the namespace where you want to install the driver. You can run `kubectl create namespace isilon` to create a new one. The use of "isilon" as the namespace is just an example. You can choose any name for the namespace.
3. Collect information from the PowerScale Systems like IP address, IsiPath, username, and password. Make a note of the value for these parameters as they must be entered in the *secret.yaml*.

**Note**: The 'clusterName' serves as a logical, unique identifier for the array that should remain unchanged once it is included in the volume handle. Altering this identifier is not advisable, as it would result in the failure of all operations associated with the volume that was created earlier.

4. Download `wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.8.0/charts/csi-isilon/values.yaml` into `cd ../dell-csi-helm-installer` to customize settings for installation.
5. Edit *my-isilon-settings.yaml* to set the following parameters for your installation:
The following table lists the primary configurable parameters of the PowerScale driver Helm chart and their default values. More detailed information can be
Expand Down
2 changes: 1 addition & 1 deletion content/v3/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can use existing volumes from the PowerScale array as Persistent Volumes in

1. Open your volume in One FS, and take a note of volume-id.
2. Create PersistentVolume and use this volume-id as a volumeHandle in the manifest. Modify other parameters according to your needs.
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of <volume_name>=_=_=<export_id>=_=_=<zone>=_=_=<cluster_name>
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of <volume_name>=_=_=<export_id>=_=_=<zone>=_=_=<cluster_name_from_secret>
4. If Quotas are enabled in the driver, it is required to add the Quota ID to the description of the NFS export in this format:
`CSI_QUOTA_ID:sC-kAAEAAAAAAAAAAAAAQEpVAAAAAAAA`
5. Quota ID can be identified by querying the PowerScale system.
Expand Down
3 changes: 3 additions & 0 deletions content/v3/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ CRDs should be configured during replication prepare stage with repctl as descri
1. Run `git clone -b v2.7.0 https://github.com/dell/csi-powerscale.git` to clone the git repository.
2. Ensure that you have created the namespace where you want to install the driver. You can run `kubectl create namespace isilon` to create a new one. The use of "isilon" as the namespace is just an example. You can choose any name for the namespace.
3. Collect information from the PowerScale Systems like IP address, IsiPath, username, and password. Make a note of the value for these parameters as they must be entered in the *secret.yaml*.

**Note**: The 'clusterName' serves as a logical, unique identifier for the array that should remain unchanged once it is included in the volume handle. Altering this identifier is not advisable, as it would result in the failure of all operations associated with the volume that was created earlier.

4. Copy *the helm/csi-isilon/values.yaml* into a new location with name say *my-isilon-settings.yaml*, to customize settings for installation.
5. Edit *my-isilon-settings.yaml* to set the following parameters for your installation:
The following table lists the primary configurable parameters of the PowerScale driver Helm chart and their default values. More detailed information can be
Expand Down

0 comments on commit 4b16fc2

Please sign in to comment.