charts/bitnami/phpmyadmin/README.md

phpMyAdmin

phpMyAdmin is a free and open source administration tool for MySQL and MariaDB. As a portable web application written primarily in PHP, it has become one of the most popular MySQL administration tools, especially for web hosting services.

TL;DR;

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

Introduction

This chart bootstraps a phpMyAdmin 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. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.

Prerequisites

• Kubernetes 1.8+ with Beta APIs enabled
• Helm 2.12+ or Helm 3.0-beta3+

Installing the Chart

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

$ helm install my-release bitnami/phpmyadmin

The command deploys phpMyAdmin 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 table lists the configurable parameters of the phpMyAdmin 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	phpMyAdmin image registry	docker.io
image.repository	phpMyAdmin image name	bitnami/phpmyadmin
image.tag	phpMyAdmin 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)
nameOverride	String to partially override phpmyadmin.fullname template with a string (will prepend the release name)	nil
fullnameOverride	String to fully override phpmyadmin.fullname template with a string	nil
service.type	Type of service for phpMyAdmin frontend	ClusterIP
service.port	Port to expose service	80
db.port	Database port to use to connect	3306
db.chartName	Database suffix if included in the same release	nil
db.host	Database host to connect to	nil
db.bundleTestDB	Deploy a MariaDB instance for testing purposes	false
db.enableSsl	Enable SSL for the connection between phpMyAdmin and the database	false
db.ssl.clientKey	Client key file when using SSL	nil
db.ssl.clientCertificate	Client certificate file when using SSL	nil
db.ssl.caCertificate	CA file when using SSL	nil
db.ssl.ciphers	List of allowable ciphers for connections when using SSL	nil
db.ssl.verify	Enable SSL certificate validation	true
ingress.enabled	Enable ingress controller resource	false
ingress.certManager	Add annotations for cert-manager	false
ingress.rewriteTarget	Add annotations to redirect traffic to /	true
ingress.annotations	Ingress annotations	{}
ingress.hosts[0].name	Hostname to your PHPMyAdmin installation	phpmyadmin.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)	phpmyadmin.local-tls-secret
extraEnvVars	Any extra environment variables to be passed to the pod (evaluated as a template)	{}
extraEnvVarsCM	Name of a Config Map containing extra environment variables to be passed to the pod (evaluated as a template)	nil
extraEnvVarsSecret	Secret with extra environment variables	nil
podSecurityContext	phpMyAdmin pods' Security Context	{ fsGroup: "1001" }
containerSecurityContext	phpMyAdmin containers' Security Context	{ runAsUser: "1001" }
resources.limits	The resources limits for the PhpMyAdmin container	{}
resources.requests	The requested resources for the PhpMyAdmin container	{}
livenessProbe	Liveness probe configuration for PhpMyAdmin	Check values.yaml file
readinessProbe	Readiness probe configuration for PhpMyAdmin	Check values.yaml file
nodeSelector	Node labels for pod assignment	{}
tolerations	List of node taints to tolerate	[]
affinity	Map of node/pod affinities	{}
podLabels	Pod labels	{}
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	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	{}

For more information please refer to the bitnami/phpmyadmin image documentation.

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

$ helm install my-release \
  --set db.host=mymariadb,db.port=3306 bitnami/phpmyadmin

The above command sets the phpMyAdmin to connect to a database in mymariadb host and 3306 port respectively.

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

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.

Upgrading

To 6.0.0

The Bitnami phpMyAdmin 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. Chart labels and Ingress configuration were also adapted to follow the Helm charts best practices.

Consequences:

• The HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443.
• No writing permissions will be granted on config.inc.php by default.
• Backwards compatibility is not guaranteed.

To upgrade to 6.0.0, backup your previous MariaDB databases, install a new phpMyAdmin chart and import the MariaDB backups.

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.

To 1.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 1.0.0. The following example assumes that the release name is phpmyadmin:

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