プロビジョニングエージェントを使用せずに一般化されたイメージを作成する

[アーティクル]
10/15/2024

適用対象: ✔️ Linux VM ✔️ フレキシブルなスケールセット

Microsoft Azure は、Linux VM のプロビジョニングエージェントを walinuxagent または cloud init の形式で提供します (推奨)。ただし、次のようなプロビジョニングエージェントでこれらのアプリケーションを使用しない場合もあります。

お使いの Linux ディストリビューション/バージョンで、cloud-init/Linux エージェントがサポートされていない。
ホスト名など、特定の VM プロパティを設定する必要がある。

Note

プロパティを設定する必要がない場合、またはあらゆる形式のプロビジョニングが必要がない場合は、特殊化されたイメージを作成することを検討してください。

この記事では、プロビジョニングエージェントをインストールせずに、Azure プラットフォームの要件を満たすように VM イメージを設定し、ホスト名を設定する方法について説明します。

ネットワークと準備完了の報告

Linux VM が Azure のコンポーネントと通信するには、DHCP クライアントが必要です。このクライアントは、仮想ネットワークからホスト IP、DNS 解決、およびルート管理を取得するために使用されます。ほとんどのディストリビューションは、これらのユーティリティをすぐに使用できます。 Linux ディストリビューションベンダーによって Azure でテストされるツールには、dhclient、network-manager、systemd-networkd などがあります。

Note

現在、プロビジョニングエージェントを使用せずに一般化されたイメージを作成する場合は、DHCP 対応の VM のみがサポートされます。

ネットワークをセットアップして構成したら、[レポートの準備完了] を選びます。これにより、VM が正常にプロビジョニングされたことが Azure に通知されます。

重要

Azure に準備完了の報告をしないと、VM が再起動されます。

デモ/サンプル

Linux エージェント (walinuxagent) が削除され、カスタム Python スクリプトが追加された既存の Marketplace イメージ (この場合は Debian Buster VM) は、VM が "準備完了" であることを Azure に伝える最も簡単な方法です。

リソースグループとベース VM を作成する:

$ az group create --location eastus --name demo1

ベース VM を作成する:

$ az vm create \
    --resource-group demo1 \
    --name demo1 \
    --location eastus \
    --ssh-key-value <ssh_pub_key_path> \
    --public-ip-address-dns-name demo1 \
    --image "debian:debian-10:10:latest"

イメージプロビジョニングエージェントを削除する

VM がプロビジョニングされたら、SSH を使用して接続し、Linux エージェントを削除できます。

$ sudo apt purge -y waagent
$ sudo rm -rf /var/lib/waagent /etc/waagent.conf /var/log/waagent.log

VM に必要なコードを追加する

また、Azure Linux エージェントを削除したため、VM 内でも、準備完了を報告するメカニズムを提供する必要があります。

Python スクリプト

import http.client
import sys
from xml.etree import ElementTree

wireserver_ip = '168.63.129.16'
wireserver_conn = http.client.HTTPConnection(wireserver_ip)

print('Retrieving goal state from the Wireserver')
wireserver_conn.request(
    'GET',
    '/machine?comp=goalstate',
    headers={'x-ms-version': '2012-11-30'}
)

resp = wireserver_conn.getresponse()

if resp.status != 200:
    print('Unable to connect with wireserver')
    sys.exit(1)

wireserver_goalstate = resp.read().decode('utf-8')

xml_el = ElementTree.fromstring(wireserver_goalstate)

container_id = xml_el.findtext('Container/ContainerId')
instance_id = xml_el.findtext('Container/RoleInstanceList/RoleInstance/InstanceId')
incarnation = xml_el.findtext('Incarnation')
print(f'ContainerId: {container_id}')
print(f'InstanceId: {instance_id}')
print(f'Incarnation: {incarnation}')

# Construct the XML response we need to send to Wireserver to report ready.
health = ElementTree.Element('Health')
goalstate_incarnation = ElementTree.SubElement(health, 'GoalStateIncarnation')
goalstate_incarnation.text = incarnation
container = ElementTree.SubElement(health, 'Container')
container_id_el = ElementTree.SubElement(container, 'ContainerId')
container_id_el.text = container_id
role_instance_list = ElementTree.SubElement(container, 'RoleInstanceList')
role = ElementTree.SubElement(role_instance_list, 'Role')
instance_id_el = ElementTree.SubElement(role, 'InstanceId')
instance_id_el.text = instance_id
health_second = ElementTree.SubElement(role, 'Health')
state = ElementTree.SubElement(health_second, 'State')
state.text = 'Ready'

out_xml = ElementTree.tostring(
    health,
    encoding='unicode',
    method='xml'
)
print('Sending the following data to Wireserver:')
print(out_xml)

wireserver_conn.request(
    'POST',
    '/machine?comp=health',
    headers={
        'x-ms-version': '2012-11-30',
        'Content-Type': 'text/xml;charset=utf-8',
        'x-ms-agent-name': 'custom-provisioning'
    },
    body=out_xml
)

resp = wireserver_conn.getresponse()
print(f'Response: {resp.status} {resp.reason}')

wireserver_conn.close()

Bash スクリプト

#!/bin/bash

attempts=1
until [ "$attempts" -gt 5 ]
do
    echo "obtaining goal state - attempt $attempts"
    goalstate=$(curl --fail -v -X 'GET' -H "x-ms-agent-name: azure-vm-register" \
                                        -H "Content-Type: text/xml;charset=utf-8" \
                                        -H "x-ms-version: 2012-11-30" \
                                           "http://168.63.129.16/machine/?comp=goalstate")
    if [ $? -eq 0 ]
    then
       echo "successfully retrieved goal state"
       retrieved_goal_state=true
       break
    fi
    sleep 5
    attempts=$((attempts+1))
done

if [ "$retrieved_goal_state" != "true" ]
then
    echo "failed to obtain goal state - cannot register this VM"
    exit 1
fi

container_id=$(grep ContainerId <<< "$goalstate" | sed 's/\s*<\/*ContainerId>//g' | sed 's/\r$//')
instance_id=$(grep InstanceId <<< "$goalstate" | sed 's/\s*<\/*InstanceId>//g' | sed 's/\r$//')

ready_doc=$(cat << EOF
<?xml version="1.0" encoding="utf-8"?>
<Health xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <GoalStateIncarnation>1</GoalStateIncarnation>
  <Container>
    <ContainerId>$container_id</ContainerId>
    <RoleInstanceList>
      <Role>
        <InstanceId>$instance_id</InstanceId>
        <Health>
          <State>Ready</State>
        </Health>
      </Role>
    </RoleInstanceList>
  </Container>
</Health>
EOF
)

attempts=1
until [ "$attempts" -gt 5 ]
do
    echo "registering with Azure - attempt $attempts"
    curl --fail -v -X 'POST' -H "x-ms-agent-name: azure-vm-register" \
                             -H "Content-Type: text/xml;charset=utf-8" \
                             -H "x-ms-version: 2012-11-30" \
                             -d "$ready_doc" \
                             "http://168.63.129.16/machine?comp=health"
    if [ $? -eq 0 ]
    then
       echo "successfully register with Azure"
       break
    fi
    sleep 5 # sleep to prevent throttling from wire server
done

一般的な手順 (Python または Bash を使用していない場合)

VM に Python がインストールされていないか使用できない場合は、次の手順に従って、このスクリプトロジックをプログラムで再現できます。

WireServer: curl -X GET -H 'x-ms-version: 2012-11-30' http://168.63.129.16/machine?comp=goalstate からの応答を解析することによって、ContainerId、InstanceId、Incarnation を取得します。

次の XML データを作成し、上記の手順で解析された ContainerId、InstanceId、Incarnation を挿入します。

<Health>
  <GoalStateIncarnation>INCARNATION</GoalStateIncarnation>
  <Container>
    <ContainerId>CONTAINER_ID</ContainerId>
    <RoleInstanceList>
      <Role>
        <InstanceId>INSTANCE_ID</InstanceId>
        <Health>
          <State>Ready</State>
        </Health>
      </Role>
    </RoleInstanceList>
  </Container>
</Health>

このデータを WireServer: curl -X POST -H 'x-ms-version: 2012-11-30' -H "x-ms-agent-name: WALinuxAgent" -H "Content-Type: text/xml;charset=utf-8" -d "$REPORT_READY_XML" http://168.63.129.16/machine?comp=health に投稿します。

最初の起動時にコードの実行を自動化する

このデモでは、最新の Linux ディストリビューションの最も一般的な init システムである systemd を使用します。そのため、この準備完了の報告メカニズムを適切なタイミングで実行するための最も簡単でネイティブな方法は、systemd サービスユニットを作成することです。次のユニットファイルを /etc/systemd/system に追加できます (この例では、ユニットファイル azure-provisioning.service)。

[Unit]
Description=Azure Provisioning

[Service]
Type=oneshot
ExecStart=/usr/bin/python3 /usr/local/azure-provisioning.py
ExecStart=/bin/bash -c "hostnamectl set-hostname $(curl \
    -H 'metadata: true' \
    'http://169.254.169.254/metadata/instance/compute/name?api-version=2019-06-01&format=text')"
ExecStart=/usr/bin/systemctl disable azure-provisioning.service

[Install]
WantedBy=multi-user.target

この systemd サービスは、基本的なプロビジョニングに関して次の 3 つの処理を行います。

Azure に準備完了を報告する (正常に完了したことを示すため)。
Azure Instance Metadata Service (IMDS) からこのデータを取得することによって、ユーザーが指定した VM 名に基づいて VM の名前を変更する。注 IMDS では、SSH 公開キーなどの他のインスタンスメタデータも提供されるため、ホスト名以外の名前を設定することができます。
最初の起動時にのみ実行され、その後の再起動では実行されないように、自身を無効にする。

filesystem のユニットで、次を実行して有効にします。

$ sudo systemctl enable azure-provisioning.service

これで、VM を一般化し、そこからイメージを作成できるようになりました。

イメージの準備を完了する

開発用マシンに戻り、次を実行して、ベース VM からイメージを作成できるように準備します。

$ az vm deallocate --resource-group demo1 --name demo1
$ az vm generalize --resource-group demo1 --name demo1

この VM からイメージを作成します。

$ az image create \
    --resource-group demo1 \
    --source demo1 \
    --location eastus \
    --name demo1img

これで、イメージから新しい VM を作成する準備ができました。これは、複数の VM を作成するためにも使用できます。

$ IMAGE_ID=$(az image show -g demo1 -n demo1img --query id -o tsv)
$ az vm create \
    --resource-group demo12 \
    --name demo12 \
    --location eastus \
    --ssh-key-value <ssh_pub_key_path> \
    --public-ip-address-dns-name demo12 \
    --image "$IMAGE_ID"
    --enable-agent false

Note

walinuxagent がイメージから作成される VM 上に存在しないため、--enable-agent を false に設定することが重要です。

VM が正常にプロビジョニングされます。新しくプロビジョニングされた VM にログインすると、レポートの準備ができた systemd サービスの出力を確認できます。

$ sudo journalctl -u azure-provisioning.service
-- Logs begin at Thu 2020-06-11 20:28:45 UTC, end at Thu 2020-06-11 20:31:24 UTC. --
Jun 11 20:28:49 thstringnopa systemd[1]: Starting Azure Provisioning...
Jun 11 20:28:54 thstringnopa python3[320]: Retrieving goal state from the Wireserver
Jun 11 20:28:54 thstringnopa python3[320]: ContainerId: 7b324f53-983a-43bc-b919-1775d6077608
Jun 11 20:28:54 thstringnopa python3[320]: InstanceId: fbb84507-46cd-4f4e-bd78-a2edaa9d059b._thstringnopa2
Jun 11 20:28:54 thstringnopa python3[320]: Sending the following data to Wireserver:
Jun 11 20:28:54 thstringnopa python3[320]: <Health><GoalStateIncarnation>1</GoalStateIncarnation><Container><ContainerId>7b324f53-983a-43bc-b919-1775d6077608</ContainerId><RoleInstanceList><Role><InstanceId>fbb84507-46cd-4f4e-bd78-a2edaa9d059b._thstringnopa2</InstanceId><Health><State>Ready</State></Health></Role></RoleInstanceList></Container></Health>
Jun 11 20:28:54 thstringnopa python3[320]: Response: 200 OK
Jun 11 20:28:56 thstringnopa bash[472]:   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
Jun 11 20:28:56 thstringnopa bash[472]:                                  Dload  Upload   Total   Spent    Left  Speed
Jun 11 20:28:56 thstringnopa bash[472]: [158B blob data]
Jun 11 20:28:56 thstringnopa2 systemctl[475]: Removed /etc/systemd/system/multi-user.target.wants/azure-provisioning.service.
Jun 11 20:28:56 thstringnopa2 systemd[1]: azure-provisioning.service: Succeeded.
Jun 11 20:28:56 thstringnopa2 systemd[1]: Started Azure Provisioning.

サポート

独自のプロビジョニングコード/エージェントを実装する場合、ユーザーがこのコードのサポートを行うため、Microsoft サポートはプロビジョニングインターフェイスが使用できないことに関連する問題のみを調査します。 Microsoft ではこの領域には継続的に改善と変更が加えているため、API の変更をプロビジョニングするために、cloud-init と Azure Linux エージェントの変更を監視するようにしてください。

次のステップ

詳細については、Linux のプロビジョニングに関するページを参照してください。

次の方法で共有

プロビジョニングエージェントを使用せずに一般化されたイメージを作成する

ネットワークと準備完了の報告

デモ/サンプル

リソースグループとベース VM を作成する:

イメージプロビジョニングエージェントを削除する

VM に必要なコードを追加する

Python スクリプト

Bash スクリプト

一般的な手順 (Python または Bash を使用していない場合)

最初の起動時にコードの実行を自動化する

イメージの準備を完了する

サポート

次のステップ

フィードバック

その他のリソース

次の方法で共有

プロビジョニング エージェントを使用せずに一般化されたイメージを作成する

ネットワークと準備完了の報告

デモ/サンプル

リソース グループとベース VM を作成する:

イメージ プロビジョニング エージェントを削除する

VM に必要なコードを追加する

Python スクリプト

Bash スクリプト

一般的な手順 (Python または Bash を使用していない場合)

最初の起動時にコードの実行を自動化する

イメージの準備を完了する

サポート

次のステップ

フィードバック

その他のリソース

プロビジョニングエージェントを使用せずに一般化されたイメージを作成する

リソースグループとベース VM を作成する:

イメージプロビジョニングエージェントを削除する