mirror of
https://github.com/helm/charts.git
synced 2026-08-23 22:37:45 +00:00
Adnan Abdulhussein
4950785264
* Use requirements.yaml to define dependencies Updates incubator/patroni, stable/redmine, stable/wordpress, and stable/drupal to vendor dependencies using Helm's built-in dependency management. * bump patroni version * remove vendored dependencies * Add chart tarballs to gitignore * ci: update scripts to fetch dependencies * patroni: fix reference to namespace
112 lines
6.8 KiB
Markdown
112 lines
6.8 KiB
Markdown
# WordPress
|
|
|
|
[WordPress](https://wordpress.org/) is one of the most versatile open source content management systems on the market. A publishing platform for building blogs and websites.
|
|
|
|
## TL;DR;
|
|
|
|
```console
|
|
$ helm install stable/wordpress
|
|
```
|
|
|
|
## Introduction
|
|
|
|
This chart bootstraps a [WordPress](https://github.com/bitnami/bitnami-docker-wordpress) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
|
|
|
|
It also packages the [Bitnami MariaDB chart](https://github.com/kubernetes/charts/tree/master/stable/mariadb) which is required for bootstrapping a MariaDB deployment for the database requirements of the WordPress application.
|
|
|
|
## Prerequisites
|
|
|
|
- Kubernetes 1.4+ with Beta APIs enabled
|
|
- PV provisioner support in the underlying infrastructure
|
|
|
|
## Get this chart
|
|
|
|
Download the latest release of the chart from the [releases](../../../releases) page.
|
|
|
|
Alternatively, clone the repo if you wish to use the development snapshot:
|
|
|
|
```console
|
|
$ git clone https://github.com/kubernetes/charts.git
|
|
```
|
|
|
|
## Installing the Chart
|
|
|
|
To install the chart with the release name `my-release`:
|
|
|
|
```console
|
|
$ helm install --name my-release stable/wordpress
|
|
```
|
|
|
|
*Replace the `x.x.x` placeholder with the chart release version.*
|
|
|
|
The command deploys WordPress on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
|
|
|
|
> **Tip**: List all releases using `helm list`
|
|
|
|
## Uninstalling the Chart
|
|
|
|
To uninstall/delete the `my-release` deployment:
|
|
|
|
```console
|
|
$ helm delete my-release
|
|
```
|
|
|
|
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
|
|
|
## Configuration
|
|
|
|
The following tables lists the configurable parameters of the WordPress chart and their default values.
|
|
|
|
| Parameter | Description | Default |
|
|
| ------------------------------- | ------------------------------- | ---------------------------------------------------------- |
|
|
| `image` | WordPress image | `bitnami/wordpress:{VERSION}` |
|
|
| `imagePullPolicy` | Image pull policy | `Always` if `image` tag is `latest`, else `IfNotPresent` |
|
|
| `wordpressUsername` | User of the application | `user` |
|
|
| `wordpressPassword` | Application password | `bitnami` |
|
|
| `wordpressEmail` | Admin email | `user@example.com` |
|
|
| `wordpressFirstName` | First name | `FirstName` |
|
|
| `wordpressLastName` | Last name | `LastName` |
|
|
| `wordpressBlogName` | Blog name | `User's Blog!` |
|
|
| `smtpHost` | SMTP host | `nil` |
|
|
| `smtpPort` | SMTP port | `nil` |
|
|
| `smtpUser` | SMTP user | `nil` |
|
|
| `smtpPassword` | SMTP password | `nil` |
|
|
| `smtpUsername` | User name for SMTP emails | `nil` |
|
|
| `smtpProtocol` | SMTP protocol [`tls`, `ssl`] | `nil` |
|
|
| `mariadb.mariadbRootPassword` | MariaDB admin password | `nil` |
|
|
| `serviceType` | Kubernetes Service type | `LoadBalancer` |
|
|
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
|
| `persistence.apache.storageClass` | PVC Storage Class for Apache volume | `generic` |
|
|
| `persistence.apache.accessMode` | PVC Access Mode for Apache volume | `ReadWriteOnce` |
|
|
| `persistence.apache.size` | PVC Storage Request for Apache volume | `1Gi` |
|
|
| `persistence.wordpress.storageClass` | PVC Storage Class for WordPress volume | `generic` |
|
|
| `persistence.wordpress.accessMode` | PVC Access Mode for WordPress volume | `ReadWriteOnce` |
|
|
| `persistence.wordpress.size` | PVC Storage Request for WordPress volume | `8Gi` |
|
|
|
|
The above parameters map to the env variables defined in [bitnami/wordpress](http://github.com/bitnami/bitnami-docker-wordpress). For more information please refer to the [bitnami/wordpress](http://github.com/bitnami/bitnami-docker-wordpress) image documentation.
|
|
|
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
|
|
|
```console
|
|
$ helm install --name my-release \
|
|
--set wordpressUsername=admin,wordpressPassword=password,mariadb.mariadbRootPassword=secretpassword \
|
|
stable/wordpress
|
|
```
|
|
|
|
The above command sets the WordPress application username and password to `admin` and `password` respectively. Additionally it sets the MariaDB `root` user password to `secretpassword`.
|
|
|
|
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
|
|
|
|
```console
|
|
$ helm install --name my-release -f values.yaml stable/wordpress
|
|
```
|
|
|
|
> **Tip**: You can use the default [values.yaml](values.yaml)
|
|
|
|
## Persistence
|
|
|
|
The [Bitnami WordPress](https://github.com/bitnami/bitnami-docker-wordpress) image stores the WordPress data and configurations at the `/bitnami/wordpress` 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.
|