charts/bitnami/phabricator

Phabricator

Phabricator is a collection of open source web applications that help software companies build better software. Phabricator is built by developers for developers. Every feature is optimized around developer efficiency for however you like to work. Code Quality starts with an effective collaboration between team members.

TL;DR;

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/phabricator

Introduction

This chart bootstraps a Phabricator 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 Phabricator 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.12+
• Helm 2.12+ or Helm 3.0-beta3+
• 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/phabricator

The command deploys Phabricator 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

The following tables list the configurable parameters of the Phabricator chart and their default values per section/component:

Global parameters

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)
global.storageClass	Global storage class for dynamic provisioning	nil

Common parameters

Parameter	Description	Default
nameOverride	String to partially override phabricator.fullname template with a string (will prepend the release name)	nil
fullnameOverride	String to fully override phabricator.fullname template with a string	nil

Phabricator parameters

Parameter	Description	Default
image.registry	Phabricator image registry	docker.io
image.repository	Phabricator image name	bitnami/phabricator
image.tag	Phabricator image tag	{TAG_NAME}
image.pullPolicy	Image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
phabricatorHost	Phabricator host to create application URLs	nil
phabricatorAlternateFileDomain	Phabricator alternate domain to upload files	nil
phabricatorUsername	User of the application	user
phabricatorPassword	Application password	random 10 character long alphanumeric string
phabricatorEmail	Admin email	user@example.com
phabricatorFirstName	First name	First Name
phabricatorLastName	Last name	Last Name
smtpHost	SMTP host	nil
smtpPort	SMTP port	nil
smtpUser	SMTP user	nil
smtpPassword	SMTP password	nil
smtpProtocol	SMTP protocol [ssl, tls]	nil
nodeSelector	Node labels for pod assignment	nil
affinity	Node/pod affinities	nil
tolerations	List of node taints to tolerate	nil
podAnnotations	Pod annotations	{}
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for Phabricator volume	nil (uses alpha storage class annotation)
persistence.accessMode	PVC Access Mode for Phabricator volume	ReadWriteOnce
persistence.size	PVC Storage Request for Phabricator volume	8Gi
resources	CPU/Memory resource requests/limits	Memory: 512Mi, CPU: 300m

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

Database parameters

Parameter	Description	Default
mariadb.enabled	Deploy MariaDB container(s)	true
mariadb.rootUser.password	MariaDB admin password	nil
externalDatabase.host	Host of the external database	localhost
externalDatabase.rootUser	Existing username in the external db	bn_wordpress
externalDatabase.rootPassword	Password for the above username	nil
externalDatabase.database	Name of the existing database	bitnami_wordpress
externalDatabase.port	Database port number	3306

Traffic Exposure Parameters

Parameter	Description	Default
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.httpsPort	Service HTTP port	443
service.loadBalancerIP	loadBalancerIP for the Phabricator Service	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 rules resource	false
ingress.certManager	Add annotations for cert-manager	false
ingress.annotations	Ingress annotations	[]
ingress.hosts[0].name	Hostname to your Phabricator installation	phabricator.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)	phabricator.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

Metrics parameters

Parameter	Description	Default
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	bitnami/apache-exporter
metrics.image.tag	Apache exporter image tag	{TAG_NAME}
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	{}

Note

:

For Phabricator to function correctly, you should specify the phabricatorHost parameter to specify the FQDN (recommended) or the public IP address of the Phabricator service.

Optionally, you can specify the phabricatorLoadBalancerIP parameter to assign a reserved IP address to the Phabricator service of the chart. However please note that this feature is only available on a few cloud providers (f.e. GKE).

To reserve a public IP address on GKE:

$ gcloud compute addresses create phabricator-public-ip

The reserved IP address can be associated to the Phabricator service by specifying it as the value of the phabricatorLoadBalancerIP parameter while installing the chart.

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

$ helm install my-release \
  --set phabricatorUsername=admin,phabricatorPassword=password,mariadb.mariadbRootPassword=secretpassword \
  bitnami/phabricator

The above command sets the Phabricator 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 my-release -f values.yaml bitnami/phabricator

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.

Ingress with Reverse Proxy and cert-manager

You can define a custom ingress rule for Phabricator with TLS certificates auto-generated by cert-manager using the following parameters:

ingress.enabled=true
ingress.certManager=true
ingress.hosts[0].name=phabricator.example.com
ingress.tls[0].hosts[0]=phabricator.example.com
phabricatorHost=example.com

Everything looks great but requests over https will cause asset requests to fail. Assuming you want to use HTTPS/TLS you will need to set the base-uri to an https schema.

Using an external database

Sometimes you may want to have Phabricator connect to an external database rather than installing one inside your cluster, e.g. to use a managed database service, or use run a single database server for all your applications. To do this, the chart allows you to specify credentials for an external database under the externalDatabase parameter. You should also disable the MariaDB installation with the mariadb.enabled option. For example with the following parameters:

mariadb.enabled=false
externalDatabase.host=myexternalhost
externalDatabase.rootUser=myuser
externalDatabase.rootPassword=mypassword
externalDatabase.database=mydatabase
externalDatabase.port=3306

Note also if you disable MariaDB per above you MUST supply values for the externalDatabase connection.

Persistence

The Bitnami Phabricator image stores the Phabricator data and configurations at the /bitnami/phabricator 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.

Upgrading

To 9.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/pulls/17305 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 7.0.0

Backwards compatibility is not guaranteed. The following notables changes were included:

• Labels are adapted to follow the Helm charts best practices.
• The parameters persistence.phabricator.storageClass, persistence.phabricator.accessMode, and persistence.phabricator.size switch to persistence.storageClass, persistence.accessMode, and persistence.size.
• The way of setting the ingress rules has changed. Instead of using ingress.paths and ingress.hosts as separate objects, you should now define the rules as objects inside the ingress.hosts value, for example:

ingress:
  hosts:
  - name: phabricator.local
    path: /

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 opencart:

$ kubectl patch deployment opencart-opencart --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/app"}]'
$ kubectl delete statefulset opencart-mariadb --cascade=false