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

CSM Docs is having dead links #1105

Merged
merged 34 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
30b22df
404 Not Found for Cert-CSI
WilsonRadadia20 May 17, 2024
707e2b7
Solved: 404 Not Found License Page
WilsonRadadia20 May 17, 2024
903812d
Solved: 404 Not Found License Page
WilsonRadadia20 May 17, 2024
c44e8ad
Solved: 404 Not Found Cert-CSI
WilsonRadadia20 May 20, 2024
e6ef322
Solved: 404 Not Found License Page
WilsonRadadia20 May 20, 2024
fca0b4a
Solved: Not Found in request a license for Application Mobility
WilsonRadadia20 May 20, 2024
1409b65
Changes Reverted
WilsonRadadia20 May 20, 2024
bc8a8c2
Solved: Not Found, supported
WilsonRadadia20 May 20, 2024
3bdd8c3
Solved: 404 Not Found, troubleshooting
WilsonRadadia20 May 20, 2024
1c89db4
Solved: 404 Not Found, proxy sever
WilsonRadadia20 May 20, 2024
6fb8af7
Solved: 404 Not Found, Powerflex
WilsonRadadia20 May 20, 2024
99d81cb
Solved: 404 Not Found, PowerMax
WilsonRadadia20 May 20, 2024
fac3206
Solved: 404 Not Found, PowerScale
WilsonRadadia20 May 20, 2024
d979fd8
Solved: Not Found, CSI drivers, Authorization, Observability, Replica…
WilsonRadadia20 May 20, 2024
ebca264
Solved: 404 Not Found, SmartQuotas powerscale
WilsonRadadia20 May 21, 2024
7550e3e
Solved: 404 Not Found, CSI Driver release notes
WilsonRadadia20 May 21, 2024
6f97f19
Solved: 404 Not Found, CSM for Authorization, Observability, Replicat…
WilsonRadadia20 May 21, 2024
8efc896
Solved: 404 Not Found, cli for dellctl
WilsonRadadia20 May 21, 2024
5895088
Solved: 404 Not Found, license page in encryption
WilsonRadadia20 May 23, 2024
e270946
Solved: 404 Not Found, license page in troubleshooting
WilsonRadadia20 May 23, 2024
1e1e88d
Solved: 404 Not Found, prerequisite in authorization
WilsonRadadia20 May 23, 2024
bc4420b
Updated Resiliency "Not Yet Tested or Supported" for Powerflex
WilsonRadadia20 May 24, 2024
c21118f
Solved: 404 Not Found, Install driver in authorization for PowerFlex
WilsonRadadia20 May 24, 2024
fc9a60e
Solved: 404 Not Found, Install driver in authorization for PowerFlex
WilsonRadadia20 May 24, 2024
7bdcbb4
Solved: 404 Not Found, PowerFlex, PowerScale, PowerMax, Proxy-server,…
WilsonRadadia20 May 27, 2024
3f6f998
Solved: 404 Not Found dellctl and installation of PowerFlex using Hel…
WilsonRadadia20 May 27, 2024
197303b
Solved: 404 Not Found License Page in Encryption
WilsonRadadia20 May 27, 2024
8892a69
Solved: 404 Not Found Troubleshooting in Support for Observability, R…
WilsonRadadia20 May 27, 2024
bdb53bf
Solved: 404 Not Found CLI in Application Mobility
WilsonRadadia20 May 27, 2024
d6a792c
Solved: 404 Not Found, SmartQuotas in PowerScale
WilsonRadadia20 May 27, 2024
702b3a5
Solved: 404 Not Found reference CLI for PowerScale and PowerMax
WilsonRadadia20 May 27, 2024
38a321a
Solved: 404 Not Found, Authorization in Upgrade Module
WilsonRadadia20 May 27, 2024
f989734
Merge branch 'main' into bug-1289-dead-links
shanmydell May 27, 2024
431fa7a
Merge branch 'main' into bug-1289-dead-links
gallacher May 27, 2024
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
2 changes: 1 addition & 1 deletion content/docs/applicationmobility/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Description: >
Use Cases
---

After Application Mobility is installed, the [dellctl CLI](../../references/cli/) can be used to register clusters and manage backups and restores of applications. These examples also provide references for using the Application Mobility Custom Resource Definitions (CRDs) to define Custom Resources (CRs) as an alternative to using the `dellctl` CLI.
After Application Mobility is installed, the [dellctl CLI](../../support/cli) can be used to register clusters and manage backups and restores of applications. These examples also provide references for using the Application Mobility Custom Resource Definitions (CRDs) to define Custom Resources (CRs) as an alternative to using the `dellctl` CLI.

## Backup and Restore an Application
This example details the steps when an application in namespace `demo1` is being backed up and then later restored to either the same cluster or another cluster. In this sample, both Application Mobility and Velero are installed in the `application-mobility` namespace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,4 +172,4 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization

6. Install the Dell CSI PowerFlex driver following the appropriate documenation for your installation method.

7. (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.
7. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,4 @@ Create the karavi-authorization-config secret using this command:

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.
6. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=

6. Install the Dell CSI PowerScale driver following the appropriate documenation for your installation method.

7. (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.
7. (Optional) Install [dellctl](../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description: >
---

## Pre-requisites
- [Request a License for Application Mobility](../../../../../license/)
- [Request a License for Application Mobility](../../../../../support/license/)
- Object store bucket accessible by both the source and target clusters

## Installation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Apart from any secrets and config maps described in the CSI driver documentation

### Secret *encryption-license*

Request a trial license following instructions on the [License page](../../../../../license). You will be provided with a YAML file similar to:
Request a trial license following instructions on the [License page](../../../../../support/license/). You will be provided with a YAML file similar to:

```yaml
apiVersion: v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The CSM Authorization RPM will be deprecated in a future release. It is highly r

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](../../../../../prerequisites/#supported-csm-modules) Dell CSI drivers with CSM for Authorization
- Configuring one to many [supported](../../../../../../prerequisites/#supported-csm-modules) Dell CSI drivers with CSM for Authorization

## Prerequisites

Expand Down Expand Up @@ -123,19 +123,19 @@ A Storage Administrator can execute the shell script, install_karavi_auth.sh as

5. After installation, application data will be stored on the system under `/var/lib/rancher/k3s/storage/`.

If errors occur during installation, review the [Troubleshooting](../../../../../authorization/troubleshooting) section.
If errors occur during installation, review the [Troubleshooting](../../../../../../authorization/troubleshooting) section.

## Configuring the CSM for Authorization Proxy Server

The first part of CSM for Authorization deployment is to configure the proxy server. This is controlled by the Storage Administrator.

Please follow the steps outlined in the [proxy server](../../../../../authorization/configuration/proxy-server) configuration.
Please follow the steps outlined in the [proxy server](../../../../../../authorization/configuration/proxy-server) configuration.

## Configuring a Dell CSI Driver with CSM for Authorization

The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../prerequisites/#supported-csm-modules) CSI drivers. This is controlled by the Kubernetes tenant administrator.
The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../../prerequisites/#supported-csm-modules) CSI drivers. This is controlled by the Kubernetes tenant administrator.

Please follow the steps outlined in [PowerFlex](../../../../../authorization/configuration/powerflex), [PowerMax](../../../../../authorization/configuration/powermax), or [PowerScale](../../../../../authorization/configuration/powerscale) to configure the CSI Driver to work with the Authorization sidecar.
Please follow the steps outlined in [PowerFlex](../../../../../../authorization/configuration/powerflex), [PowerMax](../../../../../../authorization/configuration/powermax), or [PowerScale](../../../../../../authorization/configuration/powerscale) to configure the CSI Driver to work with the Authorization sidecar.

## Updating CSM for Authorization Proxy Server Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This section outlines the upgrade steps for Container Storage Modules (CSM) for

## Upgrading CSM for Authorization proxy server

Obtain the latest single binary installer RPM by following one of our two options [here](../../installation/authorization#single-binary-installer).
Obtain the latest single binary installer RPM by following one of our two options [here](../../installation/authorization/authorization#single-binary-installer).

To update the rpm package on the system, run the below command from within the extracted folder:

Expand Down
4 changes: 2 additions & 2 deletions content/docs/prerequisites/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ weight: 1
{{</table>}}

> Notes:
> * Any orchestrator platform or version that's not mentioned here must be self-certified using [Cert-CSI](../cert-csi/) in order to be supported. Although not mandatory, we recommend users to use orchestrator platforms and versions that have not met their end of life.
> * Any orchestrator platform or version that's not mentioned here must be self-certified using [Cert-CSI](../support/cert-csi/) in order to be supported. Although not mandatory, we recommend users to use orchestrator platforms and versions that have not met their end of life.

## Tested Host Operating Systems

Expand All @@ -47,7 +47,7 @@ Container Storage Modules (CSM) does not officially support specific operating s

> Notes:
> * 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.
> * Any operating system or version that's not mentioned here must be self-certified using [Cert-CSI](../cert-csi/) in order to be supported. Although not mandatory, we recommend users to use operating systems and versions that have not met their end of life.
> * Any operating system or version that's not mentioned here must be self-certified using [Cert-CSI](../support/cert-csi/) in order to be supported. Although not mandatory, we recommend users to use operating systems and versions that have not met their end of life.

## Supported CSM Modules

Expand Down
2 changes: 1 addition & 1 deletion content/docs/secure/encryption/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Encryption provides the capability to encrypt user data residing on volumes crea

> **NOTE:** This tech-preview release is not intended for use in production environment.

> **NOTE:** Encryption requires a time-based license to create new encrypted volumes. Request a [trial license](../../license) prior to deployment.
> **NOTE:** Encryption requires a time-based license to create new encrypted volumes. Request a [trial license](../../support/license) prior to deployment.
>
> After the license expiration, existing encrypted volume can still be unlocked and used, but no new encrypted volumes can be created.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/secure/encryption/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ This may manifest in:
- failure to create a new encrypted volume

Resolution:
- obtain a [new valid license](../../../license)
- obtain a [new valid license](../../../support/license)
- check the license is for the cluster on which the encrypted volumes are created
- check [encryption-license secret](../../../deployment/helm/modules/installation/encryption#secret-encryption-license)

Expand Down
4 changes: 2 additions & 2 deletions content/docs/support/cert-csi/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ storageClasses:

> NOTE: For testing/debugging purposes, it can be useful to use the `--no-cleanup` so resources do not get deleted.

> NOTE: If you are using CSI PowerScale with [SmartQuotas](../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. Set `storageClasses.expansion` to `false` to skip this suite.
> NOTE: If you are using CSI PowerScale with [SmartQuotas](../../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage. Set `storageClasses.expansion` to `false` to skip this suite.

```bash
cert-csi certify --cert-config <path-to-config> --vsc <volume-snapshot-class>
Expand Down Expand Up @@ -533,7 +533,7 @@ Run `cert-csi test clone-volume -h` for more options.

> Raw block volumes cannot be verified since there is no filesystem.

> If you are using CSI PowerScale with [SmartQuotas](../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage.
> If you are using CSI PowerScale with [SmartQuotas](../../csidriver/features/powerscale/#usage-of-smartquotas-to-limit-storage-consumption) disabled, the `Volume Expansion` suite is expected to timeout due to the way PowerScale provisions storage.

```bash
cert-csi test expansion --sc <storage class>
Expand Down
18 changes: 9 additions & 9 deletions content/docs/support/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ Description: >

Release notes for Container Storage Modules:

[CSI Drivers](../csidriver/release)
[CSI Drivers](../../csidriver/release)

[CSM for Authorization](../authorization/release)
[CSM for Authorization](../../authorization/release)

[CSM for Observability](../observability/release)
[CSM for Observability](../../observability/release)

[CSM for Replication](../replication/release)
[CSM for Replication](../../replication/release)

[CSM for Resiliency](../resiliency/release)
[CSM for Resiliency](../../resiliency/release)

[CSM for Encryption](../secure/encryption/release)
[CSM for Encryption](../../secure/encryption/release)

[CSM for Application Mobility](../applicationmobility/release)
[CSM for Application Mobility](../../applicationmobility/release)

[CSM Operator](../deployment/csmoperator/release)
[CSM Operator](../../deployment/csmoperator/release)

[CSM Installation Wizard](../deployment/csminstallationwizard/release)
[CSM Installation Wizard](../../deployment/csminstallationwizard/release)
16 changes: 8 additions & 8 deletions content/docs/support/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Description: >

Troubleshooting links for Container Storage Modules:

[CSI Drivers](../csidriver/troubleshooting)
[CSI Drivers](../../csidriver/troubleshooting)

[CSM for Authorization](../authorization/troubleshooting)
[CSM for Authorization](../../authorization/troubleshooting)

[CSM for Observability](../observability/troubleshooting)
[CSM for Observability](../../observability/troubleshooting)

[CSM for Replication](../replication/troubleshooting)
[CSM for Replication](../../replication/troubleshooting)

[CSM for Resiliency](../resiliency/troubleshooting)
[CSM for Resiliency](../../resiliency/troubleshooting)

[CSM for Encryption](../secure/encryption/troubleshooting)
[CSM for Encryption](../../secure/encryption/troubleshooting)

[CSM for Application Mobility](../applicationmobility/troubleshooting)
[CSM for Application Mobility](../../applicationmobility/troubleshooting)

[CSM Operator](../deployment/csmoperator/troubleshooting)
[CSM Operator](../../deployment/csmoperator/troubleshooting)
Loading