Skip to content
This repository has been archived by the owner on May 8, 2024. It is now read-only.

Commit

Permalink
[openebs/openebs] Update OpenEBS charts instructions (#119)
Browse files Browse the repository at this point in the history
- Updated README
- Updated Helm repo location
- Bump up chart version

Signed-off-by: Murat Karslioglu <murat@mayadata.io>
  • Loading branch information
Murat Karslioglu authored Jun 22, 2020
1 parent fd9af7f commit 3a8c4d9
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 17 deletions.
2 changes: 1 addition & 1 deletion charts/openebs/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
apiVersion: v1
version: 1.11.0
version: 1.11.1
name: openebs
appVersion: 1.11.0
description: Containerized Storage for Containers
Expand Down
48 changes: 32 additions & 16 deletions charts/openebs/README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,52 @@
OpenEBS
=======
# OpenEBS Helm Chart

[OpenEBS](https://github.com/openebs/openebs) is an open source storage platform that provides persistent and containerized block storage for DevOps and container environments.
[OpenEBS](https://github.com/openebs/openebs) is an *open source storage platform* that provides persistent and containerized block storage for DevOps and container environments.
OpenEBS provides multiple storage engines that can be plugged in easily. A common pattern is the use of OpenEBS to deliver Dynamic LocalPV for those applications and workloads that want to access disks and cloud volumes directly.

OpenEBS can be deployed on any Kubernetes cluster - either in cloud, on-premise or developer laptop (minikube). OpenEBS itself is deployed as just another container on your cluster, and enables storage services that can be designated on a per pod, application, cluster or container level.

Introduction
------------
## Introduction

This chart bootstraps OpenEBS deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Quickstart and documentation

You can run OpenEBS on any Kubernetes 1.13+ cluster in a matter of seconds. See the [Quickstart Guide to OpenEBS](https://docs.openebs.io/docs/next/quickstart.html) for detailed instructions.

For more comprehensive documentation, start with the [Welcome to OpenEBS](https://docs.openebs.io/docs/next/overview.html) docs.

## Prerequisites
- Kubernetes 1.10+ with RBAC enabled

- Kubernetes 1.13+ with RBAC enabled
- iSCSI PV support in the underlying infrastructure

## Installing OpenEBS
```
helm install --namespace openebs stable/openebs
```
## Adding OpenEBS Helm repository

Before installing OpenEBS Helm charts, you need to add the [OpenEBS Helm repository](https://openebs.github.io/charts) to your Helm client.

## Installing OpenEBS with the release name `my-release`:
```bash
helm repo add openebs https://openebs.github.io/charts
```
helm install --name `my-release` --namespace openebs stable/openebs

## Installing OpenEBS

```bash
helm install --namespace openebs openebs/openebs
```

## To uninstall/delete the `my-release` deployment:
## Installing OpenEBS with the release name

```bash
helm install --name `my-release` --namespace openebs openebs/openebs
```

## To uninstall/delete instance with release name

```bash
helm ls --all
helm delete `my-release`
```


## Configuration

The following table lists the configurable parameters of the OpenEBS chart and their default values.
Expand Down Expand Up @@ -111,8 +127,8 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

```shell
helm install --name openebs -f values.yaml stable/openebs
```bash
helm install --name openebs -f values.yaml openebs/openebs
```

> **Tip**: You can use the default [values.yaml](values.yaml)

0 comments on commit 3a8c4d9

Please sign in to comment.