2. Terraform Cloud/EP driver

2.1. はじめに

本書では、Terraform Cloud/EP driver 機能および操作方法について説明します。
Terraform や Terraform driverの概要および、Terraform CLI driver と共通の機能については「Terraform driver 共通」を参照してください。

2.2. コンソールメニュー構成

本章では、Terraform Cloud/EP driverで利用するのメニュー構成について説明します。

2.2.1. メニュー/画面一覧

  1. 基本コンソールのメニュー
    Terraform Cloud/EP driverで利用する基本コンソールのメニュー一覧を以下に記述します。
    表 2.62 基本コンソール メニュー/画面一覧

    No

    メニューグループ

    メニュー/画面

    説明

    1

    基本コンソール

    オペレーション一覧

    オペレーション一覧をメンテナンス(閲覧/登録/更新/廃止)できます。

  2. Terraform Cloud/EP driverのメニュー
    Terraform Cloud/EP driverのメニュー一覧を以下に記述します。
    表 2.63 Terraform Cloud/EP driver メニュー/画面一覧

    No

    メニューグループ

    メニュー・画面

    説明

    1

    Terraform Cloud/EP

    インターフェース情報

    ITAと連携するTerraformの情報を管理します。

    2

    Organization管理

    Terraformで利用するOrganizationの情報を管理します。

    3

    Workspace管理

    Terraformで利用するWorkspaceの情報を管理します。

    4

    Movement一覧

    Movementの一覧を管理します。

    5

    Module素材集

    Moduleファイルを管理します。

    6

    Policy管理

    Policyファイルを管理します。

    7

    Policy set管理

    Policy Setを管理します Policy SetはPolicyおよび。Workspaceと紐づけることで、作業実行時に対象のWorkspaceに対してPolicyを有効にします。

    8

    Policy set-Policy紐付

    PolicySetとPolicyの紐付けを管理します。

    9

    Policy set-Workspace紐付

    PolicySetとWorkspaceの紐付けを管理します。

    10

    Movement-Module紐付

    MovementとModule素材の関連付けを管理します。

    11

    変数ネスト管理

    Module素材集で登録したtfファイルで定義されている変数のタイプがlist,setかつ、その変数の中でlist,set,tuple,objectが定義されている場合、メンバー変数の最大繰返数を管理します。

    12

    代入値自動登録設定

    パラメータシートのメニューに登録されているオぺレーション毎の項目や値を紐付けるMovementと変数を管理します。

    13

    作業実行

    作業実行するMovementとオペレーションを選択し実行を指示します。

    14

    作業管理

    作業実行履歴を管理します。

    15

    作業状態確認

    作業実行状態を表示します。

    16

    代入値管理

    変数の代入値を管理します。

    17

    連携先Terraform管理

    ITAと連携されているTerraformに登録されているOrganization, Workspace,Policy,PolicySetの一覧表示および削除をすることができます。

    18

    Module-変数紐付(※1)

    Module変数とModule素材の紐付を管理します。

    19

    メンバー変数管理(※1)

    メンバー変数を管理します。

    20

    Movement-変数紐付(※1)

    Movmentと変数の紐付を管理します。

    21

    Movement-メンバー変数紐付(※1)

    Movmentとメンバー変数の紐付を管理します。

    注釈

    ※1 非表示メニューは、内部機能でデータの登録・更新を行うメニューです。
    Terraform Cloud/EP driver機能をインストールした状態では表示されないメニューに設定されています。
    非表示メニューを表示するには、管理コンソール▶ロール・メニュー紐付管理 で各メニューの復活処理を行います。詳細は 管理コンソール を参照してください。

2.3. 利用手順

各Terraform Cloud/EP メニューの利用手順について説明します

2.3.1. Terraform Cloud/EP 作業フロー

Terraform Cloud/EP driver の各メニューにおける標準的な作業フローは以下のとおりです。
各作業の詳細は次項に記載しています。
作業フロー
  • 作業フロー詳細と参照先

    1. 投入オペレーション名の登録
      基本コンソールのオペレーション一覧の画面から、作業用の投入オペレーション名を登録します。
      詳細は オペレーション一覧 を参照してください。
    2. インターフェース情報の設定
      ITAと連携するTerraformの情報を登録します。
      詳細は インターフェース情報 を参照してください。
    3. Organizationの登録と連携
      Terraformで利用するOrganizationの情報を登録し、Terraformとの連携を行います。
      詳細は Organization管理 を参照してください。
    4. Workspaceの登録と連携
      Terraformで利用するWorkspaceの情報を登録し、Terraformとの連携を行います。
      詳細は Workspace管理 を参照してください。
    5. Movementの登録
      作業用のMovementを登録します。
      詳細は Movement一覧 を参照してください。
    6. Module素材の登録
      作業で実行するModuleファイルを登録します。
      詳細は Module素材集 を参照してください。
    7. Policyの登録(必要に応じて実施)
      作業実行前に行うPolicyCheckで実行するPolicyファイルを登録します。
      詳細は Policy管理 を参照してください。
    8. Policy setの登録(必要に応じて実施)
      Policyを適用するWorkspaceと紐付けるためのPolicy setを登録します。
      詳細は Policy Set管理 を参照してください。
    9. Policy setにPolicyを紐付け(必要に応じて実施)
      Policy setとPolicyの紐付けを登録します。
      詳細は Policy set-Policy紐付 を参照してください。
    10. Policy setにWorkspaceを紐付け(必要に応じて実施)
      Policy setとWorkspaceの紐付けを登録します。
      詳細は PolicySet-Workspace紐付 を参照してください。
    11. MovementにModule素材を指定
      登録したMovementにModule素材を指定します。
      詳細は Movement-Module紐付 を参照してください。
    12. 最大繰返数の設定(必要に応じて実施)
      変数およびメンバー変数の最大繰返数を設定します。
      詳細は 変数ネスト管理 を参照してください。
    13. パラメータシートの作成(必要に応じて実施)
      パラメータシート作成の「パラメータシート定義・作成」の画面から、作業対象サーバの設定に使用するデータを登録するためのパラメータシートを作成します。
      Module素材に定義した変数に具体値を設定する際に必要となります。
      詳細は パラメータシート作成機能 を参照してください。
    14. パラメータシートにデータを登録(必要に応じて実施)
      入力用メニューグループの前項で作成したパラメータシート画面から、作業対象サーバの設定に使用するデータを登録します。
      Module素材に定義した変数に具体値を設定する際に必要となります。
      詳細は パラメータシート作成機能 を参照してください。
    15. 代入値自動登録設定(必要に応じて実施)
      代入値自動登録設定の画面から、パラメータシートに登録されているオペレーション毎の項目の設定値と、Movementの変数を紐付けます。
      Module素材に定義した変数に具体値を設定する際に必要となります。
      詳細は 代入値自動登録設定 を参照してください。
    16. 作業実行
      作業実行の画面から、Movementと投入オペレーションを選択して処理の実行を行います。
      詳細は 作業実行 を参照してください。
    17. 作業状態確認
      作業状態確認の画面から、実行した作業の状態がリアルタイムで表示されます。また、作業の緊急停止や、実行ログ、エラーログを監視することができます。
      詳細は 作業状態確認 を参照してください。
    18. 作業履歴確認
      作業管理の画面から、実行した作業の一覧が表示され履歴が確認できます。
      詳細は 作業管理 を参照してください。

2.4. Policyの適用

2.4.1. Policy/PolicySet/Workspaceの紐付けについて

Policy機能の利用は、連携先Terraformが Terraform Enterprise もしくは Terraform Cloudで「Policy & Security」機能が有効なプランである必要があります。

Policyを適用させるために、Policyに関する各設定登録をした後に紐付設定をする必要があります。
最初に Policy管理 で登録したPolicyと Policy Set管理 で登録したPolicy setを
Policy set-Policy紐付 にて紐付けをします。
次に Workspace管理 で登録したTerraform Workspaceと Policy Set管理 で登録したPolicy setを
PolicySet-Workspace紐付 にて紐付けをします。
作業実行時にMovementに紐付いたWorkspaceに対し、Policy setとそれに紐付けられたPolicyが適用されます。
Policyの適用

2.5. 機能・操作方法説明

本章では、Terraform Cloud/EP driver で利用する各メニューの機能について説明します。

2.5.1. 基本コンソール

本節では、基本コンソールでの操作について記載します。
本作業は 基本コンソール を参照して、基本コンソール画面内で作業を実施してください。

オペレーション一覧

基本コンソール▶オペレーション一覧 では、オーケストレータで実行するオペレーションを管理します。作業は基本コンソール内メニューより選択します。
登録方法の詳細は、関連マニュアルの 基本コンソール を参照してください。
サブメニュー画面(オペレーション一覧)

図 2.34 サブメニュー画面(オペレーション一覧)

2.5.2. Terraform Cloud/EP メニュー

本節では、Terraform Cloud/EP driver のメニューでの操作について記載します。

インターフェース情報

  1. Terraform Cloud/EP▶インターフェース情報 では、ITAと連携するTerraformの情報をメンテナンス(閲覧/更新)することができます。
    連携対象となるTerraformのHostnameと、TerraformのUserが発行したUserTokenが必要となります。
    サブメニュー画面(インタフェース情報)

    図 2.35 サブメニュー画面(インタフェース情報)

  2. 編集 ボタンより、インターフェース情報の登録を行います。
    登録画面(インタフェース情報)

    図 2.36 登録画面(インタフェース情報)

  3. インタフェース情報画面の項目一覧は以下のとおりです。
    インタフェース情報が未登録または、複数レコード登録されている状態で作業実行した場合、作業実行は想定外エラーとなります。
    表 2.64 登録画面項目一覧(インタフェース情報)

    項目

    説明

    入力必須

    入力方法

    制約事項

    連携先Terraform

    Protocol

    ITAが連携する対象であるTerraformのプロトコルを http/https どちらを入力します。通常httpsとなります。

    手動入力

    Hostname

    ITAが連携する対象であるTerraformのHostnameを入力します。

    手動入力

    最大長256バイト

    Port

    ITAが連携する対象であるTerraformのPortを入力します。 通常空欄となります。

    手動入力

    最小値1 最大値65535

    User Token

    Terraformの UserSettings より発行したUser Tokenを入力します。

    User Tokenの発行方法は構成・構築ガイド Terraform Cloud/EP の「初期設定」を参照してください。

    手動入力

    最大長1024バイト

    Proxy

    Address

    プロキシサーバのアドレスを入力します。 ITAがプロキシ環境下にある場合、Terraformまでの疎通のために設定が必要な場合があります。

    手動入力

    Port

    プロキシサーバのポートを入力します。

    手動入力

    NULL連携

    代入値自動登録設定でパラメータシートの具体値がNULL(空白)の場合に、代入値管理への登録をNULL(空白)の値で行うか設定します。代入値自動登録設定メニューの「NULL連携」が空白の場合この値が適用されます。

    リスト選択

    状態監視周期(単位ミリ秒)

    作業状態確認」表示されるログのリフレッシュ間隔を入力します。通常は1000ミリ秒程度が推奨値です。

    手動入力

    最小値1000ミリ秒

    進行状態表示桁数

    作業状態確認」での進行ログ・エラーログの最大表示行数を入力します。

    ステータスが[未実行]、[準備中]、[実行中]、[実行中(遅延)]の場合、指定した行数でログを出力します。

    ステータスが[完了]、[完了(異常)]、[想定外エラー]、[緊急停止]、[未実行(予約)]、[予約取消]の場合、指定した行数ではなくすべてのログを出力します。

    環境毎にチューニングを要しますが、通常は1000行程度が推奨値です。

    手動入力

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Organization管理

  1. Terraform Cloud/EP▶Organization管理 では、Terraformで利用するOrganizationについてのメンテナンス(閲覧/登録/更新/廃止)を行います。
    また、ITAに登録したOrganizationをTerraformへの連携(登録/更新/削除)をすることができます。
    サブメニュー画面(Organization管理)

    図 2.37 サブメニュー画面(Organization管理)

  2. + 登録 ボタンより、Organization情報の登録を行います。
    登録画面(Organization管理)

    図 2.38 登録画面(Organization管理)

  3. Organizationを「登録」した後、「状態チェック」ボタンをクリックすると、「インターフェース情報」 に登録した連携先Terraformへの連携状態を確認できます。
    カラムグループ「Terraform連携」の「登録」「更新」「削除」ボタンをクリックすることで、連携先Terraformに対しOrganizationの登録/更新/削除が実行されます。
    OrganizationがTerraformに連携(登録)されていない状態で作業実行した場合、作業実行は想定外エラーとなります
    「6.2.1インターフェース情報」で登録した「Hostname」および「UserToken」に誤りがあると、Terraformとの連携が失敗し、連携状態に以下のメッセージが表示されます。
    『Terraformとの接続に失敗しました。インターフェース情報を確認して下さい。』
    Terraform連携(Organization管理)

    図 2.39 Terraform連携(Organization管理)

  4. Organization管理画面の項目一覧は以下のとおりです。
    表 2.65 登録画面項目一覧(Organization管理)

    項目

    説明

    入力必須

    入力方法

    制約事項

    Organization名

    Organizationの名前を入力します。

    半角英数字と記号 _ -(アンダーバーとハイフン)のみ利用可能です。

    手動入力

    最大長40バイト

    Email address

    OrganizationのEmail addressを入力します。

    手動入力

    最大長128バイト

    Terraform連携

    状態チェック

    対象のOrganizationと連携先Terraformとの連携状態を。チェックします。

    ボタン押下後、ポップアップメッセージにて状態が表示されます。

    ボタン

    登録

    連携先TerraformへOrganizationの登録を実行するボタンです。

    ボタン

    更新

    連携先Terraformに登録済みのOrganizationに対し、Email addressに変更があった場合に更新を実行するボタンです。

    ボタン

    削除

    連携先Terraformに登録済みのOrganizationの削除を実行するボタンです。

    ※削除したOrganizationは元に戻すことができません。また、Organization配下にあるWorkspaceも削除されます。

    ボタン

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Workspace管理

  1. Terraform Cloud/EP▶Workspace管理 では、Terraformで利用するWorkspaceについてのメンテナンス(閲覧/登録/更新/廃止)を行います。
    また、ITAに登録したWorkspaceをTerraformへの連携(登録/更新/削除)とリソース削除(terraform destroy)を実行することができます。
    サブメニュー画面(Workspace管理)

    図 2.40 サブメニュー画面(Workspace管理)

  2. + 登録 ボタンより、Workspace情報の登録を行います。
    登録画面(Workspace管理)

    図 2.41 登録画面(Workspace管理)

  3. Workspaceを「登録」した後、「状態チェック」ボタンをクリックすると、「インターフェース情報」 に登録した連携先Terraformへの連携状態を確認できます。
    カラムグループ「Terraform連携」の「登録」「更新」「削除」ボタンをクリックすることで、連携先Terraformに対しWorkspaceの登録/更新/削除が実行されます。
    WorkspaceがTerraformに連携(登録)されていない状態で作業実行した場合、作業実行は想定外エラーとなります
    「6.2.1インターフェース情報」で登録した「Hostname」および「UserToken」に誤りがあると、Terraformとの連携が失敗し、連携状態に以下のメッセージが表示されます。
    『Terraformとの接続に失敗しました。インターフェース情報を確認して下さい。』
    また、選択したOrganizationがTerraformに連携(登録)されていない場合も同様のメッセージが表示されます。
    Terraform連携(Workspace管理)

    図 2.42 Terraform連携(Workspace管理)

  4. 「リソース削除」ボタンをクリックすると「作業状態確認」に遷移し、対象のWorkspaceに対してリソース削除(terraform destroy)が実行されます。
  5. Workspace管理画面の項目一覧は以下のとおりです。
    表 2.66 登録画面項目一覧(Workspace管理)

    項目

    説明

    入力必須

    入力方法

    制約事項

    Organization名

    Organization管理」にて登録したOrganization名を選択します。

    リスト選択

    最大長40バイト

    Workspace名

    Workspaceの名前を入力します。

    半角英数字と記号 _ -(アンダーバーとハイフン)のみ利用可能です。

    手動入力

    最大長90バイト

    Terraform version

    Terraformのバージョンを入力します。空欄の場合は連携(登録)時に最新のバージョンが自動的に適用されます。

    手動入力

    最大長128バイト

    Terraform連携

    状態チェック

    対象のWorkspaceと連携先Terraformとの連携状態を。チェックします。

    ボタン押下後、ポップアップメッセージにて状態が表示されます。

    ボタン

    登録

    連携先TerraformへWorkspaceの登録を実行するボタンです。

    ボタン

    更新

    連携先Terraformに登録済みのWorkspaceに対し、Terraform versionに変更があった場合に更新を実行するボタンです。

    ボタン

    削除

    連携先Terraformに登録済みのWorkspaceの削除を実行するボタンです。

    ※Workspaceを削除するとリソースの削除は実行することができません。削除したWorkspaceは元に戻すことができません。

    ボタン

    作業実行

    リソース削除

    Workspaceごとに構成・管理されたリソースの削除を実行するボタンです。

    クリックすると確認ダイアログが表示され[OK]をクリックすると「作業状態確認」に遷移し、対象のWorkspaceごとに構成・管理されたリソースの削除が実行されます。

    ボタン

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Movement一覧

  1. Terraform Cloud/EP▶Movement一覧 では、Movement名についてのメンテナンス(閲覧/登録/更新/廃止)を行います。
    MovementはTerraform利用情報としてOrganization:Workspaceと紐付ける必要があるため、先に「Organization管理」「Workspace管理」にて対象を登録しておく必要があります。
    サブメニュー画面(Movement一覧)

    図 2.43 サブメニュー画面(Movement一覧)

  2. + 登録 ボタンより、Movement情報の登録を行います。
    登録画面(Movement一覧)

    図 2.44 登録画面(Movement一覧)

  3. Movement一覧画面の項目は以下の通りです。
    表 2.67 登録画面項目一覧(Movement一覧)

    項目

    説明

    入力必須

    入力形式

    制約事項

    Movement名

    Movementの名称を入力します。

    手動入力

    最大長256バイト

    オーケストレータ

    『Terraform Cloud/EP』が自動で入力されます。

    自動入力

    遅延タイマー

    Movementが指定期間遅延した場合にステータスを遅延として警告表示したい場合に指定期間(1~)を入力します。 (単位:分)

    未入力の場合は警告表示しません。

    手動入力

    Terraformm利用情報

    Organization:Workspace

    Workspace管理」にて登録した(Organizationと紐付く)Workspaceを選択します。

    リスト選択

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Module素材集

  1. Terraform Cloud/EP▶Module素材集 ではユーザーが作成したModuleのメンテナンス(閲覧/登録/更新/廃止)を行います。
    Moduleの記述などに関しては、「Moduleの記述」を参照してください。
    サブメニュー画面(Module素材集)

    図 2.45 サブメニュー画面(Module素材集)

  2. + 登録 ボタンより、Movement情報の登録を行います。
    登録画面(Module素材集)

    図 2.46 登録画面(Module素材集)

  3. Module素材集の項目一覧は以下のとおりです。
    表 2.68 登録画面項目一覧(Module素材集)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Module素材名

    ITAで管理するModule素材名を入力します。

    手動入力

    最大長255バイト

    Module素材

    作成したModule素材をアップロードします。

    ファイル選択

    最大サイズ100メガバイト

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

警告

Moduleファイル(.tf拡張子のファイル)内に定義した変数を取り出すタイミング
内部の処理で登録したModuleファイル(.tf拡張子のファイル)内に定義している変数を抜出します。
抜出した変数は、「代入値自動登録設定」で具体値の登録が可能になります。
抜出するタイミングはリアルタイムではありませんので、「代入値自動登録設定」で変数が扱えるまでに 時間がかかる 場合があります。

Policy管理

  1. Terraform Cloud/EP▶Policy管理 ではユーザーが作成したPolicyのメンテナンス(閲覧/登録/更新/廃止)を行います。
    Moduleの記述などに関しては、「Policyの記述」を参照してください。
    サブメニュー画面(Policy管理)

    図 2.47 サブメニュー画面(Policy管理)

  2. + 登録 ボタンより、Policyの登録を行います。
    登録画面(Policy管理)

    図 2.48 登録画面(Policy管理)

  3. Policy管理の項目一覧は以下のとおりです。
    表 2.69 登録画面項目一覧(Policy管理)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Policy名

    ITAで管理するPolicy名を入力します。
    半角英数字と記号 _ -(アンダーバーとハイフン)のみ利用可能です。

    手動入力

    最大長255バイト

    Policy素材

    作成したPolicyファイルをアップロードします。

    ファイル選択

    最大サイズ100メガバイト

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Policy Set管理

  1. Terraform Cloud/EP▶Policy set管理 ではPolicy setのメンテナンス(閲覧/登録/更新/廃止)を行います。
    Policy Setは「Policy set-Policy紐付」「PolicySet-Workspace紐付」にてPolicyおよびWorkspaceと紐付けることで、作業実行時にWorkspaceに対してPolicyを適用させます。
    サブメニュー画面(Policy set管理)

    図 2.49 サブメニュー画面(Policy set管理)

  2. + 登録 ボタンより、Policy setの登録を行います。
    登録画面(Policy set管理)

    図 2.50 登録画面(Policy set管理)

  3. Policy set管理の項目一覧は以下のとおりです。
    表 2.70 登録画面項目一覧(Policy set管理)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Policy set名

    ITAで管理するPolicy set名を入力します。
    半角英数字と記号 _ -(アンダーバーとハイフン)のみ利用可能です。

    手動入力

    最大長255バイト

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Policy set-Policy紐付

  1. Terraform Cloud/EP▶Policy set-Policy紐付 では、「Policy Set管理」にて登録したPolicy setと「Policy管理」にて登録したPolicyの紐付けについてメンテナンス(閲覧/登録/更新/廃止)を行います。
    サブメニュー画面(Policy set-Policy紐付)

    図 2.51 サブメニュー画面(Policy set-Policy紐付)

  2. + 登録 ボタンより、Policy set-Policy紐付の登録を行います。
    登録画面(Policy set-Policy紐付)

    図 2.52 登録画面(Policy set-Policy紐付)

  3. Policy set-Policy紐付の項目一覧は以下のとおりです。
    表 2.71 登録画面項目一覧(Policy set-Policy紐付)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Policy set名

    Policy Set管理」にて登録したPolicy set名を選択します。

    リスト選択

    Policy名

    Policy管理」にて登録したPolicy名を選択します。

    リスト選択

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

PolicySet-Workspace紐付

  1. Terraform Cloud/EP▶Policy set-Workspace紐付 では、「Policy Set管理」にて登録したPolicy setと「Workspace管理」にて登録したWorkspaceの紐付けについてメンテナンス(閲覧/登録/更新/廃止)を行います。
    サブメニュー画面(Policy set-Workspace紐付)

    図 2.53 サブメニュー画面(Policy set-Workspace紐付)

  2. + 登録 ボタンより、Policy set-Policy紐付の登録を行います。
    登録画面(Policy set-Workspace紐付)

    図 2.54 登録画面(Policy set-Workspace紐付)

  3. Policy set-Workspace紐付の項目一覧は以下のとおりです。
    表 2.72 登録画面項目一覧(Policy set-Workspace紐付)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Policy set名

    Policy Set管理」にて登録したPolicy set名を選択します。

    リスト選択

    Workspace名

    Workspace管理」にて登録した(Organizationと紐付く)Workspace名を選択します。

    リスト選択

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

Movement-Module紐付

  1. Terraform Cloud/EP▶Movement-Module紐付 では、「Movement一覧」にて登録したMovementと「Module素材集」にて登録したModule素材の紐付けについてメンテナンス(閲覧/登録/更新/廃止)を行います。
    Movementを実行する際、紐付けたModule素材が適用されます。
    Movementに対して複数のModule素材を紐付けることが可能です。
    サブメニュー画面(Movement-Module紐付)

    図 2.55 サブメニュー画面(Movement-Module紐付)

  2. + 登録 ボタンより、Movement-Module紐付の登録を行います。
    登録画面(Movement-Module紐付)

    図 2.56 登録画面(Movement-Module紐付)

  3. Movement-Module紐付の項目一覧は以下のとおりです。
    表 2.73 登録画面項目一覧(Movement-Module紐付)

    項目

    説明

    入力必須

    入力方式

    制約事項

    Movement名

    Movement一覧」にて登録したMovement名を選択します。

    リスト選択

    Module素材

    Module素材集」にて登録したModule素材を選択します。

    リスト選択

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

変数ネスト管理

  1. Terraform Cloud/EP▶変数ネスト管理 では、Module素材集で登録したtfファイルで定義されている変数のタイプがlist,setかつ、その変数の中でlist,set,tuple,objectが定義されている場合、メンバー変数の最大繰返数を閲覧及び更新できます。
    本メニューはModule素材集を元に内部機能がレコードを管理するため、登録・廃止・復活はできません。
    変数ネストの管理フロー例については「変数ネスト管理フロー例」をご参照ください。
    サブメニュー画面(変数ネスト管理)

    図 2.57 サブメニュー画面(変数ネスト管理)

  2. + 更新 ボタンより、最大繰返数の更新を行います。
    登録画面(変数ネスト管理)

    図 2.58 登録画面(変数ネスト管理)

  3. 変数ネスト管理の項目一覧は以下のとおりです。
    表 2.74 登録画面項目一覧(変数ネスト管理)

    項目

    説明

    入力必須

    入力方式

    制約事項

    変数名

    Module素材集」にて登録したModule素材で使用している変数が表示されます。

    入力不可

    メンバー変数名(繰返し有)

    変数ネスト管理対象がメンバー変数である場合、メンバー変数名が表示されます。メンバー変数名は各階層の変数を「.」で連結して表示します。

    入力不可

    最大繰返数

    配列の最大繰返数を1~1024の範囲で入力します。
    最大繰返数の上限値は「管理コンソール - システム設定」より識別ID「MAXIMUM_ITERATION_TERRAFORM-CLOUD-EP」の設定値にて、1~1024の範囲内で変更することが可能です。
    初期値はtfファイルのdefaultに記載されている値から取得した繰返数が設定されます。
    tfファイルにdefaultの記載がない場合、1が設定されます。
    最終更新者が「Terraform Cloud/EP変数更新機能」でない場合はModule素材の更新により値が変更されることはありません。

    手動入力

    入力値1~1,024(「システム設定」の設定値により変動)

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

警告

※初期登録および繰返数の更新はリアルタイムではないので、「代入値自動登録設定」で変数が扱えるまでに 時間がかかる 場合があります。

代入値自動登録設定

  1. Terraform Cloud/EP▶代入値自動登録設定 では、パラメータシート作成機能で作成したパラメータシート(オペレーションあり)と、Movementの変数を紐付けます。
    登録した情報は内部の処理により作業実行時に「代入値管理」に反映されます。
    サブメニュー画面(代入値自動登録設定)

    図 2.59 サブメニュー画面(代入値自動登録設定)

  2. + 登録 ボタンより、代入値自動登録設定の登録を行います。
    登録画面(代入値自動登録設定)

    図 2.60 登録画面(代入値自動登録設定)

  3. 登録画面の項目一覧は以下のとおりです。
    表 2.75 登録画面項目一覧(代入値自動登録設定)

    項目

    説明

    入力必須

    入力方法

    制約事項

    パラメータシート(From)

    メニューグループ:メニュー:項目

    パラメータシート作成機能で作成したパラメータシート(オペレーションあり)の項目が表示されます。

    対象の項目を選択します。

    選択対象となるパラメータシートはパラメータシート作成 ▶パラメータシート定義・作成▶ 作成対象 で、パラメータシート(オペレーションあり)で作成したパラメータシートの項目になります。

    リスト選択

    代入順序

    パラメータシート作成機能で作成したパラメータシート(オペレーションあり)のバンドルが有効の場合、パラメータシートで登録している代入順序を入力します。

    ※1

    手動入力

    1~2147483647の整数

    登録方式

    Value型:項目の設定値を紐付けた変数の具体値とする場合に選択します。

    Key型:項目の名称を紐付けた変数の具体値とする場合に選択します。

    リスト選択

    Movement名

    Movement一覧」で登録したMovementが表示されます。

    リスト選択

    IaC変数(To)

    Movement名:変数名

    Movement-Module紐付」で登録した資材で使用している変数が表示されます。

    具体値に紐付けたい変数を選択します。

    リスト選択

    HCL設定

    「False」または「True」を選択します。

    HCL設定を「True」にすることで、変数のタイプを考慮せずにパラメータシートの入力値(具体値)を1:1で設定することができます。

    HCL設定を「True」にした場合は「メンバー変数」「代入順序」は入力できません。

    内部処理により「代入値管理」に反映する際、選択した値が引き継がれます。

    リスト選択

    選択した変数名がmap型の場合は「True」で設定する必要があります。

    他レコードのオペレーション、Movement、変数名が一致している場合、HCL設定の値は同じ値で統一されている必要があります。

    Movement名:変数名:メンバー変数

    Movement-Module紐付」で登録した資材で使用している変数の形式により、メンバー変数が表示されます。

    具体値に紐付けたいメンバー変数を選択します。

    ※2

    リスト選択

    代入順序

    複数具体値が設定できる変数名およびメンバー変数の場合のみ必須入力になります。

    具体値の代入順序(1~ )を入力します。入力値に従い昇順で代入されます。

    ※3

    手動入力

    ブランクまたは1~2147483647の整数

    NULL連携

    パラメータシートの具体値がNULL(空白)の場合に、代入値管理への登録をNULL(空白)の値で行うか設定します。

    ・「有効」の場合、パラメータシートの値がどのような値でも代入値管理への登録が行われます。

    ・「無効」の場合、パラメータシート に値が入 っている場合のみ代入値管理への登録が行われます。

    ・空白の場合「インターフェース情報」で設定されている「NULL連携」の値が適用されます。

    リスト選択

    備考

    自由記述欄です。

    手動入力

    最大長4000バイト

※1:パラメータシートのバンドルが有効の場合のみ必須。
※2:選択した「Movement名:変数名」のメンバー変数が存在する場合は必須し、かつ「HCL設定」が「False」の場合のみ必須。
※3:選択した「Movement名:変数名」および「Movement名:変数名:メンバー変数」が代入順序を必要とする形式である場合のみ必須。

注釈

バンドルが有効なパラメータシートの場合
バンドルが有効なパラメータシートの項目とMovementの変数を紐付ける場合、 Terraform Cloud/EP▶代入値自動登録設定 でパラメータシート(From) の代入順序を入力する必要があります。
バンドルが有効なパラメータシートと代入値自動登録設定の関係を以下の図に示します。
バンドルが有効なパラメータシート使用時の代入値自動登録設定登録方法

図 2.61 バンドルが有効なパラメータシート使用時の代入値自動登録設定登録方法

注釈

IaC変数(To)のメンバー変数の設定について
変数のタイプがobject, tupleの場合に設定する必要があります。
メンバー変数を設定する場合は、同じ変数内のメンバー変数の具体値も全て設定してください。
代入値を設定しなかった他のメンバー変数でもデフォルト値が使用されることはありません。
詳細及び具体例は「変数のタイプについて」の「※1 …メンバー変数対象」を参照してください。

注釈

IaC変数(To)の代入順序について
変数のタイプがlist, setの場合に設定する必要があります。
詳細及び具体例は「変数のタイプについて」の「※2 …代入順序対象」を参照してください。

作業実行

Terraform Cloud/EP▶作業実行 では作業の実行を指示します。
Movement一覧、オペレーション一覧からそれぞれラジオボタンで選択し、 作業実行 ボタンを押すと、「作業状態確認」に遷移し、実行されます。
サブメニュー画面(作業実行)

図 2.62 サブメニュー画面(作業実行)

  1. 予約日時の指定
    「予約日時」を入力することで、実行およびPlan確認を予約することができます。
    「予約日時」には、未来の日時のみ登録可能です。
  2. Movementの指定
    Movement一覧 」で登録したMovementを選択します。
  3. オペレーションの指定
    オペレーション一覧」で登録したオペレーションを選択します。
  4. 実行
    「実行」ボタンをクリックすると、「5.2.10作業状態確認 」に遷移し、作業が実行されます。
    Terraform Plan完了後にTerraform Applyが自動で実行されます。
  5. Plan確認
    「Plan確認」ボタンをクリックすると、「実行」ボタンをクリックした場合同様に作業実行が開始されますが、Terraform Planのみを実行し、Terraform Applyは実行されません。
  6. パラメータ確認
    「パラメータ確認」ボタンをクリックすると、投入するパラメータの値を確認できます。Terraform PlanおよびTerraform Applyは実行されません。

Tip

Outputブロックについて
Outputブロックを含むModule素材を利用した作業ががConductorから実行された場合、Outputブロックに書かれた内容がConductor作業ディレクトリパスにjson形式ファイルで保存されます。
このファイルを使用することにより、同一Conductorの別のMovementでTerraformが出力した値を使用することができます。
ファイルパス
[Conductor作業ディレクトリパス]/[ConductorインスタンスID]/terraform_output_[作業No.].json
Conductor作業ディレクトリパス・・・Ansible ITA独自変数のデータ連携のConductor作業ディレクトリパス
ConductorインスタンスID・・・「Conductor作業一覧」のconductorインスタンスID
作業No.・・・「作業管理」の作業No.
記述例

variable "VAR_sample" {

 type = string

 default = "sample_string"

}

output "output_sample" {

 value = "${var.VAR_sample}"

}

出力例

{

 "output_sample": {

  "sensitive": false,

  "type": "string",

  "value": "sample_string"

 }

}

作業状態確認

Terraform Cloud/EP▶作業状態確認 では作業の実行状態を監視します。
サブメニュー画面(作業状態確認)

図 2.63 サブメニュー画面(作業状態確認)

  1. 実行状態表示
    実行状況に即し、ステータスが表示されます。
    また、実行ログ、エラーログに実行状況の詳細が表示されます。
    「実行種別」にはPlan確認の場合には「Plan確認」、Workspaceごとに構成・管理されたリソースの削除(「Workspace管理」から実行されます。)の場合は「リソース削除」、それ以外の場合には「通常」が入ります。
    ステータスが想定外エラーで終了した場合、「インターフェース情報」の登録不備や、「Organization管理」「Workspace管理」でのTerraformとの連携(登録)がされていない、あるいはその他のWebコンテンツの登録不備が原因であれば、エラーログにメッセージが表示されます。
    それ以外のエラーの場合はエラーログにメッセージが表示されません。この場合は、アプリケーションログにエラー情報が記録されます。必要に応じてアプリケーションログを確認ください。
    「呼出元Conductor」には、どのConductorから実行されたかを表示します。Terraform Cloud/EP driver から直接実行した場合は空欄になります。
    「実行ユーザ」には、作業実行メニューより「実行」ボタンを押下した際のログインユーザが表示されます。
    「Terraform利用情報」に表示される「RUN-ID」はTerraform側で管理する実行管理のIDで、内部機能によるTerraformとの連携処理の際に利用されます。
    ※「実行種別」が「リソース削除」の場合は下記の項目が設定されません。
    • 呼出元Conductor

    • Movement

    • オペレーション

    • 投入データ

  2. 代入値確認
    代入値確認 ボタンで「代入値管理」が表示され、作業対象のオペレーションとMovementに絞り込んだ代入値が表示されます。
  3. 緊急停止/予約取り消し
    緊急停止 ボタンで構築作業を停止させることができます。
    また、実行前の「予約実行」の作業の場合は、 予約取消 ボタンが表示されます。 予約取消 ボタンで予約実行が取り消せます。
  4. 実行ログ表示
    実行ログのプルダウンに表示されるログファイル名は以下の3種類があります。
    plan.log: Terraform Plan の実行ログ
    policyCheck.log: Terraform Policy Checkの実行ログ
    apply.log: Terraform Applyの実行ログ
  5. ログ検索
    実行ログ、エラーログは、フィルタリングができます。
    各ログのフィルタのテキストボックスに検索したい文字列を入力し、「該当行のみ表示」のチェックボックスをチェックすることで該当する行だけが表示されます。
    実行ログ、エラーログのリフレッシュ表示間隔と最大表示行数を、「インターフェース情報」の「状態監視周期(単位ミリ秒)」と「進行状態表示行数」で設定できます。
  6. 投入データ
    実行したModule素材、Policy素材および設定した代入値の一覧をjson形式で取得したファイルを格納したzip形式ファイルをダウンロードすることができます。
    格納されているファイルは以下の通りです。
    表 2.76 投入データ格納ファイル

    フォルダ名

    ファイル名

    説明

    (投入したModule素材ファイル名)
    投入したModule素材ファイルがzipファイルの直下にすべて格納されます。

    (投入したPolicyファイル名)
    投入したModule素材ファイルがzipファイルの直下にすべて格納されます。

    variables

    variables.json
    設定した各代入値についての「変数名(key)」「具体値(value)」「HCL設定」「Sensitive設定」の設定値をjson形式で取得したファイルです。
    Sensitive設定がON(true)の場合は具体値にはnullが設定されます。
  7. 結果データ
    実行ログ、エラーログおよび、Terraformが生成したstateファイルを格納したzip形式ファイルをダウンロードすることができます。
    格納されているファイルは以下の通りです。
    表 2.77 結果データ格納ファイル

    フォルダ名

    ファイル名

    説明

    plan.log
    実行ログ(plan.log)出力された内容を記載したlogファイルです。

    policyCheck.log
    実行ログ(policyCheck.log)出力された内容を記載したlogファイルです。

    apply.log
    実行ログ(apply.log)出力された内容を記載したlogファイルです。

    error.log
    エラーログ出力された内容を記載したlogファイルです。

    sv-XXXXXX.tfstate
    Terraformが生成したstateファイルです。ファイル名はTerraformが作成するため、実行毎に異なります。
    バックアップ用途として、暗号化された状態で保存されています。

作業管理

  1. Terraform Cloud/EP▶作業管理 では作業の履歴を閲覧できます。
    条件を指定し フィルタ ボタンをクリックすると、作業一覧テーブルを表示します。
    詳細 ボタンで 作業状態確認 に遷移し、実行状態の詳細を見ることができます。
    サブメニュー画面(作業管理)

    図 2.64 サブメニュー画面(作業管理)

  2. 作業管理画面の項目一覧は以下のとおりです。
    表 2.78 画面項目一覧(作業管理)

    項目

    説明

    作業No.

    作業実行時に自動採番した36桁の文字列が表示されます。

    詳細

    ボタンを押下することで「作業状態確認」に遷移し、実行状態の詳細を確認できます。

    実行種別

    作業実行時の実行種別が表示されます。

    「通常」「Plan確認」「パラメータシート確認」があります。

    ステータス

    作業実行のステータスが表示されます。

    「未実行」「未実行(予約)」「準備中」「実行中」「実行中(遅延)」「完了」「完了(異常)」「想定外エラー」「緊急停止」「予約取り消し」があります。

    実行ユーザ

    作業実行を行ったユーザ名が表示されます。

    登録日時

    作業を登録した日時が表示されます。

    Movement

    ID

    MovementのIDが表示されます。

    名称

    Movementの名称が表示されます。

    遅延タイマー

    Movementに設定した遅延タイマーの値が表示されます。

    Terraform利用情報

    WorkspaceID

    Movementに設定したTerraform WorkspaceのIDが表示されます。

    Organization:Workspace

    Movementに設定した(Terraform Organizationに紐づく)Terraform Workspaceの名称が表示されます。

    RUN-ID

    連携先Terraformで管理されるRUNのIDが表示されます。

    オペレーション

    No.

    オペレーションのNo.が表示されます。

    名称

    オペレーションの名称が表示されます。

    投入データ

    投入データ一式をzipファイル形式でダウンロードできます。

    結果データ

    結果データ一式をzipファイル形式でダウンロードできます。

    作業状況

    予約日時

    予約実行をしていた場合、予約日時が表示されます。

    開始日時

    作業の開始日時が表示されます。

    終了日時

    作業の終了日時が表示されます。

    備考

    自由記述欄です。

代入値管理

  1. Terraform Cloud/EP▶代入値管理 では、オペレーションに紐付くMovementで利用されるModule素材の変数に代入する具体値を閲覧できます。
    サブメニュー画面(代入値管理)

    図 2.65 サブメニュー画面(代入値管理)

  2. 代入値管理画面の項目一覧は以下のとおりです。
    表 2.79 画面項目一覧(代入値管理)

    項目

    説明

    作業No.

    作業実行時に自動採番した36桁の文字列が表示されます。

    オペレーション

    作業実行時に選択したオペレーションが表示されます。

    Movement名

    作業実行時に選択したMovementが表示されます。

    Movement名:変数名

    代入値自動登録設定」で選択されたMovementにアタッチした変数名が表示されます。

    HCL設定

    代入値自動登録設定」で選択されたHCL設定「False」または「True」が表示されます。 また、「メンバー変数」「代入順序」を入力した階層構造となっている変数は「True」となります。

    「True」の場合、連携先Terraformに登録されるVariablesのHCL設定が有効になります。

    Movement名:変数名:メンバー変数

    代入値自動登録設定」で選択されたMovementにアタッチしたメンバー変数名が表示されます。

    代入順序

    代入値自動登録設定」で選択されたMovementにアタッチした変数名およびメンバー変数に対する代入順序が表示されます。

    具体値

    Sensitive設定

    「True」または「False」が表示されます。

    「True」の場合、連携先Terraformに登録されるVariablesのSensitive設定が有効になります。

    オペレーション/Movementで使用する変数の具体値が表示されます。

    備考

    自由記述欄です。

連携先Terrraform管理

  1. Terraform Cloud/EP▶連携先Terrraform管理 では「インターフェース情報」に登録した情報をもとにTerraformへ接続し、Terraformに登録されているOrganizaiton/Workspace/Policy/ Policy setの一覧をそれぞれ表示できます。
    表示された一覧からITAに登録されている対象を、Terraformから削除することができます。
    Workspaceごとに構成・管理されたリソースの削除を実行することができます。
    また、Policy setに紐付いたWorkspaceおよびPolicyの紐付けを解除することができます。
    ※このページ上で行う操作について、ITA側の登録対象に影響はありません。
    サブメニュー画面(連携先Terrraform管理)

    図 2.66 サブメニュー画面(連携先Terrraform管理)

  2. 各一覧取得により表示される項目一覧は以下の通りです。
    表 2.80 項目一覧(Organization登録管理)

    項目

    説明

    Organization Name

    Terraformに登録されているOrganizationの名前です。

    Email address

    Organizationに登録されているEmail addressです。

    ITAの登録状態

    対象のOrganization Nameが「Organization管理」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    削除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のOrganizationが連携先Terraform上から削除されます
    ※削除したOrganizationは元に戻すことができません。
    表 2.81 項目一覧(Workspace登録管理)

    項目

    説明

    Organization Name

    対象のWorkspaceと紐付いているOrganizationの名前です。

    Workspace Name

    Terraformに登録されているWorkspaceの名前です。

    ITAの登録状態

    対象のOrganization Nameが「Workspace管理」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    リソース削除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると「作業状態確認」に遷移し、対象のWorkspaceごとに構成・管理されたリソースの削除が実行されます。
    ※削除したリソースは元に戻すことができません。

    削除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のWorkspaceが連携先Terraform上から削除されます。
    ※Workspaceを削除するとリソースの削除は実行することができません。また、削除したWorkspaceは元に戻すことができません。
    表 2.82 項目一覧(Policy登録管理)

    項目

    説明

    Organization Name

    対象のPolicyと紐付いているOrganizationの名前です。

    Policy Name

    Terraformに登録されているPolicyの名前です。

    ITAの登録状態

    対象のPolicy Nameが「Policy管理」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    Policy Codeをダウンロード

    ボタンをクリックすると対象のPolicyのPolicyCodeファイルをダウンロードできます。

    削除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のPolicyがTerraform上から削除されます。
    ※削除したPolicyは元に戻すことができません。
    表 2.83 項目一覧(PolicySet登録管理)

    項目

    説明

    Organization Name

    対象のPolicySetと紐付いているOrganizationの名前です。

    Policy Set Name

    対象のPolicySetの名前です。

    紐付Workspace

    Workspace Name

    対象のPolicy setに紐付いているWorkspaceの名前です。

    ITAの登録状態

    対象のPolicy Set NameとWorkspace Nameが「PolicySet-Workspace紐付」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    紐付解除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のPolicy setとWorkspaceの紐付けが解除されます。

    紐付Policy

    Policy Name

    対象のPolicy setに紐付いているPolicyの名前です。

    ITAの登録状態

    対象のPolicy Set NameとPolicy Nameが「Policy set-Policy紐付」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    紐付解除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のPolicy setとPolicyの紐付けが解除されます。

    ITAの登録状態

    対象のPolicy Set Nameが「Policy Set管理」に登録されている場合は「登録済み」と表示されます。登録されていない場合は「未登録」と表示されます。

    削除

    ボタンをクリックすると確認ダイアログが表示され[OK]をクリックすると対象のPolicy setが連携先Terraformから削除されます。

    ※削除したPolicy setは元に戻すことができません。