diff --git a/stable/mediawiki/.helmignore b/stable/mediawiki/.helmignore new file mode 100644 index 0000000000..6b8710a711 --- /dev/null +++ b/stable/mediawiki/.helmignore @@ -0,0 +1 @@ +.git diff --git a/stable/mediawiki/Chart.yaml b/stable/mediawiki/Chart.yaml new file mode 100644 index 0000000000..d798fdf216 --- /dev/null +++ b/stable/mediawiki/Chart.yaml @@ -0,0 +1,15 @@ +name: mediawiki +version: 0.4.0 +description: Extremely powerful, scalable software and a feature-rich wiki implementation that uses PHP to process and display data stored in a database. +keywords: +- mediawiki +- wiki +- http +- php +home: http://www.mediawiki.org/ +sources: +- https://github.com/bitnami/bitnami-docker-mediawiki +maintainers: +- name: Bitnami + email: containers@bitnami.com +engine: gotpl diff --git a/stable/mediawiki/README.md b/stable/mediawiki/README.md new file mode 100644 index 0000000000..b7730d6b2d --- /dev/null +++ b/stable/mediawiki/README.md @@ -0,0 +1,97 @@ +# MediaWiki + +[MediaWiki](https://www.mediawiki.org) 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; + +```console +$ helm install stable/mediawiki +``` + +## Introduction + +This chart bootstraps a [MediaWiki](https://github.com/bitnami/bitnami-docker-mediawiki) 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 MediaWiki application. + +## Prerequisites + +- Kubernetes 1.4+ with Beta APIs enabled +- PV provisioner support in the underlying infrastructure + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +$ helm install --name my-release stable/mediawiki +``` + +The command deploys MediaWiki 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 MediaWiki chart and their default values. + +| Parameter | Description | Default | +|--------------------------------------|------------------------------------------|---------------------------------------------------------| +| `image` | MediaWiki image | `bitnami/mediawiki:{VERSION}` | +| `imagePullPolicy` | Image pull policy | `Always` if `imageTag` is `latest`, else `IfNotPresent` | +| `mediawikiUser` | User of the application | `user` | +| `mediawikiPassword` | Application password | _random 10 character long alphanumeric string_ | +| `mediawikiEmail` | Admin email | `user@example.com` | +| `mediawikiName` | Name for the wiki | `Bitnami MediaWiki` | +| `smtpHost` | SMTP host | `nil` | +| `smtpPort` | SMTP port | `nil` | +| `smtpHostID` | SMTP host ID | `nil` | +| `smtpUser` | SMTP user | `nil` | +| `smtpPassword` | SMTP password | `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.mediawiki.storageClass` | PVC Storage Class for MediaWiki volume | `generic` | +| `persistence.mediawiki.accessMode` | PVC Access Mode for MediaWiki volume | `ReadWriteOnce` | +| `persistence.mediawiki.size` | PVC Storage Request for MediaWiki volume | `8Gi` | +| `resources` | CPU/Memory resource requests/limits | Memory: `512Mi`, CPU: `300m` | + +The above parameters map to the env variables defined in [bitnami/mediawiki](http://github.com/bitnami/bitnami-docker-mediawiki). For more information please refer to the [bitnami/mediawiki](http://github.com/bitnami/bitnami-docker-mediawiki) 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 mediawikiUser=admin,mediawikiPassword=password,mariadb.mariadbRootPassword=secretpassword \ + stable/mediawiki +``` + +The above command sets the MediaWiki administrator account 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/mediawiki +``` + +> **Tip**: You can use the default [values.yaml](values.yaml) + +## Persistence + +The [Bitnami MediaWiki](https://github.com/bitnami/bitnami-docker-mediawiki) image stores the MediaWiki data and configurations at the `/bitnami/mediawiki` 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. diff --git a/stable/mediawiki/requirements.lock b/stable/mediawiki/requirements.lock new file mode 100644 index 0000000000..146ddcac66 --- /dev/null +++ b/stable/mediawiki/requirements.lock @@ -0,0 +1,6 @@ +dependencies: +- name: mariadb + repository: http://storage.googleapis.com/kubernetes-charts + version: 0.5.2 +digest: sha256:400ac77ff2337dce024b0225bbfed9f509d77eb6ff6ee10000d59c5f6a367d51 +generated: 2016-10-26T14:49:03.028344205-07:00 diff --git a/stable/mediawiki/requirements.yaml b/stable/mediawiki/requirements.yaml new file mode 100644 index 0000000000..1417e46ef1 --- /dev/null +++ b/stable/mediawiki/requirements.yaml @@ -0,0 +1,4 @@ +dependencies: +- name: mariadb + version: 0.5.2 + repository: http://storage.googleapis.com/kubernetes-charts diff --git a/stable/mediawiki/templates/NOTES.txt b/stable/mediawiki/templates/NOTES.txt new file mode 100644 index 0000000000..18698fa68f --- /dev/null +++ b/stable/mediawiki/templates/NOTES.txt @@ -0,0 +1,27 @@ + +1. Get the MediaWiki URL by running: + +{{- if contains "NodePort" .Values.serviceType }} + + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT/ + +{{- else if contains "LoadBalancer" .Values.serviceType }} + + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + Watch the status with: 'kubectl get svc -w {{ template "fullname" . }}' + + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP/ +{{- else if contains "ClusterIP" .Values.serviceType }} + + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "fullname" . }}" -o jsonpath="{.items[0].metadata.name}") + echo http://127.0.0.1:8080/ + kubectl port-forward $POD_NAME 8080:80 +{{- end }} + +2. Get your MediaWiki login credentials by running: + + echo Username: {{ .Values.mediawikiUser }} + echo Password: $(printf $(printf '\%o' `kubectl get secret --namespace {{ .Release.Namespace }} {{ template "fullname" . }} -o jsonpath="{.data.mediawiki-password[*]}"`)) diff --git a/stable/mediawiki/templates/_helpers.tpl b/stable/mediawiki/templates/_helpers.tpl new file mode 100644 index 0000000000..4355810df4 --- /dev/null +++ b/stable/mediawiki/templates/_helpers.tpl @@ -0,0 +1,24 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 24 -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 24 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +*/}} +{{- define "fullname" -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- printf "%s-%s" .Release.Name $name | trunc 24 -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 24 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +*/}} +{{- define "mariadb.fullname" -}} +{{- printf "%s-%s" .Release.Name "mariadb" | trunc 24 -}} +{{- end -}} diff --git a/stable/mediawiki/templates/apache-pvc.yaml b/stable/mediawiki/templates/apache-pvc.yaml new file mode 100644 index 0000000000..c4cbd9e11a --- /dev/null +++ b/stable/mediawiki/templates/apache-pvc.yaml @@ -0,0 +1,14 @@ +{{- if .Values.persistence.enabled -}} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ template "fullname" . }}-apache + annotations: + volume.alpha.kubernetes.io/storage-class: {{ .Values.persistence.apache.storageClass | quote }} +spec: + accessModes: + - {{ .Values.persistence.apache.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.apache.size | quote }} +{{- end -}} diff --git a/stable/mediawiki/templates/deployment.yaml b/stable/mediawiki/templates/deployment.yaml new file mode 100644 index 0000000000..18d34889b4 --- /dev/null +++ b/stable/mediawiki/templates/deployment.yaml @@ -0,0 +1,93 @@ +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: {{ template "fullname" . }} + labels: + app: {{ template "fullname" . }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +spec: + replicas: 1 + template: + metadata: + labels: + app: {{ template "fullname" . }} + spec: + containers: + - name: {{ template "fullname" . }} + image: "{{ .Values.image }}" + imagePullPolicy: {{ default "" .Values.imagePullPolicy | quote }} + env: + - name: MARIADB_HOST + value: {{ template "mariadb.fullname" . }} + - name: MARIADB_PORT + value: "3306" + - name: MARIADB_PASSWORD + valueFrom: + secretKeyRef: + name: {{ template "mariadb.fullname" . }} + key: mariadb-root-password + - name: MEDIAWIKI_USERNAME + value: {{ default "" .Values.mediawikiUser | quote }} + - name: MEDIAWIKI_PASSWORD + valueFrom: + secretKeyRef: + name: {{ template "fullname" . }} + key: mediawiki-password + - name: MEDIAWIKI_EMAIL + value: {{ default "" .Values.mediawikiEmail | quote }} + - name: MEDIAWIKI_WIKI_NAME + value: {{ default "" .Values.mediawikiName | quote }} + - name: SMTP_HOST_ID + value: {{ default "" .Values.smtpHostID | quote }} + - name: SMTP_HOST + value: {{ default "" .Values.smtpHost | quote }} + - name: SMTP_PORT + value: {{ default "" .Values.smtpPort | quote }} + - name: SMTP_USER + value: {{ default "" .Values.smtpUser | quote }} + - name: SMTP_PASSWORD + valueFrom: + secretKeyRef: + name: {{ template "fullname" . }} + key: smtp-password + ports: + - name: http + containerPort: 80 + - name: https + containerPort: 443 + livenessProbe: + httpGet: + path: / + port: http + initialDelaySeconds: 120 + timeoutSeconds: 5 + readinessProbe: + httpGet: + path: / + port: http + initialDelaySeconds: 5 + timeoutSeconds: 1 + resources: +{{ toYaml .Values.resources | indent 10 }} + volumeMounts: + - name: mediawiki-data + mountPath: /bitnami/mediawiki + - name: apache-data + mountPath: /bitnami/apache + volumes: + - name: mediawiki-data + {{- if .Values.persistence.enabled }} + persistentVolumeClaim: + claimName: {{ template "fullname" . }}-mediawiki + {{- else }} + emptyDir: {} + {{- end }} + - name: apache-data + {{- if .Values.persistence.enabled }} + persistentVolumeClaim: + claimName: {{ template "fullname" . }}-apache + {{- else }} + emptyDir: {} + {{- end }} diff --git a/stable/mediawiki/templates/mediawiki-pvc.yaml b/stable/mediawiki/templates/mediawiki-pvc.yaml new file mode 100644 index 0000000000..2dfc50798b --- /dev/null +++ b/stable/mediawiki/templates/mediawiki-pvc.yaml @@ -0,0 +1,14 @@ +{{- if .Values.persistence.enabled -}} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ template "fullname" . }}-mediawiki + annotations: + volume.alpha.kubernetes.io/storage-class: {{ .Values.persistence.mediawiki.storageClass | quote }} +spec: + accessModes: + - {{ .Values.persistence.mediawiki.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.mediawiki.size | quote }} +{{- end -}} diff --git a/stable/mediawiki/templates/secrets.yaml b/stable/mediawiki/templates/secrets.yaml new file mode 100644 index 0000000000..b061a9e831 --- /dev/null +++ b/stable/mediawiki/templates/secrets.yaml @@ -0,0 +1,17 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ template "fullname" . }} + labels: + app: {{ template "fullname" . }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +type: Opaque +data: + {{ if .Values.mediawikiPassword }} + mediawiki-password: {{ .Values.mediawikiPassword | b64enc | quote }} + {{ else }} + mediawiki-password: {{ randAlphaNum 10 | b64enc | quote }} + {{ end }} + smtp-password: {{ default "" .Values.smtpPassword | b64enc | quote }} diff --git a/stable/mediawiki/templates/svc.yaml b/stable/mediawiki/templates/svc.yaml new file mode 100644 index 0000000000..6736e04769 --- /dev/null +++ b/stable/mediawiki/templates/svc.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ template "fullname" . }} + labels: + app: {{ template "fullname" . }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +spec: + type: {{ .Values.serviceType }} + ports: + - name: http + port: 80 + targetPort: http + - name: https + port: 443 + targetPort: https + selector: + app: {{ template "fullname" . }} diff --git a/stable/mediawiki/values.yaml b/stable/mediawiki/values.yaml new file mode 100644 index 0000000000..fa527f747f --- /dev/null +++ b/stable/mediawiki/values.yaml @@ -0,0 +1,85 @@ +## Bitnami MediaWiki image version +## ref: https://hub.docker.com/r/bitnami/mediawiki/tags/ +## +image: bitnami/mediawiki:1.27.1-r1 + +## Specify a imagePullPolicy +## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent' +## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images +## +# imagePullPolicy: + +## User of the application +## ref: https://github.com/bitnami/bitnami-docker-mediawiki#environment-variables +## +mediawikiUser: user + +## Application password +## Defaults to a random 10-character alphanumeric string if not set +## ref: https://github.com/bitnami/bitnami-docker-mediawiki#environment-variables +## +# mediawikiPassword: + +## Admin email +## ref: https://github.com/bitnami/bitnami-docker-mediawiki#environment-variables +## +mediawikiEmail: user@example.com + +## Name for the wiki +## ref: https://github.com/bitnami/bitnami-docker-mediawiki#environment-variables +## +mediawikiName: My Wiki + +## SMTP mail delivery configuration +## ref: https://github.com/bitnami/bitnami-docker-mediawiki#smtp-configuration +## +# smtpHost: +# smtpPort: +# smtpHostID: +# smtpUser: +# smtpPassword: + +## +## MariaDB chart configuration +## +mariadb: + ## MariaDB admin password + ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#setting-the-root-password-on-first-run + ## + # mariadbRootPassword: + + ## Enable persistence using Persistent Volume Claims + ## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/ + ## + persistence: + enabled: true + storageClass: generic + accessMode: ReadWriteOnce + size: 8Gi + +## Kubernetes configuration +## For minikube, set this to NodePort, elsewhere use LoadBalancer +## +serviceType: LoadBalancer + +## Enable persistence using Persistent Volume Claims +## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/ +## +persistence: + enabled: true + apache: + storageClass: generic + accessMode: ReadWriteOnce + size: 1Gi + mediawiki: + storageClass: generic + accessMode: ReadWriteOnce + size: 8Gi + +## Configure resource requests and limits +## ref: http://kubernetes.io/docs/user-guide/compute-resources/ +## +resources: + requests: + memory: 512Mi + cpu: 300m