From 2a1d20a5ec21f7cb108f763307e46cf2f5f441bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Rodr=C3=ADguez=20Hern=C3=A1ndez?= Date: Thu, 24 Oct 2019 14:19:15 +0200 Subject: [PATCH] [stable/ghost] Unify and refactor README.md (#18301) Signed-off-by: Carlos Rodriguez Hernandez --- stable/ghost/Chart.yaml | 2 +- stable/ghost/README.md | 19 ++++++++++++------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/stable/ghost/Chart.yaml b/stable/ghost/Chart.yaml index b9b9f6b1af..91924799ac 100644 --- a/stable/ghost/Chart.yaml +++ b/stable/ghost/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v1 name: ghost -version: 7.2.11 +version: 7.2.12 appVersion: 2.37.0 description: A simple, powerful publishing platform that allows you to share your stories with the world keywords: diff --git a/stable/ghost/README.md b/stable/ghost/README.md index 16511b25dd..1749be2b4e 100644 --- a/stable/ghost/README.md +++ b/stable/ghost/README.md @@ -31,7 +31,7 @@ To install the chart with the release name `my-release`: $ helm install --name my-release stable/ghost ``` -The command deploys Ghost on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. +The command deploys Ghost 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 Ghost chart and their default values. @@ -152,19 +152,24 @@ $ helm install --name my-release -f values.yaml stable/ghost > **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. Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist. -## Using an existing database +### Using an existing database -Sometimes you may want to have Ghost connect to an external database rather than installing one inside your cluster, e.g. to use a managed database service, or use run a single database server for all your applications. To do this, the chart allows you to specify credentials for an external database under the [`externalDatabase` parameter](#configuration). You should also disable the MariaDB installation with the `mariadb.enabled` option. For example: +Sometimes you may want to have Ghost connect to an external database rather than installing one inside your cluster, e.g. to use a managed database service, or use run a single database server for all your applications. To do this, the chart allows you to specify credentials for an external database under the [`externalDatabase` parameter](#parameters). You should also disable the MariaDB installation with the `mariadb.enabled` option. For example using the following parameters: ```console -$ helm install stable/ghost \ - --set mariadb.enabled=false,externalDatabase.host=myexternalhost,externalDatabase.user=myuser,externalDatabase.password=mypassword,externalDatabase.database=mydatabase +mariadb.enabled=false +externalDatabase.host=myexternalhost +externalDatabase.user=myuser +externalDatabase.password=mypassword +externalDatabase.database=mydatabase ``` ## Persistence @@ -172,7 +177,7 @@ $ helm install stable/ghost \ The [Bitnami Ghost](https://github.com/bitnami/bitnami-docker-ghost) image stores the Ghost data and configurations at the `/bitnami/ghost` and `/bitnami/apache` paths 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