Terraform v0.12がリリースされたのでAWS Providerをv0.11.14 からアップグレードした時の備忘録

この記事は公開されてから半年以上経過しています (公開日2019年11月10日)。

Terraform v0.l2がリリースされたのでAWS Providerをv0.11.14 からアップグレードした。

基本的に下記オフィシャルドキュメントの通りで、アップグレードには v0.12 に付属されているヘルパーコマンドを使う。
その時の手順を記載する。

Terraform v0.l2 から v0.11.14 へのアップグレード

事前準備

既存Terraformのバックアップ

既存のTerraformのコード、およびtfstateファイルをバックアップする。

Terraformのコードは v0.11 と v0.12で書き方が結構変わっているようだった。
v0.12に付属されているアップグレード機能を使ってアップグレードを行う場合、既存のTerraformコードが書き換えられてしまうため、もし v0.11に戻したい、となった場合に対応できるように既存コードのバックアップを取っておく。
tfstateも念のためバックアップを取っておく。

Terraform v0.11.14へアップグレード

Terraform v0.11 系であれば v0.12系へアップグレードできるようだが、 0.11.14 では 0.12へアップグレードする際のチェックを行うサブコマンドが追加されているので、0.11.14へアップグレードする。
すでに v0.11 系を使っていれば、v0.11.14のterraformを取得してterraform init, terraform plan, terraform applyで念のため問題ないことを確認するので良いと思うが細かいところはドキュメントを確認されたし。自分の環境では問題なかった。

  • v0.11.14でのバージョン確認
  • $ terraform version
    Terraform v0.11.14
    
    Your version of Terraform is out of date! The latest version
    is 0.12.19. You can update by downloading from www.terraform.io/downloads.html
    
  • 作業ディレクトリの初期化
  • $ terraform init
    
    Initializing the backend...
    
    Initializing provider plugins...
    
    The following providers do not have any version constraints in configuration,
    so the latest version was installed.
    
    To prevent automatic upgrades to new major versions that may contain breaking
    changes, it is recommended to add version = "..." constraints to the
    corresponding provider blocks in configuration, with the constraint strings
    suggested below.
    
    * provider.aws: version = "~> 2.27"
    
    Terraform has been successfully initialized!
    
    You may now begin working with Terraform. Try running "terraform plan" to see
    any changes that are required for your infrastructure. All Terraform commands
    should now work.
    
    If you ever set or change modules or backend configuration for Terraform,
    rerun this command to reinitialize your working directory. If you forget, other
    commands will detect it and remind you to do so if necessary.
    
  • 実行計画の確認
  • $ terraform plan
    Refreshing Terraform state in-memory prior to plan...
    The refreshed state will be used to calculate this plan, but will not be
    persisted to local or remote state storage.
    
    :
    :
    (略)
    :
    :
    
    ------------------------------------------------------------------------
    
    No changes. Infrastructure is up-to-date.
    
    This means that Terraform did not detect any differences between your
    configuration and real physical resources that exist. As a result, no
    actions need to be performed.
    
  • 適用
  • $ terraform apply
    :
    :
    (略)
    :
    :
    
    Apply complete! Resources: 0 added, 0 changed, 0 destroyed.
    

アップグレードする

Terraform v0.12.10の取得

Terraform v0.12.10を取得して展開し、Pathが通っている場所へ設置する。

$ wget https://releases.hashicorp.com/terraform/0.12.10/terraform_0.12.10_linux_amd64.zip -P /tmp/

適当なところに展開する。
ここでは /usr/local/bin/ とする。

$ sudo unzip /tmp/terraform_0.12.10_linux_amd64.zip  -d /usr/local/bin/
Archive:  /tmp/terraform_0.12.10_linux_amd64.zip
  inflating: /usr/local/bin/terraform

terraform 0.12checklistを実行する。
これにより以下がチェックされる。

  • Terraform 0.12と互換性のないプロバイダーバージョンを使っているかどうか。
  • 数字で始まるリソース名やプロバイダエイリアス名の有無。Terraform 0.12では数字で始まるリソース名は無効になったため。
  • 外部モジュールが上記の項目に該当しないかどうか。

問題なければ以下のメッセージが出力される。
問題があった場合にどのようなメッセージが返されるのかは不明。

$ terraform 0.12checklist
Looks good! We did not detect any problems that ought to be
addressed before upgrading to Terraform v0.12.

This tool is not perfect though, so please check the v0.12 upgrade
guide for additional guidance, and for next steps:
    https://www.terraform.io/upgrade-guides/0-12.html

Terraform v0.12へのアップグレード

Terraform v0.12で作業ディレクトリの初期化を行う。

$ terraform init

Initializing the backend...

Initializing provider plugins...

The following providers do not have any version constraints in configuration,
so the latest version was installed.

To prevent automatic upgrades to new major versions that may contain breaking
changes, it is recommended to add version = "..." constraints to the
corresponding provider blocks in configuration, with the constraint strings
suggested below.

* provider.aws: version = "~> 2.27"

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

Terraform 0.12upgradeでTerraformコードをアップグレードする。
Enter a value:でモジュールをアップデートするか?といったことを尋ねられるので問題なければyesを実行する。

$ terraform 0.12upgrade

This command will rewrite the configuration files in the given directory so
that they use the new syntax features from Terraform v0.12, and will identify
any constructs that may need to be adjusted for correct operation with
Terraform v0.12.

We recommend using this command in a clean version control work tree, so that
you can easily see the proposed changes as a diff against the latest commit.
If you have uncommited changes already present, we recommend aborting this
command and dealing with them before running this command again.

Would you like to upgrade the module in the current directory?
  Only 'yes' will be accepted to confirm.

  Enter a value: yes

以下のメッセージが出力されればアップデート自体は完了となる。

-----------------------------------------------------------------------------

Upgrade complete!

The configuration files were upgraded successfully. Use your version control
system to review the proposed changes, make any necessary adjustments, and
then commit.

このままplan -> applyを実行して、正常に実行できれば問題ない。
ただ、このやり方でもまだエラーが出るケースもあるようで、その場合は手動で修正していくしかない。

まとめ

Terraform v0.11(v0.11.14)->v0.12へのアップグレード手順を自分で実行した時の内容を備忘録的に書いた。

参考

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です