Terraformとは

HashiCorpによってGo言語で開発されたIac（Infrastructure as Code）ツールで、クラウド上のインフラをコードにより構成することができます。
下記の資料ご参照ください。

https://www.lac.co.jp/lacwatch/service/20200903_002270.html

今回ではterraformを使用して、GoogleCloudの仮想マシンを作成してみようと思います。
GCPの基本操作またはTerraformの概念についての説明は割愛させていただきます。

■アジェンダ

GCP上のTerraform
インスタント構成ファイル.tfの作成
実行例

GCP上のTerraform

Terraform は、Cloud Shell にプリインストールされています。
Cloud Shellを開いて、Terraform が利用できることを確認します。

terraform

ヘルプ出力

Usage: terraform [global options] <subcommand> [args]

The available commands for execution are listed below.
The primary workflow commands are given first, followed by
less common or more advanced commands.

Main commands:
  init          Prepare your working directory for other commands
  validate      Check whether the configuration is valid
  plan          Show changes required by the current configuration
  apply         Create or update infrastructure
  destroy       Destroy previously-created infrastructure

All other commands:
  console       Try Terraform expressions at an interactive command prompt
  fmt           Reformat your configuration in the standard style
  force-unlock  Release a stuck lock on the current workspace
  get           Install or upgrade remote Terraform modules
  graph         Generate a Graphviz graph of the steps in an operation
  import        Associate existing infrastructure with a Terraform resource
  login         Obtain and save credentials for a remote host
  logout        Remove locally-stored credentials for a remote host
  output        Show output values from your root module
  providers     Show the providers required for this configuration
  refresh       Update the state to match remote systems
  show          Show the current state or a saved plan
  state         Advanced state management
  taint         Mark a resource instance as not fully functional
  test          Experimental support for module integration testing
  untaint       Remove the 'tainted' state from a resource instance
  version       Show the current Terraform version
  workspace     Workspace management

Global options (use these before the subcommand, if any):
  -chdir=DIR    Switch to a different working directory before executing the
                given subcommand.
  -help         Show this help output, or the help for a specified subcommand.
  -version      An alias for the "version" subcommand.

構成ファイル.tfの作成

1 つの VM インスタンスを起動してみよう。構成ファイルの形式についてはこちらのドキュメントをご覧ください。

https://www.terraform.io/language

構成ファイルの拡張子は.tf(.tf.json)です。

instance.tf という名前の空の構成ファイルを作成します。

touch instance.tf

コマンドまたはCloud Shellのエディタで作成した構成ファイルを編集します。

nano instance.tf

ファイルに次の内容を追加して、を Google Cloud プロジェクト ID に置き換えます。

resource "google_compute_instance" "terraform" {
  project      = "<PROJECT_ID>"
  name         = "tf-instance"
  machine_type = "n1-standard-1"
  zone         = "asia-northeast1-c"
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-9"
    }
  }
  network_interface {
    network = "default"
    access_config {
    }
  }
}

簡単的に説明します。
「resource」ブロックは、インフラストラクチャ内に存在するリソースを定義します。
ブロックを開く前にリソースタイプとリソース名の 2 つの文字列があります。リソースタイプは google_compute_instance で、リソース名は terraform です。タイプの接頭辞はプロバイダに対応しているため、google_compute_instance と入力すると、Google プロバイダが管理するリソースであることを Terraform が自動的に認識します。
ブロックの内容はコンソールでVM作成する際のパラメータ

lsコマンドによりディレクトリにほかの *.tf ファイルが含まれていないことを確認します。Terraform はすべての *.tf ファイルを読み込むからです。

実行例

1.初期化
新しい構成に対して（または既存の構成をバージョン管理からチェックアウトした後に）最初に実行するコマンドは、terraform init です。このコマンドを実行すると、それ以降のコマンドで使用されるさまざまなローカル設定やローカルデータが初期化されます。

terraform init

出力例

Initializing the backend...

Initializing provider plugins...
- Finding latest version of hashicorp/google...
- Installing hashicorp/google v4.21.0...
- Installed hashicorp/google v4.21.0 (signed by HashiCorp)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

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.

2.実行プランを作成
このコマンドを実行すると、実行プランが更新されます。その後、構成ファイルで指定した、インフラストラクチャを希望の状態にするのに必要な操作が確定します。
このコマンドは、一連の変更を加えた実行プランで予想どおりの状態を実現できるかを、実際のリソースや状態に変更を加えずに確認するのに便利です。

terraform plan

出力例

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # google_compute_instance.terraform will be created
  + resource "google_compute_instance" "terraform" {
      + can_ip_forward       = false
      + cpu_platform         = (known after apply)
      + current_status       = (known after apply)
      + deletion_protection  = false
      + guest_accelerator    = (known after apply)
      + id                   = (known after apply)
      + instance_id          = (known after apply)
      + label_fingerprint    = (known after apply)
      + machine_type         = "n1-standard-1"
      + metadata_fingerprint = (known after apply)
      + min_cpu_platform     = (known after apply)
      + name                 = "tf-instance"
      + project              = "<PROJECT_ID>"
      + self_link            = (known after apply)
      + tags_fingerprint     = (known after apply)
      + zone                 = "asia-northeast1-c"

      + boot_disk {
          + auto_delete                = true
          + device_name                = (known after apply)
          + disk_encryption_key_sha256 = (known after apply)
          + kms_key_self_link          = (known after apply)
          + mode                       = "READ_WRITE"
          + source                     = (known after apply)

          + initialize_params {
              + image  = "debian-cloud/debian-9"
              + labels = (known after apply)
              + size   = (known after apply)
              + type   = (known after apply)
            }
        }

      + confidential_instance_config {
          + enable_confidential_compute = (known after apply)
        }

      + network_interface {
          + ipv6_access_type   = (known after apply)
          + name               = (known after apply)
          + network            = "default"
          + network_ip         = (known after apply)
          + stack_type         = (known after apply)
          + subnetwork         = (known after apply)
          + subnetwork_project = (known after apply)

          + access_config {
              + nat_ip       = (known after apply)
              + network_tier = (known after apply)
            }
        }

      + reservation_affinity {
          + type = (known after apply)

          + specific_reservation {
              + key    = (known after apply)
              + values = (known after apply)
            }
        }

      + scheduling {
          + automatic_restart   = (known after apply)
          + min_node_cpus       = (known after apply)
          + on_host_maintenance = (known after apply)
          + preemptible         = (known after apply)
          + provisioning_model  = (known after apply)

          + node_affinities {
              + key      = (known after apply)
              + operator = (known after apply)
              + values   = (known after apply)
            }
        }
    }

Plan: 1 to add, 0 to change, 0 to destroy.

実行プランには、実際のインフラストラクチャをこの構成に合わせて変更するために実行される操作が記述されています。出力の形式は、Git などのツールで生成される差分形式に似ています。

3.変更の適用
作成した instance.tf ファイルと同じディレクトリで、次のコマンドを実行します。

terraform apply

プランが正常に作成された場合、Terraform はここで一時停止して、続行する前に承認を求めます。

Enter a value:

この例ではプランに問題がないようなので、確認プロンプトで「yes」と入力して続行します。
プランの実行には数分かかります。VM インスタンスが利用可能になるまで Terraform が待機するためです。

出力例

.......

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

google_compute_instance.terraform: Creating...
google_compute_instance.terraform: Still creating... [10s elapsed]
google_compute_instance.terraform: Creation complete after 14s [id=projects/<project-id>/zones/asia-northeast1-c/instances/tf-instance]

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

ここまではインスタンスの作成が完了し、コンソールにも確認ができます。
すでに作成したリソースの変更については、その対応している構成ファイル.tfを修正してから、
terraform applyを実行すれば変更ができます。

4.現状の確認
Cloud Shell で現在の状態を確認します。

terraform show

出力例

# google_compute_instance.terraform:
resource "google_compute_instance" "terraform" {
    can_ip_forward       = false
    cpu_platform         = "Intel Broadwell"
    current_status       = "RUNNING"
    deletion_protection  = false
    enable_display       = false
    guest_accelerator    = []
    id                   = "projects/<project-id>/zones/asia-northeast1-c/instances/tf-instance"
    instance_id          = "4562989540648335002"
    label_fingerprint    = "42WmSpB8rSM="
    machine_type         = "n1-standard-1"
    metadata_fingerprint = "3DFjFhfX0U8="
    name                 = "tf-instance"
......
    zone                 = "asia-northeast1-c"
......
}

5.作成したインスタンスの削除
下記のコマンドによって、terraformで構築されたリソースを全部を削除できます。

terraform destroy

出力例

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  - destroy

Terraform will perform the following actions:

  # google_compute_instance.terraform will be destroyed
......
Plan: 0 to add, 0 to change, 1 to destroy.

Do you really want to destroy all resources?
  Terraform will destroy all your managed infrastructure, as shown above.
  There is no undo. Only 'yes' will be accepted to confirm.

  Enter a value: yes

google_compute_instance.terraform: Destroying... [id=projects/<project-id>/zones/asia-northeast1-c/instances/tf-instance]
google_compute_instance.terraform: Still destroying... [id=projects/<project-id>/zon...sia-northeast1-c/instances/tf-instance, 10s elapsed]
google_compute_instance.terraform: Still destroying... [id=projects/<project-id>/zon...sia-northeast1-c/instances/tf-instance, 20s elapsed]
google_compute_instance.terraform: Destruction complete after 22s

Destroy complete! Resources: 1 destroyed.

最後

次回からは下記の順番で紹介させて頂きたいと思います。

Terraformの依存関係とVPCの構成
Terraformモジュールの操作、
Terraform Stateの管理