Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
Merge pull request #13 from onmetal/druid_documentation
Browse files Browse the repository at this point in the history
Added etcd-druid documentation
  • Loading branch information
afritzler authored Sep 6, 2021
2 parents 8bfa0e6 + 022de28 commit c76cca9
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 3 deletions.
33 changes: 33 additions & 0 deletions docs/usage/druid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Etcd Druid

The [etcd-druid](https://github.com/gardener/etcd-druid) is an operator which manages [etcd](https://etcd.io/) deployments inside a Kubernetes cluster.

## Installation

`etcd-druid` can be installed via `helm install` into your Kubernetes cluster. Please make sure you have configured the `helm repo` as described [here](/usage/helm).

```shell
helm -n onmetal install druid vc/etcd-druid
```

If you want to overwrite the default `values.yaml` you can do so by providing a custom configuration.

```shell
helm -n onmetal install druid vc/etcd-druid -f VALUES_DIR/druid-values.yaml
```

## Upgrade

To upgrade your `etcd-druid` deployment run:

```shell
helm -n onmetal upgrade druid vc/etcd-druid -f VALUES_DIR/druid-values.yaml
```

## Remove

To remove the installation run:

```shell
helm -n onmetal delete druid
```
26 changes: 26 additions & 0 deletions docs/usage/helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Helm Repository

The `virtual-controlplane` project comes with it's own Helm repository containing all Helm charts necessary to setup a virtual Kubernetes API server. It can be added to your Helm environment via:

```shell
helm repo add vc https://onmetal.github.io/virtual-controlplane/
```

To update the Helm repository:

```shell
helm repo update
```

You should now be able to see the content of the helm repository via:

```shell
helm search repo vc
```

An example output would look like this:

```shell
NAME CHART VERSION APP VERSION DESCRIPTION
vc/etcd-druid 0.1.0 0.6.0 Helm chart for etcd-druid.
```
2 changes: 0 additions & 2 deletions docs/usage/local_setup.md

This file was deleted.

3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ markdown_extensions:
nav:
- Home: index.md
- Usage:
- Local Setup: usage/local_setup.md
- Helm Repository: usage/helm.md
- Etcd Druid: usage/druid.md
- Developer Guide:
- Documentation: development/documentation.md
- Contribution Guide: development/contribution.md
Expand Down

0 comments on commit c76cca9

Please sign in to comment.