charts/_docs/README_TEMPLATE.md

Application

• Short introduction to the application deployed by the chart with link to the project homepage

Sample

MediaWiki is an extremely powerful, scalable software and a feature-rich wiki implementation that uses PHP to process and display data stored in a database, such as MySQL.

TL;DR;

• List the helm install command required to deployed the chart

Sample

$ helm install my-release stable/mediawiki

Introduction

• A brief introduction to the chart and the chart(s) it depends upon.

Sample

This chart bootstraps a MediaWiki deployment on a Kubernetes cluster using the Helm package manager. The chart depends upon the MariaDB chart for the database requirements of MediaWiki.

The chart uses the Bitnami MediaWiki Docker Image for setting up the MediaWiki deployment and is developed, contributed and maintained by Bitnami.

Prerequisites

List the cluster requirements for a successful deployment of the chart

Sample

• Kubernetes 1.4+ with Beta APIs enabled
• PV provisioner support in the underlying infrastructure

Installing

• Provide chart deployment instructions. This may include steps to pull chart dependencies and so on.
• Use a release name in the helm install commands and refer to it in the upgrading and uninstalling sections.
• Link to the configuration section for customizing a chart deployment.

Sample

Install the chart using:

$ helm install my-release stable/mediawiki

The command deploys MediaWiki on the Kubernetes cluster in the default configuration and with the release name my-release. The deployment configuration can be customized by specifying the customization parameters with the helm install command using the --values or --set arguments. Find more information in the configuration section of this document.

Upgrading

• Provide instructions to upgrade a chart deployment using the helm upgrade commands

Sample

Upgrade the chart deployment using:

$ helm upgrade my-release stable/mediawiki

The command upgrades the existing my-release deployment with the most latest release of the chart.

TIP: Use helm repo update to update information on available charts in the chart repositories.

Uninstalling

• Provide instructions to uninstall a chart deployment from the cluster

Sample

Uninstall the my-release deployment using:

$ helm delete my-release

The command deletes the release named my-release and frees all the kubernetes resources associated with the release.

TIP: Specify the --purge argument to the above command to remove the release from the store and make its name free for later use.

Configuration

• Insert a table listing all the configurations that can be customized via the values.yaml file.
• TIP: The Table Editor plugin for SublimeText is useful for creating and updating this table
• Provide information on how to specify these parameters, ie. using a myvals.yml file or using the --set option and possibly an example

Sample

The following table lists all the configurable parameters expose by the MediaWiki chart and their default values.

Name	Decription	Default
mediawikiUser	Admin user name	user
mediawikiPassword	Admin user password	randomly generated alphanumeric string
mediawikiEmail	Admin user email	user@example.com
mariadb.mariadbRootPassword	MariaDB admin password	no password
persistence.enabled	Enable persistence using PVC	true

Specify the parameters you which to customize using the --set argument to the helm install command. For instance,

$ helm install my-release \
    --set mediawikiUser=admin,mediawikiPassword=password stable/mediawiki

The above command sets the MediaWiki administrator account username and password to admin and password respectively.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release \
    --values values.yaml stable/mediawiki

Tip: You can use the default values.yaml.

Persistence

• Describe how the chart handles persistence and the options to enable/disable persistence

Sample

The Bitnami MediaWiki Docker Image saves persistent data in the /bitnami/mediawiki and /bitnami/apache paths of the container. The chart makes use of Persistent Volumes Claims to set up data persistence across chart upgrades and is known to work in GKE, AWS and Minikube Kubernetes cluster setups.

See the configuration section to configure the PVC or to disable persistence.