Terraform:既存リソースの管理

前提条件

1. Terraformer のダウンロードとインストール

   オープンソースの Terraformer デプロイメントパッケージは、すべてのプロバイダー向けの包括的なパッケージとして、または各プロバイダー向けの個別のパッケージとして利用できます。必要なパッケージをダウンロードしてください。次の例は、Linux および macOS でパッケージをダウンロードする方法を示しています。詳細については、「インストール」をご参照ください。

   • Linux ユーザー

   export PROVIDER=all
   curl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-linux-amd64"
   chmod +x terraformer-${PROVIDER}-linux-amd64
   sudo mv terraformer-${PROVIDER}-linux-amd64 /usr/local/bin/terraformer

   • macOS ユーザー

   export PROVIDER=all
   curl -LO "https://github.com/GoogleCloudPlatform/terraformer/releases/download/$(curl -s https://api.github.com/repos/GoogleCloudPlatform/terraformer/releases/latest | grep tag_name | cut -d '"' -f 4)/terraformer-${PROVIDER}-darwin-amd64"
   chmod +x terraformer-${PROVIDER}-darwin-amd64
   sudo mv terraformer-${PROVIDER}-darwin-amd64 /usr/local/bin/terraformer

2. 依存関係

   1. 現在のアカウントに関連リソースの読み取り専用権限を付与します。

   2. Terraform のインストール

      説明

      Cloud Shell でコマンドを実行する場合、このステップはスキップできます。

      詳細については、「Terraform をローカルにインストールして構成する」をご参照ください。

   3. 関連するプロバイダーをダウンロードします。プロバイダーは、次の 2 つの方法のいずれかで構成できます。

      • Terraformer コマンドを実行するディレクトリでプロバイダーを初期化します。

      • プロバイダーを ~/.terraform.d/plugins/ パスにダウンロードします。

   4. アクセス資格情報を構成します。Terraformer は現在、ローカルプロファイルの読み取りによる認証のみをサポートしています。デフォルトでは、プロファイルの最初の資格情報がインポートに使用されます。Alibaba Cloud のアクセス資格情報を構成する方法の詳細については、「資格情報を構成する」をご参照ください。

使用方法

次の例では、terraformer-all-darwin-amd64 v0.8.24 を使用します。

Terraformer は、help、import、plan、and version の 4 つのコマンドをサポートしています。

1. help: コマンドの詳細を表示します。

   

2. version: 現在のバージョン番号を表示します。

   

3. import: 指定されたプロバイダーのリソースをインポートします。

   

4. plan: 指定されたプロバイダーに対してインポートされるリソースをプレビューします。

例

次の例は、中国 (杭州) リージョン内のすべての Alibaba Cloud VPC をインポートする方法を示しています。

1. インポートされたテンプレートと状態ファイルを保存するディレクトリを作成します。

   mkdir example && cd example

2. 次のコマンドを実行します。

   terraformer-all-darwin-arm64 import alicloud --resources=vpc --regions=cn-hangzhou --path-pattern={output} --path-output=./     

   • --resources: インポートするリソースのコレクションを指定します。

   • --regions: リソースが配置されているリージョンを指定します。

   • --path-pattern: 生成されるディレクトリ構造のパターンを指定します。

   • --path-output: 生成されるファイルの出力パスを指定します。

3. 生成されたテンプレートファイルは次のとおりです。デフォルトでは、リージョン情報がディレクトリパスに追加されます。すべてのリソーステンプレートを単一のファイルに圧縮するには、--compact パラメーターを指定します。このパラメーターは、すべてのリソースを resources.tf ファイルに出力します。

   └── cn-hangzhou
       ├── outputs.tf
       ├── provider.tf
       ├── terraform.tfstate
       ├── variables.tf
       ├── vpc.tf
       └── vswitch.tf
   
   2 directories, 6 files

4. ローカルの Terraform バージョンが >=0.13.0 の場合、新しい Terraform バージョンとの互換性のために状態ファイルを変更するには、次のコマンドを実行する必要があります。

   terraform state replace-provider -auto-approve "registry.terraform.io/-/alicloud" "aliyun/alicloud"

前提条件

1. ダウンロードとインストール

   aliterraformer は Alibaba Cloud Object Storage Service (OSS) に保存されています。次の場所からダウンロードできます。

   macOS

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_darwin_amd64.zip
   
   # arm64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_darwin_arm64.zip

   Linux

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_amd64.zip
   
   # arm
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_arm.zip
   
   # arm64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_linux_arm64.zip

   Windows

   # amd64
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_windows_amd64.zip
   
   # 386
   wget https://terraform-share.oss-cn-hangzhou.aliyuncs.com/aliterraformer/aliterraformer_windows_386.zip

   たとえば、macOS では、ダウンロード後にファイルを解凍します。

   unzip aliterraformer_darwin_amd64.zip
   chmod +x aliterraformer
   sudo mv aliterraformer /usr/local/bin/aliterraformer

2. 依存関係

   オープンソースの Terraformer と同様に、terraform および terraform-provider-alicloud ファイルを準備し、アクセスの制御を構成する必要があります。

   1. Resource Access Management (RAM) アカウントに関連リソースの読み取り専用権限を付与します。

   2. Terraform のインストール

      詳細については、「Terraform をローカルにインストールして構成する」をご参照ください。Cloud Shell でコマンドを実行する場合、このステップはスキップできます。

   3. terraform-provider-alicloud のダウンロード

      インポート用のプロバイダーバージョンを設定できます。init コマンドによって作成されるキャッシュディレクトリの構造は、v0.13.0 より前のバージョンと v0.13.0 以降のバージョンで異なります。次の例は、v0.13.0 以降のバージョンのディレクトリを読み取る方法を示しています。

      # 1. TF_DATA_TFER_DIR 環境変数を使用して設定
      <$TF_DATA_TFER_DIR>/providers/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0
      
      # 2. 現在の作業ディレクトリの隠しディレクトリに設定
      .terraform/providers/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0
      
      # 3. ユーザーのルートディレクトリの隠しディレクトリに設定
      <HOME>/.terraform.d/plugins/registry.terraform.io/aliyun/alicloud/1.239.0/darwin_arm64/terraform-provider-alicloud_v1.239.0

   4. アクセス資格情報の構成

      プロファイル を使用するだけでなく、環境変数とコマンドパラメーターを使用して aliterraformer でアクセス資格情報を設定できます。

      # 1. ALICLOUD_ACCESS_KEY および ALICLOUD_SECRET_KEY 環境変数を使用
      $ export ALICLOUD_ACCESS_KEY=xxxx
      $ export ALICLOUD_SECRET_KEY=xxxxx
      
      # 2. --access-key および --secret-key コマンドパラメーターを渡す
      $ aliterraformer import alicloud --access-key=xxxx --secret-key=xxx ...
      
      # 3. プロファイルメカニズムを介して AK を設定および渡す
      $ aliterraformer import alicloud --profile=default ...

使用方法

aliterraformer は help、version、products、resources、import の 5 つのコマンドをサポートしています。元のオープンソース Terraformer に products、resources コマンドを追加します。

1. help: サポートされているコマンドの詳細を表示します。

   aliterraformer help

   

2. version: 現在の Terraformer バージョンを表示します。

   aliterraformer version

3. products: 現在のバージョンがインポートをサポートしているプロダクトのリストを表示します。

   aliterraformer products

   

4. resources: 現在のバージョンがインポートをサポートしているプロダクトのリソースのリストを表示します。-p を使用してプロダクトを指定します。

   aliterraformer resources -p <productName>

   

   

5. import: インポート操作を実行します。Alibaba Cloud リソースをインポートする場合は、alicloud を指定する必要があります。次のコマンドを実行して、Alibaba Cloud リソースのインポートでサポートされているパラメーターを表示します。

   aliterraformer import alicloud -h

   

   インポートを実行するときは、まずインポートするリソースのコレクションを定義する必要があります。次に、これらのリソースをフィルターし、特定のプロパティをパラメーターとして抽出できます。

   • リソースコレクションの構築:

     import コマンドには、インポートするリソースの範囲を定義するための 4 つのフラグがあります: <--products>、<--resources>、<--excludes-products>、および <--excludes>。これらのフラグを組み合わせてリソースコレクションを構築できます。次の例は、これらのフラグの使用方法を示しています。

     • 特定のリソースのインポート

       # VPC、vSwitch、および ECS インスタンスをインポート
       aliterraformer import alicloud -r=vpc,vswitch,instance

     • 特定のプロダクトのインポート

       # ACK および ALB プロダクト配下のすべてのリソースをインポート
       aliterraformer import alicloud --products=ACK,ALB

     • 特定のプロダクトとリソースのインポート

       # ACK および ECS プロダクト配下のすべてのリソース、およびすべての VPC と vSwitch をインポート
       aliterraformer import alicloud --products=ACK,ECS -r=vpc,vswitch

     • 特定のプロダクトをインポートするが、それらのプロダクト内の一部のリソースは除外する

       # alicloud_cs_kubernetes を除く ACK 配下のすべてのリソースをインポート
       aliterraformer import alicloud --products=ACK --excludes=cs_kubernetes

     • すべてのプロダクトからすべてのリソースをインポート

       # products に ALL を入力すると、すべてのプロダクトを意味します
       aliterraformer import alicloud --products=ALL

     • すべてのプロダクトからすべてのリソースをインポートするが、特定のプロダクトは除外する

       # VPNGateway と WAF を除くすべてのプロダクトをインポート
       aliterraformer import alicloud --products=ALL --excludes-products=VPNGateway,WAF

     • すべてのプロダクトからすべてのリソースをインポートするが、特定のプロダクトとリソースは除外する

       # VPNGateway と WAF を除くすべてのプロダクトをインポートし、alicloud_cs_kubernetes リソースを除外する
       aliterraformer import alicloud --products=ALL --excludes-products=VPNGateway,WAF --excludes=cs_kubernetes

   • リソースのフィルター

     このパラメーターのフォーマットは --filter=Type1.AttrKey=AttrValue1;AttrValue2,Type2.AttrKey=AttrValue1;AttrValue2 です。Type を省略した場合、フィルター条件はすべてのリソースに適用されます。

     • ID vpc-123 の VPC をインポート

       # 複数の値を指定するには、セミコロンで区切ります: --filter="vpc.id=vpc-123;vpc-456"
       aliterraformer import alicloud -r=vpc --filter="vpc.id=vpc-123"

     • 両方とも tf-example という名前の VPC と vSwitch をインポート

       aliterraformer import alicloud -r=vpc,vswitch --filter="vpc.vpc_name=tf-example,vswitch.vswitch_name=tf-example"

     • 両方ともリソースグループ rg-12345 に属する VPC と ECS インスタンスをインポート

       aliterraformer import alicloud -r=vpc,instance --filter="resource_group_id=rg-12345"

   • output-variables を使用してプロパティを変数として抽出

     このパラメーターのフォーマットは r1:attr1,attr2;r2:attr1,attr2,attr3 です。

     • ECS インスタンスから vpc_id と vswitch_id を変数として抽出

       aliterraformer import alicloud -r=instance --output-variables="instance:vpc_id,vswitch_id"

例

次の例では、中国 (杭州) リージョンで VPC ID が vpc-12345 の VPC、vSwitch、および ECS インスタンスをインポートし、vSwitch の zone_id を変数として抽出する方法を示します。

1. インポートされたテンプレートと状態ファイルを保存するディレクトリを作成します。

   mkdir example && cd example

2. import コマンドを構築します。

   aliterraformer import alicloud \
       --regions=cn-hangzhou \
       -r=vpc,vswitch,instance \
       --filter="vpc.id=vpc-12345,vswitch.vpc_id=vpc-12345,instance.vpc_id=vpc-12345" \
       --output-variables="vswitch:zone_id" \
       --path-output=example               \
       --path-pattern={output}            \
       --compact

   • --path-output: インポートフォルダを指定します。

   • --path-pattern: インポートされたリソーステンプレートのディレクトリ構造フォーマットを指定します。デフォルトのフォーマットは {output}/{provider}/{service}/ です。他の利用可能なフォーマットには {output}/{provider}/ と {output}/ があります。たとえば、--path-pattern={output} を指定すると、すべてのテンプレートが単一のフォルダに配置されます。

   • --compact: このパラメーターが指定されていない場合、リソースは別々の {service}.tf ファイルに保存されます。このパラメーターが指定されている場合、すべてのリソースは resources.tf ファイルに保存されます。

3. インポート後、example ディレクトリに次のファイルが生成されます。

   .
   ├── outputs.tf
   ├── provider.tf
   ├── resources.tf
   ├── terraform.tfstate
   └── variables.tf

   --path-pattern={output} を指定しない場合、ディレクトリ構造は次のようになります。

   .
   └── alicloud
       ├── instance
       │   ├── provider.tf
       │   ├── terraform.tfstate
       │   └── variables.tf
       ├── vpc
       │   ├── outputs.tf
       │   ├── provider.tf
       │   ├── terraform.tfstate
       │   ├── variables.tf
       │   └── vpc.tf
       └── vswitch
           ├── outputs.tf
           ├── provider.tf
           ├── terraform.tfstate
           ├── variables.tf
           └── vswitch.tf

4. ローカルの Terraform バージョンが >=0.13.0 の場合、新しい Terraform バージョンと互換性を持たせるために状態ファイルを変更するには、次のコマンドを実行する必要があります。

   terraform state replace-provider -auto-approve "registry.terraform.io/-/alicloud" "aliyun/alicloud"