From 20c079485c94071aa58204adda6c8da0df1a690b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Rodr=C3=ADguez=20Hern=C3=A1ndez?= Date: Thu, 24 Oct 2019 16:08:28 +0200 Subject: [PATCH] [stable/testlink] Unify and refactor README.md (#18296) Signed-off-by: Carlos Rodriguez Hernandez --- stable/testlink/Chart.yaml | 2 +- stable/testlink/README.md | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/stable/testlink/Chart.yaml b/stable/testlink/Chart.yaml index 76d8b21f59..dd5ce1ee91 100644 --- a/stable/testlink/Chart.yaml +++ b/stable/testlink/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v1 name: testlink -version: 6.3.4 +version: 6.3.5 appVersion: 1.9.19 description: Web-based test management system that facilitates software quality assurance. icon: https://bitnami.com/assets/stacks/testlink/img/testlink-stack-220x234.png diff --git a/stable/testlink/README.md b/stable/testlink/README.md index fa110cbd99..d629c3e4a5 100644 --- a/stable/testlink/README.md +++ b/stable/testlink/README.md @@ -31,7 +31,7 @@ To install the chart with the release name `my-release`: $ helm install --name my-release stable/testlink ``` -The command deploys TestLink on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. +The command deploys TestLink 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` @@ -45,7 +45,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 TestLink chart and their default values. @@ -135,6 +135,8 @@ $ helm install --name my-release -f values.yaml stable/testlink > **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. @@ -146,7 +148,7 @@ Bitnami will release a new chart updating its containers if a new version of the The [Bitnami TestLink](https://github.com/bitnami/bitnami-docker-testlink) image stores the TestLink data and configurations at the `/bitnami/testlink` path of the container. Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. -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