Skip to content

Commit

Permalink
Release 1.9.0 (#944)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanmydell authored Dec 13, 2023
1 parent b57da86 commit d93f9f4
Show file tree
Hide file tree
Showing 534 changed files with 24,264 additions and 8,708 deletions.
7 changes: 4 additions & 3 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@
# order is alphabetical for easier maintenance.
#
# Bharath Sreekanth (bharathsreekanth)
# Chiman Jain (chimanjain)
# Deepak Ghivari (Deepak-Ghivari)
# Sean Gallacher (gallacher)
# Marek Suski (mareksuski-dell)
# Małgorzata Dutka (mdutka-dell)
# Matt Schmaelzle (mjsdell)
# Mukesh Gandharva (mgandharva)
# Prasanna Muthukumaraswamy (prablr79)
# Rajendra Indukuri (rajendraindukuri)
# Rajkumar Palani (rajkumar-palani)
# Raymond Sedlock (rsedlock1958)
# Sean Gallacher (gallacher)
# Yamunadevi Shanmugam (shanmydell)
# Sharon Toll (sharont58)

* @bharathsreekanth @chimanjain @Deepak-Ghivari @gallacher @mgandharva @mjsdell @prablr79 @rajendraindukuri @rajkumar-palani @rsedlock1958 @shanmydell @sharont58
* @bharathsreekanth @Deepak-Ghivari @gallacher @mareksuski-dell @mdutka-dell @mgandharva @mjsdell @prablr79 @rajendraindukuri @rajkumar-palani @rsedlock1958 @shanmydell @sharont58
10 changes: 5 additions & 5 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ defaultContentLanguage = "en"
# Useful when translating.
enableMissingTranslationPlaceholders = true

disableKinds = ["taxonomy", "taxonomyTerm"]
disableKinds = ["taxonomy", "taxonomyTerm", "term"]

# Highlighting config
pygmentsCodeFences = true
Expand Down Expand Up @@ -172,19 +172,19 @@ enable = false
# icon = "fa fa-envelope"
# desc = "Discuss development issues around the project"
[[params.versions]]
version = "Current(v1.8.0)"
version = "Current(v1.9.0)"
url = "https://dell.github.io/csm-docs/docs/"

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

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

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

[[menu.main]]
Expand Down
15 changes: 2 additions & 13 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ CSM is made up of multiple components including modules (enterprise capabilities
{{< /cardpane >}}
{{< cardpane >}}
{{< card header="[**Resiliency**](resiliency/)"
footer="Supports [PowerFlex](csidriver/features/powerflex/) [PowerScale](csidriver/features/powerscale/) [Unity](csidriver/features/unity/)">}}
footer="Supports [PowerFlex](csidriver/features/powerflex/) [PowerScale](csidriver/features/powerscale/) [Unity](csidriver/features/unity/) [PowerStore](csidriver/features/powerstore/)">}}
CSM for Resiliency is designed to make Kubernetes Applications, including those that utilize persistent storage, more resilient to various failures.
[...Learn more](resiliency/)
{{< /card >}}
Expand Down Expand Up @@ -64,15 +64,4 @@ CSM is made up of multiple components including modules (enterprise capabilities
Request a license using the [Container Storage Modules License Request](https://app.smartsheet.com/b/form/5e46fad643874d56b1f9cf4c9f3071fb) by providing the requested details.
[...Learn more](license/)
{{< /card >}}
{{< /cardpane >}}

## CSM Modules Support Matrix for Dell CSI Drivers

| CSM Module | CSI PowerFlex v2.8.0 | CSI PowerScale v2.8.0 | CSI PowerStore v2.8.0 | CSI PowerMax v2.8.0 | CSI Unity XT v2.8.0 |
| ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
| [**Authorization**](authorization/) v1.8.0 | ✔️ | ✔️ || ✔️ ||
| [**Observability**](observability/) v1.6.0 | ✔️ | ✔️ | ✔️ | ✔️ ||
| [**Replication**](replication/) v1.6.0 | ✔️ | ✔️ | ✔️ | ✔️ ||
| [**Resiliency**](resiliency/) v1.7.0 | ✔️ | ✔️ | ✔️ || ✔️ |
| [**Encryption**](secure/encryption) v0.4.0 || ✔️ ||||
| [**Application Mobility**](applicationmobility/) v0.4.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
{{< /cardpane >}}
8 changes: 3 additions & 5 deletions content/docs/applicationmobility/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,10 @@ After a backup has been created, it can be restored on the same Kubernetes clust
| Restic | Persistent Volume data will be stored in the provided object store bucket |
{{</table>}}

## Supported Operating Systems/Container Orchestrator Platforms
## Supported Container Orchestrator Platforms
{{<table "table table-striped table-bordered table-sm">}}
| COP/OS | Supported Versions |
|-|-|
| Kubernetes | 1.23, 1.24, 1.25, 1.26 |
| Red Hat OpenShift | 4.10, 4.11 |
| RHEL | 7.x, 8.x |
| CentOS | 7.8, 7.9 |
| Kubernetes | 1.26, 1.27. 1.28 |
| Red Hat OpenShift | 4.13, 4.14 |
{{</table>}}
21 changes: 3 additions & 18 deletions content/docs/authorization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,15 @@ The following diagram shows a high-level overview of CSM for Authorization with
{{<table "table table-striped table-bordered table-sm">}}
| COP/OS | Supported Versions |
|-|-|
| Kubernetes | 1.25, 1.26, 1.27 |
| RHEL | 7.x, 8.x |
| CentOS | 7.8, 7.9 |
| Kubernetes | 1.26, 1.27, 1.28 |
{{</table>}}

## Supported Storage Platforms

{{<table "table table-striped table-bordered table-sm">}}
| | PowerMax | PowerFlex | PowerScale |
|---------------|:----------------:|:-------------------:|:----------------:|
| Storage Array |PowerMax 2500/8500 PowerMaxOS 10 (6079) , PowerMaxOS 10.0.1 (6079) <br> PowerMax 2000/8000 - 5978.711.xxx, 5978.479.xxx,<br> Unisphere 10.0, 10.0.1| 3.5.x, 3.6.x | OneFS 8.1, 8.2, 9.0, 9.1, 9.2, 9.3, 9.4, 9.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 | OneFS 9.5.0.5, 9.5.0.6 |
{{</table>}}

## Supported CSI Drivers
Expand All @@ -61,21 +59,8 @@ CSM for Authorization supports the following CSI drivers and versions.
To resolve this, please refer to our [troubleshooting guide](./troubleshooting) on the topic.

## Authorization Components Support Matrix
CSM for Authorization consists of 2 components - the Authorization sidecar and the Authorization proxy server. It is important that the version of the Authorization sidecar image maps to a supported version of the Authorization proxy server.
CSM for Authorization consists of 2 components - The authorization sidecar, bundled with the driver, communicates with the Authorization proxy server to validate access to Storage platforms. The authorization sidecar is backward compatible with older Authorization proxy server versions. However, it is highly recommended to have the Authorization proxy server and sidecar installed from the same release of CSM.

{{<table "table table-striped table-bordered table-sm">}}
| Authorization Sidecar Image Tag | Authorization Proxy Server Version |
| ------------------------------- | ---------------------------------- |
| dellemc/csm-authorization-sidecar:v1.0.0 | v1.0.0, v1.1.0 |
| dellemc/csm-authorization-sidecar:v1.2.0 | v1.1.0, v1.2.0 |
| dellemc/csm-authorization-sidecar:v1.3.0 | v1.1.0, v1.2.0, v1.3.0 |
| dellemc/csm-authorization-sidecar:v1.4.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0 |
| dellemc/csm-authorization-sidecar:v1.5.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0 |
| dellemc/csm-authorization-sidecar:v1.5.1 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1 |
| dellemc/csm-authorization-sidecar:v1.6.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0 |
| dellemc/csm-authorization-sidecar:v1.7.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0, v1.7.0 |
| dellemc/csm-authorization-sidecar:v1.8.0 | v1.1.0, v1.2.0, v1.3.0, v1.4.0, v1.5.0, v1.5.1, v1.6.0, v1.7.0, v1.8.0 |
{{</table>}}
## Roles and Responsibilities

The CSM for Authorization CLI can be executed in the context of the following roles:
Expand Down
10 changes: 5 additions & 5 deletions content/docs/authorization/configuration/powerflex/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand All @@ -119,8 +119,8 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
enabled: true
# sidecarProxyImage: the container image used for the csm-authorization-sidecar.
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
# Default value: dellemc/csm-authorization-sidecar:v1.9.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
# proxyHost: hostname of the csm-authorization server
# Default value: None
Expand Down Expand Up @@ -156,10 +156,10 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
- name: authorization
# enable: Enable/Disable csm-authorization
enabled: true
configVersion: v1.8.0
configVersion: v1.9.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.8.0
image: dellemc/csm-authorization-sidecar:v1.9.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
42 changes: 39 additions & 3 deletions content/docs/authorization/configuration/powermax/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Create the karavi-authorization-config secret using this command:

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand All @@ -85,8 +85,8 @@ Create the karavi-authorization-config secret using this command:
enabled: true
# sidecarProxyImage: the container image used for the csm-authorization-sidecar.
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
# Default value: dellemc/csm-authorization-sidecar:v1.9.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
# proxyHost: hostname of the csm-authorization server
# Default value: None
Expand All @@ -100,6 +100,42 @@ Create the karavi-authorization-config secret using this command:
skipCertificateValidation: true
```

**Operator**

Refer to the [Install Driver](../../../deployment/csmoperator/drivers/powermax/#install-driver) section to edit the parameters in the Custom Resource to enable CSM Authorization.

Under `modules`, enable the module named `authorization`:

- Update the `enabled` field to `true.`

- Update the `image` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update the `PROXY_HOST` environment value to the hostname of the CSM Authorization Proxy Server.

- Update the `SKIP_CERTIFICATE_VALIDATION` environment value to `true` or `false` depending on if you want to disable or enable certificate validation of the CSM Authorization Proxy Server.

Example:

```yaml
modules:
# Authorization: enable csm-authorization for RBAC
- name: authorization
# enable: Enable/Disable csm-authorization
enabled: true
configVersion: v1.9.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.9.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
value: "csm-authorization.com"
# skipCertificateValidation: Enable/Disable certificate validation of the csm-authorization server
- name: "SKIP_CERTIFICATE_VALIDATION"
value: "true"
```

5. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.

6. (Optional) Install [dellctl](../../../references/cli) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../references/cli) for the installation steps and command list.
10 changes: 5 additions & 5 deletions content/docs/authorization/configuration/powerscale/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand All @@ -127,8 +127,8 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
enabled: true
# sidecarProxyImage: the container image used for the csm-authorization-sidecar.
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0
# Default value: dellemc/csm-authorization-sidecar:v1.9.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.9.0
# proxyHost: hostname of the csm-authorization server
# Default value: None
Expand Down Expand Up @@ -162,10 +162,10 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
- name: authorization
# enable: Enable/Disable csm-authorization
enabled: true
configVersion: v1.8.0
configVersion: v1.9.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.8.0
image: dellemc/csm-authorization-sidecar:v1.9.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
2 changes: 1 addition & 1 deletion content/docs/authorization/deployment/rpm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ yum install -y container-selinux

For environments where `yum` will not work, obtain the supported version of container-selinux for your OS version and install it.

The container-selinux RPMs for CentOS/RedHat 7 and 8 can be downloaded from [https://centos.pkgs.org/7/centos-extras-x86_64/](https://centos.pkgs.org/7/centos-extras-x86_64/) and [https://centos.pkgs.org/8/centos-appstream-x86_64/](https://centos.pkgs.org/8/centos-appstream-x86_64/), respectively.
The container-selinux RPMs for CentOS/RedHat 7 and 8 can be downloaded from [https://centos.pkgs.org/7/centos-extras-x86_64/](https://centos.pkgs.org/7/centos-extras-x86_64/) and [https://centos.pkgs.org/8-stream/centos-appstream-x86_64/](https://centos.pkgs.org/8-stream/centos-appstream-x86_64/), respectively.

## Deploying the CSM Authorization Proxy Server

Expand Down
13 changes: 10 additions & 3 deletions content/docs/authorization/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,21 @@ Description: >








### New Features/Changes

- [#922 - [FEATURE]: Use ubi9 micro as base image](https://github.com/dell/csm/issues/922)
- [#947 - [FEATURE]: Support for Kubernetes 1.28](https://github.com/dell/csm/issues/947)
- [#1066 - [FEATURE]: Support for Openshift 4.14](https://github.com/dell/csm/issues/1066)
- [#996 - [FEATURE]: Dell CSI to Dell CSM Operator Migration Process](https://github.com/dell/csm/issues/996)
- [#1031 - [FEATURE]: Update to the latest UBI Micro image for CSM](https://github.com/dell/csm/issues/1031)
- [#1062 - [FEATURE]: CSM PowerMax: Support PowerMax v10.1 ](https://github.com/dell/csm/issues/1062)

### Fixed Issues

- [#895 - [BUG]: Update CSM Authorization karavictl CLI flag descriptions](https://github.com/dell/csm/issues/895)
- [#916 - [BUG]: Remove references to deprecated io/ioutil package](https://github.com/dell/csm/issues/916)

### Known Issues

Expand Down
5 changes: 0 additions & 5 deletions content/docs/cosidriver/features/objectscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ linktitle: ObjectScale
weight: 1
Description: Code features for ObjectScale COSI Driver
---

> **Notational Conventions**
>
> The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
Fields are specified by their path. Consider the following examples:

1. Field specified by the following path `spec.authenticationType=IAM` is reflected in their resources YAML as the following:
Expand Down
5 changes: 0 additions & 5 deletions content/docs/cosidriver/installation/configuration_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ linktitle: Configuration File
weight: 1
Description: Description of configuration file for ObjectScale
---

> **Notational Conventions**
>
> The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
## Dell COSI Driver Configuration Schema

This configuration file is used to specify the settings for the Dell COSI Driver, which is responsible for managing connections to the Dell ObjectScale platform. The configuration file is written in YAML format and based on the JSON schema and adheres to its specification.
Expand Down
6 changes: 1 addition & 5 deletions content/docs/cosidriver/installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ The COSI Driver for Dell ObjectScale can be deployed by using the provided Helm
The Helm chart installs the following components in a _Deployment_ in the specified namespace:
- COSI Driver for ObjectScale

> **Notational Conventions**
>
> The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
## Dependencies

Installing any of the CSI Driver components using Helm requires a few utilities to be installed on the system running the installation.
Expand All @@ -38,7 +34,7 @@ Installing any of the CSI Driver components using Helm requires a few utilities
1. Run `git clone -b main https://github.com/dell/helm-charts.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 dell-cosi` to create a new one. The use of _dell-cosi_ as the namespace is just an example. You can choose any name for the namespace.
3. Copy the _charts/cosi/values.yaml_ into a new location with name _my-cosi-values.yaml_, to customize settings for installation.
4. Create new file called _my-cosi-configuration.yaml_, and copy the settings available in the [Configuration File](./configuration_file.md) page.
4. Create new file called _my-cosi-configuration.yaml_, and copy the settings available in the [Configuration File](../configuration_file/) page.
5. Edit *my-cosi-values.yaml* to set the following parameters for your installation:
The following table lists the primary configurable parameters of the COSI driver Helm chart and their default values. More detailed information can be found in the [`values.yaml`](https://github.com/dell/helm-charts/blob/master/charts/cosi/values.yaml) file in this repository.

Expand Down
Loading

0 comments on commit d93f9f4

Please sign in to comment.