Skip to content

Commit

Permalink
feat: doc: add doc for hostpath directory mode
Browse files Browse the repository at this point in the history
  • Loading branch information
sushiMix committed May 11, 2023
1 parent fb035dd commit 4912238
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

A Kubernetes cluster with Kubernetes v1.16 or above.
A Kubernetes cluster with Kubernetes v1.16 or above.

For more platform-specific installation instructions, [click here](./installation/platforms/).

Expand All @@ -13,12 +13,12 @@ Install OpenEBS Dynamic LocalPV Provisioner using the openebs helm chart. Sample
#helm repo update
helm install openebs openebs/openebs -n openebs --create-namespace
```

<details>
<summary>Click here for configuration options.</summary>

1. Install OpenEBS Dynamic LocalPV Provisioner without NDM.
1. Install OpenEBS Dynamic LocalPV Provisioner without NDM.

You may choose to exclude the NDM subchart from installation if...
- you want to only use OpenEBS LocalPV Hostpath
- you already have NDM installed. Check if NDM pods exist with the command `kubectl get pods -n openebs -l 'openebs.io/component-name in (ndm, ndm-operator)'`
Expand All @@ -35,7 +35,7 @@ helm install openebs openebs/openebs -n openebs --create-namespace \
--set ndmOperator.enabled=false \
--set localprovisioner.deviceClass.enabled=false
```
3. Install OpenEBS Dynamic LocalPV Provisioner with a custom hostpath directory.
3. Install OpenEBS Dynamic LocalPV Provisioner with a custom hostpath directory.
This will change the `BasePath` value for the 'openebs-hostpath' StorageClass.
```console
helm install openebs openebs/openebs -n openebs --create-namespace \
Expand Down Expand Up @@ -92,6 +92,9 @@ You can provision LocalPV hostpath StorageType volumes dynamically using the def
# hostpath directory
#- name: BasePath
# value: "/var/openebs/local"
#Use this to set a specific mode for directory creation
#- name: HostPathMode
# value: 0770
provisioner: openebs.io/local
reclaimPolicy: Delete
#It is necessary to have volumeBindingMode as WaitForFirstConsumer
Expand Down

0 comments on commit 4912238

Please sign in to comment.