anydbver

LXD+Ansible setup to install Percona database products with exact version specified.

Simple usage:

Start VirtualBox VM with LXD configured:

vagrant up
vagrant ssh

Start Percona Server 5.6:

cd anydbver
./anydbver deploy ps:5.6

Login to container with Percona Server and connect with mysql command:

./anydbver ssh
mysql

Running other database products:

Start the database with required server type and version:

./anydbver deploy help
Deploy:
./anydbver deploy percona-server:8.0.16
./anydbver deploy percona-server:8.0
./anydbver deploy percona-server
./anydbver deploy ps:5.7
./anydbver deploy ps:5.7 mydumper
./anydbver deploy ps:8.0.22 xtrabackup
./anydbver deploy ps:5.7 perf devel
./anydbver deploy ps node1 sysbench sysbench-mysql:default oltp_read_write
./anydbver deploy hn:vault.percona.local vault node1 ps:8.0 vault-server:vault.percona.local
./anydbver deploy ps:5.7 percona-toolkit
./anydbver deploy ps:8.0.22 hn:ps0 node1 ps:8.0.22 hn:ps1 node2 ps:8.0.22 hn:ps2 master:ps0 node2 ps:8.0.22 master:ps1 channel:ps1ch
./anydbver deploy mysql
./anydbver deploy \
  hn:mysql_rs0_gr0 mysql:8.0.18 group-replication \
  node1 hn:mysql_rs0_gr1 mysql:8.0.18 group-replication master:default \
  node2 hn:mysql_rs0_gr2 mysql:8.0.18 group-replication master:default \
  node3 hn:mysql_rs0_router mysql-router:8.0.18 master:default
./anydbver deploy mariadb:10.4
./anydbver deploy maria:10.4
./anydbver deploy mariadb node1 mariadb master:default
./anydbver deploy mariadb node1 mariadb master:default default mariadb master:node1 node2 mariadb master:node1
./anydbver deploy mariadb-cluster:10.3.26:25.3.30
./anydbver deploy mariadb-cluster:10.4 node1 mariadb-cluster:10.4 galera-master:default node2 mariadb-cluster:10.4 galera-master:default
./anydbver deploy ldap node1 ldap-master:default ps:5.7
./anydbver deploy ps:5.7 node1 ps:5.7 master:default node2 ps:5.7 master:node1
./anydbver deploy ps:5.7 hostname:leader.percona.local node1 ps:5.7 hostname:follower.percona.local leader:default
./anydbver deploy ps:8.0 utf8 node1 ps:5.7 master:default node2 ps:5.6 master:node1 row
./anydbver deploy hn:ps0 ps:5.7 node1 hn:ps1 ps:5.7 master:default node2 hn:ps2 ps:5.7 master:node1 node3 hn:orc orchestrator master:default
./anydbver deploy samba node1 ps samba-dc:default
./anydbver deploy pxc:5.7 node1 pxc:5.7 galera-master:default node2 pxc:5.7 galera-master:default
./anydbver deploy \
 pxc:5.7 node1 pxc:5.7 galera-master:default node2 pxc:5.7 galera-master:default \
 node3 pxc:5.7 cluster:cluster2 node4 pxc:5.7 cluster:cluster2 galera-master:node3 node5 pxc:5.7 cluster:cluster2 galera-master:node3
./anydbver deploy pxc:5.7 node1 pxc:5.7 galera-master:default node2 pxc:5.7 garbd galera-master:default
./anydbver deploy \
  haproxy-galera:node1,node2,node3 \
  node1 pxc clustercheck \
  node2 pxc galera-master:node1 clustercheck \
  node3 pxc galera-master:node1 clustercheck
./anydbver deploy ps:8.0 group-replication node1 ps:8.0 group-replication master:default node2 ps:8.0 group-replication master:default
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-mongo
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-minio k8s-mongo
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-pxc
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default cert-manager k8s-pxc
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-minio k8s-pmm k8s-pxc backup
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-minio k8s-pxc backup pxc57
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-pg
./anydbver deploy k3s node1 k3s-master:default node2 k3s-master:default node3 k3s-master:default default k8s-pg-zalando
./anydbver deploy pg:12.3
./anydbver deploy pg:12.3 node1 pg:12.3 master:default
./anydbver deploy pg node1 pg master:default default pg pgpool backend-ip:default
./anydbver deploy pg:13 patroni node1 pg:13 master:default patroni etcd-ip:default node2 pg:13 master:default patroni etcd-ip:default
./anydbver deploy haproxy-pg:node1,node2,node3 node1 pg clustercheck node2 pg clustercheck master:node1 node3 pg clustercheck master:node1
./anydbver deploy pmm node1 ppg pmm-client pmm-server:default
./anydbver deploy postgresql sysbench sysbench-pg:default oltp_read_write
./anydbver deploy percona-postgresql \
  sysbench sysbench-pg:default oltp_read_write # prepare, execute run_sysbench.sh to start sysbench
./anydbver deploy \
        postgresql sysbench sysbench-pg:default oltp_read_write  \
  node1 postgresql master:default logical:sbtest  \
  node2 postgresql master:default logical:sbtest
./anydbver deploy psmdb
./anydbver deploy mongo pbm
./anydbver deploy psmdb replica-set:rs0 node1 psmdb master:default replica-set:rs0 node2 psmdb master:default replica-set:rs0
./anydbver deploy \
 psmdb:4.2 replica-set:rs0 shardsrv \
 node1 psmdb:4.2 master:default replica-set:rs0 shardsrv \
 node2 psmdb:4.2 master:default replica-set:rs0 shardsrv \
 node3 psmdb:4.2 configsrv replica-set:cfg0 \
 node4 psmdb:4.2 configsrv replica-set:cfg0 master:node3 \
 node5 psmdb:4.2 configsrv replica-set:cfg0 master:node3 \
 node6 psmdb:4.2 mongos-cfg:cfg0/node3,node4,node5 mongos-shard:rs0/default,node1,node2
./anydbver deploy ldap node1 ldap-master:default psmdb:4.2
./anydbver deploy samba node1 psmdb:4.2 samba-dc:default
./anydbver deploy sysbench
./anydbver deploy ps:5.7 node1 ps:5.7 master:default node2 ps:5.7 master:default node3 proxysql master:default
./anydbver deploy ps:5.7 node1 ps:5.7 master:default node2 ps:5.7 master:default \
  node3 proxysql master:default node4 proxysql proxysql-ip:node3 node5 proxysql proxysql-ip:node3
./anydbver deploy pxc:5.7 node1 pxc:5.7 galera-master:default node2 pxc:5.7 galera-master:default node3 proxysql galera-master:default
./anydbver deploy pxc node1 pxc galera-master:default node2 pxc galera-master:default node3 proxysql galera-master:default
./anydbver deploy pmm node1 ps:5.7 pmm-client pmm-server:default
./anydbver deploy pmm:1.17.4 node1 ps:5.7 pmm-client:1.17.4 pmm-server:default
./anydbver deploy docker
./anydbver deploy docker docker-registry hn:registry.percona.local
./anydbver deploy mongo help
./anydbver deploy psmdb help

Connect to selected node via ssh:

Complex anydbver setups including multiple linux containers. The first container has a default name, others node1, node2.... You can connect to any node with ssh:

./anydbver ssh # connects to default node
./anydbver ssh node1

Specifying host names for nodes

In complex setups each node could have individual name. The name is specified as a linux hostname, could be used for ssh, replication source, ldap server name.

./anydbver deploy ps:5.6 hostname:ps0.percona.local node1 ps:5.6 hostname:ps1.percona.local leader:ps0
./anydbver ssh ps0
./anydbver ssh ps1.percona.local

Updating version information

anydbver stores lists of version for each database product in temporary files. You can update it with latest values by running:

./anydbver update

Container OS image

By default, containers are based on CentOS 7. Newer distributions are not supporting all old database versions, but you still can use CentOS 8, Oracle Enterprise linux 7 and 8 or Ubuntu 20.04 Focal Fossa:

./anydbver deploy \
  ps:5.7 os:el7 \
  node1 ps:5.7 os:el8 master:default \
  node2 ps:5.7 os:focal master:default \
  node3 ps:5.7 os:oel7 master:default \
  node4 ps:5.7 os:oel8 master:default \
  node5 ps:5.7 os:bionic master:default

for i in default node{1,2,3,4,5} ; do ./anydbver ssh $i grep PRETTY_NAME /etc/os-release ; done
PRETTY_NAME="CentOS Linux 7 (Core)"
PRETTY_NAME="CentOS Linux 8"
PRETTY_NAME="Ubuntu 20.04.2 LTS"
PRETTY_NAME="Oracle Linux Server 7.9"
PRETTY_NAME="Oracle Linux Server 8.3"
PRETTY_NAME="Ubuntu 18.04.5 LTS"

Default os could be changed with --os osname. Put it right after deploy keyword:

./anydbver deploy --os el8 ps node1 ps master:default

Default OS is not disabling explicit os specification:

./anydbver deploy --os el8 ps node1 ps master:default node2 os:el7 ps

Allows to install a specific version of:

• Percona Server
• Percona XtraDB Cluster
• PMM Server and clients
• Percona Server for MongoDB
• Percona Distribution for PostgreSQL
• Community Postgresql Server
• K3S kubernetes distribution

Advanced Installation

If you are able to run LXD on your linux server, there is no need to run additional virtual machines. Anydbver can re-use your LXD installation and run without vagrant.

# Specify LXD profile. It's important on servers with shared lxd environment
# In order to use non-default storage or network you should create a profile:
lxc storage create $USER dir source=/home/$USER/lxc
lxc profile copy default $USER
# replace pool: "your_storage_name", e.g with above $USER suggestion put your unix username instead of your_storage_name
lxc profile edit $USER
# add LXD_PROFILE also to your .bashrc to avoid using default storage pool
export LXD_PROFILE=$USER

Clone the repository and configure default provider:

git clone https://github.com/ihanick/anydbver.git
cd anydbver
./anydbver configure provider:lxd
./anydbver update

Kubernetes, PMM

Nested containers support is required for PMM server and Kubernetes operators. If your current setup is not able to run k3s, check https://github.com/corneliusweig/kubernetes-lxd/blob/master/README-k3s.md for lxd

In addition kubernetes requires /etc/sysctl.conf:

vm.overcommit_memory = 1
vm.overcommit_ratio = 10000
kernel.panic = 10
kernel.panic_on_oops = 1

Multi-user LXD setup requires high values for sysctl user.max_inotify_watches like 64k or 100k instead of default 8k to prevent "Error: No space left on device" problem.

In order to prevent dns issues inside k8s containers: https://kubernetes.io/docs/tasks/administer-cluster/dns-debugging-resolution/ reply from unexpected source problem could be solved with loading br_netfilter module

modprobe br_netfilter
modprobe overlay

You may have problems with flannel using vxlan network. Enable host-gw instead, add to your .bashrc:

export K3S_FLANNEL_BACKEND=host-gw

LXD 4.10 incompatibility with K3S

LXD 4.10 breaks compabibility with K3S. LXD ignores net.netfilter.nf_conntrack_tcp_timeout_established value on the host and uses default 5 days instead of 86400 seconds required for K3S. You can downgrade it, but LXD looses all settings:

# assuming you have LXD 4.10, do not run these commands on previous versions:
snap remove lxd
snap install lxd --channel=4.9/stable
# remove old storage and re-create profile
sudo rm -rf /home/$USER/lxc/*
lxc storage create $USER dir source=/home/$USER/lxc
lxc profile create $USER
lxc profile device add $USER root disk type=disk pool=$USER path=/
lxc network create lxdbr0
lxc profile device add $USER eth0 nic name=eth0 network=lxdbr0 type=nic

Anydbver command line parameters structure

Huge number of anydbver parameters and parameters order could be confusing. ./anydbver deploy command is:

• A list of node definitions

./anydbver deploy \
    node0 <what to install and how to setup on node0> \
    node1 <what to install and how to setup on node1>

• You can omit a default node name (named default or node0)

./anydbver deploy \
          <what to install and how to setup on node0> \
    node1 <what to install and how to setup on node1>

• You can't inject gaps in the node list, the following example finished with error, because only default and node1 nodes are created:

./anydbver deploy node2 percona-server:5.6
[WARNING]: Could not match supplied host pattern, ignoring: ihanick.node2
ERROR! Specified hosts and/or --limit does not match any hosts

• Installation/setup parameters could be configurable: optionname:parameter. Usually it's a version, e.g. percona-server:5.7 or percona-server:5.7.31. Other parameters requires node name or host name:

./anydbver deploy \
          mysql:5.7 hostname:server0.example.com \
    node1 mysql:5.7 master:server0.example.com

• Sometimes it's required to run multiple actions on the same host after configuring other hosts, you can repeat nodename name

./anydbver deploy \
          <what to install and how to setup on node0> \
    node1 <what to install and how to setup on node1> \
    node0 <stage 2 installation/setup steps on node0>

Global ./anydbver options

./anydbver --option_name

• --namespace, required parameter namespace name, allows to run multiple independent deployment for the same linux user

Global ./anydbver deploy options

./anydbver deploy --option_name

• --dry-run, show ansible commands without actual deploy/servers creation
• --os, required parameter os name (el7,el8,oel7,oel8, focal, bionic), specify OS for every container in a deployment
  • el7, CentOS 7
  • el8, CentOS 8
  • oel7, Oracle Linux 7
  • oel8, Oracle Linux 8
  • bionic, Ubuntu 18.04
  • focal, Ubuntu 20.04
  • stretch, Debian 9
  • buster, Debian 10
• --shared-directory, mount $PWD/tmp/shared_dir (LXD containers) as /nfs on each server

The full list of parameters

• anydbver, fetch docker-podman-k8s branch inside container: running replication setups with unmodified Docker images with docker or podman
• backup
• backend-ip, Postgresql Primary IP for PGPool II setup
• cache, required to add cache image name: cache:ps-5.7.31 . After first run save container as an image. For next anydbver executions use image do not run ansible. You can show existing caches with ./anydbver list-caches
• cert-manager, certmanager, Install Cert Manager before installing operators
• channel, mysql replication channel
• cluster
• clustercheck
• configsrv
• debug, install gdb and debug information packages
• development, short devel
• docker, installs Docker
• docker-registry, configures load Docker registry
• etcd-ip
• galera-master
• garbd
• group-replication
• gtid
• haproxy-galera
• haproxy-postgresql, short haproxy-pg
• haproxy
• hostname, short hn
• install
• k3s-master, alias k3s-leader
• k3s, k8s, kubernetes
• k8s-minio
• k8s-mongo
• k8s-pg, Percona Postgresql Operator
• k8s-pg-zalando, Zalando Postgresql Operator
• k8s-pmm
• k8s-pxc
• kube-config
• ldap-master, alias ldap-leader, OpenLDAP server node name
• ldap-server, short ldap
• ldap-simple
• logical, required parameter the database name, e.g. logical:sbtest
• mariadb-galera
• mariadb, short maria
• master_ip, short master, alias leader
• mongos-cfg
• mongos-shard
• mydumper
• mysql-jdbc
• mysql-router
• mysql
• mysql-ndb-data, Install MySQL NDB Cluster data node
• mysql-ndb-management, Install MySQL NDB Cluster management node
• mysql-ndb-sql, Install MySQL NDB Cluster sql node
• ndb-connectstring, List of MySQL NDB Cluster management nodes, comma separated
• ndb-data-nodes, List of MySQL NDB Cluster data nodes, comma separated
• ndb-sql-nodes, List of MySQL NDB Cluster sql nodes, comma separated
• odyssey, Installs Yandex Odyssey
• oltp_read_write
• orchestrator
• os, req. OS name see --os, overrides container OS image for the current node
• parallel apply ansible configuration in parallel for this and previous nodes (unstable)
• patroni
• percona-backup-mongodb, short pbm, install PBM
• pbm-agent, setup and start pbm agent and local filesystem for PBM
• percona-postgresql, short ppg
• percona-proxysql
• percona-server, short ps
• percona-toolkit
• percona-xtrabackup, short pxb
• percona-xtradb-cluster
• perf, install Linux Perf
• pgpool, installs PGPool II, requires pg option for version detection
• pmm-client
• pmm-server, required parameter PMM server node name.
• pmm
• podman, install podman for nested "Docker" containers
• postgresql, short pg
• proxysql-ip
• proxysql
• psmdb, mongo
• pxc57, Use Percona XtraDB Cluster 5.7 with Kubernetes
• rbr, alias row, row-based-replication
• replica-set
• samba-ad, short samba, install Samba with Active Directory support
• samba-dc, required parameter - samba server name
• shardsrv, mark MongoDB server as shard data node
• sysbench, installs sysbench package
• sysbench-mysql, required parameter - MySQL server node name to benchmark.
• sysbench-pg, required parameter - Postgresql server node name to benchmark.
• utf8mb3, short utf8
• vault-server, required parameter hashicorp vault server node name.
• vault
• virtual-machine, use KVM virtual machine
• wal-g, installs WAL-g