Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
templates
.helmignore
Chart.yaml
OWNERS
README.md
requirements.lock
requirements.yaml
values.yaml

README.md

phpBB

phpBB is an Internet forum package written in the PHP scripting language. The name "phpBB" is an abbreviation of PHP Bulletin Board.

TL;DR;

$ helm install stable/phpbb

Introduction

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

It also packages the Bitnami MariaDB chart which is required for bootstrapping a MariaDB deployment for the database requirements of the phpBB application.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.

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/phpbb

The command deploys phpBB 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 phpBB chart and their default values.

Parameter Description Default
global.imageRegistry Global Docker image registry nil
global.imagePullSecrets Global Docker registry secret names as an array [] (does not add image pull secrets to deployed pods)
image.registry phpBB image registry docker.io
image.repository phpBB image name bitnami/phpbb
image.tag phpBB image tag {VERSION}
image.pullPolicy Image pull policy Always if imageTag is latest, else IfNotPresent
image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
phpbbUser User of the application user
phpbbPassword Application password random 10 character long alphanumeric string
phpbbEmail Admin email user@example.com
allowEmptyPassword Allow DB blank passwords yes
smtpHost SMTP host nil
smtpPort SMTP port nil
smtpUser SMTP user nil
smtpPassword SMTP password nil
externalDatabase.host Host of the external database nil
externalDatabase.user Existing username in the external db bn_phpbb
externalDatabase.password Password for the above username nil
externalDatabase.database Name of the existing database bitnami_phpbb
ingress.enabled Enable ingress controller resource false
ingress.annotations Ingress annotations []
ingress.certManager Add annotations for cert-manager false
ingress.hosts[0].name Hostname to your phpbb installation phpbb.local
ingress.hosts[0].path Path within the url structure /
ingress.hosts[0].tls Utilize TLS backend in ingress false
ingress.hosts[0].tlsHosts Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil) nil
ingress.hosts[0].tlsSecret TLS Secret (certificates) phpbb.local-tls-secret
ingress.secrets[0].name TLS Secret Name nil
ingress.secrets[0].certificate TLS Secret Certificate nil
ingress.secrets[0].key TLS Secret Key nil
mariadb.enabled Use or not the MariaDB chart true
mariadb.rootUser.password MariaDB admin password nil
mariadb.db.name Database name to create bitnami_phpbb
mariadb.db.user Database user to create bn_phpbb
mariadb.db.password Password for the database random 10 character long alphanumeric string
service.type Kubernetes Service type LoadBalancer
service.port Service HTTP port (Dashboard) 80
nodePorts.http Kubernetes http node port ""
nodePorts.https Kubernetes https node port ""
service.externalTrafficPolicy Enable client source IP preservation Cluster
service.nodePorts.http Kubernetes http node port ""
service.nodePorts.https Kubernetes https node port ""
service.loadBalancerIP LoadBalancer service IP ""
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.phpbb.storageClass PVC Storage Class for phpBB volume nil (uses alpha storage class annotation)
persistence.phpbb.accessMode PVC Access Mode for phpBB volume ReadWriteOnce
persistence.phpbb.size PVC Storage Request for phpBB volume 8Gi
resources CPU/Memory resource requests/limits Memory: 512Mi, CPU: 300m
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 [] (does not add image pull secrets to deployed pods)
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/phpbb. For more information please refer to the bitnami/phpbb image documentation.

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

$ helm install --name my-release \
  --set phpbbUser=admin,phpbbPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/phpbb

The above command sets the phpBB 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,

$ helm install --name my-release -f values.yaml stable/phpbb

Tip: You can use the default values.yaml

Persistence

The Bitnami phpBB image stores the phpBB data and configurations at the /bitnami/phpbb 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 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 phpbb:

$ kubectl patch deployment phpbb-phpbb --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset phpbb-mariadb --cascade=false
You can’t perform that action at this time.