Skip to content

Commit

Permalink
Release 1.5 changes (#424)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanmydell authored Dec 13, 2022
1 parent 344ce12 commit e8e9eb9
Show file tree
Hide file tree
Showing 263 changed files with 7,346 additions and 6,142 deletions.
8 changes: 4 additions & 4 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -169,19 +169,19 @@ enable = false
# icon = "fa fa-envelope"
# desc = "Discuss development issues around the project"
[[params.versions]]
version = "Current(v1.4)"
version = "Current(v1.5)"
url = "https://dell.github.io/csm-docs/docs/"

[[params.versions]]
version = "v1.3"
version = "v1.4"
url = "https://dell.github.io/csm-docs/v1"

[[params.versions]]
version = "v1.2.1"
version = "v1.3"
url = "https://dell.github.io/csm-docs/v2"

[[params.versions]]
version = "v1.2"
version = "v1.2.1"
url = "https://dell.github.io/csm-docs/v3"

[[menu.main]]
Expand Down
42 changes: 21 additions & 21 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,27 +64,27 @@ CSM is made up of multiple components including modules (enterprise capabilities

## CSM Supported Modules and Dell CSI Drivers

| Modules/Drivers | CSM 1.4 | [CSM 1.3](../v1/) | [CSM 1.2.1](../v2/) | [CSM 1.2](../v3/) |
| - | :-: | :-: | :-: | :-: |
| [Authorization](https://hub.docker.com/r/dellemc/csm-authorization-sidecar) | v1.4.0 | v1.3.0 | v1.2.0 | v1.2.0 |
| [Observability](https://hub.docker.com/r/dellemc/csm-topology) | v1.3.0 | v1.2.0 | v1.1.1 | v1.1.0 |
| [Replication](https://hub.docker.com/r/dellemc/dell-csi-replicator) | v1.3.0 | v1.3.0 | v1.2.0 | v1.2.0 |
| [Resiliency](https://hub.docker.com/r/dellemc/podmon) | v1.3.0 | v1.2.0 | v1.1.0 | v1.1.0 |
| [Encryption](https://hub.docker.com/r/dellemc/csm-encryption) | v0.1.0 | NA | NA | NA |
| [Application Mobility](https://hub.docker.com/r/dellemc/csm-application-mobility-controller) | v0.1.0 | NA | NA | NA |
| [CSI Driver for PowerScale](https://hub.docker.com/r/dellemc/csi-isilon/tags) | v2.4.0 | v2.3.0 | v2.2.0 | v2.2.0 |
| [CSI Driver for Unity XT](https://hub.docker.com/r/dellemc/csi-unity/tags) | v2.4.0 | v2.3.0 | v2.2.0 | v2.2.0 |
| [CSI Driver for PowerStore](https://hub.docker.com/r/dellemc/csi-powerstore/tags) | v2.4.0 | v2.3.0 | v2.2.0| v2.2.0 |
| [CSI Driver for PowerFlex](https://hub.docker.com/r/dellemc/csi-vxflexos/tags) | v2.4.0 | v2.3.0 | v2.2.0 | v2.2.0 |
| [CSI Driver for PowerMax](https://hub.docker.com/r/dellemc/csi-powermax/tags) | v2.4.0 | v2.3.0 | v2.2.0 | v2.2.0 |
| Modules/Drivers | CSM 1.5 | [CSM 1.4](../v1/) | [CSM 1.3](../v2/) | [CSM 1.2.1](../v3/) |
| -------------------------------------------------------------------------------------------- | :-----: | :---------------: | :---------------: | :-----------------: |
| [Authorization](https://hub.docker.com/r/dellemc/csm-authorization-sidecar) | v1.5.0 | v1.4.0 | v1.3.0 | v1.2.0 |
| [Observability](https://hub.docker.com/r/dellemc/csm-topology) | v1.4.0 | v1.3.0 | v1.2.0 | v1.1.1 |
| [Replication](https://hub.docker.com/r/dellemc/dell-replication-controller) | v1.3.1 | v1.3.0 | v1.3.0 | v1.2.0 |
| [Resiliency](https://hub.docker.com/r/dellemc/podmon) | v1.4.0 | v1.3.0 | v1.2.0 | v1.1.0 |
| [Encryption](https://hub.docker.com/r/dellemc/csm-encryption) | v0.2.0 | v0.1.0 | NA | NA |
| [Application Mobility](https://hub.docker.com/r/dellemc/csm-application-mobility-controller) | v0.2.0 | v0.1.0 | NA | NA |
| [CSI Driver for PowerScale](https://hub.docker.com/r/dellemc/csi-isilon/tags) | v2.5.0 | v2.4.0 | v2.3.0 | v2.2.0 |
| [CSI Driver for Unity XT](https://hub.docker.com/r/dellemc/csi-unity/tags) | v2.5.0 | v2.4.0 | v2.3.0 | v2.2.0 |
| [CSI Driver for PowerStore](https://hub.docker.com/r/dellemc/csi-powerstore/tags) | v2.5.0 | v2.4.0 | v2.3.0 | v2.2.0 |
| [CSI Driver for PowerFlex](https://hub.docker.com/r/dellemc/csi-vxflexos/tags) | v2.5.0 | v2.4.0 | v2.3.0 | v2.2.0 |
| [CSI Driver for PowerMax](https://hub.docker.com/r/dellemc/csi-powermax/tags) | v2.5.0 | v2.4.0 | v2.3.0 | v2.2.0 |

## CSM Modules Support Matrix for Dell CSI Drivers

| CSM Module | CSI PowerFlex v2.4.0 | CSI PowerScale v2.4.0 | CSI PowerStore v2.4.0 | CSI PowerMax v2.4.0 | CSI Unity XT v2.4.0 |
| ----------------- | -------------- | --------------- | --------------- | ------------- | --------------- |
| Authorization v1.4| ✔️ | ✔️ || ✔️ ||
| Observability v1.3| ✔️ | ✔️ | ✔️ |||
| Replication v1.3|| ✔️ | ✔️ | ✔️ ||
| Resiliency v1.3| ✔️ | ✔️ ||| ✔️ |
| Encryption v0.1.0|| ✔️ ||||
| Application Mobility v0.1.0| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| CSM Module | CSI PowerFlex v2.5.0 | CSI PowerScale v2.5.0 | CSI PowerStore v2.5.0 | CSI PowerMax v2.5.0 | CSI Unity XT v2.5.0 |
| ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
| [**Authorization**](authorization/) v1.5 | ✔️ | ✔️ | | ✔️ | |
| [**Observability**](observability/) v1.4 | ✔️ | ✔️ | ✔️ | | |
| [**Replication**](replication/) v1.3.1 | | ✔️ | ✔️ | ✔️ | |
| [**Resiliency**](resiliency/) v1.4 | ✔️ | ✔️ | | | ✔️ |
| [**Encryption**](secure/encryption) v0.2.0 | | ✔️ | | | |
| [**Application Mobility**](applicationmobility/) v0.2.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
6 changes: 3 additions & 3 deletions content/docs/applicationmobility/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ After a backup has been created, it can be restored on the same Kubernetes clust
{{<table "table table-striped table-bordered table-sm">}}
| COP/OS | Supported Versions |
|-|-|
| Kubernetes | 1.23, 1.24 |
| Red Hat OpenShift | 4.10 |
| Kubernetes | 1.23, 1.24, 1.25 |
| Red Hat OpenShift | 4.10, 4.11 |
| RHEL | 7.x, 8.x |
| CentOS | 7.8, 7.9 |
{{</table>}}
{{</table>}}
7 changes: 4 additions & 3 deletions content/docs/applicationmobility/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This table lists the configurable parameters of the Application Mobility Helm ch
| - | - | - | - |
| `replicaCount` | Number of replicas for the Application Mobility controllers | Yes | `1` |
| `image.pullPolicy` | Image pull policy for the Application Mobility controller images | Yes | `IfNotPresent` |
| `controller.image` | Location of the Application Mobility Docker image | Yes | `dell/csm-application-mobility-controller:v0.1.0` |
| `controller.image` | Location of the Application Mobility Docker image | Yes | `dellemc/csm-application-mobility-controller:v0.2.0` |
| `cert-manager.enabled` | If set to true, cert-manager will be installed during Application Mobility installation | Yes | `false` |
| `veleroNamespace` | If Velero is already installed, set to the namespace where Velero is installed | No | `velero` |
| `licenseName` | Name of the Secret that contains the License for Application Mobility | Yes | `license` |
Expand All @@ -57,6 +57,7 @@ This table lists the configurable parameters of the Application Mobility Helm ch
| `velero.configuration.backupStorageLocation.config` | Additional provider-specific configuration. See https://velero.io/docs/v1.9/api-types/backupstoragelocation/ for specific details. | Yes | ` ` |
| `velero.initContainers` | List of plugins used by Velero. Dell Velero plugin is required and plugins for other providers can be added. | Yes | ` ` |
| `velero.initContainers[0].name` | Name of the Dell Velero plugin. | Yes | `dell-custom-velero-plugin` |
| `velero.initContainers[0].image` | Location of the Dell Velero plugin image. | Yes | `dellemc/csm-application-mobility-velero-plugin:v0.1.0` |
| `velero.initContainers[0].image` | Location of the Dell Velero plugin image. | Yes | `dellemc/csm-application-mobility-velero-plugin:v0.2.0` |
| `velero.initContainers[0].volumeMounts[0].mountPath` | Mount path of the volume mount. | Yes | `/target` |
| `velero.initContainers[0].volumeMounts[0].name` | Name of the volume mount. | Yes | `plugins` |
| `velero.initContainers[0].volumeMounts[0].name` | Name of the volume mount. | Yes | `plugins` |
| `velero.restic.privileged` | If set to true, Restic Pods will be run in privileged mode. Note: Set to true when using Red Hat OpenShift | No | `false` |
14 changes: 14 additions & 0 deletions content/docs/applicationmobility/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ Description: >
---



## Release Notes - CSM Application Mobility 0.2.0
### New Features/Changes

- [Scheduled Backups for Application Mobility](https://github.com/dell/csm/issues/551)

### Fixed Issues

There are no fixed issues in this release.

### Known Issues

There are no known issues in this release.

## Release Notes - CSM Application Mobility 0.1.0
### New Features/Changes

Expand Down
6 changes: 3 additions & 3 deletions content/docs/authorization/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you feel that something is unclear or missing in this document, please open u
| [karavictl role get](#karavictl-role-get) | Get role |
| [karavictl role list](#karavictl-role-list) | List roles |
| [karavictl role create](#karavictl-role-create) | Create one or more CSM roles |
| [karavictl role update](#karavictl-role-update) | Update one or more CSM roles |
| [karavictl role update](#karavictl-role-update) | Update the quota of one or more CSM roles |
| [karavictl role delete](#karavictl-role-delete ) | Delete role |
| [karavictl rolebinding](#karavictl-rolebinding) | Manage role bindings |
| [karavictl rolebinding create](#karavictl-rolebinding-create) | Create a rolebinding between role and tenant |
Expand Down Expand Up @@ -402,11 +402,11 @@ $ karavictl role create --role=role-name=system-type=000000000001=mypool=2000000

### karavictl role update

Update one or more CSM roles
Update the quota of one or more CSM roles

##### Synopsis

Updates one or more CSM roles
Updates the quota of one or more CSM roles

```
karavictl role update [flags]
Expand Down
8 changes: 8 additions & 0 deletions content/docs/authorization/configuration/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Configuration
linktitle: Configuration
weight: 2
description: Configure CSM Authorization
---

This section provides the details and instructions on how to configure CSM Authorization.
61 changes: 61 additions & 0 deletions content/docs/authorization/configuration/powerflex/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: PowerFlex
linktitle: PowerFlex
description: >
Enabling CSM Authorization for PowerFlex CSI Driver
---

## Configuring PowerFlex CSI Driver with CSM for Authorization

Given a setup where Kubernetes, a storage system, and the CSM for Authorization Proxy Server are deployed, follow these steps to configure the CSI Drivers to work with the Authorization sidecar:

1. Apply the secret containing the token data into the driver namespace. It's assumed that the Kubernetes administrator has the token secret manifest saved in `/tmp/token.yaml`.

```console
# It is assumed that array type powerflex has the namepace "vxflexos".
kubectl apply -f /tmp/token.yaml -n vxflexos
```

2. Edit these parameters in `samples/secret/karavi-authorization-config.json` file in the [CSI PowerFlex](https://github.com/dell/csi-powerflex/tree/main/samples) driver and update/add connection information for one or more backend storage arrays. In an instance where multiple CSI drivers are configured on the same Kubernetes cluster, the port range in the *endpoint* parameter must be different for each driver.

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
| username | Username for connecting to the backend storage array. This parameter is ignored. | No | - |
| password | Password for connecting to to the backend storage array. This parameter is ignored. | No | - |
| intendedEndpoint | HTTPS REST API endpoint of the backend storage array. | Yes | - |
| endpoint | HTTPS localhost endpoint that the authorization sidecar will listen on. | Yes | https://localhost:9400 |
| systemID | System ID of the backend storage array. | Yes | " " |
| skipCertificateValidation | A boolean that enables/disables certificate validation of the backend storage array. This parameter is not used. | No | true |
| isDefault | A boolean that indicates if the array is the default array. This parameter is not used. | No | default value from values.yaml |


Create the karavi-authorization-config secret using this command:

`kubectl -n vxflexos create secret generic karavi-authorization-config --from-file=config=samples/secret/karavi-authorization-config.json -o yaml --dry-run=client | kubectl apply -f -`

>__Note__:
> - Create the driver secret as you would normally except update/add the connection information for communicating with the sidecar instead of the backend storage array and scrub the username and password.
3. Create the proxy-server-root-certificate secret.

If running in *insecure* mode, create the secret with empty data:

`kubectl -n vxflexos create secret generic proxy-server-root-certificate --from-literal=rootCertificate.pem= -o yaml --dry-run=client | kubectl apply -f -`

Otherwise, create the proxy-server-root-certificate secret with the appropriate file:

`kubectl -n vxflexos create secret generic proxy-server-root-certificate --from-file=rootCertificate.pem=/path/to/rootCA -o yaml --dry-run=client | kubectl apply -f -`

4. Please refer to step 4 in the [installation steps for PowerFlex](../../../csidriver/installation/helm/powerflex/#install-the-driver) to edit the parameters in `samples/config.yaml` file to communicate with the sidecar.

Update *endpoint* to match the endpoint in `samples/secret/karavi-authorization-config.json`

5. Create the vxflexos-config secret using this command:

`kubectl create secret generic vxflexos-config -n vxflexos --from-file=config=config.yaml -o yaml --dry-run=client | kubectl apply -f -`

6. Please refer to step 9 in the [installation steps for PowerFlex](../../../csidriver/installation/helm/powerflex/#install-the-driver) to edit the parameters in *myvalues.yaml* file to communicate with the sidecar.

Enable CSM for Authorization and provide the *proxyHost* address

7. Install the CSI PowerFlex driver
55 changes: 55 additions & 0 deletions content/docs/authorization/configuration/powermax/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: PowerMax
linktitle: PowerMax
description: >
Enabling CSM Authorization for PowerMax CSI Driver
---

## Configuring PowerMax CSI Driver with CSM for Authorization

Given a setup where Kubernetes, a storage system, and the CSM for Authorization Proxy Server are deployed, follow these steps to configure the CSI Drivers to work with the Authorization sidecar:

1. Apply the secret containing the token data into the driver namespace. It's assumed that the Kubernetes administrator has the token secret manifest saved in `/tmp/token.yaml`.

```console
# It is assumed that array type powermax has the namespace "powermax".
kubectl apply -f /tmp/token.yaml -n powermax
```

2. Edit these parameters in `samples/secret/karavi-authorization-config.json` file in [CSI PowerMax](https://github.com/dell/csi-powermax/tree/main/samples/secret) driver and update/add connection information for one or more backend storage arrays. In an instance where multiple CSI drivers are configured on the same Kubernetes cluster, the port range in the *endpoint* parameter must be different for each driver.

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
| username | Username for connecting to the backend storage array. This parameter is ignored. | No | - |
| password | Password for connecting to to the backend storage array. This parameter is ignored. | No | - |
| intendedEndpoint | HTTPS REST API endpoint of the backend storage array. | Yes | - |
| endpoint | HTTPS localhost endpoint that the authorization sidecar will listen on. | Yes | https://localhost:9400 |
| systemID | System ID of the backend storage array. | Yes | " " |
| skipCertificateValidation | A boolean that enables/disables certificate validation of the backend storage array. This parameter is not used. | No | true |
| isDefault | A boolean that indicates if the array is the default array. This parameter is not used. | No | default value from values.yaml |


Create the karavi-authorization-config secret using this command:

`kubectl -n powermax create secret generic karavi-authorization-config --from-file=config=samples/secret/karavi-authorization-config.json -o yaml --dry-run=client | kubectl apply -f -`

>__Note__:
> - Create the driver secret as you would normally except update/add the connection information for communicating with the sidecar instead of the backend storage array and scrub the username and password
3. Create the proxy-server-root-certificate secret.

If running in *insecure* mode, create the secret with empty data:

`kubectl -n powermax create secret generic proxy-server-root-certificate --from-literal=rootCertificate.pem= -o yaml --dry-run=client | kubectl apply -f -`

Otherwise, create the proxy-server-root-certificate secret with the appropriate file:

`kubectl -n powermax create secret generic proxy-server-root-certificate --from-file=rootCertificate.pem=/path/to/rootCA -o yaml --dry-run=client | kubectl apply -f -`

4. Please refer to step 8 in the [installation steps for PowerMax](../../../csidriver/installation/helm/powermax/#install-the-driver) to edit the parameters in *my-powermax-settings.yaml* to communicate with the sidecar.

Update *endpoint* to match the endpoint in `samples/secret/karavi-authorization-config.json`.

5. Enable CSM for Authorization and provide the *proxyHost* address

6. Install the CSI PowerMax driver
Loading

0 comments on commit e8e9eb9

Please sign in to comment.