From 1af0c4b158ea79303a36a69bbf8799c4421e31a5 Mon Sep 17 00:00:00 2001 From: Srinivas DM <47344092+srinivassrini@users.noreply.github.com> Date: Thu, 12 Sep 2024 15:38:19 +0530 Subject: [PATCH] PAC-1729 updated readme files (#96) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * updated readme files * Update README.md - minor lang edits * Update README.md - Add volume snapshot info * Update README.md - Add back deleted line * Update README.md - Fix logo * Update README.md - Update snapshot info * Update README.md - minor lang changes --------- Co-authored-by: ”Srinivas <“srinivassena8@gmail.com”> Co-authored-by: Vishwanath S --- packs/csm-operator-addon-1.5.0/README.md | 31 ++++++++++++++++++- .../trident-operator-v23.01.0-addon/README.md | 23 ++++++++++++++ packs/trident-operator-v23.01.0/README.md | 22 +++++++++++++ 3 files changed, 75 insertions(+), 1 deletion(-) diff --git a/packs/csm-operator-addon-1.5.0/README.md b/packs/csm-operator-addon-1.5.0/README.md index ec5c0afe..fd4549a4 100644 --- a/packs/csm-operator-addon-1.5.0/README.md +++ b/packs/csm-operator-addon-1.5.0/README.md @@ -17,5 +17,34 @@ Please see [here](https://dell.github.io/csm-docs/docs/deployment/csmoperator/dr # Cloud types supported: This pack was designed to be used with clusters on Canonical MAAS +### Usage + +Dell Container Storage Modules Operator is a Kubernetes native application which helps in installing and managing CSI Drivers and CSM Modules provided by Dell Technologies for its various storage platforms. Dell Container Storage Modules Operator uses Kubernetes CRDs (Custom Resource Definitions) to define a manifest that describes the deployment specifications for each driver to be deployed. + +`StorageClass` are created and set as default. This creates the storageclass `vxflexos` for `powerflex-v2100`, `powermax` for `powermax-v2100` & `powerstore` for `powerstore-v2100`. + + +:::tip + +Check out the [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) to learn how to backup and restore your cluster. + +:::: + +### CSM Snapshot Controller Creation + +The Dell Container Storage Modules Operator pack supports snapshot controller creation. After selecting the right `Platform` **preset**, modify the parameter `charts.csm-operator.snapshot-controller.enabled` to enable the controller snapshotter for `powerflex-v2100`, `powermax-v2100` & `powerstore-v2100`. Default value is `true`. + +### CSM Volume Snapshot Creation + +The Dell Container Storage Modules Operator pack supports creation of volume snapshots. After selecting the right `Platform` **preset**, modify the parameter `charts.csm-operator.snapshot-controller.volumeSnapshotClass.create` to enable the creation of `VolumeSnapshotClass` for `powerflex-v2100`, `powermax-v2100` & `powerstore-v2100`. By default, it is `true` for `powerflex-v2100` & `powerstore-v2100`. By default, it is `false` for `powermax-v2100` + +### CSM Webhook Snapshot Creation + +The Dell Container Storage Modules Operator pack supports snapshot volume creation. After selecting the right `Platform` **preset**, modify the parameter`charts.csm-operator.snapshot-controller.webhook.enable` to enable the snapshot webhook for `powerflex-v2100`, `powermax-v2100` & `powerstore-v2100`. By default it is `true` for `powerflex-v2100`, `powermax-v2100` & `powerstore-v2100`. + + # References: - - https://github.com/dell/csm-operator + +- [GITHUB](https://github.com/dell/csm-operator) + +- [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) diff --git a/packs/trident-operator-v23.01.0-addon/README.md b/packs/trident-operator-v23.01.0-addon/README.md index 197a81b7..f6eab7ff 100644 --- a/packs/trident-operator-v23.01.0-addon/README.md +++ b/packs/trident-operator-v23.01.0-addon/README.md @@ -11,6 +11,8 @@ Trident is a fully supported open source project maintained by [NetApp](https:// from the ground up to help you meet your containerized applications' persistence demands using industry-standard interfaces, such as the [Container Storage Interface (CSI)](https://kubernetes-csi.github.io/docs/introduction.html). +## Usage + Trident deploys in Kubernetes clusters as pods and provides dynamic storage orchestration services for your Kubernetes workloads. It enables your containerized applications to quickly and easily consume persistent storage from NetApp’s broad portfolio that includes [ONTAP](https://www.netapp.com/data-management/ontap-data-management-software) (AFF/FAS/Select/Cloud), [Element](https://www.netapp.com/data-management/element-software) (HCI/SolidFire), as well as the [Azure NetApp Files](https://cloud.netapp.com/azure-netapp-files) service, [Cloud Volumes Service on Google Cloud](https://cloud.netapp.com/cloud-volumes-service-for-gcp), and [Amazon FSx for ONTAP](https://cloud.netapp.com/fsx-for-ontap). @@ -23,3 +25,24 @@ Detailed documentation for Trident can be found [here](https://docs.netapp.com/u Take a look at the [Astra documentation](https://docs.netapp.com/us-en/astra/) to get started today. See [NetApp's Support site](https://mysupport.netapp.com/site/info/version-support) for details on Trident's support policy under the [Trident's Release and Support Lifecycle](https://mysupport.netapp.com/site/info/trident-support) tab. + +:::tip + +Check out the [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) to learn how to backup and restore your cluster. + +:::: + +### Snapshot Creation + +The NetApp Trident operator pack supports snapshot creation. Snapshot creation requies the cluster profile to have the [Volume-Snapshot-controller](https://docs.spectrocloud.com/integrations/packs/?pack=volume-snapshot-controller) pack. You can add the Volume-Snapshot-controller pack to the cluster profile as an addon pack. Refer to the [Volume-Snapshot-controller](https://docs.spectrocloud.com/integrations/packs/?pack=volume-snapshot-controller) README for more information. + +# References: + +- [NetApp's Support site](https://mysupport.netapp.com/site/info/version-support) + +- [Trident's Release and Support Lifecycle](https://mysupport.netapp.com/site/info/trident-support) + +- [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) + + + diff --git a/packs/trident-operator-v23.01.0/README.md b/packs/trident-operator-v23.01.0/README.md index 197a81b7..2adff111 100644 --- a/packs/trident-operator-v23.01.0/README.md +++ b/packs/trident-operator-v23.01.0/README.md @@ -11,6 +11,7 @@ Trident is a fully supported open source project maintained by [NetApp](https:// from the ground up to help you meet your containerized applications' persistence demands using industry-standard interfaces, such as the [Container Storage Interface (CSI)](https://kubernetes-csi.github.io/docs/introduction.html). +## Usage Trident deploys in Kubernetes clusters as pods and provides dynamic storage orchestration services for your Kubernetes workloads. It enables your containerized applications to quickly and easily consume persistent storage from NetApp’s broad portfolio that includes [ONTAP](https://www.netapp.com/data-management/ontap-data-management-software) (AFF/FAS/Select/Cloud), [Element](https://www.netapp.com/data-management/element-software) (HCI/SolidFire), as well as the [Azure NetApp Files](https://cloud.netapp.com/azure-netapp-files) service, [Cloud Volumes Service on Google Cloud](https://cloud.netapp.com/cloud-volumes-service-for-gcp), and [Amazon FSx for ONTAP](https://cloud.netapp.com/fsx-for-ontap). @@ -23,3 +24,24 @@ Detailed documentation for Trident can be found [here](https://docs.netapp.com/u Take a look at the [Astra documentation](https://docs.netapp.com/us-en/astra/) to get started today. See [NetApp's Support site](https://mysupport.netapp.com/site/info/version-support) for details on Trident's support policy under the [Trident's Release and Support Lifecycle](https://mysupport.netapp.com/site/info/trident-support) tab. + +:::tip + +Check out the [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) to learn how to backup and restore your cluster. + +:::: + +### Snapshot Creation + +The NetApp Trident operator pack supports snapshot creation. Snapshot creation requies the cluster profile to have the [Volume-Snapshot-controller](https://docs.spectrocloud.com/integrations/packs/?pack=volume-snapshot-controller) pack. You can add the Volume-Snapshot-controller pack to the cluster profile as an addon pack. Refer to the [Volume-Snapshot-controller](https://docs.spectrocloud.com/integrations/packs/?pack=volume-snapshot-controller) README for more information. + +# References: + +- [NetApp's Support site](https://mysupport.netapp.com/site/info/version-support) + +- [Trident's Release and Support Lifecycle](https://mysupport.netapp.com/site/info/trident-support) + +- [Palette Backup and Restore Documentation](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore/) + + +