05edfda8c1
* Renaming ASB -> OSBA * Open Service Broker Azure -> Open Service Broker for Azure * Removing "the" and adding drupal changes. |
||
---|---|---|
.. | ||
templates | ||
.helmignore | ||
Chart.yaml | ||
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.
This chart bootstraps a phpBB deployment on a Kubernetes cluster using the Helm package manager.
It is inspired by the upstream phpBB chart, but, by default, utilizes Open Service Broker For Azure to provision an Azure Database for MySQL database for the Wordpress server to use.
Basic Installation
Installation of this chart is simple. First, ensure that you've added the azure repository. Then, install from the Azure repo:
$ helm install azure/phpbb
Prerequisites
To install this chart, you must have:
- Kubernetes 1.7+ with beta APIs enabled
- Service-Catalog installed
- The Open Service Broker for Azure installed
- PV provisioner support in the underlying infrastructure
For details on setting up these prerequisites, please see the prerequisites doc
Installing the Chart
To install the chart with the release name my-release
in the namespace phpbb:
$ helm install --name my-release --namespace phpbb azure/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 tables lists the configurable parameters of the phpBB chart and their default values.
Parameter | Description | Default |
---|---|---|
image |
phpBB image | bitnami/phpbb:{VERSION} |
imagePullPolicy |
Image pull policy | IfNotPresent |
phpbbUser |
User of the application | user |
phpbbPassword |
Application password | random 10 character long alphanumeric string |
phpbbEmail |
Admin email | user@example.com |
smtpHost |
SMTP host | nil |
smtpPort |
SMTP port | 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 | 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 |
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 \
azure/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 azure/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.