ansibleguy.infra_mariadb

Rôle Ansible - Base de Données MariaDB - Multi-Instance

Rôle Ansible pour déployer une ou plusieurs instances de MariaDB sur un serveur Linux.

Logs Molecule : Court, Complet

Testé :

Debian 11

Installation

# dernière version
ansible-galaxy role install git+https://github.com/ansibleguy/infra_mariadb

# depuis galaxy
ansible-galaxy install ansibleguy.infra_mariadb

# ou vers un chemin de rôle personnalisé
ansible-galaxy install ansibleguy.infra_mariadb --roles-path ./roles

# installer les dépendances
ansible-galaxy install -r requirements.yml

Utilisation

Vous voulez une interface graphique Ansible simple ? Découvrez ma WebUI Ansible

Configuration

Vous devez définir vos instances en configurant le dictionnaire 'mariadb' !

mariadb:
  service:
    SyslogIdentifier: 'mariadb_ag_%I'  # %I = Instance-Key
    
  instances:
    api:
      root_pwd: !vault |
        $ANSIBLE_VAULT;1.1;AES256
        64373031333937633163366236663237623464336461613334343739323763373330393930666331
        3333663262346337636536383539303834373733326631310a393865653831663238383937626238
        35396531316338373030353530663465343838373635363633613035356338353366373231343264
        3437356663383466630a666161363163346533333139656566386466383733646134616166376638
        35313765356134396130333439663461353336313230366338646165376666313232

      dbs:
        api:
          encoding: 'utf8mb4'

        templates:
        deprecated:
          state: 'absent'
      
      users:
        app:
          priv: 'api.*:ALL'
          pwd: !vault ...
        guy:
          priv: 'api.*:SELECT,SHOW VIEW'
          state: 'absent'
          pwd: !vault ...

      settings:
        # port: 3306
        innodb_log_file_size: 5G
        max_connections: 2000

      backup:
        enabled: true
        dbs: ['api']
        time: '*-*-* 01:00'
        # pour le format date-heure voir :
        #   https://wiki.archlinux.org/title/Systemd/Timers
        #   https://silentlad.com/systemd-timers-oncalendar-(cron)-format-explained
        creds:
          create: true

    test:
      ansible_user: 'not_root'
      ansible_pwd: !vault ...
      dbs:
        test:
          
      users:
        dummy:
          priv: 'test.*:ALL'
          pwd: !vault ...
          update_pwd: 'always'  # sinon il ne sera défini qu'à la création ; changer le mot de passe toujours pourrait poser des problèmes avec des répliques actives-actives

      settings:
        port: 3307
        log_warnings: 4
        long_query_time: 2
        max_allowed_packet: 2G

    old_instance:
      state: 'absent'

Vous voudrez peut-être utiliser 'ansible-vault' pour chiffrer vos mots de passe :

ansible-vault encrypt_string

Exécution

Exécutez le playbook :

ansible-playbook -K -D -i inventory/hosts.yml playbook.yml --ask-vault-pass

Il existe également quelques tags utiles :

base => ne configure que les bases ; les instances ne seront pas touchées
instances
config => configuration (base et instances)
dbs
backup => tâches de sauvegarde d'instance
users

Pour déboguer les erreurs - vous pouvez définir la variable 'debug' à l'exécution :

ansible-playbook -K -D -i inventory/hosts.yml playbook.yml -e debug=yes

Fonctionnalités

Installation de paquets
- Dépendances Ansible (minimales)
- MariaDB
Configuration
- Plusieurs instances de MariaDB
- Création/suppression de bases de données et d'utilisateurs
- Script de vérification de démarrage qui supporte plusieurs instances
- Options par défaut :
  - Execution des tâches de installation sécurisée
  - Swappiness réduit
  - Limite de fichiers ouverts augmentée (sysctl, service, db)
- Options par défaut désactivées :
  - Tâche de sauvegarde de DB
- Configuration par défaut :
  - Répertoire de données d'instance : "/var/lib/mysql/instance_${KEY}/"
  - Configuration d'instance : "/etc/mysql/instance.conf.d/server_${KEY}.cnf"
  - Redémarrage du service en cas d'échec
  - Journalisation dans syslog
  - Liaison uniquement à localhost
  - SSL OFF
  - Logs des requêtes lentes
  - Fichier InnoDB par table
  - Requêtes DNS DB désactivées
  - pour plus d'infos, consultez l'exemple ci-dessous

Infos

AVERTISSEMENT : Ce rôle attend que l'instance mariadb/mysql par défaut (mysql.service/mariadb.service) sur le système cible ne soit pas utilisée !
Son socket et port sont changés en exécutant ce rôle !
AVERTISSEMENT : Si vous exécutez vos serveurs de bases de données dans une configuration active-active, vous ne devez JAMAIS exécuter le rôle sur les deux nœuds en même temps !
Sinon, les tâches de création d'utilisateur/base de données peuvent perturber votre synchronisation !
Remarque : Ce rôle ne prend actuellement en charge que les systèmes basés sur Debian.
Remarque : La plupart des fonctionnalités du rôle peuvent être activées ou désactivées.

Pour toutes les options disponibles - consultez la configuration par défaut située dans le fichier principal des défauts !
Remarque : Nous utilisons les modules communautaires officiels pour la configuration de database et user. Le support de réplication pourrait être ajouté ultérieurement.
Remarque : La gestion des certificats pourrait être ajoutée ultérieurement à ce rôle.
Pour l'instant, vous devez fournir les certificats manuellement (_placés dans /etc/mysql/ssl/{INSTANCE_KEY}/[ca|cert|key].pem)
Remarque : Vous devez fournir les privilèges de mysql-user EXACTEMENT comme retournés par une instruction SHOW GRANT !
Astuce : Si vous montez explicitement le répertoire de données - vous devriez définir certaines options de montage pour optimiser les performances :
- noatime,nodiratime
Avertissement : Les connexions via TCP/IP à localhost/127.0.0.1 ne fonctionneront pas par défaut lorsque 'skip-name-resolve' est activé !

Cela entraînera cette erreur : Host '127.0.0.1' is not allowed to connect to this MariaDB server

Exemple

Configuration

mariadb:
  instances:
    guydb:
      root_pwd: !vault ...

      dbs:
        nice:
        memes:

      users:
        django:
          priv: 'backup.creds.defaults_file is not nonmemes.*:ALL'
          pwd: !vault ...
        backup:
          priv: '*.*:SELECT,RELOAD,PROCESS,LOCK TABLES,BINLOG MONITOR,SHOW VIEW,EVENT,TRIGGER'
          pwd: !vault ...

Résultat :

# répertoires de configuration
guy@ansible:~# tree /etc/mysql
> /etc/mysql/
> ├── conf.d
> │   ├── mysql.cnf
> │   └── mysqldump.cnf
> ├── debian.cnf
> ├── debian-start  # script de démarrage de l'instance par défaut
> ├── debian-start-instance.sh  # script de démarrage multi-instance
> ├── instance.conf.d  # configurations des instances
> │   ├── client_guydb_startup-checks.cnf  # données de connexion pour le service utilisateur de vérification de démarrage
> │   └── server_guydb.cnf  # configuration du serveur d'instance
> ├── mariadb.cnf  # configuration de l'instance par défaut
> ├── mariadb.conf.d
> ├── my.cnf -> /etc/alternatives/my.cnf
> └── my.cnf.fallback

# répertoires de données
guy@ansible:~# tree /var/lib/mysql
> /var/lib/mysql/
> ├── default
> │  └── ...  # instance par défaut mysql
> │
> ├── instance_guydb
> │  └── ...  # instance configurée
> │
> └── ...  # fichiers par défaut => non nettoyés automatiquement

# fichier de configuration de l'instance
guy@ansible:~# cat /etc/mysql/instance.conf.d/server_guydb.cnf 
> # Géré par Ansible
> [mysqld]
> datadir = /var/lib/mysql/instance_guydb
> basedir = /usr
> pid-file = /run/mysqld/mysqld_guydb.pid
> socket = /run/mysqld/mysqld_guydb.sock
> lc_messages_dir = /usr/share/mysql
> 
> # paramètres
> user = mysql
> group = mysql
> bind_address = 127.0.0.1
> port = 3306
> log_warnings = 2
> character-set-server = utf8mb4
> collation-server = utf8mb4_general_ci
> innodb_file_per_table = 1
> innodb_buffer_pool_size = 512M
> innodb_log_file_size = 1GB
> max_allowed_packet = 512M
> max_connections = 500
> query_cache_size = 64M
> tmp_table_size = 64M
> max_heap_table_size = 64M
> slow-query-log = 1
> slow-query-log-file = slow-queries.log
> long_query_time = 1
> wait_timeout = 60
> symbolic-links = 0
> local-infile = 0
> open_files_limit = 1048576

# configuration du service
guy@ansible:~# cat /etc/systemd/system/[email protected]/override.conf 
> # Géré par Ansible
> 
> [Unit]
> ConditionPathExists=/etc/mysql/instance.conf.d/server_%I.cnf
> ConditionPathExists=/etc/mysql/debian-start-instance.sh
> ConditionPathExists=/etc/mysql/instance.conf.d/client_%I_startup-checks.cnf
> Documentation=https://github.com/ansibleguy/infra_mariadb
> 
> [Service]
> Environment='MYSQLD_MULTI_INSTANCE=--defaults-file=/etc/mysql/instance.conf.d/server_%I.cnf --defaults-group-suffix=.%I'
> ExecStartPost=
> ExecStartPost=/etc/mysql/debian-start-instance.sh %I
> 
> LimitNOFILE=1048576
> StandardOutput=journal
> StandardError=journal
> SyslogIdentifier=mariadb_%I
> TimeoutStartSec=900
> TimeoutStopSec=900
> Restart=on-abort
> RestartSec=5s
> OOMScoreAdjust=-600
> BlockIOWeight=1000

# statut du service
guy@ansible:~# systemctl status [email protected] 
> ● [email protected] - Serveur de base de données MariaDB 10.5.12 (multi-instance guydb)
>      Loaded: loaded (/lib/systemd/system/[email protected]; enabled; vendor preset: enabled)
>     Drop-In: /etc/systemd/system/[email protected]
>              └─override.conf
>      Active: active (running)
>        Docs: man:mariadbd(8)
>              https://mariadb.com/kb/en/library/systemd/
>              https://github.com/ansibleguy/infra_mariadb
>     Process: 134872 ExecStartPre=/usr/bin/mysql_install_db $MYSQLD_MULTI_INSTANCE (code=exited, status=0/SUCCESS)
>     Process: 134910 ExecStartPost=/etc/mysql/debian-start-instance.sh guydb (code=exited, status=0/SUCCESS)
>      Status: "Prêt à traiter vos requêtes SQL."
>      CGroup: /system.slice/system-mariadb.slice/[email protected]
>              └─134898 /usr/sbin/mariadbd --defaults-file=/etc/mysql/instance.conf.d/server_guydb.cnf --defaults-group-suffix=.guydb

# bases de données
guy@ansible:~# mysql --socket=/run/mysql/mysqld_guydb.sock -p -e "show databases;"
> +--------------------+
> | Base de données    |
> +--------------------+
> | nice               |
> | memes              |
> | information_schema |
> | mysql              |
> | performance_schema |
> +--------------------+

# utilisateurs mysql
guy@ansible:~# mysql --socket=/run/mysql/mysqld_guydb.sock -p -e "select user, host from mysql.user;"
> +------------------------+-----------+
> | Utilisateur            | Host      |
> +------------------------+-----------+
> | backup                 | localhost |
> | django                 | localhost |
> | mariadb.sys            | localhost |
> | mariadb_startup_checks | localhost |  # utilisateur de service nécessaire pour le script de démarrage (tâches de mise à niveau, etc.)
> | mysql                  | localhost |
> | root                   | localhost |
> +------------------------+-----------+

# privilèges mysql
guy@ansible:~# mysql --socket=/run/mysql/mysqld_guydb.sock -p -e "show grants for django@localhost;"
> +---------------------------------------------------------------------------+
> | Privilèges pour django@localhost                                           |
> +---------------------------------------------------------------------------+
> | GRANT USAGE ON *.* TO `django`@`localhost` IDENTIFIED BY PASSWORD 'XXXX'  |
> | GRANT ALL PRIVILEGES ON `memes`.* TO `django`@`localhost`                 |
> +---------------------------------------------------------------------------+

guy@ansible:~# mysql --socket=/run/mysql/mysqld_guydb.sock -p -e "show grants for backup@localhost;"
> +------------------------------------------------------------------------------------------------+
> | Privilèges pour backup@localhost                                                                |
> +------------------------------------------------------------------------------------------------+
> | GRANT SELECT, RELOAD, PROCESS, LOCK TABLES, BINLOG MONITOR, SHOW VIEW, EVENT, TRIGGER ON *.*   |
> | TO `backup`@`localhost` IDENTIFIED BY PASSWORD 'XXXX'                                          |
> +------------------------------------------------------------------------------------------------+

À propos du projet

Role to deploy one or multiple MariaDB instances on a linux server

role mariadb sql database

Installer

ansible-galaxy install ansibleguy.infra_mariadb

GitHub référentiel

3 étoiles

1 forks

0 problèmes ouverts

Licence

other

Téléchargements

Propriétaire

AnsibleGuy

[email protected] | GPG: https://badges.ansibleguy.net/public.gpg