Elastic Compute Service:Initialize an instance by using user data

Scripts User-Data

• Descripción general

  Cuando se pasa un script User-Data a una instancia de Linux, este se ejecuta como un script de shell. El script se ejecuta una sola vez durante el primer inicio de la instancia.

• Frecuencia de ejecución

  • Iniciar la instancia: se ejecuta una sola vez durante el primer inicio. No vuelve a ejecutarse al reiniciar la instancia.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

  Importante

  El script no se ejecuta automáticamente en los siguientes casos:

  • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

  • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  La primera línea debe comenzar con un shebang (#!).

• Ejemplos de scripts User-Data

  • Ejecutar un script personalizado

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

    Este script User-Data de ejemplo escribe la hora del sistema en el archivo userdata_test.txt durante el primer inicio de la instancia.

  • Personalizar orígenes de software, configuraciones de DNS y servicios de sincronización de hora

    Al crear una instancia, use un script User-Data para personalizar los orígenes de software, las configuraciones de DNS y los servicios de sincronización de hora. El siguiente ejemplo utiliza CentOS Stream 9. Sustituya las configuraciones por las adecuadas para su sistema operativo.

    Importante

    El sistema configura automáticamente el repositorio yum predeterminado, el servicio Network Time Protocol (NTP) y el servicio DNS cuando inicia la instancia. Puede usar los datos de usuario para cambiar estos elementos. Tenga en cuenta lo siguiente:

    • Si personaliza el repositorio yum, Alibaba Cloud deja de brindar soporte técnico para dicho repositorio.

    • Si personaliza el servicio NTP, Alibaba Cloud deja de proporcionar servicios de sincronización de hora.

    #!/bin/sh
    # Modify DNS
    echo "nameserver 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

    Nota

    En el código anterior, 114.114.114.114 es la dirección del servidor DNS, https://mirror.stream.centos.org es la dirección del repositorio yum para CentOS Stream y server ntp1.aliyun.com es la dirección del servidor NTP de Alibaba Cloud. Modifíquelas según sus necesidades.

    También puede usar datos Cloud Config para cambiar el repositorio yum. Sin embargo, este método es menos flexible y no se adapta a los casos en los que Alibaba Cloud ya configuró previamente algunos repositorios yum. Se recomienda utilizar un script User-Data.

  • Personalizar la cuenta de administrador

    De forma predeterminada, las instancias de Linux usan el usuario root como administrador. Con los datos de usuario, puede especificar otro usuario para este rol.

    #!/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

    Nota

    Sustituya la clave pública de ejemplo ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCRnnUveAis por su clave pública real.

Datos Cloud Config

• Descripción general

  Cloud-init utiliza una serie de módulos funcionales para realizar tareas como instalar paquetes de software y configurar redes. Los datos Cloud Config determinan qué módulos se ejecutan y cuál es su lógica. Estos datos pueden obtenerse de los datos del proveedor, de los datos de usuario o de los parámetros del kernel. Al crear una instancia de ECS, personalice los datos Cloud Config para indicar qué módulos y tareas deben ejecutarse. Cuando la instancia inicia, cloud-init lee y analiza sintácticamente los datos Cloud Config, ejecuta los módulos correspondientes y aplica las tareas de configuración especificadas para configurar y desplegar automáticamente la instancia de ECS.

• Frecuencia de ejecución

  • Iniciar la instancia: la ejecución de las tareas en los datos Cloud Config depende de la configuración de frecuencia de sus módulos correspondientes. Para obtener más información sobre los módulos, consulte Modules.

    • Frecuencia once-per-instance: se ejecuta únicamente durante el primer inicio de la instancia. Por ejemplo, si configura módulos como Apt y Set Passwords, la frecuencia es once-per-instance y no vuelven a ejecutarse al reiniciar la instancia.

    • Frecuencia always: se ejecuta cada vez que inicia la instancia. Por ejemplo, si configura módulos como Bootcmd y Update Etc Hosts, la frecuencia es always y se ejecutan en cada inicio.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  • La primera línea debe ser #cloud-config, sin espacios antes.

  • El contenido debe escribirse con sintaxis YAML.

• Ejemplos de datos Cloud Config

  • Personalizar los orígenes de software de la instancia

    En la sección User Data, introduzca el siguiente contenido para configurar orígenes de software personalizados. Este ejemplo usa una imagen de Ubuntu para crear la instancia. Si utiliza otra imagen, sustituya la configuración por el contenido del módulo correspondiente.

    #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

  • Configurar la instalación automática del servicio Nginx

    En la sección User Data, introduzca el siguiente contenido para que la instancia instale automáticamente el servicio Nginx.

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

  • Configurar un nombre de host personalizado

    En la sección User Data, introduzca el siguiente contenido para establecer un nombre de host personalizado.

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

  • Configurar un script personalizado para su ejecución automática

    En la sección User Data, introduzca el siguiente contenido para que un script de shell se ejecute automáticamente cada vez que inicie la instancia.

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

Archivos Include

• Descripción general

  Un archivo Include contiene enlaces a uno o más scripts User-Data o archivos de datos Cloud Config. Separe varios enlaces con saltos de línea. Cuando la instancia inicia, cloud-init analiza y lee secuencialmente el contenido de cada enlace. Si ocurre un error al leer un enlace, cloud-init detiene la lectura de los enlaces restantes.

  Nota

  Puede usar Object Storage Service (OSS) de Alibaba Cloud para cargar scripts User-Data o datos Cloud Config, obtener los enlaces y definir su periodo de validez. Para obtener más información, consulte Getting Started with the OSS console.

• Frecuencia de ejecución

  • Iniciar la instancia: la frecuencia de ejecución depende del contenido del enlace. Por ejemplo, si el enlace apunta a un script User-Data, este se ejecuta una sola vez durante el primer inicio de la instancia. Si apunta a datos Cloud Config, sigue la frecuencia de ejecución de dichos datos.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  La primera línea debe ser #include, sin espacios antes.

• Ejemplo de archivo Include

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

  Este archivo Include de ejemplo contiene un enlace a un script. Dado que se trata de un script User-Data, se ejecuta una sola vez durante el primer inicio de la instancia.

  Nota

  Si utiliza un archivo Include o contenido comprimido con Gzip, debe usar un servicio de almacenamiento para cargar el script, obtener su enlace y definir el periodo de validez. Se recomienda usar OSS de Alibaba Cloud. Para obtener más información, consulte Getting Started with the OSS console.

Contenido comprimido con Gzip

• Descripción general

  Si el tamaño de su script User-Data, de los datos Cloud Config o del archivo Include supera los 32 KB, puede usar contenido comprimido con Gzip (en formato .gz). Cree un enlace hacia el contenido comprimido e introdúzcalo en un archivo Include. Cloud-init descomprime automáticamente el contenido Gzip. El resultado de ejecutar el contenido descomprimido es idéntico al de pasar y ejecutar el contenido original directamente.

  Nota

  Puede usar Object Storage Service (OSS) de Alibaba Cloud para cargar scripts User-Data o datos Cloud Config, obtener los enlaces y definir su periodo de validez. Para obtener más información, consulte Getting Started with the OSS console.

• Frecuencia de ejecución

  • Iniciar la instancia: depende del tipo de script y del tipo de módulo. Por ejemplo, si el enlace al contenido comprimido con Gzip corresponde a un script User-Data, este se ejecuta una sola vez durante el primer inicio de la instancia.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  La primera línea debe ser #include, sin espacios antes.

• Ejemplo de contenido comprimido con Gzip

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

  Este ejemplo muestra un archivo Include que contiene un enlace a contenido comprimido con Gzip. Después de leerlo, cloud-init lo descomprime y lo ejecuta automáticamente. Como el contenido Gzip es un script User-Data comprimido, se ejecuta una sola vez durante el primer inicio de la instancia.

Upstart Job

• Descripción general

  Upstart es un sistema de inicialización basado en eventos. Un Upstart Job es un archivo de configuración que define cuándo inicia y se detiene un servicio o tarea, así como su forma de ejecución. Por lo general, se ubica en el directorio /etc/init/ con la extensión de archivo .conf.

• Frecuencia de ejecución

  • Iniciar la instancia: se ejecuta automáticamente cada vez que inicia la instancia.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  La primera línea debe ser #upstart-job, sin espacios antes.

• Ejemplo de contenido de Upstart Job

  #upstart-job
  description "upstart test"
  start on runlevel [2345] # Executes at run levels 2, 3, 4, and 5
  stop on runlevel [!2345] # Does not execute at run levels other than 2, 3, 4, and 5
  exec echo "Hello World. The time is now $(date -R)!" | tee /root/output.txt

  Este Upstart Job de ejemplo genera un mensaje con una marca de tiempo cuando el sistema entra en los niveles de ejecución especificados y lo registra en el archivo /root/output.txt. El job deja de ejecutarse cuando el sistema abandona estos niveles de ejecución.

Archivos MIME de varias partes

• Descripción general

  Un archivo MIME de varias partes transmite distintos tipos de instrucciones. Por ejemplo, puede incluir tanto text/cloud-config (para la configuración de cloud-init) como text/x-shellscript (script de shell) en los datos de usuario. Cloud-init analiza y ejecuta estos tipos de instrucciones por separado.

• Frecuencia de ejecución

  • Iniciar la instancia: depende del tipo de cada parte del mensaje MIME y de la configuración de cloud-init. Por ejemplo, si el tipo de contenido en el mensaje MIME es un script User-Data, este se ejecuta una sola vez durante el primer inicio de la instancia. Si corresponde a datos Cloud Config, sigue la frecuencia de ejecución de dichos datos.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  • La primera línea es Content-Type: multipart/mixed; boundary="****". El límite (boundary) se puede personalizar y no debe haber espacios al inicio de la línea.

  • La segunda línea especifica la versión: MIME-Version: 1.0. Este campo suele ser obligatorio en todos los mensajes MIME.

• Ejemplo de archivo MIME de varias partes

  Content-Type: multipart/mixed; boundary="//"
  MIME-Version: 1.0
  
  --//
  Content-Type: text/cloud-config; charset="us-ascii"
  MIME-Version: 1.0
  Content-Transfer-Encoding: 7bit
  Content-Disposition: attachment; filename="cloud-config.txt"
  
  #cloud-config
  runcmd:
  - [ mkdir, /test-cloudinit ]
  write_files:
  - path: /test-cloudinit/cloud-init.txt
    content: |
      Created by cloud-init
    append: true
  
  --//
  Content-Type: text/x-shellscript; charset="us-ascii"
  MIME-Version: 1.0
  Content-Transfer-Encoding: 7bit
  Content-Disposition: attachment; filename="userdata.txt"
  
  #!/bin/bash
  mkdir test-userscript
  touch /test-userscript/userscript.txt
  echo "Created by bash shell script" >> /test-userscript/userscript.txt
  --//--

  Este archivo MIME de varias partes de ejemplo contiene instrucciones de cloud-init y un script de shell Bash:

  • Las instrucciones de cloud-init crean un archivo (/test-cloudinit/cloud-init.txt) y escriben Created by cloud-init en él.

  • El script de shell Bash crea un archivo (/test-userscript/userscript.txt) y escribe Created by bash shell script en él.

Scripts Bat

• Frecuencia de ejecución

  • Iniciar la instancia: se ejecuta una sola vez durante el primer inicio. No vuelve a ejecutarse al reiniciar la instancia.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  • La primera línea debe ser [bat], sin espacios antes.

  • Use únicamente caracteres de ancho medio. No introduzca caracteres adicionales.

  • No escriba datos en el directorio C:\Users. De lo contrario, la ejecución de los datos de usuario terminará con errores.

    Nota

    En Windows, solo se puede acceder a C:\Users y a sus subdirectorios después de iniciar sesión. Los datos de usuario se ejecutan durante la inicialización del sistema, antes del inicio de sesión, por lo que las escrituras en C:\Users fallan.

• Ejemplo de script Bat

  • Ejecutar un script personalizado

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

    Este script Bat de ejemplo escribe "bat test" en el archivo userdata_test.txt durante el primer inicio de la instancia.

Scripts de PowerShell

• Frecuencia de ejecución

  • Iniciar la instancia: se ejecuta una sola vez durante el primer inicio. No vuelve a ejecutarse al reiniciar la instancia.

  • Reemplazar el sistema operativo: se ejecuta automáticamente.

  • Reinicializar el disco del sistema: se ejecuta automáticamente.

    Importante

    El script no se ejecuta automáticamente en los siguientes casos:

    • Si reemplaza el sistema operativo con una imagen personalizada creada a partir de la instancia de origen, el sistema determina que la instancia no está iniciando por primera vez y omite la ejecución del script.

    • Si crea una instancia con una imagen personalizada, el disco del sistema ya contiene datos. Al inicializarlo, el sistema determina que la instancia no está iniciando por primera vez y no ejecuta el script.

• Formato

  • La primera línea debe ser [powershell], sin espacios antes.

  • Use únicamente caracteres de ancho medio. No introduzca caracteres adicionales.

  • No escriba datos en el directorio C:\Users. De lo contrario, la ejecución de los datos de usuario terminará con errores.

    Nota

    En Windows, solo se puede acceder a C:\Users y a sus subdirectorios después de iniciar sesión. Los datos de usuario se ejecutan durante la inicialización del sistema, antes del inicio de sesión, por lo que las escrituras en C:\Users fallan.

• Ejemplo de script de PowerShell

  • Ejecutar un script personalizado

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

    Este script de PowerShell de ejemplo escribe powershell test en el archivo userdata_test.txt durante el primer inicio de la instancia.