DokuWiki packaged by Bitnami¶

DokuWiki is a standards-compliant wiki optimized for creating documentation. Designed to be simple to use for small organizations, it stores all data in plain text files so no database is required.

Overview of DokuWiki

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/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.

Looking to use DokuWiki in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

Kubernetes 1.19+
Helm 3.2.0+
PV provisioner support in the underlying infrastructure
ReadWriteMany volumes for deployment scaling

Installing the Chart¶

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

helm install my-release bitnami/dokuwiki

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

Parameters¶

Global parameters¶

Name	Description	Value
`global.imageRegistry`	Global Docker image registry	`""`
`global.imagePullSecrets`	Global Docker registry secret names as an array	`[]`
`global.storageClass`	Global StorageClass for Persistent Volume(s)	`""`

Common parameters¶

Name	Description	Value
`kubeVersion`	Force target Kubernetes version (using Helm capabilities if not set)	`""`
`nameOverride`	String to partially override dokuwiki.fullname template with a string (will prepend the release name)	`""`
`fullnameOverride`	String to fully override dokuwiki.fullname template with a string	`""`
`namespaceOverride`	String to fully override common.names.namespace	`""`
`commonAnnotations`	Annotations to add to all deployed objects	`{}`
`commonLabels`	Labels to add to all deployed objects	`{}`
`extraDeploy`	Array of extra objects to deploy with the release (evaluated as a template).	`[]`

Dokuwiki parameters¶

Name	Description	Value
`image.registry`	DokuWiki image registry	`docker.io`
`image.repository`	DokuWiki image repository	`bitnami/dokuwiki`
`image.tag`	DokuWiki image tag	`20230404.1.0-debian-11-r14`
`image.digest`	DokuWiki image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	`""`
`image.pullPolicy`	Image pull policy	`IfNotPresent`
`image.pullSecrets`	Image pull policy	`[]`
`image.debug`	Enable image debugging	`false`
`hostAliases`	Add deployment host aliases	`[]`
`dokuwikiUsername`	User of the application	`user`
`dokuwikiPassword`	Application password	`""`
`existingSecret`	Use an existing secret with the dokuwiki password	`""`
`dokuwikiEmail`	Admin email	`user@example.com`
`dokuwikiFullName`	User's Full Name	`User Name`
`dokuwikiWikiName`	Wiki name	`My Wiki`
`customPostInitScripts`	Custom post-init.d user scripts	`{}`
`updateStrategy`	Strategy to use to update Pods	`{}`
`topologySpreadConstraints`	Topology Spread Constraints for pod assignment	`[]`
`persistence.enabled`	Enable persistence using PVC	`true`
`persistence.storageClass`	PVC Storage Class for DokuWiki volume	`""`
`persistence.accessModes`	PVC Access Mode for DokuWiki volume	`[]`
`persistence.size`	PVC Storage Request for DokuWiki volume	`8Gi`
`persistence.existingClaim`	Name of an existing PVC to be used	`""`
`persistence.annotations`	Annotations to add to the PVC	`{}`
`podSecurityContext.enabled`	Enable securityContext on for DokuWiki deployment	`true`
`podSecurityContext.fsGroup`	Group to configure permissions for volumes	`1001`
`containerSecurityContext.enabled`	Enable securityContext on for DokuWiki deployment	`true`
`containerSecurityContext.runAsUser`	User for the securityContext	`1001`
`containerSecurityContext.runAsNonRoot`	Force the container as be run as non root	`true`
`resources.requests`	The requested resources for the container	`{}`
`resources.limits`	The requested limits for the container	`{}`
`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`	Period seconds for readinessProbe	`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`
`startupProbe.enabled`	Enable/disable the startup probe	`false`
`startupProbe.initialDelaySeconds`	Delay before startup probe is initiated	`120`
`startupProbe.periodSeconds`	How often to perform the probe	`10`
`startupProbe.timeoutSeconds`	When the probe times out	`5`
`startupProbe.failureThreshold`	Minimum consecutive failures to be considered failed	`6`
`startupProbe.successThreshold`	Minimum consecutive successes to be considered successful	`1`
`podAffinityPreset`	Pod affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`podAntiAffinityPreset`	Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`soft`
`nodeAffinityPreset.type`	Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard`	`""`
`nodeAffinityPreset.key`	Node label key to match Ignored if `affinity` is set.	`""`
`nodeAffinityPreset.values`	Node label values to match. Ignored if `affinity` is set.	`[]`
`affinity`	Affinity for pod assignment	`{}`
`nodeSelector`	Node labels for pod assignment	`{}`
`tolerations`	Tolerations for pod assignment	`[]`
`command`	Override default container command (useful when using custom images)	`[]`
`args`	Override default container args (useful when using custom images)	`[]`
`extraEnvVars`	An array to add extra env vars	`[]`
`extraEnvVarsCM`	ConfigMap containing extra env vars	`""`
`extraEnvVarsSecret`	Secret containing extra env vars (in case of sensitive data)	`""`
`podAnnotations`	Pod annotations	`{}`
`customLivenessProbe`	Override default liveness probe	`{}`
`customReadinessProbe`	Override default readiness probe	`{}`
`customStartupProbe`	Override default startup probe	`{}`
`extraVolumes`	Array of extra volumes to be added to the deployment (evaluated as template). Requires setting `extraVolumeMounts`	`[]`
`extraVolumeMounts`	Array of extra volume mounts to be added to the container (evaluated as template). Normally used with `extraVolumes`.	`[]`
`lifecycleHooks`	LifecycleHook to set additional configuration at startup. Evaluated as a template	`{}`
`podLabels`	Add additional labels to the pod (evaluated as a template)	`{}`
`initContainers`	Attach additional init containers to the pod (evaluated as a template)	`[]`
`sidecars`	Attach additional containers to the pod (evaluated as a template)	`[]`
`priorityClassName`	Priority class assigned to the Pods	`""`
`schedulerName`	Alternative scheduler	`""`
`terminationGracePeriodSeconds`	In seconds, time the given to the pod to terminate gracefully	`""`
`containerPorts.http`	Container HTTP port	`8080`
`containerPorts.https`	Container HTTPS port	`8443`

Traffic Exposure Parameters¶

Name	Description	Value
`service.type`	Kubernetes Service type	`LoadBalancer`
`service.loadBalancerIP`	Use serviceLoadBalancerIP to request a specific static IP, otherwise leave blank	`""`
`service.ports.http`	Service HTTP port	`80`
`service.ports.https`	Service HTTPS port	`443`
`service.nodePorts`	Use nodePorts to request some specific ports when using NodePort	`{}`
`service.clusterIP`	Kubernetes service Cluster IP	`""`
`service.loadBalancerSourceRanges`	Kubernetes service Load Balancer sources	`[]`
`service.externalTrafficPolicy`	Enable client source IP preservation	`Cluster`
`service.extraPorts`	Extra ports to expose in the service (normally used with the `sidecar` value)	`[]`
`service.annotations`	Annotations to add to the service	`{}`
`service.sessionAffinity`	Session Affinity for Kubernetes service, can be "None" or "ClientIP"	`None`
`service.sessionAffinityConfig`	Additional settings for the sessionAffinity	`{}`
`ingress.enabled`	Set to true to enable ingress record generation	`false`
`ingress.pathType`	Ingress Path type	`ImplementationSpecific`
`ingress.apiVersion`	Override API Version (automatically detected if not set)	`""`
`ingress.hostname`	When the ingress is enabled, a host pointing to this will be created	`dokuwiki.local`
`ingress.path`	The Path to Dokuwiki. You may need to set this to '/*' in order to use this	`/`
`ingress.annotations`	Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.	`{}`
`ingress.tls`	Enable TLS configuration for the hostname defined at ingress.hostname parameter	`false`
`ingress.extraHosts`	The list of additional hostnames to be covered with this ingress record.	`[]`
`ingress.extraPaths`	Any additional arbitrary paths that may need to be added to the ingress under the main host.	`[]`
`ingress.extraTls`	The tls configuration for additional hostnames to be covered with this ingress record.	`[]`
`ingress.secrets`	If you're providing your own certificates, please use this to add the certificates as secrets	`[]`
`ingress.ingressClassName`	IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)	`""`
`ingress.selfSigned`	Create a TLS secret for this ingress record using self-signed certificates generated by Helm	`false`
`ingress.extraRules`	Additional rules to be covered with this ingress record	`[]`

Volume Permissions parameters¶

Name	Description	Value
`volumePermissions.enabled`	Enable init container that changes volume permissions in the data directory (for cases where the default k8s `runAsUser` and `fsUser` values do not work)	`false`
`volumePermissions.image.registry`	Init container volume-permissions image registry	`docker.io`
`volumePermissions.image.repository`	Init container volume-permissions image name	`bitnami/bitnami-shell`
`volumePermissions.image.tag`	Init container volume-permissions image tag	`11-debian-11-r130`
`volumePermissions.image.digest`	Init container volume-permissions image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	`""`
`volumePermissions.image.pullPolicy`	Init container volume-permissions image pull policy	`IfNotPresent`
`volumePermissions.image.pullSecrets`	Specify docker-registry secret names as an array	`[]`
`volumePermissions.resources.limits`	The resources limits for the container	`{}`
`volumePermissions.resources.requests`	The requested resources for the container	`{}`

Metrics parameters¶

Name	Description	Value
`metrics.enabled`	Start a exporter side-car	`false`
`metrics.image.registry`	Apache exporter image registry	`docker.io`
`metrics.image.repository`	Apache exporter image name	`bitnami/apache-exporter`
`metrics.image.tag`	Apache exporter image tag	`0.13.4-debian-11-r9`
`metrics.image.digest`	Apache exporter image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	`""`
`metrics.image.pullPolicy`	Image pull policy	`IfNotPresent`
`metrics.image.pullSecrets`	Specify docker-registry secret names as an array	`[]`
`metrics.podAnnotations`	Additional annotations for Metrics exporter pod	`{}`
`metrics.resources`	Exporter resource requests/limit	`{}`

Certificate injection parameters¶

Name	Description	Value
`certificates.customCertificate.certificateSecret`	Secret containing the certificate and key to add	`""`
`certificates.customCertificate.chainSecret.name`	Name of the secret containing the certificate chain	`""`
`certificates.customCertificate.chainSecret.key`	Key of the certificate chain file inside the secret	`""`
`certificates.customCertificate.certificateLocation`	Location in the container to store the certificate	`/etc/ssl/certs/ssl-cert-snakeoil.pem`
`certificates.customCertificate.keyLocation`	Location in the container to store the private key	`/etc/ssl/private/ssl-cert-snakeoil.key`
`certificates.customCertificate.chainLocation`	Location in the container to store the certificate chain	`/etc/ssl/certs/mychain.pem`
`certificates.customCAs`	Defines a list of secrets to import into the container trust store	`[]`
`certificates.command`	Override default container command (useful when using custom images)	`[]`
`certificates.args`	Override default container args (useful when using custom images)	`[]`
`certificates.extraEnvVars`	Container sidecar extra environment variables (eg proxy)	`[]`
`certificates.extraEnvVarsCM`	ConfigMap containing extra env vars	`""`
`certificates.extraEnvVarsSecret`	Secret containing extra env vars (in case of sensitive data)	`""`
`certificates.image.registry`	Container sidecar registry	`docker.io`
`certificates.image.repository`	Container sidecar image	`bitnami/bitnami-shell`
`certificates.image.tag`	Container sidecar image tag	`11-debian-11-r130`
`certificates.image.digest`	Container sidecar image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag	`""`
`certificates.image.pullPolicy`	Container sidecar image pull policy	`IfNotPresent`
`certificates.image.pullSecrets`	Container sidecar image pull secrets	`[]`

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 my-release \
  --set dokuwikiUsername=admin,dokuwikiPassword=password \
    bitnami/dokuwiki

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

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

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 -f values.yaml bitnami/dokuwiki

Tip: You can use the default values.yaml

Configuration and installation details¶

Rolling VS Immutable tags ¶

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Setting Pod's affinity¶

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Persistence¶

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

Certificates¶

CA Certificates¶

Custom CA certificates not included in the base docker image can be added with the following configuration. The secret must exist in the same namespace as the deployment. Will load all certificates files it finds in the secret.

certificates:
  customCAs:
  - secret: my-ca-1
  - secret: my-ca-2

CA Certificates secret¶

Secret can be created with:

kubectl create secret generic my-ca-1 --from-file my-ca-1.crt

TLS Certificate¶

A web server TLS Certificate can be injected into the container with the following configuration. The certificate will be stored at the location specified in the certificateLocation value.

certificates:
  customCertificate:
    certificateSecret: my-secret
    certificateLocation: /ssl/server.pem
    keyLocation: /ssl/key.pem
    chainSecret:
      name: my-cert-chain-secret
      key: chain.pem

TLS secret¶

The certificate tls secret can be created with:

kubectl create secret tls my-secret --cert tls.crt --key tls.key

The certificate chain is created with:

kubectl create secret generic my-ca-1 --from-file my-ca-1.crt

Troubleshooting¶

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading¶

To 12.0.0¶

Some of the chart values were changed to adapt to the latest Bitnami standards. More specifically:

containerPort was changed to containerPorts.http
service.port was changed to service.ports.http

No issues should be expected when upgrading.

To 11.0.0¶

This version standardizes the way of defining Ingress rules. When configuring a single hostname for the Ingress rule, set the ingress.hostname value. When defining more than one, set the ingress.extraHosts array. Apart from this case, no issues are expected to appear when upgrading.

To 10.0.0¶

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?¶

Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
Move dependency information from the requirements.yaml to the Chart.yaml
After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to this version¶

If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links¶

To 7.0.0¶

This version also introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.

The Bitnami Dokuwiki image was migrated to a "non-root" user approach. Previously the container ran as the root user and the Apache daemon was started as the daemon user. From now on, both the container and the Apache daemon run as user 1001. You can revert this behavior by setting the parameters containerSecurityContext.runAsUser to root.

Consequences:

The HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443.
Backwards compatibility is not guaranteed.

To upgrade to 7.0.0, backup Drupal data and the previous MariaDB databases, install a new Drupal chart and import the backups and data, ensuring the 1001 user has the appropriate permissions on the migrated volume.

To 6.0.0¶

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17294 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

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"}]'

License¶

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.