From 104ebeb5af627005c72f75086068e6cd0c2adc9e Mon Sep 17 00:00:00 2001 From: Bala Harish <161304963+balaharish7@users.noreply.github.com> Date: Tue, 10 Dec 2024 14:53:45 +0530 Subject: [PATCH 1/2] docs: crd install skip flag Signed-off-by: Bala Harish <161304963+balaharish7@users.noreply.github.com> --- docs/main/quickstart-guide/installation.md | 14 ++++++++++---- .../quickstart-guide/installation.md | 16 +++++++++++----- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/main/quickstart-guide/installation.md b/docs/main/quickstart-guide/installation.md index 8ea74e67..c121c63a 100644 --- a/docs/main/quickstart-guide/installation.md +++ b/docs/main/quickstart-guide/installation.md @@ -81,11 +81,17 @@ helm install openebs --namespace openebs openebs/openebs --create-namespace The above command will install OpenEBS Local PV Hostpath, OpenEBS Local PV LVM, OpenEBS Local PV ZFS, and OpenEBS Replicated Storage components in `openebs` namespace and chart name as `openebs`. :::important -The default OpenEBS helm chart will install both Local Storage and Replicated Storage. If you do not want to install OpenEBS Replicated Storage, use the following command: +- The default OpenEBS helm chart will install both Local Storage and Replicated Storage. If you do not want to install OpenEBS Replicated Storage, use the following command: -``` -helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace -``` + ``` + helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace + ``` + +- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following command: + + ``` + --set openebs-crds.csi.volumeSnapshots.enabled=false + ``` ::: If you are utilizing a custom Kubelet location or a Kubernetes distribution that uses a custom Kubelet location, it is necessary to modify the Kubelet directory in the Helm values at installation time. This can be accomplished by using the `--set` flag option in the Helm install command, as follows: diff --git a/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md b/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md index d9d7cb3d..f1ac9342 100644 --- a/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md +++ b/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md @@ -74,12 +74,18 @@ helm install openebs --namespace openebs openebs/openebs --create-namespace The above commands will install OpenEBS Local PV Hostpath, OpenEBS Local PV LVM, OpenEBS Local PV ZFS, and OpenEBS Replicated Storage components in `openebs` namespace and chart name as `openebs`. -:::note -The default OpenEBS helm chart will install both Local Storage and Replicated Storage. If you do not want to install OpenEBS Replicated Storage, use the following command: +:::important +- The default OpenEBS helm chart will install both Local Storage and Replicated Storage. If you do not want to install OpenEBS Replicated Storage, use the following command: -``` -helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace -``` + ``` + helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace + ``` + +- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following command: + + ``` + --set openebs-crds.csi.volumeSnapshots.enabled=false + ``` ::: 3. To view the chart and get the output, use the following commands: From d77c038fd184b1f4c65ad571f3b5dcfe30ff2759 Mon Sep 17 00:00:00 2001 From: Bala Harish <161304963+balaharish7@users.noreply.github.com> Date: Tue, 24 Dec 2024 17:26:23 +0530 Subject: [PATCH 2/2] docs: added the cmd for mayastor Signed-off-by: Bala Harish <161304963+balaharish7@users.noreply.github.com> --- docs/main/quickstart-guide/installation.md | 8 ++++- .../quickstart-guide/installation.md | 30 ++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/docs/main/quickstart-guide/installation.md b/docs/main/quickstart-guide/installation.md index c121c63a..2c47ecaa 100644 --- a/docs/main/quickstart-guide/installation.md +++ b/docs/main/quickstart-guide/installation.md @@ -87,7 +87,7 @@ The above command will install OpenEBS Local PV Hostpath, OpenEBS Local PV LVM, helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace ``` -- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following command: +- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following option: ``` --set openebs-crds.csi.volumeSnapshots.enabled=false @@ -108,6 +108,12 @@ If you are utilizing a custom Kubelet location or a Kubernetes distribution that --set zfs-localpv.zfsNode.kubeletDir= ``` +- For Replicated PV Mayastor + +``` +--set mayastor.csi.node.kubeletDir= +``` + Specifically: - For **MicroK8s**, the Kubelet directory must be updated to `/var/snap/microk8s/common/var/lib/kubelet/` by replacing the default `/var/lib/kubelet/` with `/var/snap/microk8s/common/var/lib/kubelet/`. diff --git a/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md b/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md index f1ac9342..1d7daa23 100644 --- a/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md +++ b/docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md @@ -81,13 +81,41 @@ The above commands will install OpenEBS Local PV Hostpath, OpenEBS Local PV LVM, helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace ``` -- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following command: +- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following option: ``` --set openebs-crds.csi.volumeSnapshots.enabled=false ``` ::: +If you are utilizing a custom Kubelet location or a Kubernetes distribution that uses a custom Kubelet location, it is necessary to modify the Kubelet directory in the Helm values at installation time. This can be accomplished by using the `--set` flag option in the Helm install command, as follows: + +- For Local PV LVM + +``` +--set lvm-localpv.lvmNode.kubeletDir= +``` + +- For Local PV ZFS + +``` +--set zfs-localpv.zfsNode.kubeletDir= +``` + +- For Replicated PV Mayastor + +``` +--set mayastor.csi.node.kubeletDir= +``` + +Specifically: + +- For **MicroK8s**, the Kubelet directory must be updated to `/var/snap/microk8s/common/var/lib/kubelet/` by replacing the default `/var/lib/kubelet/` with `/var/snap/microk8s/common/var/lib/kubelet/`. + +- For **k0s**, the default Kubelet directory (`/var/lib/kubelet`) must be changed to `/var/lib/k0s/kubelet/`. + +- For **RancherOS**, the default Kubelet directory (`/var/lib/kubelet`) must be changed to `/opt/rke/var/lib/kubelet/`. + 3. To view the chart and get the output, use the following commands: **Command**