[stable/sealed-secrets] Update README (#20253)

* Add missing documentation in README.md

In PR #20251, I forgot to commit the updated README.md

Signed-off-by: Marco Kilchhofer <marco@kilchhofer.info>

* Add missing default value to README

Signed-off-by: Marco Kilchhofer <marco@kilchhofer.info>

* Format table in README.md

Signed-off-by: Marco Kilchhofer <marco@kilchhofer.info>
This commit is contained in:
Marco Kilchhofer
2020-01-20 13:59:36 -08:00
committed by Kubernetes Prow Robot
parent 35e0cd0a33
commit f2ff7a3164
2 changed files with 24 additions and 18 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
name: sealed-secrets
description: A Helm chart for Sealed Secrets
version: 1.7.0
version: 1.7.1
appVersion: 0.9.6
kubeVersion: ">=1.9.0-0"
home: https://github.com/bitnami-labs/sealed-secrets
+23 -17
View File
@@ -43,23 +43,29 @@ Read about kubeseal usage on [sealed-secrets docs](https://github.com/bitnami-la
## Configuration
| Parameter | Description | Default |
|----------:|:------------|:--------|
| **controller.create** | `true` if Sealed Secrets controller resources should be created | `true` |
| **rbac.create** | `true` if rbac resources should be created | `true` |
| **rbac.pspEnabled** | `true` if psp resources should be created | `false` |
| **serviceAccount.create** | Whether to create a service account or not | `true` |
| **serviceAccount.name** | The name of the service account to create or use | `"sealed-secrets-controller"` |
| **secretName** | The name of the TLS secret containing the key used to encrypt secrets | `"sealed-secrets-key"` |
| **image.tag** | The `Sealed Secrets` image tag | `v0.9.6` |
| **image.pullPolicy** | The image pull policy for the deployment | `IfNotPresent` |
| **image.repository** | The repository to get the controller image from | `quay.io/bitnami/sealed-secrets-controller` |
| **resources** | CPU/Memory resource requests/limits | `{}` |
| **crd.create** | `true` if crd resources should be created | `true` |
| **crd.keep** | `true` if the sealed secret CRD should be kept when the chart is deleted | `true` |
|**networkPolicy** | Whether to create a network policy that allows access to the service | `false`|
|**securityContext.runAsUser** | Defines under which user the operator Pod and its containers/processes run | `1001`|
|**commandArgs** | Set optional command line arguments passed to the controller process | |
| Parameter | Description | Default |
|------------------------------:|:---------------------------------------------------------------------------|:--------------------------------------------|
| **controller.create** | `true` if Sealed Secrets controller resources should be created | `true` |
| **rbac.create** | `true` if rbac resources should be created | `true` |
| **rbac.pspEnabled** | `true` if psp resources should be created | `false` |
| **serviceAccount.create** | Whether to create a service account or not | `true` |
| **serviceAccount.name** | The name of the service account to create or use | `"sealed-secrets-controller"` |
| **secretName** | The name of the TLS secret containing the key used to encrypt secrets | `"sealed-secrets-key"` |
| **image.tag** | The `Sealed Secrets` image tag | `v0.9.6` |
| **image.pullPolicy** | The image pull policy for the deployment | `IfNotPresent` |
| **image.repository** | The repository to get the controller image from | `quay.io/bitnami/sealed-secrets-controller` |
| **resources** | CPU/Memory resource requests/limits | `{}` |
| **crd.create** | `true` if crd resources should be created | `true` |
| **crd.keep** | `true` if the sealed secret CRD should be kept when the chart is deleted | `true` |
| **networkPolicy** | Whether to create a network policy that allows access to the service | `false` |
| **securityContext.runAsUser** | Defines under which user the operator Pod and its containers/processes run | `1001` |
| **commandArgs** | Set optional command line arguments passed to the controller process | `[]` |
| **ingress.enabled** | Enables Ingress | `false` |
| **ingress.annotations** | Ingress annotations | `{}` |
| **ingress.path** | Ingress path | `/v1/cert.pem` |
| **ingress.hosts** | Ingress accepted hostnames | `["chart-example.local"]` |
| **ingress.tls** | Ingress TLS configuration | `[]` |
- In the case that **serviceAccount.create** is `false` and **rbac.create** is `true` it is expected for a service account with the name **serviceAccount.name** to exist _in the same namespace as this chart_ before installation.
- If **serviceAccount.create** is `true` there cannot be an existing service account with the name **serviceAccount.name**.