Update README with chart options

This commit is contained in:
James Munnelly 2017-09-21 19:52:37 +01:00
parent 3d6c0ff3cb
commit 310d7bfc4e
2 changed files with 66 additions and 5 deletions

View File

@ -49,11 +49,8 @@ To deploy the latest version of cert-manager using Helm, run:
$ helm install --name cert-manager --namespace kube-system contrib/charts/cert-manager
```
#### Deploy RBAC roles
```
$ kubectl create -f https://raw.githubusercontent.com/jetstack-experimental/cert-manager/master/docs/rbac.yaml
```
There are a number of options you can customise when deploying, as detailed in
[the chart itself](https://github.com/jetstack-experimental/cert-manager/tree/master/contrib/charts/cert-manager).
### 2. Set up letsencrypt staging issuer

View File

@ -0,0 +1,64 @@
# cert-manager
cert-manager is a Kubernetes addon to automate the management and issuance of
TLS certificates from various issuing sources.
It will ensure certificates are valid and up to date periodically, and attempt
to renew certificates at an appropriate time before expiry.
## TL;DR;
```console
$ helm install .
```
## Introduction
This chart creates a cert-manager deployment on a Kubernetes cluster using the Helm package manager.
## Prerequisites
- Kubernetes cluster with support for CustomResourceDefinition or ThirdPartyResource
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm install --name my-release .
```
> **Tip**: List all releases using `helm list`
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```console
$ helm delete my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
The following tables lists the configurable parameters of the Drupal chart and their default values.
| Parameter | Description | Default |
| ---------------------- | --------------------------------------- | ---------------------------------------------- |
| `image.repository` | Image repository | `jetstackexperimental/cert-manager-controller` |
| `image.tag` | Image tag | `canary` |
| `image.pullPolicy` | Image pull policy | `Always` |
| `replicaCount` | Number of cert-manager replicas | `1` |
| `createCustomResource` | Create CRD/TPR with this release | `true` |
| `rbac.enabled` | Create RBAC resources with this release | `true` |
| `resources` | CPU/Memory resource requests/limits | `None` |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console
$ helm install --name my-release -f values.yaml .
```
> **Tip**: You can use the default [values.yaml](values.yaml)