Tutoriel – Déployer MySQL 8.0 InnoDB Cluster

août 30, 2018

Une nouvelle version de ce tutoriel est disponible.

Il concerne les versions MySQL supérieures ou égales à 8.0.17:

Tutoriel – Déployer MySQL 8.0 InnoDB Cluster (09-2019)

Pour les versions inférieures tu peux rester sur cette page, mais cependant, je t’invite vivement à utiliser la dernière GA en date.

C’est dommage de se priver des nouvelles fonctionnalités.

😉



Cela fait maintenant plus d’un trimestre que MySQL 8.0 est GA (8.0.11; 8.0.12), il est grand temps que je t’en parle 🙂

Dans la liste des besoins essentiels de mes clients se trouve la Haute Disponibilité avec MySQL. On va voir, dans cet article, comment déployer et gérer un cluster MySQL « from scratch » , sous la forme d’un tutoriel, grâce à la solution HA tout en un : MySQL InnoDB Cluster.

Si tu utilises MySQL 5.7 tu peux également mettre en oeuvre InnoDB Cluster, je te recommande cet article: Tutoriel – Déployer MySQL 5.7 InnoDB Cluster.

Note: L’article traite de MySQL InnoDB Cluster, HA natif de MySQL Server (plugin Group Replication) avec pour moteur de stockage InnoDB, solution à ne pas confondre avec MySQL NDB Cluster (moteur de stockage NDB).

Le contexte

3 instances MySQL autonomes, <spoil alert> qui vont grâce au plugin MySQL Group Replication se transformer en une base de données distribuée.</spoil alert>

  • Instance MySQL 1 (mysql_8.0_node1) : 172.19.0.11; Nœud numéro 1 du cluster
  • Instance MySQL 2 (mysql_8.0_node2) : 172.19.0.12; Nœud numéro 2 du cluster
  • Instance MySQL 3 (mysql_8.0_node3) : 172.19.0.13; Nœud numéro 3 du cluster

1 instance applicative : 192.168.1.11; MySQL Router + mon application.

Note: J’utilise l’image Docker MySQL Server supportée par l’équipe MySQL d’Oracle.

Note: Je n’aborde pas dans cet article la redondance de MySQL Router. Plusieurs scénarios sont possibles, je te recommande de lire ça, ceci et cela.

MySQL Shell n’a pas besoin d’être installé sur toutes les instances (contrairement à 5.7, pour persister la configuration), cependant ce client texte est quand même beaucoup plus puissant que le client texte par défaut. Si tu ne le connais pas encore, essaie le et tu verras tu ne pourras plus t’en passer 🙂

En ce qui concerne les versions des logiciels, ce sont les plus récentes à ce jour (journée caniculaire du mois d’août 2018):

Note: Dans cet article j’utilise la dernière GA de MySQL 8.0. En ce qui concerne MySQL Router et MySQL Shell, il est impératif d’utiliser la dernière version courante.

Pour récapituler notre architecture, une image valant (au moins) 1000 mots, ça nous donne à :

MySQL InnoDB Cluster Architecture

Vérifier la configuration des instances

La première étape consiste à s’assurer que les instances MySQL sont correctement configurées pour l’utilisation de MySQL Group Replication, la couche haute disponibilité de notre architecture. A noter qu’il est préférable de provisionner ses instances déjà correctement configurées (comme détaillé dans cet article) pour MySQL Group Replication.

Note: J’utilise le compte utilisateur root pour configurer le cluster, cependant ce n’est pas un pré-requis. Il est possible (et souhaitable) de créer un compte utilisateur spécifique (ou plusieurs), avec les droits qui vont bien. La méthode recommandée pour créer cet utilisateur et d’utiliser l’option clusterAdmin des méthodes dba.configureInstance() et cluster.addInstance(). Plus d’info ici (Paragraphe « User Privileges »).

La vérification de la configuration se fait grâce à MySQL Shell et la méthode checkInstanceConfiguration() :

Dans mon cas, avec l’installation Docker de MySQL 8.0 par défaut sous Ubuntu, niveau configuration j’ai quasiment tout à faire 🙂

La méthode renvoie un document JSON (pratique pour l’automatisation) avec la liste des tâches à effectuer pour être conforme… Configurons donc !

J’ai deux solutions :

  • 1/ je prépare mes instances « manuellement » (cette tâche peut bien évidemment s’automatiser) comme expliqué dans l’article comment configurer un groupe.
  • 2/ je laisse MySQL Shell faire le boulot en utilisant la méthode : configureInstance()

je sens que ton cœur balance pour la 2… moi aussi 🙂 :

Alors plusieurs commentaires !

Les informations de configurations sont automatiquement sauvegardées avec la commande SET PERSIST. Commande super pratique (Cloud Friendly) apparue en 8.0, qui me permet de faire des changements de configurations à chaud (online) et persistants, stockés dans le fichier mysqld-auto.cnf.

On peut également voir ces informations en SQL, grâce à la table persisted_variables de performance_schema :

La persistance des changements ce fait automatiquement grâce au paramètre persisted_globals_load activé par défaut (ON). Elle est effective après l’exécution des commandes:

Note: je te recommande cet excellent article sur les variables persistantes de mon non moins excellent collègue Jesper.

SET PERSIST est très appréciable dans les environnements où accéder au fichier de configuration est compliqué voir impossible (Cloud Friendly, je te dis!!!). Cependant, dans un environnement plus maîtrisé (plus classique), il peut être préférable, de centraliser toutes les informations de configurations dans le fichier de configuration original (my.cnf / my.ini).

C’est bien évidemment possible grâce à l’option mycnfPath de la méthode dba.configureInstance().

Exemple:

Tu as donc le choix !

Grâce à ton œil aiguisé, tu as remarqué, que l’outil me propose de redémarrer l’instance MySQL, ce qui est bien pratique. Cependant, dans le cas présent, la plateforme que j’utilise (image Docker) ne dispose pas d’un processus de supervision de mysqld (comme c’est généralement le cas sur ta plateforme préférée. Info ici). En clair, je vais devoir redémarrer sans l’outil (mais je devrai m’en sortir… ou pas 🙂 ).

Note: Assure toi d’avoir les droits nécessaires pour mettre à jour le fichier de configuration de MySQL.

L’instance 172.19.0.11 est configurée et prête pour être un membre d’un cluster MySQL InnoDB Cluster  !

On peut le vérifier en redémarrant l’instance MySQL et refaire un checkInstanceConfiguration  :

Statut: OK.

La même procédure doit être appliquée sur les autres instances MySQL.

Je me retrouve, après configuration et redémarrage  avec le résultat suivant:

All good!

Créer le cluster

Une fois les 3 instances correctement configurées, l’étape suivante consiste à créer le cluster avec createCluster. Cette méthode va être jouée sur le premier membre, l’instance MySQL sur  172.19.0.11,  elle va permettre de créer un cluster… d’un nœud.   Bon faut bien commencer quelque part 🙂 :

createCluster() prend comme paramètre le nom du cluster (pocCluster). Je peux lui passer également quelques information optionnelles comme la whitelist.

On peut vérifier l’état du nœud dans le cluster avec status() :

Notes : Assure toi que ton DNS (ou /etc/hosts) est correctement configuré, sinon tu vas avoir des soucis de connections…

L’ajouts des nœuds suivant se fait avec addInstance(), il est néanmoins conseillé d’exécuter checkInstanceState() au préalable pour s’assurer de la compatibilité des GTID sets :

Nœud 2

Au cas où l’instance ajoutée contient plus de transactions que le groupe checkInstanceState le fait savoir :

En fonction du contexte, il faut alors soit restaurer une sauvegarde d’un membre du cluster sur l’instance problématique (celle qui diverge) ou alors si tu sais ce que tu fais, une synchronisation des GTIDs est toujours possible, voir un reset master.

Nœud 3

Et le résultat final:

Et voilà!

Un Cluster MySQL Group Replication de 3 nœuds facilement et rapidement déployé grâce à MySQL Shell, c’est ça MySQL InnoDB Cluster (enfin presque, il manque encore un élément).

La configuration actuelle est la suivante:

  • Nœud 1 (mysql_8.0_node1) = 172.19.0.11 : Primaire (lecture/écriture)
  • Nœud 2 (mysql_8.0_node2) = 172.19.0.12 : Secondaire (lecture seule)
  • Nœud 3 (mysql_8.0_node3) = 172.19.0.13 : Secondaire (lecture seule)

Et qu’est ce que l’on fait maintenant ???

Le Router !

Le Router !

Le Router !

Configuration de MySQL Router

Il est recommandé d’installer MySQL Router sur la machine hôte de l’application, je vais donc suivre cette recommandation et l’installer sur la machine 192.168.1.11.

Note: Si tu ne peux (veux) pas mettre MySQL Router sur l’application, il va alors te falloir gérer le HA du Router. Plusieurs solutions sont envisageables comme :

Bootstrap MySQL Router

La première étape est le bootstrap, c’est à dire créer un lien entre MySQL Router et le cluster. Il faut donc fournir à mysqlrouter au minimum l’adresse d’un membre du cluster :

Note: il se peut que tu rencontres un problème de permission. Probablement dû à la configuration de AppArmor… Google (ou équivalent) est ton ami 🙂 (si tu es sous Ubuntu clic ici)

J’ai créé une configuration différente de celle par défaut, en personnalisant avec quelques options:

  • conf-base-port : le port proposé par défaut est 6446 pour la lecture/écriture. Dans mon cas, je veux utiliser le célèbre port 3306.
  • directory : histoire de ranger tout le bazar de cette instance de Router dans le répertoire spécifié.

La liste complète des options est disponible ici.

Pour résumer, 4 ports TCP ont été configurés, dont 2 pour les connexions MySQL traditionnelles:

3306 (au lieu de 6446 par défaut) : lectures / écritures pour le nœud primaire
3307 (au lieu de 6447 par défaut) : lectures seules pour les nœuds secondaires (en Round-Robin)
Et le pendant pour les connexions avec le protocole X (3308 & 3309 (au lieu de respectivement 64460 & 64470)), pour une utilisation NoSQL Document Store de MySQL.

Le fichier de configuration de MySQL Router contient quelques informations importantes, tel que le(s) port(s) à utiliser par l’application (comme vu précédemment) :

Il est évidemment possible de modifier ce fichier.

Ensuite, il faut démarrer MySQL Router avec le script start.sh

L’arrêt du Router se fait avec le script stop.sh (mais tu l’avais deviné)

Voilà pour le Router !

C’est terminé pour la phase de déploiement du cluster.

Simple, rapide et surtout facilement automatisable, tels sont les principales caractéristiques de MySQL InnoDB Cluster. Qualités qui constituent le cœur même de l’ADN de MySQL.


Se connecter au cluster

A partir de maintenant, ton cluster est « up and running ». Ton application va donc devoir se connecter au port 3306 (car on l’a configuré comme cela, sinon c’est 6446 par défaut) pour utiliser la base de donnée. D’ailleurs du point de vue de l’application, la base de donnée est MySQL Router, sauf qu’en réalité ce n’est pas 1 instance, mais bel et bien 3 instances MySQL qui sont en backend et ceci en toute transparence \o/.

La partie utilisation du cluster est hors du scope de cet article, mais on peut facilement simuler le comportement de l’application avec un client MySQL et MySQL router.

Je me connecte avec MySQL Shell en mode SQL (ça c’est l’applicatif), au cluster (à mysql_8.0_node1, nœud primaire InnoDB Cluster), par l’intermédiaire de MySQL Router en localhost (car je suis sur la machine 192.168.1.11) sur le port 3306.

Le paramètre report_host (défini dans mon fichier de configuration) me renvoi la valeur du  nœud 1, le primaire.

En cas d’arrêt du primaire, un nouveau va être automatiquement élu par le cluster (voir paragraphe failover plus bas) est la même commande me donnera un résultat différent:

Gestion des nœuds

Quelques commandes qui vont te simplifier la vie…

Performance_Schema

Quelques informations sont disponibles en SQL au niveau des instances.

Identifier le nœud primaire

Description des membres du cluster

Récupérer les méta-données d’un cluster

Les méta-données du cluster sont stockées sur les membres dans le schéma mysql_innodb_cluster_metadata :

Pour récupérer les informations relatives à l’état du cluster dans une nouvelle session il faut utiliser la méthode dba.getCluster :

Failover

Le basculement niveau base de données (changement de primaire) est automatiquement géré par les membres du cluster entre eux.

Crash du noeud primaire (172.19.0.11)…

Nouveau primaire élu par le groupe : 172.19.0.13.

Et 172.19.0.11 est porté disparu (MIA).

Les données configuration cluster étant sauvegardées, une fois le nœud redémarré/réparé/restauré il fera automatiquement parti du cluster à nouveau. et il aura un rôle de secondaire.

En cas de configuration non persistante, un rejoinInstance() est nécessaire pour remettre le nœud dans le cluster. (voir paragraphe suivant Remettre un membre dans le groupe).

Remettre un membre dans le groupe

Nécessaire si la conf n’est pas persistante ou si la variable group_replication_start_on_boot = OFF.

Le nœud peut alors être remit dans le groupe avec la commande rejoinInstance() :

Supprimer une instance du groupe

Sans grande surprise, c’est la commande removeInstance

L’instance n’est alors plus listée dans les méta-données :

Pour la remettre dans le groupe, il faut donc rejouer le processus de l’ajout d’instance vu plus haut :

Perte du quorum

Si le cluster perd plus de la moitié de ses membres (crash ou split brain par exemple) il se retrouve dans un état assez désagréable, network partitioning, en clair il faut une intervention externe au cluster pour permettre aux membres restant de continuer à faire leur boulot.

Note: Par perte j’entend arrêt non prévu (crash). En cas d’arrêt normal ou propre, même si le cluster perd son quorum (dans ce cas présent arrêt normal de 2 nœuds), le nœud restant sait que les autres nœuds ne sont plus là (en clair pas de risque de split brain) donc le cluster continue de fonctionner. Mais c’est un cluster avec un seul nœud… 

Dans notre cas, avec 3 instances, il faut en perdre 2 d’un coup :

Perte des nœuds (crash) 172.19.0.11 & 172.19.0.12…  (Mayday, Mayday, Mayday!!!)

Le failover automatique ne peut pas s’enclencher, le nœud survivant (172.19.0.13) est bloqué.

Il faut donc intervenir :

Evidemment, sauf si tu es joueur 🙂 , il faut éviter de rester trop longtemps dans cet état.

Une fois les instances remisent en condition, il faut soit simplement les démarrer ou alors utiliser rejoinInstance() pour les remettre dans le cluster, en tant que secondaire.

Repartir après un arrêt total du cluster

La perte du quorum est une chose, mais il y a pire, perdre tout les nœuds…

En cas d’arrêt total du cluster i.e. toutes les instances sont éteintes, il faut utiliser, une fois les instances MySQL de nouveau démarrées  rebootClusterFromCompleteOutage() :

Le reboot doit se faire sur l’instance la plus à jour (ici la machine 172.19.0.13) :

Le membre sur lequel la commande est exécutée est le nouveau primaire.

Voilà c’est tout pour aujourd’hui 🙂

Dans la même thématique :

Video:

Articles connexes:

Thanks for using MySQL!

12 Responses to “Tutoriel – Déployer MySQL 8.0 InnoDB Cluster”

  1. […] Si tu utilises MySQL 8.0, alors lit plutôt ce tuto : Tutoriel – Déployer MySQL 8.0 InnoDB Cluster. […]

  2. Bonjour,

    Merci pour cet excellent article. Ce tutoriel peut-il aussi s’appliquer à MariaDB ? Merci

  3. Merci pour ton feedback.
    La réponse courte: non!
    La réponse légèrement plus élaborée, mariadb est un fork de MySQL 5.1, version qui a plus de 10 ans maintenant…
    http://dasini.net/blog/2017/07/19/topo-sur-les-premieres-versions-publique-de-mysql/
    Même si ils réutilisent certains de nos produits (InnoDB par exemple), avec plus ou moins de succès, on a bien aujourd’hui 2 bases de données vraiment différentes et à la compatibilité plus qu’aléatoire.
    Il faut donc faire le bon choix pour ses applications critiques 😉

  4. Bonjour,

    Je teste la procédure avec Mysql 8.0.12 sur windows server 2016.

    La création du cluster est ok, mais qd je rajoute la 2ème instance, celle-si est dans l’état « RECOVERING ».

    MySQL 192.168.100.112:33060+ ssl JS > cluster.status()
    {
    « clusterName »: « gtcCluster »,
    « defaultReplicaSet »: {
    « name »: « default »,
    « primary »: « 192.168.100.112:3306 »,
    « ssl »: « REQUIRED »,
    « status »: « OK_NO_TOLERANCE »,
    « statusText »: « Cluster is NOT tolerant to any failures. 1 member is not active »,
    « topology »: {
    « 192.168.100.111:3306 »: {
    « address »: « 192.168.100.111:3306 »,
    « mode »: « R/O »,
    « readReplicas »: {},
    « role »: « HA »,
    « status »: « RECOVERING »
    },
    « 192.168.100.112:3306 »: {
    « address »: « 192.168.100.112:3306 »,
    « mode »: « R/W »,
    « readReplicas »: {},
    « role »: « HA »,
    « status »: « ONLINE »
    }
    }
    },
    « groupInformationSourceMember »: « mysql://root@192.168.100.112:3306 »
    }

    Une idée d’ou peut venir ce problème ???
    J’ai redéroulée plusieurs fois la procédure from scratch en reinstallant mysql 8 sur chaque serveur.

  5. […] See my MySQL InnoDB Cluster tutorial. […]

  6. […] Tutoriel – Déployer MySQL 8.0 InnoDB Cluster […]

  7. […] have a MySQL InnoDB Cluster up and running. If not, please RTFM ?Additionally you can read this tutorial and this article from my colleague […]

  8. […] already know what is MySQL Group Replication & MySQL InnoDB Cluster.Additionally you can read this tutorial and this article from my colleague lefred or this one on Windows Platform from my colleague […]

  9. […] make it as simple as possible ?I’m using MySQL 8.0.16.I have an InnoDB Cluster setup – up and running.So my main assumption is that you already know what is MySQL Group […]

  10. […] have an InnoDB Cluster setup, up and running.So my main assumption is that you already know what is MySQL Group Replication […]

  11. […] Tutoriel – Déployer MySQL 8.0 InnoDB Cluster […]

  12. […] fait maintenant 1 an que j’ai écris la v1 de ce tuto sur MySQL InnoDB Cluster (ici) et durant ce laps de temps, mes collègues d’Oracle MySQL ont travaillé très dur pour […]