Back to Charts

phpMyAdmin

stable/phpmyadmin/README.md

latest15.0 KB
Original Source

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.

This Helm chart is deprecated

Given the stable deprecation timeline, the Bitnami maintained phpMyAdmin Helm chart is now located at bitnami/charts.

The Bitnami repository is already included in the Hubs and we will continue providing the same cadence of updates, support, etc that we've been keeping here these years. Installation instructions are very similar, just adding the bitnami repo and using it during the installation (bitnami/<chart> instead of stable/<chart>)

bash
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/<chart>           # Helm 3
$ helm install --name my-release bitnami/<chart>    # Helm 2

To update an exisiting stable deployment with a chart hosted in the bitnami repository you can execute

bash
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm upgrade my-release bitnami/<chart>

Issues and PRs related to the chart itself will be redirected to bitnami/charts GitHub repository. In the same way, we'll be happy to answer questions related to this migration process in this issue created as a common place for discussion.

TL;DR;

console
$ helm install my-release stable/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

Installing the Chart

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

console
$ helm install my-release stable/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:

console
$ 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.

ParameterDescriptionDefault
global.imageRegistryGlobal Docker image registrynil
global.imagePullSecretsGlobal Docker registry secret names as an array[] (does not add image pull secrets to deployed pods)
image.registryphpMyAdmin image registrydocker.io
image.repositoryphpMyAdmin image namebitnami/phpmyadmin
image.tagphpMyAdmin image tag{TAG_NAME}
image.pullPolicyImage pull policyIfNotPresent
image.pullSecretsSpecify docker-registry secret names as an array[] (does not add image pull secrets to deployed pods)
nameOverrideString to partially override phpmyadmin.fullname template with a string (will prepend the release name)nil
fullnameOverrideString to fully override phpmyadmin.fullname template with a stringnil
service.typeType of service for phpMyAdmin frontendClusterIP
service.portPort to expose service80
db.portDatabase port to use to connect3306
db.chartNameDatabase suffix if included in the same releasenil
db.hostDatabase host to connect tonil
db.bundleTestDBDeploy a MariaDB instance for testing purposesfalse
db.enableSslEnable SSL for the connection between phpMyAdmin and the databasefalse
db.ssl.clientKeyClient key file when using SSL``
db.ssl.clientCertificateClient certificate file when using SSL``
db.ssl.caCertificateCA file when using SSL``
db.ssl.ciphersList of allowable ciphers for connections when using SSLnil
db.ssl.verifyEnable SSL certificate validationtrue
ingress.enabledEnable ingress controller resourcefalse
ingress.certManagerAdd annotations for cert-managerfalse
ingress.rewriteTargetAdd annotations to redirect traffic to /true
ingress.annotationsIngress annotations{}
ingress.hosts[0].nameHostname to your PHPMyAdmin installationphpmyadmin.local
ingress.hosts[0].pathPath within the url structure/
ingress.hosts[0].tlsUtilize TLS backend in ingressfalse
ingress.hosts[0].tlsHostsArray of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil)nil
ingress.hosts[0].tlsSecretTLS Secret (certificates)phpmyadmin.local-tls-secret
resourcesCPU/Memory resource requests/limits{}
nodeSelectorNode labels for pod assignment{}
tolerationsList of node taints to tolerate[]
affinityMap of node/pod affinities{}
podLabelsPod labels{}
podAnnotationsPod annotations{}
metrics.enabledStart a side-car prometheus exporterfalse
metrics.image.registryApache exporter image registrydocker.io
metrics.image.repositoryApache exporter image namebitnami/apache-exporter
metrics.image.tagApache exporter image tag{TAG_NAME}
metrics.image.pullPolicyImage pull policyIfNotPresent
metrics.image.pullSecretsSpecify docker-registry secret names as an array[] (does not add image pull secrets to deployed pods)
metrics.podAnnotationsAdditional annotations for Metrics exporter pod{prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resourcesExporter 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,

console
$ helm install my-release \
  --set db.host=mymariadb,db.port=3306 stable/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,

console
$ helm install my-release -f values.yaml stable/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 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:

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