シャットダウンスクリプトの実行

Linux VM Windows VM

インスタンスが停止または再起動する直前にコマンドを実行するシャットダウンスクリプトを作成します。これは、自動スクリプトを使用してインスタンスの起動とシャットダウンを実行し、インスタンスでクリーンアップまたはタスク（ログのエクスポートや他のシステムとの同期など）を実行する時間を確保できるようにする場合に便利です。

シャットダウンスクリプトは、インスタンスがマネージドインスタンスグループに属し、オートスケーラーが使用されている場合に特に役立ちます。オートスケーラーによってグループ内のインスタンスがシャットダウンされる場合、インスタンスが停止する前にシャットダウンスクリプトが実行され、定義したアクションがシャットダウンスクリプトによって実行されます。スクリプトは、インスタンスが停止する前の限られたシャットダウン期間中に実行されます。たとえば、シャットダウンスクリプトによって、処理済みのデータが Cloud Storage にコピーされることや、ログがバックアップされることがあります。

シャットダウンスクリプトは起動スクリプトとほぼ同様に機能します。起動スクリプトに関するドキュメントの多くは、シャットダウンスクリプトにも適用されます。

始める前に

このガイドのコマンドラインの例を使用する場合、以下を行ってください。
1. gcloud コマンドラインツールの最新バージョンをインストールするか、最新バージョンに更新します。
2. デフォルトのリージョンとゾーンを設定します。
このガイドの API の例を使用する場合、API アクセスを設定します。
スタートアップスクリプトについて学習します。
メタデータサーバーとは何かを理解します。

このタスクに必要な権限

このタスクを行うには、次の権限が必要です。

インスタンスの作成に必要なすべての権限
インスタンスの compute.instances.setMetadata

仕様

制限事項

シャットダウンスクリプトを使用する場合には注意すべき制限がいくつかあります。

シャットダウンスクリプトは、インスタンスが停止するまでの限られた時間で実行を完了する必要があります。
- オンデマンドインスタンス: インスタンスの停止または削除後 90 秒
- プリエンプティブルインスタンス: インスタンスのプリエンプションの開始後 30 秒
Compute Engine は、ベストエフォート方式でのみシャットダウンスクリプトを実行します。まれに、Compute Engine ではシャットダウンスクリプトの完了を保証できないことがあります。
Linux インスタンスの場合、イメージバージョン v20141007 以降のシャットダウンスクリプトのみ利用できます。Windows Server インスタンスの場合、イメージバージョン v20150310 以降のシャットダウンスクリプトのみ利用できます。

シャットダウンスクリプトの呼び出し

シャットダウンスクリプトは、再起動や停止など、特定の Advanced Configuration and Power Interface（ACPI）イベントがトリガーになります。インスタンスを再起動または停止する方法は多数ありますが、シャットダウンスクリプトの実行をトリガーするアクションは限られています。シャットダウンスクリプトは、次のアクションの一環として実行されます。

API への instances.delete リクエストや instances.stop などによってインスタンスがシャットダウンされるとき。
Compute Engine によってプリエンプティブルインスタンスがプリエンプションプロセスの一部として停止されるとき。
sudo shutdown や sudo reboot などのゲストオペレーティングシステムに対するリクエストによってインスタンスがシャットダウンされるとき。
Cloud Console または gcloud compute ツールを使用してインスタンスを手動でシャットダウンするとき。

instances().reset を使用してインスタンスがリセットされる場合、シャットダウンスクリプトは実行されません。

シャットダウンスクリプトは任意のファイル形式にできます。シャットダウンスクリプトが存在する場合、Compute Engine では、以下を行います。

インスタンス内のローカルファイルにスクリプトをコピーします。
そのファイルを実行するための権限が設定されます。
インスタンスの停止時にファイルを実行します。

たとえば、bash スクリプトの代わりに Python スクリプトを使用できます。スクリプトは種類に関係なくそのまま実行されることに注意してください。

bash 以外のスクリプトを実行するには、オペレーティングシステムがどのインタープリターを使用すべきか把握できるよう、ファイルの先頭にシバン行を追加します。たとえば、Python スクリプトを使用する場合は次のようなシバン行を追加します。

#!/usr/bin/python

シャットダウンスクリプトの実行時間

インスタンスがシャットダウンまたは再起動される前に、限られた期間でシャットダウンスクリプトが実行されます。この期間中に、Compute Engine により、シャットダウンスクリプトが実行されます。この期間を経過してもスクリプトが完了していない場合は、インスタンスが自動的に停止し、実行中のすべてのタスクが終了します。sudo shutdown コマンドを使用してゲストオペレーティングシステムにリクエストを行うことで、インスタンスをシャットダウンまたは再起動する場合、この制限は適用されません。

シャットダウン期間の長さは、インスタンスの種類によって異なります。プリエンプティブルインスタンスでは、通常のインスタンスよりもシャットダウン期間が短くなります。それぞれのインスタンスのタイプに対するシャットダウン期間制限の詳細については、シャットダウン期間をご覧ください。

一般に、オペレーティングシステムでシャットダウンプロセスを完了してバッファをディスクにフラッシュする時間が確保されるように、シャットダウン期間内にシャットダウンスクリプトの実行を完了する必要があります。

ローカルシャットダウンスクリプトの使用

ローカルシャットダウンスクリプトは、ローカルコンピュータ上に存在するスクリプトです。ローカルシャットダウンスクリプトは、Compute Engine に対してファイルとして渡すか内容を直接渡します。

シャットダウンスクリプトでは必要な数だけアクションを実行できますが、ローカルでファイルを渡す場合は、スクリプトをメタデータ値の長さの上限である 256 KB よりも長くすることはできません。この長さの上限を超えるスクリプトを使用するには、ファイルを Cloud Storage に保存してください。詳細については、Cloud Storage からシャットダウンスクリプトを使用するをご覧ください。

シャットダウンスクリプトファイルを渡す

ローカルシャットダウンスクリプトファイルは、gcloud コマンドラインツールを介してのみ渡すことができます。

ローカルシャットダウンスクリプトファイルを渡すには、--metadata-from-file フラグと、その後にメタデータキーのペア、shutdown-script=PATH/TO/FILE（ここで PATH/TO/FILE はシャットダウンスクリプトへの相対パス）を指定します。次に例を示します。

gcloud compute instances create example-instance \
    --metadata-from-file shutdown-script=examples/scripts/install.sh

シャットダウンスクリプトの内容を直接渡す

シャットダウンスクリプトの内容を直接渡すこともできます。

Console

Cloud Console では、shutdown-script メタデータキーを使用してシャットダウンスクリプトを直接指定します。

Cloud Console で、[VM インスタンス] ページに移動します。
[VM インスタンス] に移動
[インスタンスを作成] をクリックします。
[新しいインスタンスの作成] ページで、インスタンスのプロパティを入力します。詳細構成オプションで、[管理、セキュリティ、ディスク、ネットワーク、単一テナンシー] セクションを展開します。

[メタデータ] セクションで、メタデータキーとして shutdown-script を指定します。
[値] ボックスで、シャットダウンスクリプトの内容を指定します。
[作成] をクリックしてインスタンスを作成します。

gcloud

gcloud コマンドラインツールを使用して --metadata フラグを指定し、シャットダウンスクリプトの内容を指定します。その後に shutdown-script=CONTENTS キーペアを指定します。CONTENTS はシャットダウンスクリプトの内容です。

gcloud compute instances create example-instance --metadata shutdown-script="#! /bin/bash
> # Shuts down Apache server
> /etc/init.d/apache2 stop"

API

API では、インスタンスを作成するときにリクエストのメタデータプロパティの一部としてシャットダウンスクリプトを渡します。メタデータキーとして shutdown-script を使用します。

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances

{...
  "metadata": {
    "items": [
      {
       "key": "shutdown-script",
       "value": "#! /bin/bash\n\n# Shuts down Apache server\n/etc/init.d/apache2 stop"
      }
    ]
  }...
}

Windows インスタンスでシャットダウンスクリプトを渡す

以下の Windows 固有のメタデータキーを使用して、Windows インスタンスでシャットダウンスクリプトを実行します。以下に示す特殊なキーのいずれかを選択します。実行するスクリプトの種類に対応するキーを選択する必要があります。

複数のキーをインスタンスに渡すことで複数のシャットダウンスクリプトを指定できますが、各キーは仮想マシンごとに 1 回のみ指定できます。

ローカルシャットダウンスクリプトで使用できるキーは次のとおりです。手順は上と同じです。

`cmd` シャットダウンスクリプト	`bat` シャットダウンスクリプト	`ps1` シャットダウンスクリプト
`windows-shutdown-script-cmd`	`windows-shutdown-script-bat`	`windows-shutdown-script-ps1`

Cloud Storage からのシャットダウンスクリプトの使用

Cloud Storage にシャットダウンスクリプトを保存し、そこから使用できます。それには起動スクリプトのドキュメントに記載されている手順に従いますが、startup-script-url は shutdown-script-url に置き換えてください。

Windows インスタンスの場合は、windows-startup-script-url を windows-shutdown-script-url に置き換えます。

実行中のインスタンスに対するシャットダウンスクリプトの適用

実行中のインスタンスにシャットダウンスクリプトを追加する方法については、実行中のインスタンスに対する起動スクリプトの適用の手順をご覧ください。ただし、メタデータキーは次のいずれかのキーに置き換えてください。

shutdown-script: このキーで、シャットダウンスクリプトの内容を直接指定します。gcloud コマンドラインツールを使用すると、--metadata-from-file フラグと shutdown-script メタデータキーを使ってシャットダウンスクリプトファイルへのパスを指定できます。
shutdown-script-url: このキーで、Cloud Storage のシャットダウンスクリプトファイルの URL を指定します。

シャットダウン スクリプトの実行

始める前に

このタスクに必要な権限

仕様

制限事項

シャットダウン スクリプトの呼び出し

シャットダウン スクリプトの実行時間

ローカル シャットダウン スクリプトの使用

シャットダウン スクリプト ファイルを渡す

シャットダウン スクリプトの内容を直接渡す