From cb121f376df4589bd3eebb2b2574dcf15a133740 Mon Sep 17 00:00:00 2001 From: Gutium Alexei Date: Fri, 7 Jun 2024 19:03:37 +0300 Subject: [PATCH] fix readme --- stacks/openebs-nfs-provisioner/README.md | 21 +++++++++++---------- stacks/openebs-nfs-provisioner/deploy.sh | 2 +- stacks/openebs-nfs-provisioner/uninstall.sh | 1 - 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/stacks/openebs-nfs-provisioner/README.md b/stacks/openebs-nfs-provisioner/README.md index 4e4ec36b..6561ebb9 100644 --- a/stacks/openebs-nfs-provisioner/README.md +++ b/stacks/openebs-nfs-provisioner/README.md @@ -9,17 +9,17 @@ Under the hood, the NFS provisioner runs a NFS server pod for each shared storag - This stack requires a minimum configuration of 2 Nodes at the $10/month plan (2GB memory / 1 vCPU). - A 1Gi block storage volume is required as well for testing the dynamic NFS provisioner. -## OpenEBS Dynamic NFS Provisioner Overview Diagram +## OpenEBS NFS Provisioner Overview Diagram The following diagram shows how OpenEBS Dynamic NFS Provisioner works on a Kubernetes cluster (based on the example used in the getting started section): -![OpenEBS Dynamic NFS Provisioner Overview](assets/images/arch_openebs.png) +![OpenEBS NFS Provisioner Overview](assets/images/arch_openebs.png) ## Software included -| Package | Application Version | Helm Chart Version | License | -| --------| ------------------- | ------------------ | ------- | -| OpenEBS Dynamic NFS provisioner | [0.11.0](https://github.com/openebs/dynamic-nfs-provisioner/tree/v0.9.0/deploy/helm/charts) | [0.9.0](https://github.com/openebs/dynamic-nfs-provisioner/releases/tag/nfs-provisioner-0.9.0) | [Apache 2.0](https://github.com/openebs/dynamic-nfs-provisioner/blob/develop/LICENSE) | +| Package | License | +| --------| ------- | +| OpenEBS NFS provisioner | [Apache 2.0](https://github.com/openebs/openebs/blob/main/LICENSE) | ### Connecting to Your Cluster @@ -273,9 +273,9 @@ Disk stats (read/write): ### Tweaking Helm Values -The OpenEBS dynamic NFS provisioner stack provides some custom values to start with. Please have a look at the [values](values.yml) file from the main GitHub repository. +The OpenEBS NFS provisioner stack provides some custom values to start with. Please have a look at the [values](values.yml) file from the main GitHub repository. -You can always inspect all the available options, as well as the default values for the OpenEBS dynamic NFS provisioner Helm chart by running below command: +You can always inspect all the available options, as well as the default values for the OpenEBS NFS provisioner Helm chart by running below command: ```console helm show values openebs-nfs/nfs-provisioner --version 0.9.0 --version 0.9.0 @@ -291,13 +291,13 @@ helm upgrade openebs-nfs-provisioner openebs-nfs/nfs-provisioner --version 0.9.0 ### Upgrading the OpenEBS Dynamic NFS Provisioner Chart -You can check what versions are available to upgrade by navigating to the [openebs/dynamic-nfs-provisioner](https://github.com/openebs/dynamic-nfs-provisioner) official releases page from GitHub. +You can check what versions are available to upgrade by navigating to the [openebs/openebs](https://github.com/openebs/openebs) official releases page from GitHub. To upgrade the stack to a newer version, run the following command, replacing the `<>` placeholders with their corresponding information: ```console helm upgrade openebs-nfs-provisioner openebs-nfs/nfs-provisioner \ - --version \ + --version \ --namespace openebs-nfs-provisioner \ --values ``` @@ -338,7 +338,8 @@ helm uninstall openebs-nfs-provisioner -n openebs-nfs-provisioner ### Additional Resources -- [OpenEBS NFS Provisioner on GitHub](https://github.com/openebs/dynamic-nfs-provisioner) +- [OpenEBS NFS Provisioner on GitHub](https://github.com/openebs/openebs) +- [Installation guide](https://openebs.io/docs/quickstart-guide/installation) - [Deploying Wordpress on DigitalOcean using OpenEBS NFS Provisioner](https://github.com/digitalocean/container-blueprints/tree/main/DOKS-wordpress) - [Configuring Node Affinity for NFS Volumes](https://github.com/openebs/dynamic-nfs-provisioner/blob/develop/docs/tutorial/node-affinity.md) - [Setting Resource requirements for NFS Server](https://github.com/openebs/dynamic-nfs-provisioner/blob/develop/docs/tutorial/configure-nfs-server-resource-requirements.md) diff --git a/stacks/openebs-nfs-provisioner/deploy.sh b/stacks/openebs-nfs-provisioner/deploy.sh index 360118d8..ac7cd649 100755 --- a/stacks/openebs-nfs-provisioner/deploy.sh +++ b/stacks/openebs-nfs-provisioner/deploy.sh @@ -5,7 +5,7 @@ set -e ################################################################################ # repo ################################################################################ -helm repo add openebs https://openebs.github.io/charts +helm repo add openebs https://openebs.github.io/openebs helm repo update > /dev/null ################################################################################ diff --git a/stacks/openebs-nfs-provisioner/uninstall.sh b/stacks/openebs-nfs-provisioner/uninstall.sh index 37a0c826..f58bb51e 100644 --- a/stacks/openebs-nfs-provisioner/uninstall.sh +++ b/stacks/openebs-nfs-provisioner/uninstall.sh @@ -8,7 +8,6 @@ set -e STACK="openebs-nfs-provisioner" NAMESPACE="openebs-nfs-provisioner" - helm uninstall "$STACK" \ --namespace "$NAMESPACE"