Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated authorization and resiliency docs for release 1.8 #800

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ menu:
no_list: true
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

The Dell Technologies (Dell) Container Storage Modules (CSM) enables simple and consistent integration and automation experiences, extending enterprise storage capabilities to Kubernetes for cloud-native stateful applications. It reduces management complexity so developers can independently consume enterprise storage with ease and automate daily operations such as provisioning, snapshotting, replication, observability, authorization, application mobility, encryption, and resiliency.

<img src="csm_hexagon.png" alt="CSM Hex Diagram" width="500"/>
Expand Down Expand Up @@ -66,9 +74,9 @@ CSM is made up of multiple components including modules (enterprise capabilities

| CSM Module | CSI PowerFlex v2.7.0 | CSI PowerScale v2.7.0 | CSI PowerStore v2.8.0 | CSI PowerMax v2.7.0 | CSI Unity XT v2.7.0 |
| ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
| [**Authorization**](authorization/) v1.7.0 | ✔️ | ✔️ | ❌ | ✔️ | ❌ |
| [**Authorization**](authorization/) v1.8.0 | ✔️ | ✔️ | ❌ | ✔️ | ❌ |
| [**Observability**](observability/) v1.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
| [**Replication**](replication/) v1.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
| [**Resiliency**](resiliency/) v1.6.0 | ✔️ | ✔️ | ✔️ | ❌ | ✔️ |
| [**Resiliency**](resiliency/) v1.7.0 | ✔️ | ✔️ | ✔️ | ❌ | ✔️ |
| [**Encryption**](secure/encryption) v0.4.0 | ❌ | ✔️ | ❌ | ❌ | ❌ |
| [**Application Mobility**](applicationmobility/) v0.4.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
4 changes: 4 additions & 0 deletions content/docs/authorization/Backup and Restore/rpm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization RPM backup and restore
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

## Roles

Role data is stored in the `common` Config Map in the underlying `k3s` deployment.
Expand Down
1 change: 1 addition & 0 deletions content/docs/authorization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ CSM for Authorization consists of 2 components - the Authorization sidecar and t
| 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

Expand Down
4 changes: 4 additions & 0 deletions content/docs/authorization/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization CLI
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

karavictl is a command-line interface (CLI) used to interact with and manage your Container Storage Modules (CSM) Authorization deployment.
This document outlines all karavictl commands, their intended use, options that can be provided to alter their execution, and expected output from those commands.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.7.0
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.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.7.0
configVersion: v1.8.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.7.0
image: dellemc/csm-authorization-sidecar:v1.8.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
4 changes: 2 additions & 2 deletions content/docs/authorization/configuration/powermax/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.7.0
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.0

# proxyHost: hostname of the csm-authorization server
# Default value: None
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.7.0
# Default value: dellemc/csm-authorization-sidecar:v1.8.0
sidecarProxyImage: dellemc/csm-authorization-sidecar:v1.8.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.7.0
configVersion: v1.8.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.6.0
image: dellemc/csm-authorization-sidecar:v1.8.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Configuring the CSM for Authorization Proxy Server
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

## Configuring the CSM for Authorization Proxy Server

The storage administrator must first configure Authorization with the following via `karavictl`:
Expand Down
4 changes: 4 additions & 0 deletions content/docs/authorization/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,8 @@ tags:
- csm-authorization
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

Installation information for CSM Authorization can be found in this section.
4 changes: 4 additions & 0 deletions content/docs/authorization/deployment/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization Helm deployment
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

CSM Authorization can be installed by using the provided Helm v3 charts on Kubernetes platforms.

The following CSM Authorization components are installed in the specified namespace:
Expand Down
8 changes: 8 additions & 0 deletions content/docs/authorization/deployment/rpm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization RPM deployment
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

This section outlines the deployment steps for Container Storage Modules (CSM) for Authorization. The deployment of CSM for Authorization is handled in 2 parts:
- Deploying the CSM for Authorization proxy server, to be controlled by storage administrators
- Configuring one to many [supported](../../../authorization#supported-csi-drivers) Dell CSI drivers with CSM for Authorization
Expand Down
4 changes: 4 additions & 0 deletions content/docs/authorization/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization design
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

Container Storage Modules (CSM) for Authorization is designed as a service mesh solution and consists of many internal components that work together in concert to achieve its overall functionality.

This document provides an overview of the major components, including how they fit together and pointers to implementation details.
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.7.0
## Release Notes - CSM Authorization 1.8.0


### New Features/Changes
Expand Down
8 changes: 8 additions & 0 deletions content/docs/authorization/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ Description: >
Troubleshooting guide
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

## RPM Deployment
- [The Failure of Building an Authorization RPM](#The-Failure-of-Building-an-Authorization-RPM)
- [Running `karavictl tenant` commands result in an HTTP 504 error](#running-karavictl-tenant-commands-result-in-an-http-504-error)
Expand Down
4 changes: 4 additions & 0 deletions content/docs/authorization/uninstallation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization Uninstallation
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

This section outlines the uninstallation steps for Container Storage Modules (CSM) for Authorization.

## Uninstalling the RPM
Expand Down
4 changes: 4 additions & 0 deletions content/docs/authorization/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Upgrade Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

This section outlines the upgrade steps for Container Storage Modules (CSM) for Authorization. The upgrade of CSM for Authorization is handled in 2 parts:
- Upgrading the CSM for Authorization proxy server
- Upgrading the Dell CSI drivers with CSM for Authorization enabled
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,10 +245,10 @@ spec:
- name: authorization
# enable: Enable/Disable csm-authorization
enabled: $AUTHORIZATION_ENABLED
configVersion: v1.7.0
configVersion: v1.8.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.7.0
image: dellemc/csm-authorization-sidecar:v1.8.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -253,10 +253,10 @@ spec:
- name: authorization
# enabled: Enable/Disable csm-authorization
enabled: $AUTHORIZATION_ENABLED
configVersion: v1.7.0
configVersion: v1.8.0
components:
- name: karavi-authorization-proxy
image: dellemc/csm-authorization-sidecar:v1.7.0
image: dellemc/csm-authorization-sidecar:v1.8.0
envs:
# proxyHost: hostname of the csm-authorization server
- name: "PROXY_HOST"
Expand Down
9 changes: 5 additions & 4 deletions content/docs/deployment/csmoperator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ The table below lists the driver and modules versions installable with the CSM O

| CSI Driver | Version | CSM Authorization | CSM Replication | CSM Observability | CSM Resiliency |
| ------------------ |---------|-------------------|-----------------|-------------------|----------------|
| CSI PowerScale | 2.8.0 | ✔ 1.7.0 | ✔ 1.5.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerScale | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerScale | 2.7.0 | ✔ 1.7.0 | ✔ 1.5.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerScale | 2.6.0 | ✔ 1.6.0 | ✔ 1.4.0 | ✔ 1.5.0 | ❌ |
| CSI PowerFlex | 2.8.0 | ✔ 1.7.0 | ✔ 1.5.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerFlex | 2.7.0 | ✔ 1.6.0 | ✔ 1.4.0 | ✔ 1.5.0 | |
| CSI PowerFlex | 2.6.0 | ✔ 1.5.0 | ❌ | ✔ 1.4.0 | ❌ |
| CSI PowerFlex | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ✔ 1.5.0 | ✔ 1.7.0 |
| CSI PowerFlex | 2.7.0 | ✔ 1.7.0 | ✔ 1.4.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerFlex | 2.6.0 | ✔ 1.6.0 | ❌ | ✔ 1.4.0 | ❌ |
| CSI PowerStore | 2.8.0 | ❌ | ❌ | ❌ | ✔ 1.7.0 |
| CSI PowerStore | 2.7.0 | ❌ | ❌ | ❌ | ✔ 1.6.0 |
| CSI PowerStore | 2.6.0 | ❌ | ❌ | ❌ | ❌ |
| CSI PowerMax | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ❌ | ❌ |
| CSI PowerMax | 2.7.0 | ✔ 1.7.0 | ✔ 1.5.0 | ❌ | ❌ |
| CSI Unity XT | 2.8.0 | ❌ | ❌ | ❌ | ❌ |
| CSI Unity XT | 2.7.0 | ❌ | ❌ | ❌ | ❌ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Installing Authorization via Dell CSM Operator
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

## Install CSM Authorization via Dell CSM Operator

The CSM Authorization module for supported Dell CSI Drivers can be installed via the Dell CSM Operator.
Expand Down
4 changes: 4 additions & 0 deletions content/docs/observability/deployment/online.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Container Storage Modules (CSM) for Observability Installer
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

<!--
Copyright (c) 2020 Dell Inc., or its subsidiaries. All Rights Reserved.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/resiliency/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 resiliency
---

## Release Notes - CSM Resiliency 1.6.0
## Release Notes - CSM Resiliency 1.7.0


### New Features/Changes
Expand Down
4 changes: 4 additions & 0 deletions content/v1/authorization/Backup and Restore/rpm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization RPM backup and restore
---

{{% pageinfo color="primary" %}}
The CSM Authorization RPM is no longer actively maintained or supported. It will be deprecated in CSM 2.0. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward.
{{% /pageinfo %}}

## Roles

Role data is stored in the `common` Config Map in the underlying `k3s` deployment.
Expand Down
4 changes: 4 additions & 0 deletions content/v1/authorization/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization CLI
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

karavictl is a command-line interface (CLI) used to interact with and manage your Container Storage Modules (CSM) Authorization deployment.
This document outlines all karavictl commands, their intended use, options that can be provided to alter their execution, and expected output from those commands.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Configuring the CSM for Authorization Proxy Server
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

## Configuring the CSM for Authorization Proxy Server

The storage administrator must first configure the proxy server with the following:
Expand Down
4 changes: 4 additions & 0 deletions content/v1/authorization/deployment/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization Helm deployment
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

CSM Authorization can be installed by using the provided Helm v3 charts on Kubernetes platforms.

The following CSM Authorization components are installed in the specified namespace:
Expand Down
4 changes: 4 additions & 0 deletions content/v1/authorization/deployment/rpm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization RPM deployment
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

This section outlines the deployment steps for Container Storage Modules (CSM) for Authorization. The deployment of CSM for Authorization is handled in 2 parts:
- Deploying the CSM for Authorization proxy server, to be controlled by storage administrators
- Configuring one to many [supported](../../../authorization#supported-csi-drivers) Dell CSI drivers with CSM for Authorization
Expand Down
4 changes: 4 additions & 0 deletions content/v1/authorization/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: >
Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization design
---

{{% pageinfo color="primary" %}}
The CSM Authorization karavictl CLI is no longer actively maintained or supported. It will be deprecated in CSM 2.0.
{{% /pageinfo %}}

Container Storage Modules (CSM) for Authorization is designed as a service mesh solution and consists of many internal components that work together in concert to achieve its overall functionality.

This document provides an overview of the major components, including how they fit together and pointers to implementation details.
Expand Down
Loading