From 621fd8b91d85ba053dc4b25f4ac0b988e1929f5e Mon Sep 17 00:00:00 2001 From: coulof <49235405+coulof@users.noreply.github.com> Date: Mon, 13 May 2024 16:16:57 +0200 Subject: [PATCH] Restructure the left menu & reference ; remove FAQ (#1075) --- content/docs/_index.md | 4 +- content/docs/references/FAQ/_index.md | 112 ------------------ content/docs/references/_index.md | 7 -- content/docs/references/policies/_index.md | 7 -- content/docs/securitypolicy/_index.md | 15 --- content/docs/support/_index.md | 16 ++- content/docs/{ => support}/cert-csi/_index.md | 2 +- .../{ => support}/cert-csi/img/HTMLReport.png | Bin .../cert-csi/img/interruptTest.png | Bin .../{ => support}/cert-csi/img/listRuns.png | Bin .../{ => support}/cert-csi/img/longevity.png | Bin .../cert-csi/img/multiDBTabularReport.png | Bin .../cert-csi/img/resourceUsage.png | Bin .../{ => support}/cert-csi/img/scaling.PNG | Bin .../cert-csi/img/tabularReport.png | Bin .../{ => support}/cert-csi/img/textReport.png | Bin .../cert-csi/img/unifiedTest.png | Bin .../docs/{ => support}/cert-csi/qualified.md | 0 .../{references => support}/cli/_index.md | 2 +- .../contributionguidelines/_index.md | 2 +- .../deprecationpolicy/_index.md | 2 +- .../{references => support}/learn/_index.md | 4 +- content/docs/{ => support}/license/_index.md | 4 +- content/docs/{ => support}/release/_index.md | 2 +- .../{ => support}/troubleshooting/_index.md | 2 +- 25 files changed, 26 insertions(+), 155 deletions(-) delete mode 100644 content/docs/references/FAQ/_index.md delete mode 100644 content/docs/references/_index.md delete mode 100644 content/docs/references/policies/_index.md delete mode 100644 content/docs/securitypolicy/_index.md rename content/docs/{ => support}/cert-csi/_index.md (99%) rename content/docs/{ => support}/cert-csi/img/HTMLReport.png (100%) rename content/docs/{ => support}/cert-csi/img/interruptTest.png (100%) rename content/docs/{ => support}/cert-csi/img/listRuns.png (100%) rename content/docs/{ => support}/cert-csi/img/longevity.png (100%) rename content/docs/{ => support}/cert-csi/img/multiDBTabularReport.png (100%) rename content/docs/{ => support}/cert-csi/img/resourceUsage.png (100%) rename content/docs/{ => support}/cert-csi/img/scaling.PNG (100%) rename content/docs/{ => support}/cert-csi/img/tabularReport.png (100%) rename content/docs/{ => support}/cert-csi/img/textReport.png (100%) rename content/docs/{ => support}/cert-csi/img/unifiedTest.png (100%) rename content/docs/{ => support}/cert-csi/qualified.md (100%) rename content/docs/{references => support}/cli/_index.md (99%) rename content/docs/{references => support}/contributionguidelines/_index.md (99%) rename content/docs/{references/policies => support}/deprecationpolicy/_index.md (99%) rename content/docs/{references => support}/learn/_index.md (95%) rename content/docs/{ => support}/license/_index.md (94%) rename content/docs/{ => support}/release/_index.md (98%) rename content/docs/{ => support}/troubleshooting/_index.md (98%) diff --git a/content/docs/_index.md b/content/docs/_index.md index 3510637cbb..127367ddfd 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -58,10 +58,10 @@ CSM is made up of multiple components including modules (enterprise capabilities {{< /card >}} {{< /cardpane >}} {{< cardpane >}} - {{< card header="[License](license/)" + {{< card header="[License](support/license/)" footer="Required for [Application Mobility](applicationmobility/) & [Encryption](secure/encryption/)">}} The tech-preview releases of Application Mobility and Encryption require a license. 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/) + [...Learn more](support/license/) {{< /card >}} {{< /cardpane >}} \ No newline at end of file diff --git a/content/docs/references/FAQ/_index.md b/content/docs/references/FAQ/_index.md deleted file mode 100644 index 19199ffd2d..0000000000 --- a/content/docs/references/FAQ/_index.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "CSM FAQ" -linktitle: "FAQ" -description: Frequently asked questions of Dell Technologies (Dell) Container Storage Modules -weight: 1 ---- - -- [What are Dell Container Storage Modules (CSM)? How different is it from a CSI driver?](#what-are-dell-container-storage-modules-csm-how-different-is-it-from-a-csi-driver) -- [Where do I start with Dell Container Storage Modules (CSM)?](#where-do-i-start-with-dell-container-storage-modules-csm) -- [What are the prerequisites for deploying Container Storage Modules?](#what-are-the-prerequisites-for-deploying-container-storage-modules) -- [How do I uninstall or disable a module?](#how-do-i-uninstall-or-disable-a-module) -- [How do I troubleshoot Container Storage Modules?](#how-do-i-troubleshoot-container-storage-modules) -- [Can I use the CSM functionality like Prometheus collection or Authorization quotas for my non-Kubernetes storage clients?](#can-i-use-the-csm-functionality-like-prometheus-collection-or-authorization-quotas-for-my-non-kubernetes-storage-clients) -- [Should I install the module in the same namespace as the driver or another?](#should-i-install-the-module-in-the-same-namespace-as-the-driver-or-another) -- [Which Kubernetes distributions are supported?](#which-kubernetes-distributions-are-supported) -- [How do I get a list of Container Storage Modules deployed in my cluster with their versions?](#how-do-i-get-a-list-of-container-storage-modules-deployed-in-my-cluster-with-their-versions) -- [Do all Container Storage Modules need to be the same version, or can I mix and match?](#do-all-container-storage-modules-need-to-be-the-same-version-or-can-i-mix-and-match) -- [Can I run Container Storage Modules in a production environment?](#can-i-run-container-storage-modules-in-a-production-environment) -- [Is Dell Container Storage Modules (CSM) supported by Dell Technologies?](#is-dell-container-storage-modules-csm-supported-by-dell-technologies) -- [Can I modify a module or contribute to the project?](#can-i-modify-a-module-or-contribute-to-the-project) -- [What is coming next?](#what-is-coming-next) - -### What are Dell Container Storage Modules (CSM)? How different is it from a CSI driver? -Dell **C**ontainer **S**torage **M**odules are a set of modules that aim to extend features beyond what is available in the [CSI specification](https://kubernetes-csi.github.io/docs/). - -The main goal with CSM modules is to expose storage array enterprise features directly within Kubernetes so developers are empowered to leverage them for their deployment in a seamless way. - -### Where do I start with Dell Container Storage Modules (CSM)? -The umbrella repository for every Dell Container Storage Module is: [https://github.com/dell/csm](https://github.com/dell/csm). - -### What are the prerequisites for deploying Container Storage Modules? -Prerequisites can be found on the respective module deployment pages: -- [Dell Container Storage Module for Observability Deployment](../../deployment/helm/modules/installation/observability/deployment#prerequisites) -- [Dell Container Storage Module for Authorization Deployment](../../deployment/helm/modules/installation/authorization#prerequisites) -- [Dell Container Storage Module for Resiliency Deployment](../../deployment/helm/modules/installation/resiliency) -- [Dell Container Storage Module for Replication Deployment](../../deployment/helm/modules/installation/replication/installation/#before-you-begin) -- [Dell Container Storage Module for Application Mobility Deployment](../../deployment/helm/modules/installation/applicationmobility#pre-requisites) -- [Dell Container Storage Module for Encryption Deployment](../../deployment/helm/modules/installation/encryption#vault-server) - -Prerequisites for deploying the Dell CSI drivers can be found here: -- [Dell CSI Drivers Deployment](../../deployment/helm/drivers/installation/) - -### How do I uninstall or disable a module? -- [Dell Container Storage Module for Authorization](../../deployment/helm/modules/uninstall/authorization/) -- [Dell Container Storage Module for Observability](../../deployment/helm/modules/uninstall/observability/) -- [Dell Container Storage Module for Resiliency](../../deployment/helm/modules/uninstall/resiliency/) -- [Dell Container Storage Module for Replication](../../deployment/helm/modules/uninstall/replication/) -- [Dell Container Storage Module for Application Mobility](../../deployment/helm/modules/uninstall/applicationmobility/) -- [Dell Container Storage Module for Encryption](../../deployment/helm/modules/uninstall/encryption/) - -### How do I troubleshoot Container Storage Modules? -- [Dell CSI Drivers](../../csidriver/troubleshooting/) -- [Dell Container Storage Module for Authorization](../../authorization/troubleshooting/) -- [Dell Container Storage Module for Observability](../../observability/troubleshooting/) -- [Dell Container Storage Module for Replication](../../replication/troubleshooting/) -- [Dell Container Storage Module for Resiliency](../../resiliency/troubleshooting/) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/troubleshooting/) -- [Dell Container Storage Module for Encryption](../../secure/encryption/troubleshooting/) - -### Can I use the CSM functionality like Prometheus collection or Authorization quotas for my non-Kubernetes storage clients? -No, all the modules have been designed to work inside Kubernetes with Dell CSI drivers. - -### Should I install the module in the same namespace as the driver or another? -It is recommended to install CSM for Observability in a namespace separate from the Dell CSI drivers because it works across multiple drivers. All other modules either run as standalone or with the Dell CSI driver as a sidecar. - -### Which Kubernetes distributions are supported? -The supported Kubernetes distributions for Container Storage Modules are documented: -- [Dell Container Storage Module for Authorization](../../authorization/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Observability](../../observability/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Replication](../../replication/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Resiliency](../../resiliency/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Encryption](../../secure/encryption/#supported-operating-systemscontainer-orchestrator-platforms) - -The supported distros for the Dell CSI Drivers are located [here](../../csidriver/#supported-operating-systemscontainer-orchestrator-platforms). - -### How do I get a list of Container Storage Modules deployed in my cluster with their versions? -The easiest way to find the module version is to check the image tag for the module. For all the namespaces you can execute the following: -``` -kubectl get pods -A -o jsonpath="{..image}" | tr -s '[[:space:]]' '\n' | grep 'csm\|karavi' | sort | uniq -c -``` -Or if you know the namespace: -``` -kubectl get deployment,daemonset -o wide -n {{namespace}} -``` - -### Do all Container Storage Modules need to be the same version, or can I mix and match? -It is advised to comply with the support matrices (links below) and not deviate from it with mixed versions. -- [Dell Container Storage Module for Authorization](../../authorization/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Observability](../../observability/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Replication](../../replication/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Resiliency](../../resiliency/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Application Mobility](../../applicationmobility/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell Container Storage Module for Encryption](../../secure/encryption/#supported-operating-systemscontainer-orchestrator-platforms) -- [Dell CSI Drivers](../../csidriver/#supported-operating-systemscontainer-orchestrator-platforms). - -### Can I run Container Storage Modules in a production environment? - -Currently, the Container Storage Modules Authorization, Observability, Replication, and Resiliency are GA and ready for production systems. The modules Encryption and Application Mobility are launched for Tech Preview Release and it is not intended to use in the Production systems. - -### Is Dell Container Storage Modules (CSM) supported by Dell Technologies? -Yes! - -If you find an issue, please follow our [support process](../../support/) - -### Can I modify a module or contribute to the project? -Yes! - -All Container Storage Modules are released as open-source projects under Apache-2.0 License. You are free to contribute directly following the [contribution guidelines](https://github.com/dell/csm/blob/main/docs/CONTRIBUTING.md), fork the projects, modify them, and of course share feedback or open tickets ;-) - -### What is coming next? -This is just the beginning of the journey for Dell Container Storage Modules, and there is a full roadmap with more to come, which you can check under the [GitHub Milestones](https://github.com/dell/csm/milestones) page. diff --git a/content/docs/references/_index.md b/content/docs/references/_index.md deleted file mode 100644 index ce3be78438..0000000000 --- a/content/docs/references/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "References" -linkTitle: "References" -weight: 14 -Description: > - Dell Technologies (Dell) Container Storage Modules (CSM) References ---- diff --git a/content/docs/references/policies/_index.md b/content/docs/references/policies/_index.md deleted file mode 100644 index a5e2875d16..0000000000 --- a/content/docs/references/policies/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Policies" -linkTitle: "Policies" -weight: 4 -Description: > - Dell Technologies (Dell) Container Storage Modules (CSM) Policies ---- diff --git a/content/docs/securitypolicy/_index.md b/content/docs/securitypolicy/_index.md deleted file mode 100644 index 06223eb64f..0000000000 --- a/content/docs/securitypolicy/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Security Policy" -linkTitle: "Security Policy" -weight: 13 -Description: > - Dell Container Storage Modules (CSM) Security Policy ---- - -# Reporting Security Issues/Vulnerabilities - -The Dell Container Storage Modules team and community take security bugs seriously. We sincerely appreciate all your efforts and responsibility to disclose your findings. - -To report a security issue, please submit the security advisory form ["Report a Vulnerability"](https://github.com/dell/csm/security/advisories/new). - ->CSM recommends staying on the [latest release](https://github.com/dell/csm/releases/latest) of Dell Container Storage Modules to take advantage of new features, enhancements, bug fixes, and security fixes. diff --git a/content/docs/support/_index.md b/content/docs/support/_index.md index 54535f32f8..1cea4e05c9 100644 --- a/content/docs/support/_index.md +++ b/content/docs/support/_index.md @@ -5,7 +5,19 @@ weight: 13 Description: > Dell Container Storage Modules (CSM) support --- - +### Where can I get support ? For all your support needs or to follow the latest ongoing discussions and updates, join our Slack group. Click [Here](http://del.ly/Slack_request) to request your invite. -You can also interact with us on [GitHub](https://github.com/dell/csm) by creating a [GitHub Issue](https://github.com/dell/csm/issues). \ No newline at end of file +You can also interact with us on [GitHub](https://github.com/dell/csm) by creating a [GitHub Issue](https://github.com/dell/csm/issues). + +If you have a support contract for a Dell Storage Backend that has a CSI Driver you can open a service request on [https://dell.com/support](https://dell.com/support) and select the **CSI Driver** product. + + +### How to report Security Issues or Vulnerabilities ? + +The Dell Container Storage Modules team and community take security bugs seriously. We sincerely appreciate all your efforts and responsibility to disclose your findings. + +To report a security issue, please submit the security advisory form ["Report a Vulnerability"](https://github.com/dell/csm/security/advisories/new). + +>CSM recommends staying on the [latest release](https://github.com/dell/csm/releases/latest) of Dell Container Storage Modules to take advantage of new features, enhancements, bug fixes, and security fixes. + diff --git a/content/docs/cert-csi/_index.md b/content/docs/support/cert-csi/_index.md similarity index 99% rename from content/docs/cert-csi/_index.md rename to content/docs/support/cert-csi/_index.md index d5993d4bce..ddac9c353d 100644 --- a/content/docs/cert-csi/_index.md +++ b/content/docs/support/cert-csi/_index.md @@ -1,7 +1,7 @@ --- title: Cert-CSI linktitle: Cert-CSI -weight: 13 +weight: 3 description: Tool to validate Dell CSI Drivers --- diff --git a/content/docs/cert-csi/img/HTMLReport.png b/content/docs/support/cert-csi/img/HTMLReport.png similarity index 100% rename from content/docs/cert-csi/img/HTMLReport.png rename to content/docs/support/cert-csi/img/HTMLReport.png diff --git a/content/docs/cert-csi/img/interruptTest.png b/content/docs/support/cert-csi/img/interruptTest.png similarity index 100% rename from content/docs/cert-csi/img/interruptTest.png rename to content/docs/support/cert-csi/img/interruptTest.png diff --git a/content/docs/cert-csi/img/listRuns.png b/content/docs/support/cert-csi/img/listRuns.png similarity index 100% rename from content/docs/cert-csi/img/listRuns.png rename to content/docs/support/cert-csi/img/listRuns.png diff --git a/content/docs/cert-csi/img/longevity.png b/content/docs/support/cert-csi/img/longevity.png similarity index 100% rename from content/docs/cert-csi/img/longevity.png rename to content/docs/support/cert-csi/img/longevity.png diff --git a/content/docs/cert-csi/img/multiDBTabularReport.png b/content/docs/support/cert-csi/img/multiDBTabularReport.png similarity index 100% rename from content/docs/cert-csi/img/multiDBTabularReport.png rename to content/docs/support/cert-csi/img/multiDBTabularReport.png diff --git a/content/docs/cert-csi/img/resourceUsage.png b/content/docs/support/cert-csi/img/resourceUsage.png similarity index 100% rename from content/docs/cert-csi/img/resourceUsage.png rename to content/docs/support/cert-csi/img/resourceUsage.png diff --git a/content/docs/cert-csi/img/scaling.PNG b/content/docs/support/cert-csi/img/scaling.PNG similarity index 100% rename from content/docs/cert-csi/img/scaling.PNG rename to content/docs/support/cert-csi/img/scaling.PNG diff --git a/content/docs/cert-csi/img/tabularReport.png b/content/docs/support/cert-csi/img/tabularReport.png similarity index 100% rename from content/docs/cert-csi/img/tabularReport.png rename to content/docs/support/cert-csi/img/tabularReport.png diff --git a/content/docs/cert-csi/img/textReport.png b/content/docs/support/cert-csi/img/textReport.png similarity index 100% rename from content/docs/cert-csi/img/textReport.png rename to content/docs/support/cert-csi/img/textReport.png diff --git a/content/docs/cert-csi/img/unifiedTest.png b/content/docs/support/cert-csi/img/unifiedTest.png similarity index 100% rename from content/docs/cert-csi/img/unifiedTest.png rename to content/docs/support/cert-csi/img/unifiedTest.png diff --git a/content/docs/cert-csi/qualified.md b/content/docs/support/cert-csi/qualified.md similarity index 100% rename from content/docs/cert-csi/qualified.md rename to content/docs/support/cert-csi/qualified.md diff --git a/content/docs/references/cli/_index.md b/content/docs/support/cli/_index.md similarity index 99% rename from content/docs/references/cli/_index.md rename to content/docs/support/cli/_index.md index f27b4925cf..d2dc3763e0 100644 --- a/content/docs/references/cli/_index.md +++ b/content/docs/support/cli/_index.md @@ -1,7 +1,7 @@ --- title: "CLI" linkTitle: "CLI" -weight: 1 +weight: 4 Description: > CLI for Dell Container Storage Modules (CSM) --- diff --git a/content/docs/references/contributionguidelines/_index.md b/content/docs/support/contributionguidelines/_index.md similarity index 99% rename from content/docs/references/contributionguidelines/_index.md rename to content/docs/support/contributionguidelines/_index.md index 427bd231af..633c8c6977 100644 --- a/content/docs/references/contributionguidelines/_index.md +++ b/content/docs/support/contributionguidelines/_index.md @@ -1,7 +1,7 @@ --- title: "Contribution Guidelines" linkTitle: "Contribution Guidelines" -weight: 3 +weight: 5 Description: > Dell Technologies (Dell) Container Storage Modules (CSM) docs Contribution Guidelines --- diff --git a/content/docs/references/policies/deprecationpolicy/_index.md b/content/docs/support/deprecationpolicy/_index.md similarity index 99% rename from content/docs/references/policies/deprecationpolicy/_index.md rename to content/docs/support/deprecationpolicy/_index.md index 19a4783ba1..c21a1d5fab 100644 --- a/content/docs/references/policies/deprecationpolicy/_index.md +++ b/content/docs/support/deprecationpolicy/_index.md @@ -1,7 +1,7 @@ --- title: "Deprecation Policy" linkTitle: "Deprecation Policy" -weight: 1 +weight: 4 Description: > Dell Technologies (Dell) Container Storage Modules (CSM) Deprecation Policy --- diff --git a/content/docs/references/learn/_index.md b/content/docs/support/learn/_index.md similarity index 95% rename from content/docs/references/learn/_index.md rename to content/docs/support/learn/_index.md index 51dcf458c4..482e079410 100644 --- a/content/docs/references/learn/_index.md +++ b/content/docs/support/learn/_index.md @@ -1,7 +1,7 @@ --- -title: Learn +title: Learn more about CSM Description: Blogs and Youtube videos for CSM -weight: 2 +weight: 7 --- You can learn more and engage with the CSM community over different channels by: * Reading the official [blogs](https://infohub.delltechnologies.com/t/blogs-99/) and [white paper](https://infohub.delltechnologies.com/t/persistent-storage-for-containerized-applications-on-kubernetes-with-powermax-san-storage-13/) are on [https://infohub.delltechnologies.com/](https://infohub.delltechnologies.com/) diff --git a/content/docs/license/_index.md b/content/docs/support/license/_index.md similarity index 94% rename from content/docs/license/_index.md rename to content/docs/support/license/_index.md index ec7bd9d734..c12954dba9 100644 --- a/content/docs/license/_index.md +++ b/content/docs/support/license/_index.md @@ -1,9 +1,9 @@ --- title: "License" linkTitle: "License" -weight: 12 +weight: 6 Description: > - Dell Container Storage Modules (CSM) License + Obtain trial License for Tech-preview of Dell Container Storage Modules (CSM) --- The tech-preview releases of [Container Storage Modules](https://github.com/dell/csm) for Application Mobility and Encryption require a license. This section details how to request a license. diff --git a/content/docs/release/_index.md b/content/docs/support/release/_index.md similarity index 98% rename from content/docs/release/_index.md rename to content/docs/support/release/_index.md index 248ba5ebae..cb79438dc0 100644 --- a/content/docs/release/_index.md +++ b/content/docs/support/release/_index.md @@ -1,7 +1,7 @@ --- title: "Release notes" linkTitle: "Release notes" -weight: 12 +weight: 1 Description: > Dell Container Storage Modules (CSM) release notes --- diff --git a/content/docs/troubleshooting/_index.md b/content/docs/support/troubleshooting/_index.md similarity index 98% rename from content/docs/troubleshooting/_index.md rename to content/docs/support/troubleshooting/_index.md index 07e9260af6..11dea7fc9c 100644 --- a/content/docs/troubleshooting/_index.md +++ b/content/docs/support/troubleshooting/_index.md @@ -1,7 +1,7 @@ --- title: "Troubleshooting" linkTitle: "Troubleshooting" -weight: 11 +weight: 2 Description: > Dell Container Storage Modules (CSM) troubleshooting information ---