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

Linux Windows

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

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

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

シャットダウンタスクと再起動タスクでは、VM が常に次のようにシャットダウンスクリプトを実行します。

Linux VM の場合は、root ユーザーを使用します。
Windows VM の場合は、System アカウントを使用します。

始める前に

スタートアップスクリプトについて学習します。
メタデータサーバーとは何かを理解します。
まだ設定していない場合は、認証を設定します。認証とは、Google Cloud サービスと API にアクセスするために ID を確認するプロセスです。ローカル開発環境からコードまたはサンプルを実行するには、次のように Compute Engine に対する認証を行います。

このページのサンプルをどのように使うかに応じて、タブを選択してください。
コンソール

Google Cloud コンソールを使用して Google Cloud サービスと API にアクセスする場合、認証を設定する必要はありません。
gcloud
1. Google Cloud CLI をインストールし、次のコマンドを実行して初期化します。
```
gcloud init
```
  注: すでに gcloud CLI をインストールしている場合は、gcloud components update を実行して、最新バージョンがインストールされていることを確認してください。
2. デフォルトのリージョンとゾーンを設定します。
Terraform

このページの Terraform サンプルをローカル開発環境から使用するには、gcloud CLI をインストールして初期化し、自身のユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定してください。
1. Google Cloud CLI をインストールします。
2. gcloud CLI を初期化するには:
```
gcloud init
```
3. Google アカウントのローカル認証情報を作成します。
```
gcloud auth application-default login
```
詳細については、ローカル開発環境の認証の設定をご覧ください。
REST

このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

このタスクに必要な権限

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

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

仕様

制限事項

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

シャットダウンスクリプトは、インスタンスが停止するまでの限られた時間で実行を完了する必要があります。
- オンデマンドインスタンス: インスタンスの停止または削除後 90 秒
- プリエンプティブルインスタンス: インスタンスのプリエンプションの開始後 30 秒
Compute Engine は、ベストエフォート方式でのみシャットダウンスクリプトを実行します。まれに、Compute Engine ではシャットダウンスクリプトの完了を保証できないことがあります。
Windows では、ローカルグループポリシーを使用してシャットダウンスクリプトを起動します。
- インストールパッケージでは、システムのシャットダウン時にスクリプトを起動するように、ローカルグループポリシー Computer Configuration/Windows Setting/Scripts (Startup/Shutdown) 設定を構成します。

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

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

API への instances.delete リクエストや instances.stop などによってインスタンスがシャットダウンされるとき。
Compute Engine によってプリエンプティブルインスタンスがプリエンプションプロセスの一部として停止されるとき。
sudo shutdown や sudo reboot などのゲストオペレーティングシステムに対するリクエストによってインスタンスがシャットダウンされるとき。
Google Cloud コンソールまたは 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 コマンドラインツールを介してのみ渡すことができます。

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

Terraform

シャットダウンスクリプトを直接指定するには、メタデータでシャットダウンスクリプトのパスを指定して google_compute_instance リソースを使用します。

resource "google_compute_instance" "shutdown_content_from_file" {
  name         = "instance-name-shutdown-content-from-file"
  machine_type = "f1-micro"
  zone         = "us-central1-c"
  metadata = {
    # Shuts down Apache server
    shutdown-script = file("${path.module}/shutdown-script.sh")
  }
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }
  network_interface {
    # A default network is created for all Google Cloud projects
    network = "default"
    access_config {
    }
  }
}

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

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

コンソール

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

[インスタンスの作成] ページに移動します。

[インスタンスの作成] に移動
VM の詳細を指定します。
[詳細オプション] セクションを開きます。
[管理] を開いて、次の操作を行います。
1. [カスタムメタデータ] セクションで [項目を追加] をクリックします。
2. [キー] フィールドに、メタデータキーとして「shutdown-script」と入力します。
3. [値] フィールドに、シャットダウンスクリプトの内容を追加します。
VM 作成プロセスを続行します。

gcloud

Google Cloud CLI を使用して --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"

Terraform

シャットダウンスクリプトを直接指定するには、メタデータでシャットダウンスクリプトを指定して google_compute_instance リソースを使用します。

resource "google_compute_instance" "default" {
  name         = "instance-name-shutdown-content-directly"
  machine_type = "f1-micro"
  zone         = "us-central1-c"
  metadata = {
    # Shuts down Apache server
    shutdown-script = "#! /bin/bash /etc/init.d/apache2 stop"
  }
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }
  network_interface {
    # A default network is created for all Google Cloud projects
    network = "default"
    access_config {
    }
  }
}

REST

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: このキーで、シャットダウンスクリプトの内容を直接指定します。Google Cloud CLI を使用すると、--metadata-from-file フラグと shutdown-script メタデータキーを使用してシャットダウンスクリプトファイルへのパスを指定できます。
shutdown-script-url: このキーで、Cloud Storage のシャットダウンスクリプトファイルの URL を指定します。

シャットダウンスクリプトの出力の表示

Linux

Linux シャットダウンスクリプトからの出力を確認するには、次のいずれかの操作を行います。

インスタンスに接続し、次のコマンドを実行します。
```
sudo journalctl -u google-shutdown-scripts.service
```
Google Cloud コンソールでシリアルポート 1 を介して出力を表示し、google_metadata_script_runner イベントを確認します。
Windows ワークステーションの IAP Desktop。詳細については、GitHub の GoogleCloudPlatform/iap-desktop リポジトリをご覧ください。

Windows

Windows Server シャットダウンスクリプトからの出力を確認するには、次のいずれかを使用して GCEMetadataScripts イベントを確認します。

Google Cloud コンソールのシリアルポート 1。詳細については、シリアルポート出力の表示をご覧ください。
Windows イベントビューアのアプリケーションログ。
Windows ワークステーションの IAP Desktop。詳細については、GitHub の GoogleCloudPlatform/iap-desktop リポジトリをご覧ください。

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

始める前に

コンソール

gcloud

Terraform

REST

このタスクに必要な権限

仕様

制限事項

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

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

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

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

gcloud

Terraform

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

コンソール

gcloud

Terraform

REST

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

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

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

シャットダウン スクリプトの出力の表示

Linux

Windows

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

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

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

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

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

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

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

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

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

シャットダウンスクリプトの出力の表示