Skip to content

Commit

Permalink
CSM 1.9.2 doc changes (#978)
Browse files Browse the repository at this point in the history
  • Loading branch information
boyamurthy authored Feb 16, 2024
1 parent 97101da commit 1a06da9
Show file tree
Hide file tree
Showing 22 changed files with 34 additions and 47 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.1)"
version = "Current(v1.9.2)"
url = "https://dell.github.io/csm-docs/docs/"

[[params.versions]]
Expand Down
2 changes: 1 addition & 1 deletion content/docs/authorization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The following diagram shows a high-level overview of CSM for Authorization with
{{<table "table table-striped table-bordered table-sm">}}
| | PowerMax | PowerFlex | PowerScale |
|---------------|:----------------:|:-------------------:|:----------------:|
| Storage Array |PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx,<br> Unisphere 10.0, 10.0.1, 10.1| 3.6.x, 4.0.x, 4.5 | OneFS 9.5.0.5, 9.5.0.6 |
| Storage Array |PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx,<br> Unisphere 10.0, 10.0.1, 10.1| 3.6.x, 4.0.x, 4.5 | OneFS 9.5.0.x (x >= 5) |
{{</table>}}

## Supported CSI Drivers
Expand Down
12 changes: 2 additions & 10 deletions content/docs/csidriver/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
| VMware Tanzu | no | no | NFS | NFS | NFS,iSCSI |
| Rancher Kubernetes Engine | 1.4.x| 1.4.x | 1.4.x | 1.4.x | 1.4.x |
| Amazon Elastic Kubernetes Service<br> Anywhere | yes | yes | yes | yes | yes |
| Kubernetes K3s Engine on Debian OS | no | no | yes | no | no |
| OS dependencies | iscsi-initiator-utils<br>multipathd or powerpath<br>nvme-cli<br>nfs-utils | [SDC](https://www.dell.com/support/home/en-us/product-support/product/scaleio/drivers) | iscsi-initiator-utils<br>multipathd<br>nfs-utils | nfs-utils | iscsi-initiator-utils<br>multipathd<br>nvme-cli<br>nfs-utils |
{{</table>}}

> Notes:
> * The required OS dependencies are only for the protocol needed (e.g. if NVMe isn't the storage access protocol then nvme-cli is not required).
> * The base OS tested by Dell Technologies are Red Hat Enterprise Linux, Red Hat CoreOS, SUSE Linux Enterprise Server.
> * The host operating system/version being used must align with what each Dell Storage platform supports. Please visit [E-Lab Navigator](https://elabnavigator.dell.com/eln/modernHomeSSM) for specific Dell Storage platform host operating system level support matrices.
### CSI Driver Capabilities
Expand Down Expand Up @@ -58,7 +58,7 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
{{<table "table table-striped table-bordered table-sm">}}
| | PowerMax | PowerFlex | Unity XT | PowerScale | PowerStore |
|---------------|:-------------------------------------------------------:|:----------------:|:--------------------------:|:----------------------------------:|:----------------:|
| Storage Array | PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br>Unisphere 10.0,10.0.1,10.1 | 3.6.x, 4.0.x, 4.5.x | 5.1.x, 5.2.x, 5.3.0 | OneFS 9.3, 9.4, 9.5.0.5, 9.5.0.6 | 3.0, 3.2, 3.5 |
| Storage Array | PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br>Unisphere 10.0,10.0.1,10.1 | 3.6.x, 4.0.x, 4.5.x | 5.1.x, 5.2.x, 5.3.0 | OneFS 9.3, 9.4, 9.5.0.x (x >= 5) | 3.0, 3.2, 3.5 |
{{</table>}}

### Backend Storage Details
Expand All @@ -76,11 +76,3 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
| Platform-specific configurable settings | Service Level selection<br>iSCSI CHAP | - | Host IO Limit<br>Tiering Policy<br>NFS Host IO size<br>Snapshot Retention duration | Access Zone<br>NFS version (3 or 4);Configurable Export IPs | iSCSI CHAP |
| Auto RDM(vSphere) | Yes(over FC) | N/A | N/A | N/A | N/A |
{{</table>}}

### Community Qualified Platforms
{{<table "table table-striped table-bordered table-sm">}}
| cert-csi results | OS | CO | Storage Platform | Protocol | CSM |
|--------------------------------------------------------|:----------:|:----------------:|:-----------------------:|:---------:|:----------:|
| [Ticket 1079](https://github.com/dell/csm/issues/1079) | Debian 10 | K3s v1.24.7+k3s1 | Unity VSA 5.3.1.0.5.008 | iSCSI | CSI v1.8.0 |

{{</table>}}
4 changes: 2 additions & 2 deletions content/docs/csidriver/installation/offline/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The resulting offline bundle file can be copied to another machine, if necessary

For example, here is the output of a request to build an offline bundle for the Dell CSM Operator:
```bash
git clone -b v1.3.0 https://github.com/dell/csm-operator.git
git clone -b v1.4.2 https://github.com/dell/csm-operator.git
```
```bash
cd csm-operator
Expand Down Expand Up @@ -97,7 +97,7 @@ bash scripts/csm-offline-bundle.sh -c
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.4.1
docker.io/dellemc/dell-csm-operator:v1.4.2
gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
nginxinc/nginx-unprivileged:1.20
otel/opentelemetry-collector:0.42.0
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/release/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ description: Release notes for PowerFlex CSI driver
- [#1058 - [BUG]: CSI Health monitor for Node missing for CSM PowerFlex in Operator samples](https://github.com/dell/csm/issues/1058)
- [#1061 - [BUG]: Golint is not installing with go get command](https://github.com/dell/csm/issues/1061)
- [#1110 - [BUG]: Multi Controller defect - sidecars timeout](https://github.com/dell/csm/issues/1110)

- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)

### Known Issues

Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/release/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ description: Release notes for PowerMax CSI driver
- [#1056 - [BUG]: Missing runtime dependencies reference in PowerMax README file.](https://github.com/dell/csm/issues/1056)
- [#1061 - [BUG]: Golint is not installing with go get command](https://github.com/dell/csm/issues/1061)
- [#1110 - [BUG]: Multi Controller defect - sidecars timeout](https://github.com/dell/csm/issues/1110)

- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)

### Known Issues

Expand Down
1 change: 1 addition & 0 deletions content/docs/csidriver/release/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ description: Release notes for PowerScale CSI driver
- [#1053 - [BUG]: make gosec is erroring out - Repos PowerMax,PowerStore,PowerScale (gosec is installed)](https://github.com/dell/csm/issues/1053)
- [#1061 - [BUG]: Golint is not installing with go get command](https://github.com/dell/csm/issues/1061)
- [#1110 - [BUG]: Multi Controller defect - sidecars timeout](https://github.com/dell/csm/issues/1110)
- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)

### Known Issues

Expand Down
1 change: 1 addition & 0 deletions content/docs/csidriver/release/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ description: Release notes for PowerStore CSI driver
- [#1053 - [BUG]: make gosec is erroring out - Repos PowerMax,PowerStore,PowerScale (gosec is installed)](https://github.com/dell/csm/issues/1053)
- [#1061 - [BUG]: Golint is not installing with go get command](https://github.com/dell/csm/issues/1061)
- [#1108 - [BUG]: Volumes failing to mount when customer using NVMeTCP on Powerstore](https://github.com/dell/csm/issues/1108)
- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)

### Known Issues

Expand Down
1 change: 1 addition & 0 deletions content/docs/csidriver/release/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ description: Release notes for Unity XT CSI driver

- [#1014 - [BUG]: Missing error check for os.Stat call during volume publish](https://github.com/dell/csm/issues/1014)
- [#1110 - [BUG]: Multi Controller defect - sidecars timeout](https://github.com/dell/csm/issues/1110)
- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)

### Known Issues

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
csmVersion=1.9.0
csmVersion=1.9.2
imageRepository=dellemc
controllerCount=1
nodeSelectorLabel=node-role.kubernetes.io/control-plane:
Expand All @@ -9,4 +9,4 @@ certSecretCount=1
pollRate=60
driverPodLabel=dell-storage
arrayThreshold=3
maxVolumesPerNode=0
maxVolumesPerNode=0
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
<select id="csm-version" class="form-select" onchange="onCSMVersionChange(); validateInput(validateForm, CONSTANTS)" required>
<option value="1.7.0">CSM 1.7</option>
<option value="1.8.0">CSM 1.8</option>
<option value="1.9.1" selected>CSM 1.9.1</option>
<option value="1.9.2" selected>CSM 1.9.2</option>
</select>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const CONSTANTS = {
OPERATOR: "operator",
CSM_HELM_V170: "1.0.0",
CSM_HELM_V180: "1.1.0",
CSM_HELM_V191: "1.2.1",
CSM_HELM_V192: "1.2.1",
HELM_TAINTS: `
- key: "$KEY"
operator: "Exists"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ function onArrayChange() {
onReplicationChange(replicationNote);
validateInput(validateForm, CONSTANTS);
onRenameSDCChange(driver, CONSTANTS);
hideImageRepo($("#csm-version").val());
});
}

Expand Down Expand Up @@ -224,19 +223,11 @@ function onRenameSDCChange(driverName, CONSTANTS_PARAM) {
}
}

const hideImageRepo = (csmVersion) => {
if (csmVersion === "1.8.0" || csmVersion === "1.7.0"){
$(".image-repository").show();
} else {
$(".image-repository").hide();
}
}

const onCSMVersionChange = () => {
csmVersion = document.getElementById("csm-version").value;
csmVersion !== ""? loadTemplate(document.getElementById("array").value, document.getElementById("installation-type").value, document.getElementById("csm-version").value) : null;
displayModules(installationType, driver, CONSTANTS);
hideImageRepo(csmVersion);
onObservabilityChange();
onObservabilityOperatorChange();
onAuthorizationChange();
Expand Down Expand Up @@ -478,11 +469,11 @@ function displayCommands(releaseNameValue, commandTitleValue, commandNoteValue,
case "1.8.0":
helmChartVersion = CONSTANTS.CSM_HELM_V180;
break;
case "1.9.1":
helmChartVersion = CONSTANTS.CSM_HELM_V191;
case "1.9.2":
helmChartVersion = CONSTANTS.CSM_HELM_V192;
break;
default:
helmChartVersion = CONSTANTS.CSM_HELM_V191;
helmChartVersion = CONSTANTS.CSM_HELM_V192;
break;
}
$("#command-text-area").show();
Expand Down
8 changes: 4 additions & 4 deletions content/docs/deployment/csmoperator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The installation process involves the creation of a `Subscription` object either
1. Install volume snapshot CRDs. For detailed snapshot setup procedure, [click here](../../snapshots/#volume-snapshot-feature).
2. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
git clone -b v1.4.2 https://github.com/dell/csm-operator.git
```
3. `cd csm-operator`
4. _(Optional)_ If using a local Docker image, edit the `deploy/operator.yaml` file and set the image name for the CSM Operator Deployment.
Expand Down Expand Up @@ -136,7 +136,7 @@ This needs to be performed on a Linux system with access to the Internet as a gi
To build an offline bundle, the following steps are needed:
1. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
git clone -b v1.4.2 https://github.com/dell/csm-operator.git
```
2. `cd csm-operator`
3. Run the `csm-offline-bundle.sh` script which will be found in the `scripts` directory with an argument of `-c` in order to create an offline bundle
Expand Down Expand Up @@ -175,7 +175,7 @@ Here is the output of a request to build an offline bundle for the Dell CSM Oper
dellemc/dell-csi-replicator:v1.7.0
dellemc/dell-replication-controller:v1.7.0
dellemc/sdc:4.5
docker.io/dellemc/dell-csm-operator:v1.4.1
docker.io/dellemc/dell-csm-operator:v1.4.2
gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
nginxinc/nginx-unprivileged:1.20
otel/opentelemetry-collector:0.42.0
Expand Down Expand Up @@ -342,7 +342,7 @@ The `Update approval` (**`InstallPlan`** in OLM terms) strategy plays a role whi
#### Using Installation Script
1. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
git clone -b v1.4.2 https://github.com/dell/csm-operator.git
```
2. `cd csm-operator`
3. Execute `bash scripts/install.sh --upgrade` . This command will install the latest version of the operator.
Expand Down
17 changes: 9 additions & 8 deletions content/docs/deployment/csmoperator/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,7 @@ Description: >
Release notes for Dell Container Storage Modules Operator
---

## Release Notes - Container Storage Modules Operator v1.4.1







## Release Notes - Container Storage Modules Operator v1.4.2

### New Features/Changes

Expand All @@ -33,10 +26,18 @@ Description: >
- [#1117 - [BUG]: Operator crashes when deployed from OpenShift with OLM](https://github.com/dell/csm/issues/1117)
- [#1120 - [BUG]: Skip Certificate Validation is not propagated to Authorization module in CSM Operator](https://github.com/dell/csm/issues/1120)
- [#1122 - [BUG]: CSM Operator does not calculate status correctly when module is deployed with driver](https://github.com/dell/csm/issues/1122)
- [#1103 - [BUG]: CSM Operator doesn't apply fSGroupPolicy value to CSIDriver Object](https://github.com/dell/csm/issues/1103)
- [#1133 - [BUG]: CSM Operator does not calculate status correctly when application-mobility is deployed by itself](https://github.com/dell/csm/issues/1133))
- [#1137 - [BUG]: CSM Operator intermittently does not calculate status correctly when deploying a driver](https://github.com/dell/csm/issues/1137))
- [#1143 - [BUG]: CSM Operator does not calculate status correctly when deploying the authorization proxy server](https://github.com/dell/csm/issues/1143))
- [#1146 - [BUG]: CSM Operator does not calculate status correctly when deploying observability with csi-powerscale](https://github.com/dell/csm/issues/1146))
- [#1147 - [BUG]: CSM Operator labels csm objects with CSMVersion 1.8.0, an old version](https://github.com/dell/csm/issues/1147))

### Known Issues
| Issue | Workaround |
|-------|------------|
| The status calculation done for the csm object associated with the Authorization Proxy Server when deployed with CSM Operator assumes that the proxy server will be deployed in the "authorization" namespace. If a different namespace is used, the status will stay in the failed state, even though the deployment is healthy. | We recommend using the "authorization" namespace for the proxy server. If this is not possible, the health of the deployment can be verified by checking the status of all the pods rather than by checking the status field.|
| The status field of a csm object as deployed by CSM Operator may, in limited cases, display a "Failed" status for a successful deployment. | As a workaround, the deployment is still usable as long as all pods are running/healthy. |
| The images of sideCars are currently missing in the sample YAMLs in the offline bundle. As a consequence, the csm-operator is pulling them from registry.k8s.io. | We recommend manually updating the images of sideCars in the sample YAML file, for example, `storage_csm_powerflex_v291.yaml`, before proceeding with the driver installation. Here is an example snippet for the sideCars section in the YAML file:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion content/docs/observability/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ CSM for Observability provides the following capabilities:
{{<table "table table-striped table-bordered table-sm">}}
| | PowerFlex | PowerStore | PowerScale | PowerMax |
|---------------|:-------------------:|:----------------:|:----------------:|:----------------:|
| Storage Array | 3.6.x, 4.0.x, 4.5 | 3.0, 3.2, 3.5 | OneFS 9.3, 9.4, 9.5.0.5, 9.5.0.6 | PowerMax 2000/8000 <br> PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079) <br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br> Unisphere 10.0, 10.0.1, 10.1 |
| Storage Array | 3.6.x, 4.0.x, 4.5 | 3.0, 3.2, 3.5 | OneFS 9.3, 9.4, 9.5.0.x (x >= 5) | PowerMax 2000/8000 <br> PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079) <br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br> Unisphere 10.0, 10.0.1, 10.1 |
{{</table>}}

## Supported CSI Drivers
Expand Down
2 changes: 1 addition & 1 deletion content/docs/replication/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ CSM for Replication provides the following capabilities:
{{<table "table table-striped table-bordered table-sm">}}
| | PowerMax | PowerStore | PowerScale | PowerFlex |
| ------------- | :------------------------------------------------------------------------------------------------------: | :------------------------------------------: | :------------------------------------------: | :-------: |
| Storage Array | PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br> Unisphere 10.0,10.0.1,10.1 | 3.0, 3.2, 3.5 | OneFS 9.3, 9.4, 9.5.0.5, 9.5.0.6 | 3.6.x, 4.0.x, 4.5 |
| Storage Array | PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) , PowerMaxOS 10.1 (6079)<br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx <br> Unisphere 10.0,10.0.1,10.1 | 3.0, 3.2, 3.5 | OneFS 9.3, 9.4, 9.5.0.x (x >= 5) | 3.6.x, 4.0.x, 4.5 |
{{</table>}}

>Note: File Replication for PowerMax is currently not supported
Expand Down
2 changes: 1 addition & 1 deletion content/docs/resiliency/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ CSM for Resiliency provides the following capabilities:
{{<table "table table-striped table-bordered table-sm">}}
| | PowerFlex | Unity XT | PowerScale | PowerStore |
| ------------- | :----------: | :-------------------------------: | :-------------------------------------: | :---------------------------: |
| Storage Array | 3.6.x, 4.0.x, 4.5 | 5.1.x, 5.2.x, 5.3.0 | OneFS 9.3, 9.4, 9.5.0.5, 9.5.0.6 | 3.0, 3.2, 3.5 |
| Storage Array | 3.6.x, 4.0.x, 4.5 | 5.1.x, 5.2.x, 5.3.0 | OneFS 9.3, 9.4, 9.5.0.x (x >= 5) | 3.0, 3.2, 3.5 |
{{</table>}}

## Supported CSI Drivers
Expand Down

0 comments on commit 1a06da9

Please sign in to comment.