Skip to content

Commit 570ce22

Browse files
authored
docs: crd install skip flag (#507)
* docs: crd install skip flag Signed-off-by: Bala Harish <[email protected]> * docs: added the cmd for mayastor Signed-off-by: Bala Harish <[email protected]> --------- Signed-off-by: Bala Harish <[email protected]>
1 parent 5ba4086 commit 570ce22

File tree

2 files changed

+54
-8
lines changed

2 files changed

+54
-8
lines changed

docs/main/quickstart-guide/installation.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,17 @@ helm install openebs --namespace openebs openebs/openebs --create-namespace
8181
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`.
8282

8383
:::important
84-
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:
84+
- 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:
8585

86-
```
87-
helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace
88-
```
86+
```
87+
helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace
88+
```
89+
90+
- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following option:
91+
92+
```
93+
--set openebs-crds.csi.volumeSnapshots.enabled=false
94+
```
8995
:::
9096

9197
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:
@@ -102,6 +108,12 @@ If you are utilizing a custom Kubelet location or a Kubernetes distribution that
102108
--set zfs-localpv.zfsNode.kubeletDir=<your-directory-path>
103109
```
104110

111+
- For Replicated PV Mayastor
112+
113+
```
114+
--set mayastor.csi.node.kubeletDir=<your-directory-path>
115+
```
116+
105117
Specifically:
106118

107119
- 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/`.

docs/versioned_docs/version-4.1.x/quickstart-guide/installation.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,47 @@ helm install openebs --namespace openebs openebs/openebs --create-namespace
7474

7575
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`.
7676

77-
:::note
78-
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:
77+
:::important
78+
- 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:
79+
80+
```
81+
helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace
82+
```
83+
84+
- If the CustomResourceDefinitions for CSI VolumeSnapshots are already present in your cluster, you may skip their creation by using the following option:
85+
86+
```
87+
--set openebs-crds.csi.volumeSnapshots.enabled=false
88+
```
89+
:::
90+
91+
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:
92+
93+
- For Local PV LVM
7994

8095
```
81-
helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace
96+
--set lvm-localpv.lvmNode.kubeletDir=<your-directory-path>
8297
```
83-
:::
98+
99+
- For Local PV ZFS
100+
101+
```
102+
--set zfs-localpv.zfsNode.kubeletDir=<your-directory-path>
103+
```
104+
105+
- For Replicated PV Mayastor
106+
107+
```
108+
--set mayastor.csi.node.kubeletDir=<your-directory-path>
109+
```
110+
111+
Specifically:
112+
113+
- 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/`.
114+
115+
- For **k0s**, the default Kubelet directory (`/var/lib/kubelet`) must be changed to `/var/lib/k0s/kubelet/`.
116+
117+
- For **RancherOS**, the default Kubelet directory (`/var/lib/kubelet`) must be changed to `/opt/rke/var/lib/kubelet/`.
84118

85119
3. To view the chart and get the output, use the following commands:
86120

0 commit comments

Comments
 (0)