Skip to content

Commit

Permalink
Release 1.9.1 doc changes (#968)
Browse files Browse the repository at this point in the history
  • Loading branch information
boyamurthy authored Feb 2, 2024
1 parent ac474d9 commit c1ec864
Show file tree
Hide file tree
Showing 44 changed files with 226 additions and 187 deletions.
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ enable = false
# icon = "fa fa-envelope"
# desc = "Discuss development issues around the project"
[[params.versions]]
version = "Current(v1.9.0)"
version = "Current(v1.9.1)"
url = "https://dell.github.io/csm-docs/docs/"

[[params.versions]]
Expand Down
2 changes: 1 addition & 1 deletion content/docs/authorization/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description: >
Dell Container Storage Modules (CSM) release notes for authorization
---

## Release Notes - CSM Authorization 1.8.0
## Release Notes - CSM Authorization 1.9.1



Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
{{<table "table table-striped table-bordered table-sm">}}
| Features | PowerMax | PowerFlex | Unity XT | PowerScale | PowerStore |
|--------------------------|:--------:|:---------:|:---------:|:----------:|:----------:|
| CSI Driver version | 2.9.0 | 2.9.0 | 2.9.0 | 2.9.0 | 2.9.0 |
| CSI Driver version | 2.9.1 | 2.9.1 | 2.9.1 | 2.9.1 | 2.9.1 |
| Static Provisioning | yes | yes | yes | yes | yes |
| Dynamic Provisioning | yes | yes | yes | yes | yes |
| Expand Persistent Volume | yes | yes | yes | yes | yes |
Expand Down
3 changes: 2 additions & 1 deletion content/docs/csidriver/features/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ For example, if `nodeNameTemplate` is _abc-%foo%-hostname_ and nodename is _work

## Controller HA

Starting with version 1.5, the CSI PowerMax driver supports running multiple replicas of the controller Pod. At any time, only one controller Pod is active(leader), and the rest are on standby. In case of a failure, one of the standby Pods becomes active and takes the position of leader. This is achieved by using native leader election mechanisms utilizing `kubernetes leases`. Additionally by leveraging `pod anti-affinity`, no two-controller Pods are ever scheduled on the same node.
Starting with version 1.5, the CSI PowerMax driver supports running multiple replicas of the controller Pod.
Leader election is only applicable for all sidecar containers and driver container will be running in all controller pods . In case of a failure, one of the standby Pods becomes active and takes the position of leader. This is achieved by using native leader election mechanisms utilizing `kubernetes leases`. Additionally by leveraging `pod anti-affinity`, no two-controller Pods are ever scheduled on the same node.

To increase or decrease the number of controller Pods, edit the following value in `values.yaml` file:
```yaml
Expand Down
3 changes: 1 addition & 2 deletions content/docs/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,7 @@ spec:

## Controller HA

CSI PowerScale driver version 1.4.0 and later supports running multiple replicas of the controller pod. At any time, only one controller pod is active(leader), and the rest are on standby.
In case of a failure, one of the standby pods becomes active and takes the position of leader. This is achieved by using native leader election mechanisms utilizing `kubernetes leases`.
CSI PowerScale driver version 1.4.0 and later supports running multiple replicas of the controller pod. Leader election is only applicable for all sidecar containers and driver container will be running in all controller pods. In case of a failure, one of the standby pods becomes active and takes the position of leader. This is achieved by using native leader election mechanisms utilizing `kubernetes leases`.

Additionally by leveraging `pod anti-affinity`, no two-controller pods are ever scheduled on the same node.

Expand Down
8 changes: 4 additions & 4 deletions content/docs/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ CRDs should be configured during replication prepare stage with repctl as descri

**Steps**

1. Run `git clone -b v2.9.0 https://github.com/dell/csi-powerscale.git` to clone the git repository.
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*.
4. Download `wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.9.0/charts/csi-isilon/values.yaml` into `cd ../dell-csi-helm-installer` to customize settings for installation.
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
found in the [`values.yaml`](https://github.com/dell/helm-charts/blob/csi-isilon-2.9.0/charts/csi-isilon/values.yaml) file in this repository.
found in the [`values.yaml`](https://github.com/dell/helm-charts/blob/csi-isilon-2.9.1/charts/csi-isilon/values.yaml) file in this repository.

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
Expand Down Expand Up @@ -210,7 +210,7 @@ Create isilon-creds secret using the following command:

8. Install the driver using `csi-install.sh` bash script and default yaml by running
```bash
cd dell-csi-helm-installer && wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.9.0/charts/csi-isilon/values.yaml &&
cd dell-csi-helm-installer && wget -O my-isilon-settings.yaml https://raw.githubusercontent.com/dell/helm-charts/csi-isilon-2.9.1/charts/csi-isilon/values.yaml &&
./csi-install.sh --namespace isilon --values my-isilon-settings.yaml
```

Expand Down
6 changes: 3 additions & 3 deletions content/docs/csidriver/installation/helm/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ When the driver is installed using values generated by installation wizard, then
## Install the Driver

**Steps**
1. Run `git clone -b v2.9.0 https://github.com/dell/csi-powerflex.git` to clone the git repository.
1. Run `git clone -b v2.9.1 https://github.com/dell/csi-powerflex.git` to clone the git repository.

2. A namespace for the driver is expected prior to running the command below. If one is not created already, you can run `kubectl create namespace vxflexos` to create a new one.
Note that the namespace can be any user-defined name that follows the conventions for namespaces outlined by Kubernetes. In this example we assume that the namespace is 'vxflexos'
Expand Down Expand Up @@ -151,7 +151,7 @@ Use the below command to replace or update the secret:

7. Download the default values.yaml file
```bash
cd dell-csi-helm-installer && wget -O myvalues.yaml https://github.com/dell/helm-charts/raw/csi-vxflexos-2.9.0/charts/csi-vxflexos/values.yaml
cd dell-csi-helm-installer && wget -O myvalues.yaml https://github.com/dell/helm-charts/raw/csi-vxflexos-2.9.1/charts/csi-vxflexos/values.yaml
```

8. If you are using custom images, check the fields under `images` in `my-vxflexos-settings.yaml` to make sure that they are pointing to the correct image repository.
Expand All @@ -160,7 +160,7 @@ Use the below command to replace or update the secret:

| Parameter | Description | Required | Default |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| version | Set to verify the values file version matches driver version and used to pull the image as part of the image name. | Yes | 2.9.0 |
| version | Set to verify the values file version matches driver version and used to pull the image as part of the image name. | Yes | 2.9.1 |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" |
| images.powerflexSdc | Set to give the location of the SDC image used if automatic SDC deployment is being utilized. | Yes | dellemc/sdc:4.5 |
| certSecretCount | Represents the number of certificate secrets, which the user is going to create for SSL authentication. | No | 0 |
Expand Down
6 changes: 3 additions & 3 deletions content/docs/csidriver/installation/helm/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ CRDs should be configured during replication prepare stage with repctl as descri

**Steps**

1. Run `git clone -b v2.9.0 https://github.com/dell/csi-powermax.git` to clone the git repository. This will include the Helm charts and dell-csi-helm-installer scripts.
1. Run `git clone -b v2.9.1 https://github.com/dell/csi-powermax.git` to clone the git repository. This will include the Helm charts and dell-csi-helm-installer scripts.
2. Ensure that you have created a namespace where you want to install the driver. You can run `kubectl create namespace powermax` to create a new one
3. Edit the `samples/secret/secret.yaml` file,to point to the correct namespace, and replace the values for the username and password parameters.
These values can be obtained using base64 encoding as described in the following example:
Expand All @@ -206,7 +206,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
```
5. Download the default values.yaml file
```bash
cd dell-csi-helm-installer && wget -O my-powermax-settings.yaml https://github.com/dell/helm-charts/raw/csi-powermax-2.9.0/charts/csi-powermax/values.yaml
cd dell-csi-helm-installer && wget -O my-powermax-settings.yaml https://github.com/dell/helm-charts/raw/csi-powermax-2.9.1/charts/csi-powermax/values.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
Expand Down Expand Up @@ -247,7 +247,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
| powerMaxDebug | Enables low level and http traffic logging between the CSI driver and Unisphere. Don't enable this unless asked to do so by the support team. | No | false |
| enableCHAP | Determine if the driver is going to configure SCSI node databases on the nodes with the CHAP credentials. If enabled, the CHAP secret must be provided in the credentials secret and set to the key "chapsecret" | No | false |
| fsGroupPolicy | Defines which FS Group policy mode to be used, Supported modes `None, File and ReadWriteOnceWithFSType` | No | "ReadWriteOnceWithFSType" |
| version | Current version of the driver. Don't modify this value as this value will be used by the install script. | Yes | v2.9.0 |
| version | Current version of the driver. Don't modify this value as this value will be used by the install script. | Yes | v2.9.1 |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" || driverRepository | Defines the registry of the container image used for the driver. | Yes | dellemc |
| maxPowerMaxVolumesPerNode | Specifies the maximum number of volume that can be created on a node. | Yes| 0 |
| **controller** | Allows configuration of the controller-specific parameters.| - | - |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/csidriver/installation/helm/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
## Install the Driver

**Steps**
1. Run `git clone -b v2.9.0 https://github.com/dell/csi-powerstore.git` to clone the git repository.
1. Run `git clone -b v2.9.1 https://github.com/dell/csi-powerstore.git` to clone the git repository.
2. Ensure that you have created namespace where you want to install the driver. You can run `kubectl create namespace csi-powerstore` to create a new one. "csi-powerstore" is just an example. You can choose any name for the namespace.
But make sure to align to the same namespace during the whole installation.
3. Edit `samples/secret/secret.yaml` file and configure connection information for your PowerStore arrays changing following parameters:
Expand All @@ -163,7 +163,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
> 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. Download the default values.yaml file
```bash
cd dell-csi-helm-installer && wget -O my-powerstore-settings.yaml https://github.com/dell/helm-charts/raw/csi-powerstore-2.9.0/charts/csi-powerstore/values.yaml
cd dell-csi-helm-installer && wget -O my-powerstore-settings.yaml https://github.com/dell/helm-charts/raw/csi-powerstore-2.9.1/charts/csi-powerstore/values.yaml
```
7. Edit the newly created values file and provide values for the following parameters `vi my-powerstore-settings.yaml`:

Expand Down
8 changes: 4 additions & 4 deletions content/docs/csidriver/installation/helm/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Install CSI Driver for Unity XT using this procedure.

* As a pre-requisite for running this procedure, you must have the downloaded files, including the Helm chart from the source [git repository](https://github.com/dell/csi-unity) with the command
```bash
git clone -b v2.9.0 https://github.com/dell/csi-unity.git
git clone -b v2.9.1 https://github.com/dell/csi-unity.git
```
* In the top-level dell-csi-helm-installer directory, there should be two scripts, `csi-install.sh` and `csi-uninstall.sh`.
* Ensure _unity_ namespace exists in Kubernetes cluster. Use the `kubectl create namespace unity` command to create the namespace if the namespace is not present.
Expand All @@ -98,12 +98,12 @@ Procedure
2. Get the required values.yaml using the command below:

```bash
cd dell-csi-helm-installer && wget -O my-unity-settings.yaml https://github.com/dell/helm-charts/raw/csi-unity-2.9.0/charts/csi-unity/values.yaml
cd dell-csi-helm-installer && wget -O my-unity-settings.yaml https://github.com/dell/helm-charts/raw/csi-unity-2.9.1/charts/csi-unity/values.yaml
```

3. Edit `values.yaml` to set the following parameters for your installation:

The following table lists the primary configurable parameters of the Unity XT driver chart and their default values. More detailed information can be found in the [`values.yaml`](https://github.com/dell/helm-charts/blob/csi-unity-2.9.0/charts/csi-unity/values.yaml) file in this repository.
The following table lists the primary configurable parameters of the Unity XT driver chart and their default values. More detailed information can be found in the [`values.yaml`](https://github.com/dell/helm-charts/blob/csi-unity-2.9.1/charts/csi-unity/values.yaml) file in this repository.

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
Expand Down Expand Up @@ -327,7 +327,7 @@ cd dell-csi-helm-installer && wget -O my-unity-settings.yaml https://github.com/
**Syntax**:
```bash
git clone -b csi-unity-2.9.0 https://github.com/dell/helm-charts
git clone -b csi-unity-2.9.1 https://github.com/dell/helm-charts
helm install <release-name> dell/container-storage-modules -n <namespace> --version <container-storage-module chart-version> -f <values.yaml location>
Expand Down
26 changes: 13 additions & 13 deletions content/docs/csidriver/installation/offline/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,21 +83,21 @@ bash scripts/csm-offline-bundle.sh -c
*
* Pulling and saving container images
dellemc/csi-isilon:v2.8.0
dellemc/csi-metadata-retriever:v1.6.0
dellemc/csipowermax-reverseproxy:v2.6.0
dellemc/csi-powermax:v2.9.0
dellemc/csi-powerstore:v2.9.0
dellemc/csi-unity:v2.8.0
dellemc/csi-vxflexos:v2.9.0
dellemc/csm-authorization-sidecar:v1.9.0
dellemc/csi-isilon:v2.9.1
dellemc/csi-metadata-retriever:v1.6.1
dellemc/csipowermax-reverseproxy:v2.8.1
dellemc/csi-powermax:v2.9.1
dellemc/csi-powerstore:v2.9.1
dellemc/csi-unity:v2.8.1
dellemc/csi-vxflexos:v2.9.1
dellemc/csm-authorization-sidecar:v1.9.1
dellemc/csm-metrics-powerflex:v1.5.0
dellemc/csm-metrics-powerscale:v1.2.0
dellemc/csm-topology:v1.5.0
dellemc/dell-csi-replicator:v1.7.0
dellemc/dell-csi-replicator:v1.7.1
dellemc/dell-replication-controller:v1.7.0
dellemc/sdc:4.5
docker.io/dellemc/dell-csm-operator:v1.3.0
docker.io/dellemc/dell-csm-operator:v1.4.1
gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
nginxinc/nginx-unprivileged:1.20
otel/opentelemetry-collector:0.42.0
Expand Down Expand Up @@ -186,8 +186,8 @@ Preparing a offline bundle for installation
*
* Loading docker images
Loaded image: docker.io/dellemc/csi-powerstore:v2.9.0
Loaded image: docker.io/dellemc/csi-isilon:v2.8.0
Loaded image: docker.io/dellemc/csi-powerstore:v2.9.1
Loaded image: docker.io/dellemc/csi-isilon:v2.9.1
...
...
Loaded image: registry.k8s.io/sig-storage/csi-resizer:v1.8.0
Expand Down Expand Up @@ -225,4 +225,4 @@ Now that the required images are available and the Helm Charts/Operator configur
*NOTES:*
1. Offline bundle installation is only supported with manual installs i.e. without using Operator Lifecycle Manager.
2. Installation should be done using the files that are obtained after unpacking the offline bundle (dell-csm-operator-bundle.tar.gz) as the image tags in the manifests are modified to point to the internal registry.
3. Offline bundle installs operator in `default` namespace via install.sh script. Make sure that the current context in kubeconfig file has the namespace set to `default`.
3. Offline bundle installs operator in `default` namespace via install.sh script. Make sure that the current context in kubeconfig file has the namespace set to `default`.
Loading

0 comments on commit c1ec864

Please sign in to comment.