Elastic Compute Service:Inicializar uma instância usando dados do usuário

Scripts de User-Data

• Visão geral

  Ao passar um script de User-Data para uma instância Linux, ele é executado como um script de shell. O script roda apenas uma vez na primeira inicialização da instância.

• Frequência de execução

  • Iniciar instância: executa apenas uma vez na primeira inicialização. O script não roda novamente ao reiniciar a instância.

  • Substituir sistema operacional: executa automaticamente.

  • Reinicializar disco do sistema: executa automaticamente.

  Importante

  O script não é executado automaticamente nos seguintes casos:

  • Se você usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema não a considera a primeira inicialização. Assim, o script não executa.

  • Ao criar uma instância com imagem personalizada, o disco do sistema já contém dados. Na inicialização do disco, o sistema ignora a primeira inicialização e não executa o script.

• Formato

  A primeira linha deve começar com um shebang (#!).

• Exemplos de scripts de User-Data

  • Executar um script personalizado

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

    Este script de User-Data de exemplo grava a hora do sistema no userdata_test.txt arquivo durante a primeira inicialização da instância.

  • Personalize fontes de software, configurações de DNS e serviços de sincronização de hora

    Ao criar uma instância, use um script de User-Data para personalizar fontes de software, DNS e sincronização de hora. O exemplo usa CentOS Stream 9. Substitua as configurações conforme seu sistema operacional.

    Importante

    O sistema configura automaticamente o repositório yum padrão, o serviço NTP e o DNS na inicialização. Use user data para alterar o repositório yum, o NTP e o DNS. Observe o seguinte:

    • Se você personalizar o repositório yum, a Alibaba Cloud não fornecerá mais suporte para ele.

    • Caso personalize o serviço NTP, a Alibaba Cloud deixará de oferecer serviços de sincronização de tempo.

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

    No código anterior, 114.114.114.114 é o endereço do servidor DNS, https://mirror.stream.centos.org é o endereço do repositório yum para o CentOS Stream, e server ntp1.aliyun.com é o endereço do servidor NTP da Alibaba Cloud. Substitua-os conforme necessário.

    Você também pode usar dados do Cloud Config para alterar o repositório yum. Porém, esse método é menos flexível e ignora repositórios pré-configurados pela Alibaba Cloud. Recomendamos o uso de um script User-Data.

  • Personalize a conta de administrador

    Por padrão, as instâncias Linux usam o usuário root como administrador. Você pode usar user data para definir outro usuário como administrador.

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

    Substitua a chave pública de exemplo ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCRnnUveAis**** pela sua chave pública real.

Dados do Cloud Config

• Visão geral

  O cloud-init usa módulos funcionais para tarefas como instalar pacotes e configurar redes. Os dados do Cloud Config determinam os módulos e sua lógica. Esses dados vêm de dados do fornecedor, user data ou parâmetros do kernel. Ao criar uma instância ECS, personalize esses dados para definir os módulos e tarefas. Na inicialização, o cloud-init lê os dados, executa os módulos e aplica as configurações. Isso configura e implanta a instância ECS automaticamente.

• Frequência de execução

  • Iniciar instância: a execução das tarefas depende das configurações de frequência dos módulos correspondentes. Para mais informações sobre os módulos, consulte Módulos.

    • Frequência uma vez por instância: executa só na primeira inicialização. Configure módulos como Apt e Set Passwords. Eles não executam ao reiniciar a instância.

    • Frequência sempre: executa em toda inicialização da instância. Configure módulos como Bootcmd e Update Etc Hosts. Eles executam sempre que a instância iniciar.

  • Substituir sistema operacional: executa automaticamente.

  • Reinicializar disco do sistema: executa automaticamente.

    Importante

    O script não executa automaticamente nos seguintes casos:

    • Ao usar imagem personalizada da instância de origem para substituir o sistema operacional, o sistema ignora a primeira inicialização. O script não será executado.

    • Com imagem personalizada, o disco do sistema já contém dados. O sistema não executa o script na inicialização, pois não é a primeira vez.

• Formato

  • A primeira linha deve ser #cloud-config, sem espaços antes.

  • O conteúdo deve ser escrito em sintaxe YAML.

• Exemplo de dados do Cloud Config

  • Personalizar fontes de software da instância

    Na seção User Data , insira o conteúdo para configurar fontes personalizadas. O exemplo usa imagem Ubuntu. Para outras imagens, substitua a configuração pelo conteúdo do módulo adequado.

    #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 a instalação automática do serviço Nginx

    Na seção User Data , insira o seguinte conteúdo para configurar a instalação automática do serviço Nginx na instância.

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

  • Configurar um nome de host personalizado

    Na User Data seção, insira o seguinte conteúdo para definir um nome de host personalizado.

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

  • Configure um script personalizado para execução automática.

    Na User Data seção, insira o seguinte conteúdo para configurar um script de shell para execução automática a cada inicialização da instância.

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

Arquivos Include

• Visão geral

  Um arquivo Include contém links para scripts User-Data ou arquivos de dados Cloud Config. Separe vários links com quebras de linha. Na inicialização da instância, o cloud-init analisa e lê cada link sequencialmente. Se ocorrer um erro na leitura, o cloud-init para de ler os links restantes.

  Nota

  Use o Alibaba Cloud Object Storage Service (OSS) para enviar scripts User-Data ou dados Cloud Config, obter links e definir a validade. Para mais informações, consulte Primeiros passos com o console do OSS.

• Frequência de execução

  • Iniciar instância: a frequência depende do conteúdo do link. Se for um script User-Data, executa apenas uma vez na primeira inicialização. Se for dados Cloud Config, segue a frequência de execução do Cloud Config.

  • Substituir sistema operacional: executa automaticamente.

  • Reinicializar disco do sistema: executa automaticamente.

    Importante

    O script não executa automaticamente nos seguintes casos:

    • Se usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema ignora a primeira inicialização. O script não será executado.

    • Se criar uma instância com imagem personalizada, o disco do sistema já terá dados. Ao inicializar o disco, o sistema ignora a primeira inicialização. O script não é executado.

• Formato

  A primeira linha deve ser #include, sem espaços antes.

• Arquivo Include de exemplo

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

  O arquivo Include de exemplo contém um link para um script. Esse script é do tipo User-Data, então executa apenas uma vez na primeira inicialização da instância.

  Nota

  Ao usar um arquivo Include ou conteúdo compactado em Gzip, use um serviço de armazenamento para enviar o script. Obtenha o link do script e defina seu período de validade. Recomendamos o uso do Alibaba Cloud OSS. Para mais informações, consulte Primeiros passos com o console do OSS.

Conteúdo compactado em Gzip

• Visão geral

  Se o tamanho do seu script User-Data, dados Cloud Config ou arquivo Include exceder 32 KB, use conteúdo compactado em Gzip (no formato .gz ). Crie um link para o conteúdo compactado e insira-o em um arquivo Include. O cloud-init descompacta o conteúdo Gzip automaticamente. O efeito da execução do conteúdo descompactado é o mesmo que executar o conteúdo original diretamente.

  Nota

  Use o Alibaba Cloud OSS para enviar scripts User-Data ou dados Cloud Config. Obtenha os links e defina o período de validade deles. Para mais informações, consulte Primeiros passos com o console do OSS.

• Frequência de execução

  • Iniciar instância: Definida pelo tipo de script e módulo. Por exemplo, se o link do conteúdo Gzip for para um script User-Data, ele executa apenas uma vez na primeira inicialização.

  • Substituir sistema operacional: Executa automaticamente.

  • Reinicializar disco do sistema: Executa automaticamente.

    Importante

    O script não executa automaticamente nos seguintes casos:

    • Se você usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema não a considerará na primeira inicialização. Assim, o script não será executado.

    • Ao criar uma instância com imagem personalizada, o disco do sistema já contém dados. Ao inicializar o disco, o sistema não a considera na primeira inicialização e não executa o script.

• Formato

  A primeira linha deve ser #include, sem espaços antes.

• Exemplo de conteúdo compactado com Gzip

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

  Este exemplo mostra um arquivo Include com um link para conteúdo compactado em Gzip. Após o cloud-init ler o conteúdo, ele o descompacta e executa automaticamente. O conteúdo Gzip é um script User-Data compactado. Ele é executado apenas uma vez na primeira inicialização da instância.

Tarefa do Upstart

• Visão geral

  O Upstart é um sistema de inicialização orientado a eventos. Um Upstart Job é um arquivo de configuração que define quando um serviço ou tarefa inicia, para e como é executado. Geralmente, é colocado no diretório /etc/init/ com a extensão de arquivo .conf.

• Frequência de execução

  • Iniciar instância: executa automaticamente toda vez que a instância é iniciada.

  • Substituir sistema operacional: executa automaticamente.

  • Reinicializar disco do sistema: executa automaticamente.

    Importante

    O script não é executado automaticamente nos seguintes casos:

    • Se você usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema identifica que não é a primeira inicialização. Assim, o script não é executado.

    • Se você usar uma imagem personalizada para criar uma instância, o disco do sistema já conterá dados. Ao inicializar o disco do sistema, o sistema identifica que não é a primeira inicialização. Logo, o script não é executado.

• Formato

  A primeira linha deve ser #upstart-job, sem espaços antes dela.

• Exemplo de conteúdo 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

  O Upstart Job de exemplo gera uma mensagem com timestamp ao entrar nos níveis de execução especificados e a registra no /root/output.txt arquivo. A tarefa para de executar quando o sistema sai desses níveis de execução.

Arquivos multipartes MIME

• Visão geral

  Um arquivo MIME multipart pode transmitir vários tipos de instruções. Por exemplo, você pode usar um arquivo MIME multipart para incluir ambos text/cloud-config (para configuração do cloud-init) e text/x-shellscript (shell script) no user data. O cloud-init analisa e executa essas instruções separadamente.

• Frequência de execução

  • Início da instância: depende do tipo de cada parte na mensagem MIME e da configuração do cloud-init. Por exemplo, se for um script de User-Data, executa apenas uma vez na primeira inicialização. Se for dados do Cloud Config, segue a frequência do Cloud Config.

  • Substituição do sistema operacional: executa automaticamente.

  • Reinicialização do disco do sistema: executa automaticamente.

    Importante

    O script não é executado automaticamente nos seguintes casos:

    • Se você usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema identifica que não é a primeira inicialização. Portanto, o script não é executado.

    • Se você criar uma instância com imagem personalizada, o disco do sistema já conterá dados. Ao inicializar o disco, o sistema identifica que não é a primeira inicialização. Por isso, o script não é executado.

• Formato

  • A primeira linha é Content-Type: multipart/mixed; boundary="****"O boundary pode ser personalizado e não deve haver espaço no início da linha.

  • A segunda linha especifica a versão MIME-Version: 1.0Este campo geralmente é obrigatório em toda mensagem MIME.

• Arquivo multipart MIME de exemplo

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

  O arquivo multipart MIME de exemplo contém instruções do cloud-init e um script de shell Bash:

  • As instruções do cloud-init criam um arquivo (/test-cloudinit/cloud-init.txt) e gravam Criado pelo cloud-init nele.

  • O script de shell Bash cria um arquivo (/test-userscript/userscript.txt) e grava Criado pelo script de shell bash nele.

Scripts Bat

• Frequência de execução

  • Iniciar instância: Executa apenas uma vez na primeira inicialização. O script não roda novamente ao reiniciar a instância.

  • Substituir sistema operacional: Executa automaticamente.

  • Reinicializar disco do sistema: Executa automaticamente.

    Importante

    O script não é executado automaticamente nos seguintes casos:

    • Se você substituir o sistema operacional por uma imagem personalizada, o sistema ignora a primeira inicialização. Assim, ele não executa o script.

    • Com imagens personalizadas, o disco do sistema da nova instância já contém dados. O sistema ignora a primeira inicialização e não executa o script.

• Formato

  • A primeira linha deve ser [bat], sem espaços antes.

  • Use apenas caracteres de meia largura. Não insira caracteres extras.

  • Não grave dados na C:\Users pasta. Caso contrário, a execução dos dados do usuário falhará.

    Nota

    No Windows, C:\Users e suas subpastas são acessíveis apenas após o login. Os dados do usuário rodam na inicialização antes do login, então gravações em C:\Users falham.

• Exemplo de script Bat

  • Execute um script personalizado

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

    Este script Bat de exemplo grava "bat test" no userdata_test.txt arquivo quando a instância é iniciada pela primeira vez.

Scripts do PowerShell

• Frequência de execução

  • Iniciar instância: executa apenas uma vez na primeira inicialização da instância. O script não é executado novamente quando a instância é reiniciada.

  • Substituir sistema operacional: executa automaticamente.

  • Reinicializar disco do sistema: executa automaticamente.

    Importante

    O script não é executado automaticamente nos seguintes casos:

    • Se você usar uma imagem personalizada da instância de origem para substituir o sistema operacional, o sistema não considera isso a primeira inicialização. Portanto, o script não é executado.

    • Se você usar uma imagem personalizada para criar uma instância, o disco do sistema já contém dados. Ao inicializar o disco, o sistema não considera a primeira inicialização e não executa o script.

• Formato

  • A primeira linha deve ser [powershell], sem espaços antes.

  • Use apenas caracteres de meia largura. Não insira caracteres extras.

  • Não grave dados no C:\Users diretório. Caso contrário, a execução dos dados do usuário falha.

    Nota

    No Windows, C:\Users e seus subdiretórios são acessíveis apenas após o login. Os dados do usuário executam na inicialização do sistema antes do login, então gravações em C:\Users falham.

• Exemplo de script PowerShell

  • Execute um script personalizado

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

    Este exemplo de script PowerShell grava powershell test no userdata_test.txt arquivo quando a instância é iniciada pela primeira vez.