云服务器 ECS：使用自定义数据进行实例初始化

User-Data脚本

• 简介

  User-Data脚本传入Linux实例后直接作为Shell脚本执行，且仅在实例首次启动时运行一次。

• 运行频率

  • 启动实例：仅在实例首次启动时运行一次，重启实例不会再自动运行。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

  重要

  以下情况不会自动运行脚本：

  • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

  • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  首行均以#!开头。

• User-Data脚本示例

  • 运行自定义脚本

    #!/bin/sh
    echo "Hello World. The time is now $(date -R)!" | tee /root/userdata_test.txt

    示例User-Data脚本的效果是在实例首次启动时，向userdata_test.txt文件写入系统时间。

  • 自定义实例软件源、DNS解析配置及时间同步服务

    在创建实例时，您可以通过User-Data脚本自定义实例的软件源、DNS解析配置及时间同步服务。以下示例以CentOS Stream 9为例，实际使用中请根据您的操作系统进行相应配置替换。

    重要

    系统会在实例启动时自动配置默认的yum源、NTP服务和DNS服务，您可以使用实例自定义数据更改默认的yum源、NTP服务和DNS服务，但请注意：

    • 如果您自定义了yum源，阿里云官方不再提供yum源相关支持。

    • 如果您自定义了NTP服务，阿里云官方不再提供相关时间同步服务。

    #!/bin/sh
    # Modify DNS
    echo "nameserve 114.114.114.114" | tee /etc/resolv.conf
    # Modify yum repo and update
    cp /etc/yum.repos.d/centos.repo /etc/yum.repos.d/centos.repo.bak
    cp /etc/yum.repos.d/centos-addons.repo /etc/yum.repos.d/centos-addons.repo.bak
    sed -i "s@http://mirrors.cloud.aliyuncs.com/centos-stream/@https://mirror.stream.centos.org/@g" /etc/yum.repos.d/centos.repo
    sed -i "s@http://mirrors.cloud.aliyuncs.com/centos-stream/@https://mirror.stream.centos.org/@g" /etc/yum.repos.d/centos-addons.repo
    yum update -y
    # Modify NTP Server
    echo "server ntp1.aliyun.com" | tee /etc/ntp.conf
    systemctl restart ntpd.service

    说明

    其中114.114.114.114为DNS服务器地址、https://mirror.stream.centos.org为CentOS Stream的yum仓库地址、server ntp1.aliyun.com为阿里云的NTP服务器地址，请您根据实际环境替换。

    您也可以使用Cloud Config数据更改yum源，但是不够灵活，不能适配阿里云已对部分yum源进行预配置的情况，建议使用User-Data脚本。

  • 自定义管理员账号

    Linux实例默认使用root用户作为管理员，您可以使用实例自定义数据使用其他用户作为管理员。

    #!/bin/sh
    useradd test-user
    echo "test-user   ALL=(ALL)        NOPASSWD:ALL" | tee -a /etc/sudoers
    mkdir /home/test-user/.ssh
    touch /home/test-user/.ssh/authorized_keys
    echo "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCRnnUveAis****" | tee -a /home/test-user/.ssh/authorized_keys

    说明

    请使用您的公钥替换示例中的公钥ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCRnnUveAis****。

Cloud Config数据

• 简介

  在Cloud-init中，定义了一系列的功能模块，来完成部分需要执行的任务和配置，例如安装软件包、设置网络等。执行哪些模块及具体的执行逻辑，由Cloud Config数据决定，可从vendordata、自定义数据、内核参数中获取。在创建ECS实例时，用户可自定义Cloud Config数据，指定需要执行的模块和任务，并作为自定义数据提供给实例。实例启动时，cloud-init会读取并解析Cloud Config数据，并按照配置文件中的指示运行对应模块并执行配置任务，自动配置和部署ECS实例。

• 运行频率

  • 启动实例：Cloud Config数据中的任务是否会被执行，取决于这些任务对应模块的频率设置。各模块的说明，请参见Modules。

    • 频率为once-per-instance：仅在实例首次启动时运行。例如配置的是Apt、Set Passwords等模块，运行频率为once-per-instance，重启实例时不会运行。

    • 频率为always：实例每次启动都运行。例如配置的是Bootcmd、Update Etc Hosts等模块，运行频率为always，实例每次启动都运行。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  • 首行为#cloud-config，且起始位置不能有空格。

  • 必须遵循YAML语法编写内容。

• Cloud Config数据示例

  • 自定义实例软件源

    在自定义数据区域输入以下内容，以配置自定义实例软件源。示例中使用Ubuntu镜像创建实例，如果您使用其他镜像，请替换为对应模块的配置内容。

    #cloud-config
    apt:
      preserve_sources_list: false
      disable_suites:
        - $RELEASE-updates
        - backports
        - $RELEASE
        - mysuite
      primary:
        - arches:
            - amd64
            - i386
            - default
          uri: http://us.archive.ubuntu.com/ubuntu

  • 配置自动安装nginx服务

    在自定义数据区域输入如下内容，以配置实例自动安装nginx服务。

    #cloud-config
    packages: 
     - nginx 
    runcmd: 
     - systemctl start nginx.service

  • 配置自定义主机名

    在自定义数据区域输入如下内容，以自定义设置主机名。

    #cloud-config
    hostname: my-instance
    fqdn: my-instance.localdomain

  • 配置自动运行自定义脚本

    在自定义数据区域输入如下内容，以配置实例每次启动时自动运行shell脚本。

    #cloud-config
    bootcmd:
    - echo "Hello World. The time is now $(date -R)!" | tee /root/userdata_test.txt

Include文件

• 简介

  通过Include文件指向一个或多个User-Data脚本或Cloud Config数据的链接，多个链接按行分隔。实例启动时，cloud-init会逐个解析并读取链接里的内容。如果在读取某一个链接的内容时出错，则停止读取剩余的链接。

  说明

  您可以通过阿里云对象存储OSS，上传User-Data脚本或Cloud Config数据、获取链接、设置链接有效期等。具体操作，请参见OSS控制台快速入门。

• 运行频率

  • 启动实例：执行频率由链接里的内容决定。例如，链接的内容为User-Data脚本，则仅在实例首次启动时运行一次；脚本类型链接的内容为Cloud Config数据，则遵循Cloud Config数据的运行频率。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  首行为#include，且起始位置不能有空格。

• Include文件示例

  #include
  https://ecs-image-test.oss-cn-hangzhou.aliyuncs.com/userdata/myscript.sh

  示例Include文件包含一个脚本链接，该脚本为User-Data脚本，则仅在实例首次启动时运行一次。

  说明

  如果您采用Include文件或Gzip压缩内容的方式，需要使用存储服务上传脚本、获取脚本链接、设置链接有效期等操作，推荐您使用阿里云对象存储OSS。具体操作，请参见OSS控制台快速入门。

Gzip压缩内容

• 简介

  如果您的User-Data脚本、Cloud Config数据或Include文件内容的大小超过32 KB，可以采用Gzip压缩内容（.gz格式）并做成链接，然后以Include文件的形式输入。cloud-init会自动解压Gzip压缩内容，运行解压后内容的效果和直接传入后运行没有区别。

  说明

  您可以通过阿里云对象存储OSS，上传User-Data脚本或Cloud Config数据、获取链接、设置链接有效期等。具体操作，请参见OSS控制台快速入门。

• 运行频率

  • 启动实例：由脚本类型和模块类型决定。例如，Gzip压缩内容链接的脚本类型为User-Data脚本，则仅在实例首次启动时运行一次。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  首行为#include，且起始位置不能有空格。

• Gzip压缩内容示例

  #include
  https://ecs-image-test.oss-cn-hangzhou.aliyuncs.com/userdata/myscript.gz

  示例Gzip压缩内容表示Include文件包含一个Gzip压缩内容链接，cloud-init读取该Gzip压缩内容后会自动解压并运行，该Gzip压缩内容由User-Data脚本压缩得到，所以仅在实例首次启动时运行一次。

Upstart Job

• 简介

  Upstart是一个事件驱动型的初始化系统，Upstart Job是一个配置文件，定义了一个服务或任务何时启动、停止和如何运行。它通常放置在/etc/init/目录下，文件扩展名为.conf。

• 运行频率

  • 启动实例：实例每次启动都会自动运行。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  首行为#upstart-job，且起始位置不能有空格。

• Upstart Job内容示例

  #upstart-job
  description "upstart test"
  start on runlevel [2345] #在运行级别2、3、4、5执行
  stop on runlevel [!2345] #在运行级别2、3、4、5以外不执行
  exec echo "Hello World. The time is now $(date -R)!" | tee /root/output.txt

  示例Upstart Job表示在系统进入指定的运行级别时输出一条包含时间戳的消息，并将该消息记录到/root/output.txt文件中。当系统离开这些运行级别时，作业会停止执行。

bat脚本

• 运行频率

  • 启动实例：实例首次启动时运行一次，重启实例不会自动运行。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  • 首行为[bat]，且起始位置不能有空格。

  • 只能输入半角字符，不能有多余字符。

  • 写入数据的路径不能为C:\Users目录，否则自定义数据会执行失败。

    说明

    在Windows系统中，C:\Users及其子目录是用户配置文件和数据的默认存储位置，需要登录系统后才可以访问，而在系统初始化执行userdata阶段实际还未登录系统，所以写入数据到C:\Users目录会失败。

• Bat脚本示例

  • 运行自定义脚本

    [bat]
    echo "bat test" > C:\userdata_test.txt

    示例Bat脚本的效果是在实例首次启动时向userdata_test.txt文件写入内容"bat test"。

PowerShell脚本

• 运行频率

  • 启动实例：实例首次启动时运行一次，重启实例不会自动运行。

  • 更换操作系统：自动运行。

  • 重新初始化系统盘：自动运行。

    重要

    以下情况不会自动运行脚本：

    • 如果更换操作系统使用的是自定义镜像且来源于原实例，更换操作系统时会判断实例不是初次启动，因此不会自动运行脚本。

    • 如果创建使用的是自定义镜像，则创建实例时系统盘就有数据，初始化系统盘时会判断实例不是首次启动，因此不会自动运行脚本。

• 格式

  • 首行为[powershell]，且起始位置不能有空格。

  • 只能输入半角字符，不能有多余字符。

  • 写入数据的路径不能为C:\Users目录，否则自定义数据会执行失败。

    说明

    在Windows系统中，C:\Users及其子目录是用户配置文件和数据的默认存储位置，需要登录系统后才可以访问，而在系统初始化执行userdata阶段实际还未登录系统，所以写入数据到C:\Users目录会失败。

• PowerShell脚本示例

  • 运行自定义脚本

    [powershell]
    write-output "powershell test" | Out-File C:\userdata_test.txt

    示例PowerShell脚本的效果是在实例首次启动时向userdata_test.txt文件写入内容powershell test。