Elastic Compute Service:Install cloud-init

Pour plus d'informations sur cloud-init, consultez la documentation officielle de cloud-init.

Scénarios

Étape 1 : Vérifier si vous devez installer ou mettre à niveau cloud-init

1. Connectez-vous au serveur source.

2. Exécutez les commandes suivantes pour vérifier si cloud-init est installé.

   Série CentOS

   rpm -qa | grep -i cloud-init 
   pip list | grep -i cloud-init

   Série Ubuntu

   dpkg -l | grep -i cloud-init 
   pip list | grep -i cloud-init

   • Si aucune sortie n'est renvoyée ou si la version est antérieure à 0.7.9 : Vous devez Étape 2 : Installer cloud-init.

     Important

     La version 0.7.9 est une première édition communautaire de cloud-init et ne peut pas être utilisée pour initialiser les instances ECS. Vous devez effectuer une mise à niveau vers une version ultérieure.

   • Si la version est 18 ou ultérieure : Vous n'avez pas besoin d'installer cloud-init. Toutefois, cloud-init configure automatiquement le réseau lors de l'initialisation de l'instance. Si la configuration par défaut ne répond pas à vos exigences, vous pouvez désactiver la fonctionnalité d'initialisation du réseau. Pour plus d'informations, consultez Désactiver l'initialisation automatique du réseau par Alibaba Cloud.

   • Si la version est 19.1.21 : Nous vous recommandons de mettre à niveau vers Alibaba Cloud cloud-init 23.2.2. Par rapport à Alibaba Cloud cloud-init 19.1.21, Alibaba Cloud cloud-init 23.2.2 offre les améliorations et fonctionnalités suivantes :

     • Si la version de cloud-init d'une instance est 23.2.2, l'instance prend en charge l'accès aux métadonnées en mode de renforcement de la sécurité. Pour plus d'informations sur les métadonnées d'instance, consultez Métadonnées d'instance.

     • Autres améliorations de fonctionnalités, améliorations des performances, corrections de bugs et contributions de la communauté. Pour plus d'informations, consultez le fichier ChangeLog.

   • Autres cas : Vous n'avez pas besoin d'installer cloud-init. Vous pouvez directement effectuer les opérations décrites dans Étapes suivantes.

3. Pour éviter la perte de données causée par des opérations accidentelles lors de l'installation de cloud-init, nous vous recommandons de sauvegarder d'abord les données du serveur source, par exemple en créant des snapshots.

Étape 2 : Installer cloud-init

• Alibaba Cloud cloud-init 23.2.2 : version recommandée. Cette version dépend de Python 3.6 ou ultérieur et utilise la source de données Aliyun.

• Alibaba Cloud cloud-init 19.1.21 : cette version dépend de Python 3.6 ou ultérieur et utilise la source de données Aliyun.

• Alibaba Cloud cloud-init 0.7.6a18 : cette version est requise pour certains systèmes d'exploitation plus anciens, tels que CentOS 6, Debian 9 et SUSE Linux Enterprise Server 12. Elle dépend de Python 2.7 et utilise la source de données Aliyun.

  Important

  La communauté Python a cessé le support technique de Python 2.7. Nous vous recommandons d'utiliser une version plus récente de cloud-init chaque fois que possible afin d'éviter les problèmes potentiels liés aux bibliothèques de dépendances.

• cloud-init édition communautaire : l'édition communautaire de cloud-init est maintenue par la communauté. La dernière version d'Alibaba Cloud cloud-init est la 23.2.2. Si vous avez besoin d'une version plus récente de cloud-init, vous pouvez installer l'édition communautaire. Pour plus d'informations sur les versions, consultez le site officiel de cloud-init.

L'édition communautaire de cloud-init correspond à la version officielle du projet cloud-init, tandis qu'Alibaba Cloud cloud-init est optimisé pour la plateforme Alibaba Cloud et offre un meilleur support pour les services de cette plateforme. Par conséquent, nous vous recommandons d'utiliser Alibaba Cloud cloud-init. Choisissez l'édition de cloud-init à installer en fonction de vos besoins réels.

# Check and install python3-pip
if ! python3 -c 'import setuptools' >& /dev/null; then
  yum -y install python3-pip
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/redhat-release | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh centos "$issue_major"

# Check and install python3-pip
if ! python3 -c 'import setuptools' >& /dev/null; then
  yum -y install python3-pip
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/os-release | grep VERSION_ID | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh rhel "$issue_major"

# Check and install python3-pip
if ! python3 -c 'import setuptools' >& /dev/null; then
  apt-get install python36 python3-pip -y
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/os-release | grep VERSION_ID | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh ubuntu "$issue_major"

# Check and install python3-pip
if ! python3 -c 'import setuptools' >& /dev/null; then
  apt-get -y install python3-pip
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/os-release | grep VERSION_ID | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh debian "$issue_major"

# Check and install python3-pip
if ! python3 -c 'import setuptools'>& /dev/null; then
  zypper -n install python3-pip
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/os-release | grep VERSION_ID | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh sles "$issue_major"

# Check and install python3-pip
if ! python3 -c 'import setuptools'>& /dev/null; then
  zypper -n install python3-pip
fi
# Back up the earlier version of cloud-init
test -d /etc/cloud && mv /etc/cloud /etc/cloud-old
# Download and decompress Alibaba Cloud cloud-init
wget https://ecs-image-tools.oss-cn-hangzhou.aliyuncs.com/cloudinit/cloud-init-19.1.21.tgz
tar -zxvf ./cloud-init-19.1.21.tgz
# Install cloud-init
issue_major=$( cat /etc/os-release | grep VERSION_ID | grep -Eo '[0-9]+\.?[0-9]+' | head -1 | awk -F'.' '{printf $1}')
bash ./cloud-init-*/tools/deploy.sh opensuse "$issue_major"

(Facultatif) Étape 3 : Configurer cloud-init

Étapes suivantes

• Pour migrer des serveurs Linux vers le cloud, utilisez Server Migration Center (SMC). Pour plus d'informations, consultez la rubrique Migrer des serveurs vers ECS.

• Pour les instances ECS exécutant des images Linux personnalisées sur Alibaba Cloud, redémarrez le système afin de vérifier les résultats. Si le système configure automatiquement le nom d'hôte, le réseau et les paramètres NTP, cela signifie que cloud-init est installé. Par exemple, exécutez les commandes suivantes pour afficher le fichier de configuration réseau :

  sudo reboot
  cat /etc/sysconfig/network-scripts/ifcfg-eth0

  La sortie suivante indique que le système a automatiquement configuré les paramètres réseau (protocole DHCP, périphérique réseau, type de périphérique, etc.) via cloud-init.

  BOOTPROTO=dhcp
  DEVICE=eth0
  ONBOOT=yes
  STARTMODE=auto
  TYPE=Ethernet
  USERCTL=no

FAQ

• Que faire si des bibliothèques de dépendances sont manquantes lors de l'installation de cloud-init avec Python 3 ?

  Les bibliothèques manquantes varient selon les images. Installez les bibliothèques requises via pip, puis relancez l'installation de cloud-init.

• Que faire en cas d'exécution anormale de cloud-init avec un message d'erreur ?

  Des conflits de versions entre les bibliothèques de dépendances installées par le gestionnaire de packages par défaut du système (tel que yum) et celles installées par pip peuvent provoquer des dysfonctionnements de cloud-init. Nous vous recommandons de télécharger les bibliothèques de dépendances requises en vous basant sur les messages d'erreur.

  Message d'erreur	Cause	Commande de dépannage
  no setuptools module in python	Le module python setuptools est manquant	Exemple avec Python 3.6 : CentOS/Red Hat : yum -y install python3-pip Ubuntu/Debian : apt-get -y install python3-pip OpenSUSE/SUSE : zypper -n install python3-pip
  File "/home/testuser/cloud-init/cloudinit/log.py", line 19, in <module> import six ImportError: No module named six )	La bibliothèque de dépendances six est manquante	pip3 install six
  File "/home/testuser/cloud-init/cloudinit/url_helper.py", line 20, in <module> import oauthlib.oauth1 as oauth1 ImportError: No module named oauthlib.oauth1 )	La bibliothèque de dépendances oauthlib est manquante	pip3 install oauthlib
  Le message d'erreur n'indique pas quelle bibliothèque de dépendances est manquante	Le message d'erreur n'est pas répertorié	En vous basant sur les bibliothèques listées dans le fichier requirements.txt de cloud-init, exécutez la commande suivante pour installer toutes les bibliothèques de dépendances : pip3 install -r requirements.txt

• Que faire si une nouvelle version de Python 3 installée sur l'instance provoque un dysfonctionnement de cloud-init ?

  Si vous installez une nouvelle version de Python 3 (par exemple Python 3.9) sur l'instance et la définissez comme version par défaut (en créant un lien symbolique, par exemple ln -s /usr/bin/python3,9 /usr/bin/python3), cloud-init peut dysfonctionner. Par exemple, l'exécution de cloud-init --version renvoie l'erreur suivante :

  $cloud-init --version
  Traceback (most recent call last):
    File "/usr/local/bin/cloud-init", line 33, in <module>
      sys.exit(load_entry_point('cloud-init==19.1.9', 'console_scripts', 'cloud-init')())
    File "/usr/local/bin/cloud-init", line 22, in importlib_load_entry_point
      for entry_point in distribution(dist_name).entry_points
    File "/usr/lib64/python3.9/importlib/metadata.py", line 524, in distribution
      return Distribution.from_name(distribution_name)
    File "/usr/lib64/python3.9/importlib/metadata.py", line 187, in from_name
      raise PackageNotFoundError(name)
  importlib.metadata.PackageNotFoundError: cloud-init

  Vous pouvez résoudre ce problème en appliquant l'une des méthodes suivantes :

  • Méthode 1 : Réinstallez cloud-init en utilisant la nouvelle version de Python 3.

  • Méthode 2 : Modifiez le fichier exécutable cloud-init pour changer le chemin de l'interpréteur Python vers la version précédente de Python 3. Prenons Python 3.6 comme exemple. Suivez les étapes ci-dessous pour modifier l'interpréteur dans le fichier exécutable cloud-init :

    1. Ouvrez le fichier cloud-init en exécutant la commande suivante.

       vim   /usr/local/bin/cloud-init

    2. Appuyez sur i pour passer en mode édition, et remplacez le contenu après #! au début du fichier par le chemin de Python 3.6.

       Après modification, la ligne #! se présente comme suit :

       #!/usr/bin/python3.6

    3. Appuyez sur la touche Esc pour quitter le mode édition, saisissez :wq, puis appuyez sur Entrée pour enregistrer et quitter le fichier.

• Que faire si les données utilisateur spécifiées dans les métadonnées de l'instance lors de la création ne s'exécutent pas ou échouent après l'installation de cloud-init ?

  1. Vérifiez la présence de user-data dans les métadonnées de l'instance en exécutant la commande suivante depuis l'instance.

     curl http://100.100.100.200/latest/user-data

     Description du résultat :

     • Si user-data est défini, les informations correspondantes sont renvoyées. Passez à l'étape suivante pour le dépannage.

     • Si aucune information n'est renvoyée, user-data n'est pas défini.

  2. Utilisez les méthodes suivantes pour déterminer pourquoi user-data ne s'exécute pas ou échoue lors de son exécution.

     • Vérifiez que le format de user-data est correct.

       L'exécution de user-data est assurée par cloud-init. Vous devez vous assurer que le format des données est valide. Par exemple, la première ligne de user-data doit commencer par #!. Pour plus d'informations, reportez-vous à la rubrique Personnaliser les configurations d'initialisation des instances.

     • Examinez les résultats d'exécution de user-data dans le fichier journal de cloud-init /var/log/cloud-init.log et résolvez le problème en vous basant sur les messages d'erreur.

       L'exemple suivant illustre les informations enregistrées dans le fichier journal :

        util.py[DEBUG]: Running command ['/var/lib/cloud/instance/scripts/part-001'] with allowed return codes [0] (shell=False, capture=False)

     • Consultez la sortie standard et la sortie d'erreur standard du processus d'exécution de user-data.

       Dans systemd, l'outil d'initialisation du système Linux, user-data est exécuté par le service système cloud-final.service. Exécutez la commande suivante pour afficher la sortie standard et la sortie d'erreur standard du processus d'exécution de user-data, puis analysez les résultats pour résoudre le problème.

       journalctl -u cloud-final.service

     • Si aucune des méthodes précédentes ne permet d'identifier la raison pour laquelle user-data ne s'exécute pas ou échoue, nous vous recommandons de copier le contenu de user-data sur un hôte local pour le déboguer et vérifier s'il s'exécute correctement.

• Que faire si les configurations d'initialisation du système et les scripts de données utilisateur de l'instance ne s'exécutent pas comme prévu après l'installation de cloud-init ?

  1. Exécutez les commandes suivantes pour vérifier si les quatre services cloud-init sont configurés pour démarrer au lancement du système.

     systemctl is-enabled cloud-init-local.service
     systemctl is-enabled cloud-init.service
     systemctl is-enabled cloud-config.service
     systemctl is-enabled cloud-final.service

     Si un message d'erreur ou la valeur disabled est renvoyée, cela signifie que cloud-init n'est pas configuré pour démarrer automatiquement au lancement du système.

  2. Exécutez les commandes suivantes pour configurer cloud-init afin qu'il démarre au lancement du système.

     systemctl enable cloud-init-local.service
     systemctl enable cloud-init.service
     systemctl enable cloud-config.service
     systemctl enable cloud-final.service

• Que faire si la partition racine n'est pas automatiquement étendue à l'intérieur de l'instance après avoir augmenté la taille du disque système lors de la création de l'instance ?

  L'extension automatique des partitions pour les instances Linux est prise en charge par cloud-init. Assurez-vous que l'outil growpart est installé sur le système et que le fichier cloud.cfg est correctement configuré.

  1. Exécutez la commande suivante pour vérifier si l'outil growpart est installé sur le système.

     which growpart

  2. (Si nécessaire) Si l'outil n'est pas installé, exécutez les commandes suivantes pour installer growpart.

     • Série RHEL :

       sudo yum -y install cloud-utils-growpart

     • Série Debian :

       sudo apt -y install cloud-guest-utils

  3. Exécutez la commande suivante pour vérifier si le contenu ci-dessous figure dans le fichier /etc/cloud/cloud.cfg.

     cat /etc/cloud/cloud.cfg

     Assurez-vous que la fréquence d'exécution de growpart et de resizefs est définie sur once-per-instance :

     # The modules that run in the 'init' stage
     cloud_init_modules:
      - migrator
      - source-address
      - pip-source
      - seed_random
      - bootcmd
      - write-files
      - [ growpart, once-per-instance ]
      - [ resizefs, once-per-instance ]
      - set_hostname
      - update_hostname
      - update_etc_hosts
      - rsyslog
      - users-groups
      - ssh

  4. (Si nécessaire) Si ce contenu est absent, ajoutez-le au fichier /etc/cloud/cloud.cfg.

• Que faire si le nouveau nom d'hôte ne prend pas effet après sa mise à jour dans la console et le redémarrage d'une instance ECS dont la version de cloud-init est antérieure ou égale à 0.7.6a16 ?

  • Description du problème

    Après avoir mis à jour le nom d'hôte dans la console ECS et redémarré l'instance ECS, le nouveau nom d'hôte n'est pas appliqué. Lorsque vous exécutez la commande cloud-init --version, la version de cloud-init est 0.7.6a16 ou une version antérieure.

  • Cause

    Lorsque cloud-init met à jour le nom d'hôte via le module update_hostname, il exécute la commande hostname pour obtenir le nom d'hôte actuel du système, lit le fichier /var/lib/cloud/data/previous-hostname pour récupérer le nom d'hôte stocké dans le cache de données de cloud-init, puis vérifie la cohérence entre les deux valeurs. Si elles correspondent, le nom d'hôte est mis à jour. En cas d'incohérence, cloud-init suppose que le nom d'hôte a été modifié manuellement et n'effectue pas la mise à jour.

    Sur les systèmes d'exploitation de la série Red Hat, les sauts de ligne du fichier /var/lib/cloud/data/previous-hostname sont traités lors de la lecture du fichier, mais la sortie de la commande hostname ne subit pas ce traitement. Par conséquent, les deux résultats diffèrent et le nom d'hôte n'est pas mis à jour.

  • Solution

    Vous pouvez appliquer l'une des solutions suivantes pour résoudre ce problème :

    • Mettez à niveau la version de cloud-init. Pour plus d'informations, reportez-vous à l'étape Étape 2 : Installer cloud-init.

      • Si vous utilisez CentOS 6 ou une version antérieure, utilisez cloud-init 0.7.6a18.

      • Si vous utilisez CentOS 7, utilisez cloud-init 19.1.21.

      • Si vous utilisez CentOS 8 ou une version ultérieure, nous vous recommandons d'utiliser cloud-init 23.2.2 ou une version ultérieure.

    • Traitez manuellement le saut de ligne.

      Modifiez manuellement le fichier cloud-init défectueux cloudinit/distros/rhel.py (obtenez le chemin du fichier en exécutant la commande find / -name rhel.py). Reportez-vous au commit distros/rhel.py: _read_hostname() missing strip on "hostname" pour traiter le saut de ligne dans la sortie de la commande hostname. L'exemple suivant montre comment effectuer ce traitement :

      diff --git a/cloudinit/distros/rhel.py b/cloudinit/distros/rhel.py
      index 0b68414e..65176e99 100644
      --- a/cloudinit/distros/rhel.py
      +++ b/cloudinit/distros/rhel.py
      @@ -143,6 +143,7 @@ class Distro(distros.Distro):
                   return util.load_file(filename).strip()
               elif self.uses_systemd():
                   (out, _err) = util.subp(['hostname'])
      +            out = out.strip()
                   if len(out):
                       return out
                   else: