Compute Engine VM インスタンスの起動と停止を自動化する
はじめに
公式ドキュメント「VM インスタンスの起動と停止をスケジュールする」を参考に、Compute Engine VM インスタンスの起動と停止を自動化してみました。
Compute Engine VM インスタンスはインスタンスの起動時間に応じて使用料金が発生します。(最低1分間分の使用料金が発生し、1分以降は1秒単位で課金されます)
なので、開発環境などのインスタンスを休日や夜間停止することで、コスト削減ができます。
手順
必要な権限を割り当てる
要件の確認と実装方針について
公式ドキュメントの「始める前に」によると、インスタンススケジュールを使うには Compute Engine サービス エージェントに次の権限が必要になります。
- compute.instances.start
- compute.instances.stop
これらの権限がない場合は、 Compute インスタンス管理者(v1)ロールを付与する旨が記載されています。
サービス エージェントとは、Google が管理するサービスアカウントです。
ユーザーに代わって処理を行うためにリソースにアクセスするときなどに、サービス エージェントが使われます。
今回は Compute Engine サービス エージェントがユーザーの代わりにインスタンスの起動と停止を実施します。
Compute インスタンス管理者(v1)ロールとは、Compute Engine に関わる様々なリソースにアクセスできる権限があります。
このロールだと必要以上の権限が付与されてしまします。
なので今回はクラスメソッドさんのブログを参考に、必要な権限だけを付与したロールを作成し、Compute Engine サービス エージェントに付与します。
割り当て手順
IAM と管理のページの「ロール」から、「ロールの作成」ボタンをクリックします。
作成ページに移行するので、項目を入力します。
「権限を追加」ボタンから、今回必要な2つの権限を選び、「作成」をクリックします。
IAM ページに移動し、Compute Engine サービス エージェント(service-<プロジェクト番号>@compute-system.iam.gserviceaccount.com
)の権限を編集します。
「別のロールを追加」をクリックし、プルダウンから先ほど追加したロールを選択し、保存します。
インスタンススケジュールを作成する
インスタンス スケジュールは、Compute Engine のページの画面上部にあります。
タブを「インスタンス スケジュール」に切り替えると「スケジュールを作成」ボタンが表示されるのでクリックします。
「新しいスケジュールの作成」パネルが表示されるので、必要事項を入力します。
作成時に設定する「リージョン」は、スケジュールで起動/停止したいインスタンスと同じリージョンにする必要があります。
「送信」ボタンを押し、スケジュールを作成します。
スケジュールにインスタンスを追加する
作成したインスタンススケジュールの名前をクリックし、詳細ページを表示します。
「スケジュールにインスタンスを追加」ボタンをクリックすると、追加できるインスタンスの一覧がパネルに表示されます。
スケジュールのリージョンを東京(asia-northeast1)にしたので、一覧には東京リージョンのインスタンスのみ表示されます。
追加するインスタンスにチェックを入れて「追加」ボタンを押します。
「必要な権限を割り当てる」を実施していなかった場合、インスタンスの追加で以下のエラーが発生します。
Compute Engine System service account service-<プロジェクト番号>@compute-system.iam.gserviceaccount.com needs to have [compute.instances.start,compute.instances.stop] permissions applied in order to perform this operation.
動作を確認
インスタンスの追加が完了したので、動作を確認します。
アクティビティからログを確認することができました。
ドキュメントには
スケジュールされた VM インスタンスは、起動オペレーションまたは停止オペレーションを開始するスケジュール時刻よりも最大 15 分遅れることがあります。
と記載があり、わたしの環境では指定した時間から2分後に起動/停止オペレーションが実行されていました。
確実に起動/停止したい時間があるなら、遅延を考慮してスケジュールの時間を決める必要があります。
以上です。
どなたかの参考になれば幸いです。