安装cloud-init

关于cloud-init的更多信息，请参见cloud-init官方文档。

步骤一：检查是否需要升级安装cloud-init

1. 登录源服务器。

2. 运行以下命令检查是否已安装cloud-init。

   CentOS系列

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

   Ubuntu系列

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

   • 若无任何输出或版本低于社区0.7.9版本：您需要步骤二：安装cloud-init。

     说明

     0.7.9版本初期的社区版cloud-init，不适用于初始化ECS实例，必须升级至较高版本。

   • 若版本为18或高于18版本：无需安装cloud-init，但cloud-init在初始化实例时可以自动配置网络，如果默认配置不符合您的需求，您可按需自定义网络配置。

   • 其他：无需再安装cloud-init，可直接执行后续步骤。

（可选）步骤三：配置cloud-init

自定义网络配置

如果您的cloud-init版本为18或者高于18，会自动完成网络的初始化配置，自动配置的网络为BOOTPROTO=dhcp DEVICE=eth0 ONBOOT=yes STARTMODE=auto TYPE=Ethernet USERCTL=no。如果默认的网络配置不符合您的业务需求，可以参考以下操作自定义网络。

1. 安装cloud-init后，打开/etc/cloud/cloud.cfg文件。

   vim /etc/cloud/cloud.cfg

2. 按i进入编辑模式，在Example datasource config之前增加disabled配置。

   network:
     config: disabled

   说明

   增加该配置之后，cloud-init不会管理/etc/sysconfig/network-scripts/下网络配置，需要您自行管理。

   

3. 编辑完成后，按Esc键退出编辑模式，然后输入:wq并回车，保存退出文件。

保留主机名以及/etc/hosts配置文件

cloud-init的配置文件中，默认设置了不保留主机名。如果您不希望实例的主机名以及/etc/hosts配置文件被修改，可以参考以下操作修改cloud-init的配置文件。

1. 安装cloud-init后，打开/etc/cloud/cloud.cfg文件。

   vim /etc/cloud/cloud.cfg

2. 按i进入编辑模式，将preserve_hostname: false修改为preserve_hostname: true。

   

3. 编辑完成后，按Esc键退出编辑模式，然后输入:wq并回车，保存退出文件。

   当preserve_hostname: true时，cloud-init将不会自动修改主机名以及/etc/hosts配置文件。

故障排查

• 通过Python 3安装cloud-init时，缺少依赖库怎么处理？

  不同镜像缺少的库可能不同，您都可以通过pip安装，之后再次安装cloud-init。

• cloud-init运行异常，提示报错信息，如何处理？

  如果系统默认软件包管理器（例如yum）和pip管理器分别安装过不同版本的依赖库，可能造成库版本冲突，导致cloud-init运行异常。建议您根据报错信息按需下载依赖库。

  报错信息	原因	排错命令
  no setuptools module in python	缺失模块python setuptools	以python3.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 )	缺失依赖库six	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 )	缺失依赖库oauthlib	pip3 install oauthlib
  报错时没有明确缺少的依赖库	未映射相关错误信息	根据cloud-init的requirements.txt文件里显示的库，运行以下命令安装所有依赖库： pip3 install -r requirements.txt

• 如何确定cloud-init已成功安装且版本正确？

  当您安装好cloud-init后，可以使用cloud-init --version命令查看cloud-init的版本信息，如果符合预期版本，则表示cloud-init已成功安装。例如，您安装的是阿里云版cloud-init 19.1.21。安装完成后，如果运行cloud-init --version命令的回显信息包含19.1.21，则表示cloud-init 19.1.21已成功安装。

• 实例中安装了新版本的Python 3导致了cloud-init执行异常，如何处理？

  如果您在实例中安装了新版本的Python 3（例如Python 3.9），并将新版本的Python 3设置为默认版本（即已为新版Python 3创建了软链接，例如，ln -s /usr/bin/python3.9 /usr/bin/python3），则会导致已安装的cloud-init执行异常。例如，运行cloud-init --version将会报错：

  $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

  您可以通过以下任一方式解决该问题：

  • 方式一：使用新版的Python 3重新安装cloud-init。

  • 方式二：修改cloud-init执行文件，将Python解释器对应的路径修改为历史版本的Python 3。以Python 3.6为例，修改cloud-init执行文件中解释器的操作如下：

    1. 运行以下命令，打开cloud-init文件。

       vim   /usr/local/bin/cloud-init

    2. 按i进入编辑模式，将文件开头#!后的内容修改为Python 3.6所在的路径。

       修改后，对应的#!行内容如下所示：

       #!/usr/bin/python3.6

    3. 按Esc键退出编辑模式，然后输入:wq并回车，保存退出文件。

• 安装cloud-init后，在创建实例时设置的实例元数据中的自定义数据（user-data）不执行或者执行失败，如何处理？

  1. 在实例内，运行以下命令，检查实例元数据中的user-data是否存在。

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

     检查结果说明：

     • 如果已设置了user-data，则会返回对应的user-data信息。您需要继续下一步进行问题排查。

     • 如果没有返回信息，则表示您没有设置user-data。

  2. 通过多种方式，排查user-data不执行或执行失败的原因。

     • 检查user-data数据格式是否准确。

       user-data的数据由cloud-init执行，您需要确保数据格式准确无误。例如，user-data的首行必须以#!开头。更多信息，请参见使用实例自定义数据（Linux实例）。

     • 检查在创建实例时，是否选择了仅加固模式。

       如果选择了仅加固模式，将导致cloud-init组件初始化配置失败，影响实例的元数据、自定义数据等配置。更多信息，请参见查看实例元数据。

     • 通过cloud-init的日志文件/var/log/cloud-init.log，查看user-data执行结果，并根据报错信息排查问题。

       日志文件记录信息示例如下：

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

     • 查看user-data执行过程的标准输出以及标准错误输出。

       在Linux系统初始化工具systemd中，user-data由系统服务cloud-final.service执行，您可以运行以下命令查看user-data执行过程的标准输出以及标准错误输出，并根据输出内容排查问题。

       journalctl -u cloud-final.service

     • 如果以上方式均无法定位user-data不执行或者执行失败的原因，建议您将user-data内容拷贝到本地主机进行调试，查看是否可以成功执行。

• 安装cloud-init后，但系统初始化配置和实例自定义数据（User data）脚本无法正常执行，如何处理？

  1. 运行以下命令，检查cloud-init的四个服务是否设置为开机自启动。

     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

     如果出现报错信息或者disabled信息，表示cloud-init未设置开机自启动。

  2. 运行以下命令，设置cloud-init开机自启动。

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

• 在创建实例时对系统盘进行扩容，但在实例内部发现根分区大小并没有自动扩容，如何处理？

  Linux实例分区自动扩容由cloud-init提供支持，需要确保系统安装growpart工具且cloud.cfg文件中配置正确。

  1. 运行以下命令，检查系统是否安装growpart工具。

     which growpart

  2. 可选：如果没有安装，运行以下命令，安装growpart工具。

     • RHEL系列：

       sudo yum -y install cloud-utils-growpart

     • Debian系列：

       sudo apt -y install cloud-guest-utils

  3. 运行以下命令，查看/etc/cloud/cloud.cfg文件中是否存在如下图中的内容。

     cat /etc/cloud/cloud.cfg

     

  4. 可选：如果不存在，添加该内容到/etc/cloud/cloud.cfg文件中。