Clustering Looker

Ce tutoriel explique la méthode recommandée pour créer une configuration Looker en cluster pour les instances hébergées par le client.

Présentation

Les déploiements Looker hébergés par le client peuvent être à un seul nœud ou en cluster :

• Une application Looker à un seul nœud, la configuration par défaut, comporte tous les services qui composent l'application Looker s'exécutant sur un seul serveur.
• Une configuration Looker en cluster est une configuration plus complexe, impliquant généralement des serveurs de base de données, des équilibreurs de charge et plusieurs serveurs exécutant l'application Looker. Chaque nœud d'une application Looker en cluster est un serveur exécutant une seule instance Looker.

Une organisation peut souhaiter exécuter Looker en tant que cluster pour deux raisons principales :

• Équilibrage de charge
• Disponibilité et basculement améliorés

En fonction des problèmes de scaling, un Looker en cluster peut ne pas fournir la solution. Par exemple, si un petit nombre de requêtes volumineuses utilisent la mémoire système, la seule solution consiste à augmenter la mémoire disponible pour le processus Looker.

Alternatives à l'équilibrage de charge

Avant d'équilibrer la charge de Looker, envisagez d'augmenter la mémoire et éventuellement le nombre de processeurs d'un seul serveur exécutant Looker. Looker recommande de configurer une surveillance détaillée des performances pour l'utilisation de la mémoire et du processeur afin de s'assurer que le serveur Looker est correctement dimensionné pour sa charge de travail.

Les requêtes volumineuses nécessitent plus de mémoire pour de meilleures performances. Le clustering peut améliorer les performances lorsque de nombreux utilisateurs exécutent de petites requêtes.

Pour les configurations comportant jusqu'à 50 utilisateurs qui utilisent Looker de manière légère, Looker recommande d'exécuter un seul serveur équivalent à une instance AWS EC2 de grande taille (M4.large : 8 Go de RAM, 2 cœurs de processeur). Pour les configurations comportant plus d'utilisateurs ou de nombreux utilisateurs actifs, vérifiez si le processeur atteint des pics ou si les utilisateurs constatent une lenteur dans l'application. Si c'est le cas, déplacez Looker vers un serveur plus grand ou exécutez une configuration Looker en cluster.

Disponibilité/basculement améliorés

L'exécution de Looker dans un environnement en cluster peut réduire les temps d'arrêt en cas de panne. La haute disponibilité est particulièrement importante si l'API Looker est utilisée dans les systèmes d'entreprise principaux ou si Looker est intégré à des produits destinés aux clients.

Dans une configuration Looker en cluster, un serveur proxy ou un équilibreur de charge redirige le trafic lorsqu'il détermine qu'un nœud est en panne. Looker gère automatiquement les nœuds qui quittent le cluster et ceux qui le rejoignent.

Éléments individuels obligatoires

Les composants suivants sont requis pour une configuration Looker en cluster :

• Base de données d'application MySQL
• Nœuds Looker (serveurs exécutant le processus Java Looker)
• Équilibreur de charge
• Système de fichiers partagé
• Version appropriée des fichiers JAR de l'application Looker

Le schéma suivant illustre l'interaction entre les composants. De manière générale, un équilibreur de charge distribue le trafic réseau entre les nœuds Looker en cluster. Les nœuds communiquent chacun avec une base de données d'application MySQL partagée, un répertoire de stockage partagé et les serveurs Git pour chaque projet LookML.

Base de données d'application MySQL

Looker utilise une base de données d'application (souvent appelée base de données interne) pour stocker les données d'application. Lorsque Looker s'exécute en tant qu'application à un seul nœud, il utilise normalement une base de données HyperSQL en mémoire.

Dans une configuration Looker en cluster, l'instance Looker de chaque nœud doit pointer vers une base de données transactionnelle partagée (l'application partagée ou la base de données interne). La compatibilité avec la base de données d'application pour Looker en cluster est la suivante :

• Seul MySQL est compatible avec la base de données d'application pour les instances Looker en cluster. Amazon Aurora et MariaDB ne sont pas compatibles.
• Les versions 5.7+ et 8.0+ de MySQL sont compatibles.
• Les bases de données en cluster telles que Galera ne sont pas compatibles.

Remarque : Une base de données dupliquée avec accès en lecture est recommandée pour améliorer les performances et la redondance. Votre base de données dupliquée avec accès en lecture n'a pas besoin d'être une base de données MySQL.

Looker ne gère pas la maintenance ni les sauvegardes de cette base de données. Toutefois, étant donné que la base de données héberge la quasi-totalité des données de configuration de l'application Looker, elle doit être provisionnée en tant que base de données à haute disponibilité et sauvegardée au moins une fois par jour.

Nœuds Looker

Chaque nœud est un serveur sur lequel s'exécute le processus Java Looker. Les serveurs du cluster Looker doivent pouvoir se joindre les uns les autres et accéder à la base de données de l'application Looker. Les ports par défaut sont listés dans Ouvrir les ports pour que les nœuds communiquent sur cette page.

Équilibreur de charge

Pour équilibrer la charge ou rediriger les requêtes vers les nœuds disponibles, un équilibreur de charge ou un serveur proxy (par exemple, NGINX ou AWS ELB) est nécessaire pour diriger le trafic vers chaque nœud Looker. L'équilibreur de charge gère les vérifications de l'état. En cas de défaillance d'un nœud, l'équilibreur de charge doit être configuré pour rediriger le trafic vers les nœuds opérationnels restants.

Lorsque vous choisissez et configurez l'équilibreur de charge, assurez-vous qu'il peut être configuré pour fonctionner uniquement en tant que couche 4. L'équilibreur de charge Amazon Classic en est un exemple. De plus, l'équilibreur de charge doit avoir un délai d'inactivité long (3 600 secondes) pour éviter que les requêtes ne soient supprimées.

Système de fichiers partagé

Vous devez utiliser un système de fichiers partagé compatible avec POSIX (tel que NFS, AWS EFS, Gluster, BeeGFS, Lustre ou de nombreux autres). Looker utilise le système de fichiers partagé comme dépôt pour diverses informations utilisées par tous les nœuds du cluster.

Remarque : L'installation d'applications et d'outils à partir de Looker Marketplace nécessite l'utilisation d'un système de fichiers partagé (réseau).

Application Looker (exécutable JAR)

Vous devez utiliser un fichier JAR d'application Looker qui soit Looker 3.56 ou version ultérieure.

Remarque : À partir de Looker 6.18, le fichier JAR Looker a été divisé en deux fichiers JAR distincts : le fichier JAR principal Looker et un fichier JAR de dépendances Looker. Si vous installez Looker 6.18 ou version ultérieure, ou si vous effectuez une mise à jour vers cette version, veillez à télécharger les deux fichiers JAR.

Looker recommande vivement que chaque nœud d'un cluster exécute la même version de Looker et le même correctif, comme indiqué dans Démarrer Looker sur les nœuds de cette page.

Configurer le cluster

Les tâches suivantes sont requises :

1. Installer Looker
2. Configurer une base de données d'application MySQL
3. Configurer le système de fichiers partagé
4. Partager le dépôt de clés SSH (selon votre situation)
5. Ouvrir les ports pour que les nœuds communiquent
6. Démarrer Looker sur les nœuds

Installer Looker

Assurez-vous que Looker est installé sur chaque nœud à l'aide des fichiers JAR de l'application Looker et des instructions de la page de documentation Étapes d'installation hébergée par le client.

Configurer une base de données d'application MySQL

Pour une configuration Looker en cluster, la base de données d'application doit être une base de données MySQL. Si vous disposez d'une instance Looker non en cluster existante qui utilise HyperSQL pour la base de données d'application, vous devez migrer les données d'application des données HyperSQL vers votre nouvelle base de données d'application MySQL partagée.

Remarque : Veillez à sauvegarder votre répertoire Looker. Le processus de migration ne peut s'effectuer que d'une base de données HyperSQL vers une base de données MySQL, et non l'inverse.

Consultez la page de documentation Migrer vers MySQL pour savoir comment sauvegarder Looker, puis migrer la base de données d'application de HyperSQL vers MySQL.

Configurer le système de fichiers partagé

Seuls certains types de fichiers (fichiers de modèle, clés de déploiement, plug-ins et potentiellement fichiers manifestes d'application) appartiennent au système de fichiers partagé. Pour configurer le système de fichiers partagé :

1. Sur le serveur qui stockera le système de fichiers partagé, vérifiez que vous avez accès à un autre compte qui peut su au compte utilisateur Looker.
2. Sur le serveur du système de fichiers partagé, connectez-vous au compte utilisateur Looker.
3. Si Looker est en cours d'exécution, arrêtez votre configuration Looker.
4. Si vous utilisiez auparavant le clustering à l'aide de scripts Linux inotify, arrêtez ces scripts, supprimez-les de cron et supprimez-les.
5. Créez un partage réseau et installez-le sur chaque nœud du cluster. Assurez-vous qu'il est configuré pour s'installer automatiquement sur chaque nœud et que l'utilisateur Looker peut le lire et y écrire. Dans l'exemple suivant, le partage réseau est nommé /mnt/looker-share.

6. Sur un nœud, copiez vos clés de déploiement, puis déplacez vos plug-ins et les répertoires looker/models et looker/models-user-*, qui stockent vos fichiers de modèle, vers votre partage réseau. Exemple :

   mv looker/models /mnt/looker-share/
   mv looker/models-user-* /mnt/looker-share/
   

   Remarque : Vos clés de déploiement doivent être copiées dans le stockage partagé et sur chaque nœud du cluster.

7. Pour chaque nœud, ajoutez le paramètre --shared-storage-dir à LOOKERARGS. Spécifiez le partage réseau, comme illustré dans cet exemple :

   --shared-storage-dir /mnt/looker-share
   

   LOOKERARGS doit être ajouté à $HOME/looker/lookerstart.cfg afin que les paramètres ne soient pas affectés par les mises à jour. Si vos LOOKERARGS ne sont pas listés dans ce fichier, il est possible que quelqu'un les ait ajoutés directement au script shell $HOME/looker/looker.

   Chaque nœud du cluster doit écrire dans un répertoire /log unique, ou au moins dans un fichier journal unique.

Partager le dépôt de clés SSH

• Vous créez un cluster de système de fichiers partagé à partir d'une configuration Looker existante.
• Vous disposez de projets créés dans Looker 4.6 ou version antérieure.

Remarque : La procédure suivante nécessite de modifier le répertoire $HOME/.ssh de l'utilisateur Looker. Cela peut rendre difficile la connexion et la résolution d'un problème en cas d'erreur dans la configuration. Avant d'effectuer ces étapes, assurez-vous d'avoir accès à un autre compte qui peut su au compte utilisateur Looker.

Configurez le dépôt de clés SSH pour qu'il soit partagé :

1. Sur le serveur de fichiers partagé, créez un répertoire nommé ssh-share. Exemple : /mnt/looker-share/ssh-share.

   Assurez-vous que le répertoire ssh-share appartient à l'utilisateur Looker et que les autorisations sont définies sur 700. Assurez-vous également que les répertoires situés au-dessus du répertoire ssh-share (comme /mnt et /mnt/looker-share) ne sont pas accessibles en écriture à l’échelle mondiale ni en écriture pour le groupe.

2. Sur un nœud, copiez le contenu de $HOME/.ssh dans le nouveau répertoire ssh-share. Exemple :

   cp $HOME/.ssh/* /mnt/looker-share/ssh-share

3. Pour chaque nœud, créez une sauvegarde du fichier SSH existant et créez un lien symbolique vers le répertoire ssh-share. Exemple :

   cd $HOME
   mv .ssh .ssh_bak
   ln -s /mnt/looker-share/ssh-share .ssh
   

   Veillez à effectuer cette étape pour chaque nœud.

Ouvrir les ports pour que les nœuds communiquent

Les nœuds Looker en cluster communiquent entre eux via HTTPS avec des certificats autosignés et un schéma d'authentification supplémentaire basé sur la rotation des secrets dans la base de données d'application.

Les ports par défaut qui doivent être ouverts entre les nœuds de cluster sont 1551 et 61616. Ces ports sont configurables à l'aide des options de démarrage listées ici. Nous vous recommandons vivement de limiter l'accès réseau à ces ports pour n'autoriser le trafic qu'entre les hôtes du cluster.

Démarrer Looker sur les nœuds

Redémarrez le serveur sur chaque nœud avec les options de démarrage requises.

Remarque : Chaque nœud d'un cluster doit exécuter la même version de Looker et le même correctif.

Options de démarrage disponibles

Le tableau suivant présente les options de démarrage disponibles, y compris celles qui sont requises pour démarrer un cluster ou le rejoindre :

Option	Obligatoire ?	Valeurs	Objectif
--clustered	Oui		Ajoutez l'option pour spécifier que ce nœud s'exécute en mode cluster.
-H ou --hostname	Oui	10.10.10.10	Nom d'hôte que les autres nœuds utilisent pour contacter ce nœud, tel que l'adresse IP du nœud ou son nom d'hôte système. Doit être différent des noms d'hôte de tous les autres nœuds du cluster.
-n	Non	1551	Port pour la communication entre les nœuds. La valeur par défaut est 1551. Tous les nœuds doivent utiliser le même numéro de port pour la communication entre les nœuds.
-q	Non	61616	Port pour la mise en file d'attente des événements à l'échelle du cluster. La valeur par défaut est 61616.
-d	Oui	/path/to/looker-db.yml	Chemin d'accès au fichier contenant les identifiants de la base de données de l'application Looker.
--shared-storage-dir	Oui	/path/to/mounted/shared/storage	L'option doit pointer vers le répertoire partagé configuré précédemment sur cette page, qui contient les répertoires looker/model et looker/models-user-*.

Remarque : Votre option de démarrage --clustered ne doit pas inclure de valeur.

Exemple de LOOKERARGS et de spécification des identifiants de base de données

Placez les options de démarrage Looker dans un fichier lookerstart.cfg, situé dans le même répertoire que les fichiers JAR Looker.

Par exemple, vous pouvez indiquer à Looker :

• d'utiliser le fichier nommé looker-db.yml pour ses identifiants de base de données,
• qu'il s'agit d'un nœud en cluster,
• que les autres nœuds du cluster doivent contacter cet hôte sur l'adresse IP 10.10.10.10.

Vous devez spécifier :

LOOKERARGS="-d looker-db.yml --clustered -H 10.10.10.10"

Remarque : Veillez à spécifier l'adresse IP correcte pour votre nœud.

Le fichier looker-db.yml contient les identifiants de la base de données, tels que :

host: your.db.hostname.com
username: db_user
database: looker
dialect: mysql
port: 3306
password: secretPassword

De plus, si votre base de données MySQL nécessite une connexion SSL, le fichier looker-db.yml nécessite également les éléments suivants :

ssl: true

Remarque : Vous devez stocker une copie de votre fichier d'identifiants dans le stockage partagé et sur chaque nœud du cluster.

Remarque : Suivez les bonnes pratiques de sécurité lorsque vous enregistrez des identifiants dans un fichier. Idéalement, définissez les autorisations du fichier looker-db.yml sur 600, appartenant au compte "utilisateur" Linux sous lequel l'application Looker est exécutée. Ce fichier ne doit jamais être enregistré dans un dépôt Git.

Si vous ne souhaitez pas stocker la configuration dans le fichier looker-db.yml sur le disque, vous pouvez configurer la variable d'environnement LOOKER_DB pour qu'elle contienne une liste de clés et de valeurs pour chaque ligne du fichier looker-db.yml. Exemple :

export LOOKER_DB="dialect=mysql&host=localhost&username=root&password=&database=looker&port=3306"

Trouver vos clés de déploiement SSH Git

L'emplacement où Looker stocke les clés de déploiement SSH Git dépend de la version dans laquelle le projet a été créé :

• Pour les projets créés avant Looker 4.8, les clés de déploiement sont stockées dans le répertoire SSH intégré du serveur, ~/.ssh.
• Pour les projets créés dans Looker 4.8 ou version ultérieure, les clés de déploiement sont stockées dans un répertoire contrôlé par Looker, ~/looker/deploy_keys/PROJECT_NAME.

Modifier un cluster Looker

Après avoir créé un cluster Looker, vous pouvez ajouter ou supprimer des nœuds sans modifier les autres nœuds en cluster.

Mettre à jour un cluster vers une nouvelle version de Looker

Les mises à jour peuvent impliquer des modifications de schéma dans la base de données interne de Looker qui ne seraient pas compatibles avec les versions précédentes de Looker. Il existe deux méthodes pour mettre à jour Looker.

Méthode plus sûre

1. Créez une sauvegarde de la base de données d'application.
2. Arrêtez tous les nœuds du cluster.
3. Remplacez les fichiers JAR sur chaque serveur.
4. Démarrez chaque nœud un par un.

Méthode plus rapide

Remarque : Cette méthode réduit les temps d'arrêt, mais perd toutes les modifications apportées entre la création de l'instance dupliquée et le moment où le serveur proxy pointe vers les nouveaux nœuds. Par exemple, si quelqu'un ajoute des utilisateurs ou crée des Looks pendant la transition, ces modifications peuvent ne pas être capturées dans la nouvelle base de données d'application.

Pour effectuer la mise à jour à l'aide de cette méthode plus rapide, mais moins complète :

1. Créez une instance dupliquée de la base de données d'application de Looker.
2. Démarrez un nouveau cluster pointant vers l'instance dupliquée.
3. Faites pointer le serveur proxy ou l'équilibreur de charge vers les nouveaux nœuds, après quoi vous pourrez arrêter les anciens nœuds.