Skip to content

Commit

Permalink
Restructuring and updating mkdocs (#220)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Mattsson <[email protected]>
  • Loading branch information
datamattsson authored Dec 23, 2024
1 parent a5c78f8 commit 7e73458
Show file tree
Hide file tree
Showing 68 changed files with 170 additions and 160 deletions.
14 changes: 7 additions & 7 deletions docs/csi_driver/archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Upgrade considerations:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, SUSE Rancher, Mirantis Kubernetes Engine and others; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations. Lowest tested and known working version is Kubernetes 1.21.<br />
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, SUSE Rancher, Mirantis Kubernetes Engine and others; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations. Lowest tested and known working version is Kubernetes 1.21.<br />
<sup>2</sup> = The HPE CSI Driver will recognize CentOS, AlmaLinux and Rocky Linux as RHEL derives and they are supported by HPE.
<sup>3</sup> = Learn about each data platform's team [support commitment](../legal/support/index.md#container_storage_providers).
</small>
Expand Down Expand Up @@ -137,7 +137,7 @@ Upgrade considerations:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, SUSE Rancher, Mirantis Kubernetes Engine and others; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.<br />
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, SUSE Rancher, Mirantis Kubernetes Engine and others; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.<br />
<sup>2</sup> = The HPE CSI Driver will recognize CentOS, AlmaLinux and Rocky Linux as RHEL derives and they are supported by HPE.
</small>

Expand Down Expand Up @@ -188,7 +188,7 @@ Release highlights:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.
</small>

#### HPE CSI Driver for Kubernetes 2.1.0
Expand Down Expand Up @@ -239,7 +239,7 @@ Release highlights:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.
</small>

#### HPE CSI Driver for Kubernetes 2.0.0
Expand Down Expand Up @@ -287,7 +287,7 @@ Release highlights:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.
</small>

#### HPE CSI Driver for Kubernetes 1.4.0
Expand Down Expand Up @@ -333,7 +333,7 @@ Release highlights:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, Rancher and Mirantis Kubernetes Engine; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.
</small>

#### HPE CSI Driver/Operator for Kubernetes 1.3.0
Expand Down Expand Up @@ -379,7 +379,7 @@ Release highlights:
</table>

<small>
<sup>1</sup> = For HPE Ezmeral Container Platform and Rancher; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](../partners) for other variations.<br />
<sup>1</sup> = For HPE Ezmeral Container Platform and Rancher; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations.<br />
<sup>2</sup> = Only FC is supported on Primera OS prior to 4.2.0.
</small>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
The HPE Alletra 5000/6000 and Nimble Storage Container Storage Provider ("CSP") for Kubernetes is the reference implementation for the HPE CSI Driver for Kubernetes. The CSP abstracts the data management capabilities of the array for use by Kubernetes. The documentation found herein is mainly geared towards day-2 operations and reference documentation for the `StorageClass` and `VolumeSnapshotClass` parameters but also contains important array setup requirements.

!!! caution "Important"
For a successful deployment, it's important to understand the array platform requirements found within the [CSI driver](../../csi_driver/index.md#compatibility_and_support) (compute node OS and Kubernetes versions) and the CSP.
For a successful deployment, it's important to understand the array platform requirements found within the [CSI driver](../../index.md#compatibility_and_support) (compute node OS and Kubernetes versions) and the CSP.

[TOC]

!!! seealso
There's a brief introduction on [how to use HPE Nimble Storage](../../learn/video_gallery/index.md#using_the_hpe_csi_driver_with_hpe_nimble_storage) with the HPE CSI Driver in the Video Gallery. It also applies broadly to HPE Alletra 5000/6000.
There's a brief introduction on [how to use HPE Nimble Storage](../../../learn/video_gallery/index.md#using_the_hpe_csi_driver_with_hpe_nimble_storage) with the HPE CSI Driver in the Video Gallery. It also applies broadly to HPE Alletra 5000/6000.

## Platform Requirements

Always check the corresponding CSI driver version in [compatibility and support](../../csi_driver/index.md#compatibility_and_support) for the required array Operating System ("OS") version for a particular release of the driver. If a certain feature is gated against a certain version of the array OS it will be called out where applicable.
Always check the corresponding CSI driver version in [compatibility and support](../../index.md#compatibility_and_support) for the required array Operating System ("OS") version for a particular release of the driver. If a certain feature is gated against a certain version of the array OS it will be called out where applicable.

!!! tip
The documentation reflected here always corresponds to the latest supported version and may contain references to future features and capabilities.
Expand Down Expand Up @@ -88,7 +88,7 @@ Some features may be limited and restricted in a multitenant deployment, such as

### Limitations

Consult the [compatibility and support](../../csi_driver/index.md#compatibility_and_support) table for supported array OS versions. CSI and CSP specific limitations are listed below.
Consult the [compatibility and support](../../index.md#compatibility_and_support) table for supported array OS versions. CSI and CSP specific limitations are listed below.

- Striped volumes on grouped arrays are not supported by the CSI driver.
- The CSP is not capable of provisioning or importing volumes protected by Peer Persistence.
Expand All @@ -108,7 +108,7 @@ A `StorageClass` is used to provision or clone a persistent volume. It can also

Backward compatibility with the HPE Nimble Storage FlexVolume driver is being honored to a certain degree. `StorageClass` API objects needs be rewritten and parameters need to be updated regardless.

Please see [using the HPE CSI Driver](../../csi_driver/using.md#base_storageclass_parameters) for base `StorageClass` examples. All parameters enumerated reflects the current version and may contain unannounced features and capabilities.
Please see [using the HPE CSI Driver](../../using.md#base_storageclass_parameters) for base `StorageClass` examples. All parameters enumerated reflects the current version and may contain unannounced features and capabilities.

!!! note
These are optional parameters unless specified.
Expand All @@ -132,11 +132,11 @@ These parameters are mutable between a parent volume and creating a clone from a
| syncOnDetach | Boolean | Indicates that a snapshot of the volume should be synced to the replication partner each time it is detached from a node. Defaults to "false". |

<small>
Restrictions applicable when using the [CSI volume mutator](../../csi_driver/using.md#using_volume_mutations):
Restrictions applicable when using the [CSI volume mutator](../../using.md#using_volume_mutations):
<br /><sup>1</sup> = Parameter is immutable and can't be altered after provisioning/cloning.
<br /><sup>2</sup> = Performance policies may only be mutated between performance polices with the same block size.
<br /><sup>3</sup> = Deduplication may only be mutated within the same performance policy application category and block size.
<br /><sup>4</sup> = This parameter was removed in HPE CSI Driver 1.4.0 and replaced with [`VolumeGroupClasses`](#creating_a_volumegroupclass).
<br /><sup>4</sup> = This parameter was removed in HPE CSI Driver 1.4.0 and replaced with [`VolumeGroupClasses`](#volumegroupclass_parameters).
</small>

!!! note
Expand Down Expand Up @@ -194,21 +194,21 @@ These parameters are applicable only for Pod inline volumes and to be specified

## VolumeGroupClass Parameters

If basic data protection is required and performed on the array, `VolumeGroups` needs to be created, even it's just a single volume that needs data protection using snapshots and replication. Learn more about `VolumeGroups` in the [provisioning concepts documentation](../../csi_driver/using.md#volume_groups).
If basic data protection is required and performed on the array, `VolumeGroups` needs to be created, even it's just a single volume that needs data protection using snapshots and replication. Learn more about `VolumeGroups` in the [provisioning concepts documentation](../../using.md#volume_groups).

| Parameter | String | Description |
| ------------------ | ------- | ----------- |
| description | Text | Text to be added to the volume collection description on the array. Empty by default. |
| protectionTemplate | Text | The name of the protection template to assign to the volume collection. Default examples of protection templates include "Retain-30Daily", "Retain-48Hourly-30Daily-52Weekly", and "Retain-90Daily". Empty by default, meaning no array snapshots are performed on the `VolumeGroups`. |

!!! tip "New feature"
`VolumeGroupClasses` were introduced with version 1.4.0 of the CSI driver. Learn more in the [Using section](../../csi_driver/using.md#volume_groups).
`VolumeGroupClasses` were introduced with version 1.4.0 of the CSI driver. Learn more in the [Using section](../../using.md#volume_groups).

## VolumeSnapshotClass Parameters

These parametes are for `VolumeSnapshotClass` objects when using CSI snapshots. The external snapshotter needs to be deployed on the Kubernetes cluster and is usually performed by the Kubernetes vendor. Check [enabling CSI snapshots](../../csi_driver/using.md#enabling_csi_snapshots) for more information.
These parametes are for `VolumeSnapshotClass` objects when using CSI snapshots. The external snapshotter needs to be deployed on the Kubernetes cluster and is usually performed by the Kubernetes vendor. Check [enabling CSI snapshots](../../using.md#enabling_csi_snapshots) for more information.

How to use `VolumeSnapshotClass` and `VolumeSnapshot` objects is elaborated on in [using CSI snapshots](../../csi_driver/using.md#using_csi_snapshots).
How to use `VolumeSnapshotClass` and `VolumeSnapshot` objects is elaborated on in [using CSI snapshots](../../using.md#using_csi_snapshots).

| Parameter | String | Description |
| ----------- | ------ | ----------- |
Expand Down
Loading

0 comments on commit 7e73458

Please sign in to comment.