135 lines
10 KiB
Markdown
135 lines
10 KiB
Markdown
# OpenEBS Helm Repository
|
|
|
|
<img width="200" align="right" alt="OpenEBS Logo" src="https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/stacked/color/openebs-stacked-color.png" xmlns="http://www.w3.org/1999/html">
|
|
|
|
[OpenEBS](https://openebs.io) helps Developers and Platform SREs easily deploy Kubernetes Stateful Workloads that require fast and highly reliable container attached storage. OpenEBS can be deployed on any Kubernetes cluster - either in cloud, on-premise (virtual or bare metal) or developer system (minikube).
|
|
|
|
OpenEBS Data Engines and Control Plane are implemented as micro-services, deployed as containers and orchestrated by Kubernetes itself. An added advantage of being a completely Kubernetes native solution is that administrators and developers can interact and manage OpenEBS using all the wonderful tooling that is available for Kubernetes like kubectl, Helm, Prometheus, Grafana, etc.
|
|
|
|
OpenEBS turns any storage available on the Kubernetes worker nodes into local or distributed Kubernetes Persistent Volumes.
|
|
|
|
#### Local PV
|
|
|
|
Local Volumes are accessible only from a single node in the cluster. Pods using Local Volume have to be scheduled on the node where volume is provisioned. Local Volumes are typically preferred for distributed workloads like Cassandra, MongoDB, Elastic, etc that are distributed in nature and have high availability built into them. Depending on the type of storage attached to the Kubernetes worker, OpenEBS offers different flavors of Local PV - Hostpath, LVM, ZFS and Rawfile.
|
|
|
|
#### Replicated PV
|
|
|
|
Replicated Volumes as the name suggests, are those that have their data synchronously replicated to multiple nodes. Volumes can sustain node failures. The replication also can be setup across availability zones helping applications move across availability zones. OpenEBS offers Replicated PV Mayastor as an replicated storage solution, which provides high availability and high performance.
|
|
|
|
## Documentation and user guides
|
|
|
|
OpenEBS can run on any Kubernetes 1.23+ cluster in a matter of minutes. See the [Quickstart Guide to OpenEBS](https://openebs.io/docs/quickstart-guide/installation) for detailed instructions.
|
|
|
|
## Getting started
|
|
|
|
### How to customize OpenEBS Helm chart?
|
|
|
|
OpenEBS Helm chart is a unified Helm chart that pulls together engine specific charts. The engine charts are included as [dependencies](https://github.com/openebs/openebs/tree/HEAD/charts/Chart.yaml).
|
|
|
|
```bash
|
|
openebs
|
|
├── (default) Local PV HostPath
|
|
├── (default) Local PV LVM
|
|
├── (default) Local PV ZFS
|
|
├── (default) Local PV Rawfile
|
|
└── (default) Replicated PV Mayastor
|
|
```
|
|
|
|
### Prerequisites
|
|
|
|
- [Local PV Hostpath Prerequisites](https://openebs.io/docs/quickstart-guide/prerequisites#local-pv-hostpath-prerequisites)
|
|
- [Local PV LVM Prerequisites](https://openebs.io/docs/quickstart-guide/prerequisites#local-pv-lvm-prerequisites)
|
|
- [Local PV ZFS Prerequisites](https://openebs.io/docs/quickstart-guide/prerequisites#local-pv-zfs-prerequisites)
|
|
- [Replicated PV Mayastor Prerequisites](https://openebs.io/docs/quickstart-guide/prerequisites#replicated-pv-mayastor-prerequisites)
|
|
|
|
### Setup Helm Repository
|
|
|
|
Before installing OpenEBS Helm chart, the [OpenEBS Helm repository](https://openebs.github.io/openebs) needs to be added to the Helm client.
|
|
|
|
#### Setup Helm repository
|
|
|
|
```bash
|
|
helm repo add openebs https://openebs.github.io/openebs
|
|
helm repo update
|
|
```
|
|
|
|
#### Install OpenEBS Helm chart with default values.
|
|
|
|
```bash
|
|
helm install openebs --namespace openebs openebs/openebs --create-namespace
|
|
```
|
|
|
|
The above commands will install OpenEBS LocalPV Hostpath, OpenEBS LocalPV LVM, OpenEBS LocalPV ZFS and OpenEBS Mayastor components in openebs namespace with chart name as openebs.
|
|
|
|
Replicated PV Mayastor can be excluded during the installation with the following command:
|
|
|
|
```bash
|
|
helm install openebs --namespace openebs openebs/openebs --set engines.replicated.mayastor.enabled=false --create-namespace
|
|
```
|
|
|
|
As a next step [verify the installation](https://openebs.io/docs/quickstart-guide/installation#verifying-openebs-installation) and do the [post installation](https://openebs.io/docs/quickstart-guide/installation#post-installation-considerations) steps.
|
|
|
|
For more details on customizing and installing OpenEBS please see the [chart values](https://github.com/openebs/openebs/tree/HEAD/charts/README.md).
|
|
|
|
### To uninstall/delete instance with release name
|
|
|
|
```bash
|
|
helm delete `<RELEASE NAME>` -n `<RELEASE NAMESPACE>`
|
|
```
|
|
|
|
> **Tip**: Prior to deleting the Helm chart, make sure all the storage volumes and pools are deleted.
|
|
|
|
## Chart Dependencies
|
|
|
|
| Repository | Name | Version |
|
|
|------------|------|---------|
|
|
| | openebs-crds | 4.6.1-prerelease |
|
|
| https://grafana.github.io/helm-charts | alloy | 1.0.1 |
|
|
| https://grafana.github.io/helm-charts | loki | 6.29.0 |
|
|
| https://openebs.github.io/dynamic-localpv-provisioner | localpv-provisioner | 4.6.0 |
|
|
| https://openebs.github.io/lvm-localpv | lvm-localpv | 1.10.1 |
|
|
| https://openebs.github.io/mayastor-extensions | mayastor | 2.12.1 |
|
|
| https://openebs.github.io/rawfile-localpv | rawfile-localpv | 0.15.1 |
|
|
| https://openebs.github.io/zfs-localpv | zfs-localpv | 2.11.1 |
|
|
|
|
## Values
|
|
|
|
| Key | Description | Default |
|
|
|:----|:------------|:--------|
|
|
| alloy.​enabled | Enable/Disable Alloy. | `true` |
|
|
| alloy.​logging_config.​labels | Labels to enable scraping on, at-least one of these labels should be present. | <pre>{<br>"openebs.io/logging":true<br>}</pre> |
|
|
| alloy.​logging_config.​tenant_id | X-Scope-OrgID to be populated when pushing logs. Make sure the caller also uses the same. | `"openebs"` |
|
|
| engines.​local.​hostpath.​enabled | Enable/Disable Dynamic LocalPV Provisioner | `true` |
|
|
| engines.​local.​lvm.​enabled | Enable/Disable LocalPV LVM Storage Engine | `true` |
|
|
| engines.​local.​rawfile.​enabled | Enable/Disable LocalPV Rawfile Storage Engine | `false` |
|
|
| engines.​local.​zfs.​enabled | Enable/Disable LocalPV ZFS Storage Engine | `true` |
|
|
| engines.​replicated.​mayastor.​enabled | Enable/Disable Replicated PV Mayastor Storage Engine | `true` |
|
|
| global.​imagePullPolicy | Global override for image pull policy | `""` |
|
|
| global.​imagePullSecrets | Global image pull secrets (merged with local imagePullSecrets and not overridden) - secret | `[]` |
|
|
| global.​imageRegistry | Global override for container image registry | `""` |
|
|
| loki.​enabled | Enable/Disable loki. | `true` |
|
|
| loki.​localpvScConfig.​loki.​basePath | Host path where local loki data is stored in. | `"/var/local/{{ .Release.Name }}/localpv-hostpath/loki"` |
|
|
| loki.​localpvScConfig.​loki.​reclaimPolicy | ReclaimPolicy of loki's localpv hostpath storage class. | `"Delete"` |
|
|
| loki.​localpvScConfig.​loki.​volumeBindingMode | VolumeBindingMode of loki's localpv hostpath storage class. | `"WaitForFirstConsumer"` |
|
|
| loki.​localpvScConfig.​minio.​basePath | Host path where local minio data is stored in. | `"/var/local/{{ .Release.Name }}/localpv-hostpath/minio"` |
|
|
| loki.​localpvScConfig.​minio.​reclaimPolicy | ReclaimPolicy of minio's localpv hostpath storage class. | `"Delete"` |
|
|
| loki.​localpvScConfig.​minio.​volumeBindingMode | VolumeBindingMode of minio's localpv hostpath storage class. | `"WaitForFirstConsumer"` |
|
|
| loki.​minio.​enabled | Disable this if you want to enable external s3 bucket, and uncomment the storage section above. | `true` |
|
|
| loki.​minio.​persistence.​enabled | Enabled persistence for minio | `true` |
|
|
| loki.​minio.​persistence.​size | Size of minio local storage volume | `"2Gi"` |
|
|
| loki.​minio.​persistence.​storageClass | Storage class for minio storage | `"openebs-minio-localpv"` |
|
|
| loki.​minio.​replicas | Specify the number of Minio Replicas. | `3` |
|
|
| loki.​singleBinary.​persistence.​enabled | Enabled persistence for loki | `true` |
|
|
| loki.​singleBinary.​persistence.​size | Size of loki local storage volume | `"2Gi"` |
|
|
| loki.​singleBinary.​persistence.​storageClass | Storage class for loki storage | `"openebs-loki-localpv"` |
|
|
| mayastor.​etcd.​clusterDomain | Kubernetes Cluster Domain | `"cluster.local"` |
|
|
| openebs-crds.​csi.​volumeSnapshots.​enabled | Enable/Disable installation of Volume Snapshot CRD's | `true` |
|
|
| preUpgradeHook.​enabled | Enable/Disable openebs pre-upgrade hook | `true` |
|
|
| preUpgradeHook.​image.​pullPolicy | The imagePullPolicy for the container | `"IfNotPresent"` |
|
|
| preUpgradeHook.​image.​registry | The container image registry URL for the hook job | `"docker.io"` |
|
|
| preUpgradeHook.​image.​repo | The container repository for the hook job | `"openebs/kubectl"` |
|
|
| preUpgradeHook.​image.​tag | The container image tag for the hook job | `"1.25.15"` |
|
|
| preUpgradeHook.​imagePullSecrets | Optional array of imagePullSecrets containing private registry credentials # Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ | `[]` |
|
|
| preUpgradeHook.​tolerations | Node tolerations for server scheduling to nodes with taints # Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ # | `[]` |
|
|
|