この記事はGoogle Cloud Platform Advent Calendar 2015の記事ではありません。
昨日JSONなアレに疲れたアナタに贈るGoogle Cloud Deployment Managerのススメという記事を書いたんですが、テンプレートの記述に関する比較に終始してしまい、一つ大きな利点を見逃していたので追加のエントリーです。
Previewについて
CloudFormationにはDry runやPreviewといった機能はありません。
皆さんいつも本番に反映する時は慎重にレビューをし、ドキドキしながら適用していることと思います。あるいは、専用の別アカウントあたりで実際に適用してみて確認するみたいなことをしているかもしれません。
それ、Deployment Managerならできます。
ただし、少し注意点やポイントがあるのでまとめてみます。
実際のコマンドを見ながら
コマンドの基本は以下となります。
gcloud deployment-manager deployments <操作名> <デプロイメント名> --config <テンプレートファイルのパス> --preview
まずは作成から
使用するテンプレート↓
resources:
- name: cloudsql-instance
type: sqladmin.v1beta4.instance
properties:
region: us-central
instanceType: CLOUD_SQL_INSTANCE
settings:
tier: D1
activationPolicy: ON_DEMAND
- name: sample_db
type: sqladmin.v1beta4.database
properties:
instance: $(ref.cloudsql-instance.name)
charset: utf8mb4
collation: utf8mb4_general_ci
作成のプレビュー
プレビューを行う場合は--previewオプションを付けます。
付けなければいきなり適用されますので注意してください。
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments create sample-deploy --config cloud-sql.yml --preview
Waiting for create operation-1450429178867-527285bfa6d38-b87344ea-200e0e5d...done.
Create operation operation-1450429178867-527285bfa6d38-b87344ea-200e0e5d completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance IN_PREVIEW -
sample_db sqladmin.v1beta4.database IN_PREVIEW -
状態（STATE）がIN_PREVIEWになったのが確認できるかと思います。
この時点ではまだリソースは作られていません。
プレビュー時のエラーチェックは構文的なバリデーションのみとなっています。実際のサービスの制限や依存関係に起因するエラーはこの時点では分かりません。
作成の適用
プレビューで既にテンプレートを送信済みなので、デプロイメント名のみの指定でOKです。
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy
Waiting for update operation-1450429201683-527285d56923b-123f8853-97528672...done.
Update operation operation-1450429201683-527285d56923b-123f8853-97528672 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
状態（STATE）がCOMPLETEDになりました。これでリソースが出来上がっています。
更新
では、作成したリソースの一部を更新してみましょう。
リソースの追加
DBを一つ追加してみます。
先ほどのテンプレートを以下のように更新します。
resources:
- name: cloudsql-instance
type: sqladmin.v1beta4.instance
properties:
region: us-central
instanceType: CLOUD_SQL_INSTANCE
settings:
tier: D1
activationPolicy: ON_DEMAND
- name: sample_db
type: sqladmin.v1beta4.database
properties:
instance: $(ref.cloudsql-instance.name)
charset: utf8mb4
collation: utf8mb4_general_ci
- name: sample_db_2
type: sqladmin.v1beta4.database
properties:
instance: $(ref.cloudsql-instance.name)
charset: utf8mb4
collation: utf8mb4_general_ci
追加のプレビュー
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy --config cloud-sql.yml --preview
Waiting for update operation-1450429831076-5272882da58a0-e242a24a-ccb9de67...done.
Update operation operation-1450429831076-5272882da58a0-e242a24a-ccb9de67 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database IN_PREVIEW -
追加されるリソースがIN_PREVIEWそれ以外は変化無いのでCOMPLETEDになっています。
追加の適用
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy
Waiting for update operation-1450429913772-5272887c82fe0-71ea9698-3902a139...done.
Update operation operation-1450429913772-5272887c82fe0-71ea9698-3902a139 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database COMPLETED -
全てのリソースがCOMPLETEDになりました。
リソースの変更
今度は、追加ではなく変更をしてみます。
２つあるDBのうち、片方の文字コードだけ変えてみます（地味ｗｗｗ）
resources:
- name: cloudsql-instance
type: sqladmin.v1beta4.instance
properties:
region: us-central
instanceType: CLOUD_SQL_INSTANCE
settings:
tier: D1
activationPolicy: ON_DEMAND
- name: sample_db
type: sqladmin.v1beta4.database
properties:
instance: $(ref.cloudsql-instance.name)
charset: utf8mb4
collation: utf8mb4_general_ci
- name: sample_db_2
type: sqladmin.v1beta4.database
properties:
instance: $(ref.cloudsql-instance.name)
charset: utf8 # <- here!!
collation: utf8_general_ci #<-here!!
変更のプレビュー
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy --config cloud-sql.yml --preview
Waiting for update operation-1450430214580-5272899b62721-5a3da25c-8b02793a...done.
Update operation operation-1450430214580-5272899b62721-5a3da25c-8b02793a completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database IN_PREVIEW -
差分があるリソースのみがIN_PREVIEWとなっていますね。
ちなみにこれはブラウザのコンソールからも見ることができます。
差分がグラフィカルに見れたりすると素敵なんですが、残念ながら状態と今現在の設定のみの表示となってます。
変更の適用
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy
Waiting for update operation-1450434821949-52729ac550648-b01326ac-036f0ea0...done.
Update operation operation-1450434821949-52729ac550648-b01326ac-036f0ea0 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database COMPLETED -
プレビューで問題が見つかったら
例えば、違うリソースを弄っていることが発覚して取り下げたい場合は以下のようにcancel-previewコマンドで取り下げができます。
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments update sample-deploy --config cloud-sql.yml --preview
Waiting for update operation-1450436669687-5272a1a7744d8-79551062-f0eb9ff4...done.
Update operation operation-1450436669687-5272a1a7744d8-79551062-f0eb9ff4 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database IN_PREVIEW -
marcy@marcy-ubuntu:~$ gcloud deployment-manager deployments cancel-preview sample-deploy
Waiting for cancel-preview operation-1450436708378-5272a1cc5a590-bb26393f-95ec5cc2...done.
Cancel preview operation operation-1450436708378-5272a1cc5a590-bb26393f-95ec5cc2 completed successfully.
NAME TYPE STATE ERRORS
cloudsql-instance sqladmin.v1beta4.instance COMPLETED -
sample_db sqladmin.v1beta4.database COMPLETED -
sample_db_2 sqladmin.v1beta4.database COMPLETED -
便利ですね！
重要な注意点
とても便利なプレビュー機能ですが、一つだけ重要な注意点があります。
差分の判定は実際のリソースではなく、テンプレートの比較で判定しています。
なので、Deployment Managerを介さずにコンソールやコマンド・APIから変更が行われた場合は「差分と検知されずに更新されない」あるいは「別の部分が変わっていた場合は元に戻ってしまう」ということになりますので注意してください。
以上、補足でした。
この重要なポイントは @rrreeeyyy さんの以下のツイートで思い出すことができました。ありがとうございます。
https://twitter.com/rrreeeyyy/status/677744289305128962