Switch branches/tags
Find file History
jldeen and jeremyrickard Update wordpress version and chart with support for prod envs and ist…
…io (#131)

* bump chart version

* add in support for replicas, istio and certmanager

* add in how to get wordpress database connection details

* support for istio and apiVersion changes

* add in support for SSL and type of mysql deployment

* support for existingPVC & clarify replicas for prod enviroments
Latest commit 053ec9a Oct 1, 2018

README.md

WordPress

WordPress is one of the most versatile open source content management systems on the market. A publishing platform for building blogs and websites.

TL;DR;

First, ensure that you've added the azure repository. Then, install from the azure repo:

$ helm install azure/wordpress

Introduction

This chart bootstraps a WordPress deployment on a Kubernetes cluster using the Helm package manager.

It is inspired by the upstream wordpress chart, but, by default, utilizes Open Service Broker For Azure to provision an Azure Database for MySQL database for the Wordpress server to use.

Prerequisites

You will need the following before you can install this chart:

Please see the prerequisities document for details on how to install everything.

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release azure/wordpress

The command deploys WordPress on the Kubernetes cluster in the default configuration. The 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:

$ 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 IfNotPresent
wordpressUsername User of the application user
wordpressPassword Application password random 10 character long alphanumeric string
wordpressEmail Admin email user@example.com
wordpressFirstName First name FirstName
wordpressLastName Last name LastName
wordpressBlogName Blog name User's Blog!
allowEmptyPassword Allow DB blank passwords yes
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.enabled Deploy MariaDB container(s) false
mariadb.mariadbRootPassword MariaDB admin password nil
mariadb.mariadbDatabase Database name to create bitnami_wordpress
mariadb.mariadbUser Database user to create bn_wordpress
mariadb.mariadbPassword Password for the database random 10 character long alphanumeric string
externalDatabase.azure.location The Azure region in which to deploy Azure Database for MySQL eastus
externalDatabase.azure.servicePlan The plan to request for Azure Database for MySQL standard100
serviceType Kubernetes Service type LoadBalancer
healthcheckHttps Use https for liveliness and readiness false
ingress.enabled Enable ingress controller resource false
ingress.hosts[0].name Hostname to your WordPress installation wordpress.local
ingress.hosts[0].path Path within the url structure /
ingress.hosts[0].tls Utilize TLS backend in ingress false
ingress.hosts[0].tlsSecret TLS Secret (certificates) wordpress.local-tls-secret
ingress.hosts[0].annotations Annotations for this host's ingress record []
ingress.secrets[0].name TLS Secret Name nil
ingress.secrets[0].certificate TLS Secret Certificate nil
ingress.secrets[0].key TLS Secret Key nil
persistence.enabled Enable persistence using PVC true
persistence.storageClass PVC Storage Class nil (uses alpha storage class annotation)
persistence.accessMode PVC Access Mode ReadWriteOnce
persistence.size PVC Storage Request 10Gi
nodeSelector Node labels for pod assignment {}

The above parameters map to the env variables defined in bitnami/wordpress. For more information please refer to the bitnami/wordpress image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install azure/wordpress \
  --name my-release \
  --set wordpressUsername=admin \
  --set wordpressPassword=password  

The above command sets the WordPress 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 --name my-release -f values.yaml stable/wordpress

Tip: You can use the default values.yaml

Persistence

The Bitnami WordPress image stores the WordPress data and configurations at the /bitnami 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 section to configure the PVC or to disable persistence.

Ingress

This chart provides support for ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress or traefik you can utilize the ingress controller to service your WordPress application.

To enable ingress integration, please set ingress.enabled to true

Hosts

Most likely you will only want to have one hostname that maps to this WordPress installation, however it is possible to have more than one host. To facilitate this, the ingress.hosts object is an array.

For each item, please indicate a name, tls, tlsSecret, and any annotations that you may want the ingress controller to know about.

Indicating TLS will cause WordPress to generate HTTPS urls, and WordPress will be connected to at port 443. The actual secret that tlsSecret references does not have to be generated by this chart. However, please note that if TLS is enabled, the ingress record will not work until this secret exists.

For annotations, please see this document. Not all annotations are supported by all ingress controllers, but this document does a good job of indicating which annotation is supported by many popular ingress controllers.

TLS Secrets

This chart will facilitate the creation of TLS secrets for use with the ingress controller, however this is not required. There are three common use cases:

  • helm generates / manages certificate secrets
  • user generates / manages certificates separately
  • an additional tool (like kube-lego) manages the secrets for the application

In the first two cases, one will need a certificate and a key. We would expect them to look like this:

  • certificate files should look like (and there can be more than one certificate if there is a certificate chain)
-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----
  • keys should look like:
-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----

If you are going to use helm to manage the certificates, please copy these values into the certificate and key values for a given ingress.secrets entry.

If you are going are going to manage TLS secrets outside of helm, please know that you can create a TLS secret by doing the following:

kubectl create secret tls wordpress.local-tls --key /path/to/key.key --cert /path/to/cert.crt

Please see this example for more information.