[stable/dokuwiki] Unify and refactor README.md (#18299)

Signed-off-by: Carlos Rodriguez Hernandez <crhernandez@bitnami.com>
This commit is contained in:
Carlos Rodríguez Hernández
2019-10-24 07:08:52 -07:00
committed by Kubernetes Prow Robot
parent 1c5c166148
commit 1e44f8082f
2 changed files with 6 additions and 4 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
apiVersion: v1
name: dokuwiki
version: 5.2.10
version: 5.2.11
appVersion: 0.20180422.201901061035
description: DokuWiki is a standards-compliant, simple to use wiki optimized for creating
documentation. It is targeted at developer teams, workgroups, and small companies.
+5 -3
View File
@@ -29,7 +29,7 @@ To install the chart with the release name `my-release`:
$ helm install --name my-release stable/dokuwiki
```
The command deploys DokuWiki on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
The command deploys DokuWiki on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list`
@@ -43,7 +43,7 @@ $ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
## Parameters
The following table lists the configurable parameters of the DokuWiki chart and their default values.
@@ -131,6 +131,8 @@ $ helm install --name my-release -f values.yaml stable/dokuwiki
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
@@ -143,7 +145,7 @@ The [Bitnami DokuWiki](https://github.com/bitnami/bitnami-docker-dokuwiki) image
Persistent Volume Claims are used to keep the data across deployments. There is a [known issue](https://github.com/kubernetes/kubernetes/issues/39178) in Kubernetes Clusters with EBS in different availability zones. Ensure your cluster is configured properly to create Volumes in the same availability zone where the nodes are running. Kuberentes 1.12 solved this issue with the [Volume Binding Mode](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode).
See the [Configuration](#configuration) section to configure the PVC or to disable persistence.
See the [Parameters](#parameters) section to configure the PVC or to disable persistence.
## Upgrading