Portainer Templates logo

Portainer Templates

Percona XtraDB Cluster

Stack

Databases

Percona XtraDB Cluster - synchronous, multi-primary MySQL high availability built on Galera.

Configuration

Type
Compose
Platform
linux
Env vars
MYSQL_DATABASE=appMYSQL_PASSWORD=''MYSQL_ROOT_PASSWORD=''MYSQL_USER=app
Source
Repo

Template by deployable-sh·Source

Report issue

Services

pxc-node1

Configuration

Image
percona/percona-xtradb-cluster:8.4
Ports
3306:3306
Volumes
/var/lib/mysql : node1-data
Env vars
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}CLUSTER_NAME=pxcMYSQL_DATABASE=${MYSQL_DATABASE:-app}MYSQL_USER=${MYSQL_USER:-app}MYSQL_PASSWORD=${MYSQL_PASSWORD}
Restart
unless-stopped

Image details

Pulls: 40.5M
User: percona
Created: Jun 09, 2016
Updated: 14 days ago
Status: active

pxc-node2

Configuration

Image
percona/percona-xtradb-cluster:8.4
Volumes
/var/lib/mysql : node2-data
Env vars
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}CLUSTER_NAME=pxcCLUSTER_JOIN=pxc-node1
Restart
unless-stopped

Image details

Pulls: 40.5M
User: percona
Created: Jun 09, 2016
Updated: 14 days ago
Status: active

pxc-node3

Configuration

Image
percona/percona-xtradb-cluster:8.4
Volumes
/var/lib/mysql : node3-data
Env vars
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}CLUSTER_NAME=pxcCLUSTER_JOIN=pxc-node1
Restart
unless-stopped

Image details

Pulls: 40.5M
User: percona
Created: Jun 09, 2016
Updated: 14 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Percona XtraDB Cluster

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Percona XtraDB Cluster, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: percona-xtradb-cluster

x-pxc: &pxc
  image: percona/percona-xtradb-cluster:8.4
  restart: unless-stopped
  stop_grace_period: 2m

services:
  pxc-node1:
    <<: *pxc
    environment:
      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
      CLUSTER_NAME: pxc
      MYSQL_DATABASE: ${MYSQL_DATABASE:-app}
      MYSQL_USER: ${MYSQL_USER:-app}
      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
    ports:
      - "3306:3306"
    volumes:
      - node1-data:/var/lib/mysql

  pxc-node2:
    <<: *pxc
    environment:
      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
      CLUSTER_NAME: pxc
      CLUSTER_JOIN: pxc-node1
    depends_on: [pxc-node1]
    volumes:
      - node2-data:/var/lib/mysql

  pxc-node3:
    <<: *pxc
    environment:
      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
      CLUSTER_NAME: pxc
      CLUSTER_JOIN: pxc-node1
    depends_on: [pxc-node1]
    volumes:
      - node3-data:/var/lib/mysql

volumes:
  node1-data:
  node2-data:
  node3-data:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f percona-xtradb-cluster/compose.yaml up -d

More install options in our documentation.

Container Documentation

pxc-node1 Documentation

Percona XtraDB Cluster docker image | https://github.com/percona-lab/percona-docker/

pxc-node2 Documentation

Percona XtraDB Cluster docker image | https://github.com/percona-lab/percona-docker/

pxc-node3 Documentation

Percona XtraDB Cluster docker image | https://github.com/percona-lab/percona-docker/

Serve Percona XtraDB Cluster on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying percona-xtradb-cluster.example.com to http://pxc-node1:3306

Add this to your Caddyfile

percona-xtradb-cluster.example.com {
	reverse_proxy http://pxc-node1:3306
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3306 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3306
  • Stop the other service, or pick a different host port. In 3306:3306 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3306. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, percona-xtradb-cluster can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3306

Image won't pull

Test the pull directly on the host: docker pull percona/percona-xtradb-cluster:8.4

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Percona XtraDB Cluster is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • pxc-node1 runs percona/percona-xtradb-cluster:8.4
  • pxc-node2 runs percona/percona-xtradb-cluster:8.4, starts after pxc-node1
  • pxc-node3 runs percona/percona-xtradb-cluster:8.4, starts after pxc-node1

Ports

A port is the door the app answers on. A mapping like 3306:3306 means it's reachable on port 3306 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3306:3306

Volumes

A volume is where Percona XtraDB Cluster keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/mysql kept in the node1-data volume Docker manages
  • /var/lib/mysql kept in the node2-data volume Docker manages
  • /var/lib/mysql kept in the node3-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Percona XtraDB Cluster takes 6 of them, all with defaults you can leave alone or tweak:

  • MYSQL_ROOT_PASSWORD, pulled from your own environment
  • CLUSTER_NAME, defaults to pxc
  • MYSQL_DATABASE, defaults to app
  • MYSQL_USER, defaults to app
  • MYSQL_PASSWORD, pulled from your own environment
  • CLUSTER_JOIN, defaults to pxc-node1

Restart policy

The restart policy here is unless-stopped, so Docker restarts Percona XtraDB Cluster after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like pxc-node1) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Percona XtraDB Cluster up. Add the template list to Portainer once, then deploying Percona XtraDB Cluster is a click rather than a wall of config.