Elastic Compute Service:インスタンスの初期化構成をカスタマイズする

User-data スクリプト

• 概要

  user-data スクリプトが Linux インスタンスに渡されると、スクリプトはシェルスクリプトとして実行され、インスタンスが初めて起動されたときに一度だけ実行されます。

• 実行頻度

  • インスタンスの起動: user-data スクリプトは、ECS インスタンスが初めて起動されたときに一度だけ実行されます。 インスタンスの再起動時にはスクリプトは実行されません。

  • オペレーティングシステムの置き換え: user-data スクリプトは自動的に実行されます。

  • システムディスクの再初期化: user-data スクリプトは自動的に実行されます。

  重要

  次のシナリオでは、スクリプトは自動的に実行されません。

  • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

  • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。 システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  最初の行はシャープ記号と感嘆符 (#!) で始まります。

• user-data スクリプトのサンプル

  • カスタムスクリプトを実行する

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

    サンプルの user-data スクリプトは、ECS インスタンスが初めて起動されたときに一度だけ実行され、システム時刻を userdata_test.txt ファイルに書き込みます。

  • ECS インスタンスのソフトウェア リポジトリ、DNS 解決、時刻同期サービスの構成をカスタマイズする

    ECS インスタンスを作成するときに、user-data スクリプトを使用して、インスタンスのソフトウェア リポジトリ、DNS 解決、時刻同期サービスの構成をカスタマイズできます。 次のサンプルコードでは、CentOS Stream 9 が使用されています。 オペレーティングシステムに基づいて構成を置き換えてください。

    重要

    インスタンスが起動すると、システムはデフォルトの YUM リポジトリ、Network Time Protocol (NTP) サービス、およびドメインネームシステム (DNS) サービスを構成します。 インスタンスのユーザーデータを使用して、構成されているデフォルトの YUM リポジトリと NTP および DNS サービスを変更できます。 以下の点にご注意ください。

    • カスタム YUM リポジトリを使用する場合、Alibaba Cloud は YUM リポジトリのサポートの提供を停止します。

    • NTP サービスをカスタマイズする場合、Alibaba Cloud は時刻同期サービスの提供を停止します。

    #!/bin/sh
    # Modify DNS  // DNS を変更する
    echo "nameserver 114.114.114.114" | tee /etc/resolv.conf
    # Modify yum repo and update // yum リポジトリを変更して更新する
    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 // NTP サーバーを変更する
    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 を Alibaba Cloud の実際の NTP サーバーアドレスに置き換えてください。

    cloud-config データを使用して YUM リポジトリを変更することもできます。 ただし、cloud-config データは user-data スクリプトほど柔軟ではなく、Alibaba Cloud によって特定の YUM リポジトリが事前に構成されているシナリオには適していません。 user-data スクリプトを使用することをお勧めします。

  • 管理者アカウントを指定する

    デフォルトでは、Linux インスタンスはルートアカウントを管理者アカウントとして使用します。 インスタンスのインスタンスユーザーデータを使用して、別のアカウントを管理者アカウントとして指定できます。

    #!/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-init は、ベンダーデータ、カスタムデータ、およびカーネルパラメーターから cloud-config データを取得します。 cloud-config データは、タスクにどのモジュールが関与し、どのようなアクションを実行するかを決定します。 ECS インスタンスを作成する前に、モジュールとタスクを指定することでカスタム cloud-config データを構成し、cloud-config データをインスタンスユーザーデータとしてインスタンスに渡すことができます。 インスタンスが起動されると、cloud-init は cloud-config データを読み取って解析し、構成ファイルの指示に従ってモジュールを実行し、タスクを実行して ECS インスタンスを構成およびデプロイします。

• 実行頻度

  • インスタンスの起動: cloud-config データのタスクを実行するかどうかは、タスクに対応するモジュールの実行頻度によって決まります。 モジュールの詳細については、モジュールを参照してください。

    • インスタンスごと 1 回: モジュールは、ECS インスタンスが初めて起動されたときに一度だけ実行されます。 たとえば、「Apt」や「パスワードの設定」などのモジュールは、「インスタンスごと 1 回」の頻度で構成および実行されます。 インスタンスの再起動時にはモジュールは実行されません。

    • 常に: モジュールは、ECS インスタンスが起動されるたびに実行されます。 たとえば、「Bootcmd」や「Etc ホストの更新」などのモジュールが「常に」の頻度で実行される場合、モジュールは ECS インスタンスが起動されるたびに実行されます。

  • オペレーティングシステムの置き換え: モジュールは自動的に実行されます。

  • システムディスクの再初期化: モジュールは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。 システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  • 最初の行は #cloud-config で始まり、ヘッダーにはスペースが含まれていません。

  • Cloud-config データは YAML 構文に従う必要があります。

• cloud-config データのサンプル

  • ECS インスタンスのソフトウェア リポジトリを指定する

    [ユーザーデータ] フィールドで、ECS インスタンスのソフトウェア リポジトリを指定するために次のコンテンツを入力します。この例では、Ubuntu イメージを使用して ECS インスタンスを作成します。別のイメージを使用する場合は、サンプル コード内の構成をイメージの実際の構成に置き換えます。

    #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 # リポジトリのURIを指定します

  • ECS インスタンスのソフトウェア リポジトリを指定する

    [ユーザーデータ] フィールドで、ECS インスタンスに次のコンテンツを入力して、インスタンスが NGINX サービスを自動的にインストールできるようにします。

    #cloud-config
    packages: 
     - nginx
    # パッケージ
    runcmd: 
     - systemctl start nginx.service
    # nginx.service を開始します
    

  • NGINX サービスの自動インストールを構成する

    ユーザーデータECS インスタンスの フィールドに次のコンテンツを入力して、インスタンスが NGINX サービスを自動的にインストールできるようにします。

    #cloud-config
    # クラウド設定
    hostname: my-instance
    fqdn: my-instance.localdomain

  • ホスト名を指定する

    [ユーザーデータ] フィールドの ECS インスタンスに、以下のコンテンツを入力して、インスタンスが起動されるたびにシェルスクリプトが自動的に実行されるようにします。

    #cloud-config
    bootcmd:
    - echo "Hello World. The time is now $(date -R)!" | tee /root/userdata_test.txt  # Hello World. 現在時刻は $(date -R) です！ を /root/userdata_test.txt に出力します。
    

インクルードファイル

• 概要

  インクルードファイルには、ユーザーデータスクリプトまたは cloud-init データへの 1 つ以上のリンクが含まれています。各リンクは別々の行を占めます。 ECS インスタンスが起動すると、cloud-init はリンクを 1 つずつ読み取って解析します。 cloud-init がリンクの読み取り中にエラーが発生した場合、cloud-init は残りのリンクの読み取りを停止します。

  説明

  Alibaba Cloud Object Storage Service (OSS) を使用して、ユーザーデータスクリプトまたは cloud-init データを ECS インスタンスにアップロードし、リンクを取得し、リンクの有効期間を指定できます。 詳細については、「OSS コンソールを使用して開始する」をご参照ください。

• 実行頻度

  • インスタンスの起動: 実行頻度は、リンクが指すコンテンツによって異なります。たとえば、リンクがユーザーデータスクリプトを指している場合、スクリプトは ECS インスタンスが最初に起動されたときに 1 回だけ実行されます。リンクが cloud-init データを指している場合は、cloud-init データの実行頻度が優先されます。

  • オペレーティングシステムの置き換え: インクルードファイルは自動的に実行されます。

  • システムディスクの再初期化: インクルードファイルは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• フォーマット

  最初の行は #include で始まり、ヘッダーにはスペースが含まれていません。

• インクルードファイルのサンプル

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

  この例では、インクルードファイルにはユーザーデータスクリプトへのリンクが含まれており、スクリプトは ECS インスタンスが最初に起動されたときに 1 回だけ実行されます。

  説明

  インクルードファイルまたは Gzip 圧縮コンテンツを使用する場合は、ストレージサービスを使用してスクリプトをアップロードし、スクリプトリンクを取得し、リンクの有効期間を指定します。 Alibaba Cloud OSS を使用することをお勧めします。 詳細については、「OSS コンソールを使用して開始する」をご参照ください。

Include ファイル

• 概要

  ユーザーデータスクリプト、cloud-config データ、またはインクルードファイルのサイズが 32 KB を超える場合は、Gzip を使用してインクルードファイルの内容を .gz 形式で圧縮し、対応するリンクを生成してから、そのインクルードファイルを ECS インスタンスに渡すことができます。Cloud-init は、Gzip で圧縮されたコンテンツを自動的に解凍します。解凍されたコンテンツを実行した結果は、圧縮されていないコンテンツを ECS インスタンスに直接渡して実行した結果と同じです。

  説明

  Alibaba Cloud OSS を使用して、ユーザーデータ スクリプトまたは cloud-config データを ECS インスタンスにアップロードし、リンクを取得して、リンクの有効期間を指定することもできます。詳細については、「OSS コンソールを使用して開始する」をご参照ください。

• 実行頻度

  • インスタンスの起動: 実行頻度は、スクリプトの種類とモジュールの種類によって異なります。たとえば、リンクがユーザーデータ スクリプトである Gzip 圧縮コンテンツに転送される場合、Gzip 圧縮コンテンツは、ECS インスタンスが初めて起動されたときに一度だけ実行されます。

  • オペレーティングシステムの置き換え: Gzip 圧縮コンテンツは自動的に実行されます。

  • システム ディスクの再初期化: Gzip 圧縮コンテンツは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタム イメージを使用して、カスタム イメージが作成されたソース インスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタム イメージを使用して ECS インスタンスを作成する場合、インスタンスのシステム ディスクにはデータが保存されます。システム ディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  最初の行は #include で始まり、ヘッダーにはスペースが含まれていません。

• Gzip 圧縮コンテンツのサンプル コード

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

  この例では、インクルード ファイルには、ユーザーデータ スクリプトである Gzip 圧縮コンテンツへのリンクが含まれています。 cloud-init が Gzip 圧縮されたユーザーデータ スクリプトを読み取ると、スクリプトは自動的に解凍され、インスタンスが初めて起動されたときに一度だけ実行されます。

Upstart ジョブ

• 概要

  Upstart はイベント駆動型の初期化システムです。 Upstart ジョブは、サービスまたはタスクを開始または停止するタイミングと実行方法を定義する構成ファイルです。 Upstart ジョブファイルのファイル拡張子は .conf で、/etc/init/ ディレクトリにあります。

• 実行頻度

  • インスタンスの起動: ECS インスタンスが起動されるたびに、Upstart ジョブが自動的に実行されます。

  • オペレーティングシステムの置き換え: Upstart ジョブが自動的に実行されます。

  • システムディスクの再初期化: Upstart ジョブが自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  最初の行は #upstart-job で始まり、ヘッダーにはスペースが含まれていません。

• Upstart ジョブの例

  #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 ジョブは、システムが指定されたランレベルで実行されたときにタイムスタンプを含むメッセージを返し、そのメッセージを /root/output.txt ファイルに追加します。 Upstart ジョブは、システムが上記の指定されたランレベルとは異なるランレベルで実行されると停止します。

MIME マルチパートファイル

• 概要

  MIME マルチパートファイルは、複数の種類の命令を送信できます。たとえば、MIME マルチパートファイルを使用して、ユーザーデータに text/cloud-config（cloud-init 構成用）と text/x-shellscript（シェルスクリプト）の両方を含めることができます。 cloud-init は、命令を個別に解析して実行します。

• 実行頻度

  • インスタンスの起動：実行頻度は、MIME メッセージのパートタイプと cloud-init 構成によって異なります。たとえば、MIME メッセージの一部がユーザーデータスクリプトである場合、スクリプトは ECS インスタンスが初めて起動されたときに一度だけ実行されます。 MIME メッセージの一部が cloud-config データである場合、cloud-config データの実行頻度が優先されます。

  • オペレーティングシステムの置き換え：MIME マルチパートファイルは自動的に実行されます。

  • システムディスクの再初期化：MIME マルチパートファイルは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  • 最初の行は Content-Type: multipart/mixed: boundary="****" で始まります。ここで、boundary はカスタマイズ可能であり、ヘッダーにはスペースが含まれていません。

  • 2 行目はバージョン MIME-Version: 1.0 を指定します。これは通常、すべての MIME メッセージで必要です。

• MIME マルチパートファイルの例

  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
  write_files:
  - content: |
      Created by cloud-init
    path:  /test-cloudinit/cloud-init.txt
    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
  --//--

  MIME マルチパートファイルの例には、cloud-init 命令と Bash シェルスクリプトが含まれています。

  • cloud-init 命令は、ファイル（/test-cloudinit/cloud-init.txt）を作成し、Created by cloud-init を書き込みます。

  • Bash シェルスクリプトは、ファイル（/test-userscript/userscript.txt）を作成し、Created by bash shell script を書き込みます。

バッチスクリプト

• 実行頻度

  • インスタンスの起動: バッチスクリプトは、ECS インスタンスが初めて起動されたときに一度だけ実行されます。インスタンスの再起動時には、スクリプトは実行されません。

  • オペレーティングシステムの置き換え: バッチスクリプトは自動的に実行されます。

  • システムディスクの再初期化: バッチスクリプトは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  • 最初の行は [bat] で、ヘッダーにスペースは含まれていません。

  • 半角文字のみ入力できます。その他の文字は使用できません。

  • インスタンスユーザーデータが書き込まれるパスを C:\Users にすることはできません。設定した場合、インスタンスユーザーデータは実行されません。

    説明

    Windows オペレーティングシステムでは、ユーザー構成ファイルとデータはデフォルトで C:\Users ディレクトリとそのサブディレクトリに保存されます。このディレクトリとそのサブディレクトリには、オペレーティングシステムにログインした後にのみアクセスできます。初期化ステージでオペレーティングシステムがユーザーデータを実行するときには、オペレーティングシステムにログインしていません。このステージでは、C:\Users ディレクトリまたはそのサブディレクトリにデータを書き込むことはできません。

• バッチスクリプトの例

  • カスタムスクリプトを実行する

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

    この例では、バッチスクリプトは ECS インスタンスが初めて起動されたときに一度だけ実行され、"bat test" が userdata_test.txt ファイルに書き込まれます。

PowerShell スクリプト

• 実行頻度

  • インスタンスの起動: PowerShell スクリプトは、ECS インスタンスが初めて起動されたときに一度だけ実行されます。インスタンスの再起動時には、スクリプトは実行されません。

  • オペレーティングシステムの置き換え: PowerShell スクリプトは自動的に実行されます。

  • システムディスクの再初期化: PowerShell スクリプトは自動的に実行されます。

    重要

    次のシナリオでは、スクリプトは自動的に実行されません。

    • カスタムイメージを使用して、カスタムイメージが作成されたソースインスタンスのオペレーティングシステムを置き換える場合、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

    • カスタムイメージを使用して ECS インスタンスを作成する場合、インスタンスのシステムディスクにはデータが保存されます。システムディスクを初期化すると、システムはインスタンスが初めて起動されたのではないと判断し、スクリプトを実行しません。

• 形式

  • 最初の行は [powershell] で、ヘッダーにスペースは含まれていません。

  • 半角文字のみ入力できます。その他の文字は使用できません。

  • インスタンスユーザーデータが書き込まれるパスを C:\Users にすることはできません。設定した場合、インスタンスユーザーデータは実行されません。

    説明

    Windows オペレーティングシステムでは、ユーザー構成ファイルとデータはデフォルトで C:\Users ディレクトリとそのサブディレクトリに保存されます。このディレクトリとそのサブディレクトリには、オペレーティングシステムにログインした後にのみアクセスできます。初期化ステージでオペレーティングシステムがユーザーデータを実行するときには、オペレーティングシステムにログインしていません。このステージでは、C:\Users ディレクトリまたはそのサブディレクトリにデータを書き込むことはできません。

• PowerShell スクリプトの例

  • カスタムスクリプトを実行する

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

    この例では、PowerShell スクリプトは ECS インスタンスが初めて起動されたときに一度だけ実行され、powershell test が userdata_test.txt ファイルに書き込まれます。