Switch branches/tags
Find file History
javsalgar and k8s-ci-robot [stable/dokuwiki] Add service.port in values.yaml (#9394)
* [stable/dokuwiki] Add service.port in values.yaml

Signed-off-by: Javier J. Salmeron Garcia <jsalmeron@bitnami.com>

* Update readme

Signed-off-by: Javier J. Salmeron Garcia <jsalmeron@bitnami.com>

* Fix readme

Signed-off-by: Javier J. Salmeron Garcia <jsalmeron@bitnami.com>

* Remove - in template

Signed-off-by: Javier J. Salmeron Garcia <jsalmeron@bitnami.com>
Latest commit 84bca18 Nov 20, 2018

README.md

DokuWiki

DokuWiki is a standards-compliant, simple to use wiki optimized for creating documentation. It is targeted at developer teams, workgroups, and small companies. All data is stored in plain text files, so no database is required.

TL;DR;

$ helm install stable/dokuwiki

Introduction

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

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

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:

$ helm install --name my-release stable/dokuwiki

The command deploys DokuWiki 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 table lists the configurable parameters of the DokuWiki chart and their default values.

Parameter Description Default
global.imageRegistry Global Docker image registry nil
image.registry DokuWiki image registry docker.io
image.repository DokuWiki image name bitnami/dokuwiki
image.tag DokuWiki image tag {VERSION}
image.pullPolicy Image pull policy Always
image.pullSecrets Specify image pull secrets nil
dokuwikiUsername User of the application user
dokuwikiFullName User's full name User Name
dokuwikiPassword Application password random 10 character alphanumeric string
dokuwikiEmail User email user@example.com
dokuwikiWikiName Wiki name My Wiki
service.type Kubernetes Service type LoadBalancer
service.port Service HTTP port 80
service.httpsPort Service HTTPS port 443
service.loadBalancerIP Kubernetes LoadBalancerIP to request nil
service.externalTrafficPolicy Enable client source IP preservation Cluster
service.nodePorts.http Kubernetes http node port ""
service.nodePorts.https Kubernetes https node port ""
ingress.enabled Enable ingress controller resource false
ingress.hosts[0].name Hostname to your DokuWiki installation dokuwiki.local
ingress.hosts[0].path Path within the url structure /
ingress.hosts[0].tls Utilize TLS backend in ingress false
ingress.hosts[0].certManager Add annotations for cert-manager false
ingress.hosts[0].tlsSecret TLS Secret (certificates) dokuwiki.local-tls
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.apache.storageClass PVC Storage Class for apache volume nil (uses alpha storage class annotation)
persistence.apache.accessMode PVC Access Mode for apache volume ReadWriteOnce
persistence.apache.size PVC Storage Request for apache volume 1Gi
persistence.dokuwiki.storageClass PVC Storage Class for DokuWiki volume nil (uses alpha storage class annotation)
persistence.dokuwiki.accessMode PVC Access Mode for DokuWiki volume ReadWriteOnce
persistence.dokuwiki.size PVC Storage Request for DokuWiki volume 8Gi
resources CPU/Memory resource requests/limits Memory: 512Mi, CPU: 300m
livenessProbe.enabled Enable/disable the liveness probe true
livenessProbe.initialDelaySeconds Delay before liveness probe is initiated 120
livenessProbe.periodSeconds How often to perform the probe 10
livenessProbe.timeoutSeconds When the probe times out 5
livenessProbe.failureThreshold Minimum consecutive failures to be considered failed 6
livenessProbe.successThreshold Minimum consecutive successes to be considered successful 1
readinessProbe.enabled Enable/disable the readiness probe true
readinessProbe.initialDelaySeconds Delay before readinessProbe is initiated 30
readinessProbe.periodSeconds How often to perform the probe 10
readinessProbe.timeoutSeconds When the probe times out 5
readinessProbe.failureThreshold Minimum consecutive failures to be considered failed 6
readinessProbe.successThreshold Minimum consecutive successes to be considered successful 1
nodeSelector Node labels for pod assignment {}
affinity Affinity settings for pod assignment {}
tolerations Toleration labels for pod assignment []
podAnnotations Pod annotations {}
metrics.enabled Start a side-car prometheus exporter false
metrics.image.registry Apache exporter image registry docker.io
metrics.image.repository Apache exporter image name lusotycoon/apache-exporter
metrics.image.tag Apache exporter image tag v0.5.0
metrics.image.pullPolicy Image pull policy IfNotPresent
metrics.image.pullSecrets Specify docker-registry secret names as an array nil
metrics.podAnnotations Additional annotations for Metrics exporter pod {prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resources Exporter resource requests/limit {}

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

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

$ helm install --name my-release \
  --set dokuwikiUsername=admin,dokuwikiPassword=password \
    stable/dokuwiki

The above command sets the DokuWiki 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/dokuwiki

Tip: You can use the default values.yaml

Persistence

The Bitnami DokuWiki image stores the DokuWiki data and configurations at the /bitnami/dokuwiki and /bitnami/apache paths of the container.

Persistent Volume Claims are used to keep the data across deployments. There is a known issue in Kubernetes Clusters with EBS in different availability zones. Ensure your cluster is configured properly to create Volumes in the same availability zone where the nodes are running. Kuberentes 1.12 solved this issue with the Volume Binding Mode.

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

Upgrading

To 3.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 3.0.0. The following example assumes that the release name is dokuwiki:

$ kubectl patch deployment dokuwiki-dokuwiki --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'