TiDB Cloud Terraform プロバイダーを入手する

このドキュメントでは、 TiDB Cloud Terraform Provider を取得する方法を学習します。

前提条件

TiDB Cloud Terraform プロバイダーの概要の要件が満たされていることを確認してください。

ステップ 1. Terraform をインストールする

TiDB Cloud Terraform プロバイダーがTerraform レジストリにリリースされました。必要なのは、Terraform (>=1.0) をインストールすることだけです。

macOS の場合は、次の手順に従ってHomebrewを使用して Terraform をインストールできます。

1. 必要なすべてのHomebrewパッケージを含むリポジトリである HashiCorp Tap をインストールします。

   brew tap hashicorp/tap
   

2. hashicorp/tap/terraformで Terraform をインストールします。

   brew install hashicorp/tap/terraform
   

他のオペレーティング システムの手順については、 Terraform ドキュメントを参照してください。

ステップ 2. API キーを作成する

TiDB CloudAPI は HTTP ダイジェスト認証を使用します。秘密キーがネットワーク経由で送信されるのを防ぎます。

現在、 TiDB Cloud Terraform Provider は API キーの管理をサポートしていません。したがって、 TiDB Cloudコンソールで API キーを作成する必要があります。

詳細な手順については、 TiDB CloudAPI ドキュメントを参照してください。

ステップ 3. TiDB Cloud Terraform プロバイダーをダウンロードする

1. main.tfファイルを作成します。

   terraform {
     required_providers {
       tidbcloud = {
         source = "tidbcloud/tidbcloud"
         version = "~> 0.1.0"
       }
     }
     required_version = ">= 1.0.0"
   }
   

   • source属性は、ダウンロード元のターゲット Terraform プロバイダーを指定します。 Terraform レジストリ 。
   • version属性はオプションで、Terraform プロバイダーのバージョンを指定します。指定しない場合は、最新のプロバイダーのバージョンがデフォルトで使用されます。
   • required_versionはオプションで、Terraform のバージョンを指定します。指定しない場合は、デフォルトで最新の Terraform バージョンが使用されます。

2. terraform initコマンドを実行して、Terraform レジストリからTiDB Cloud Terraform Provider をダウンロードします。

   $ terraform init
   
   Initializing the backend...
   
   Initializing provider plugins...
   - Reusing previous version of tidbcloud/tidbcloud from the dependency lock file
   - Using previously-installed tidbcloud/tidbcloud v0.1.0
   
   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.
   

ステップ 4. API キーを使用してTiDB Cloud Terraform プロバイダーを構成する

main.tfファイルは次のように設定できます。

terraform {
  required_providers {
    tidbcloud = {
      source = "tidbcloud/tidbcloud"
    }
  }
}

provider "tidbcloud" {
  public_key = "your_public_key"
  private_key = "your_private_key"
}

public_keyとprivate_keyは API キーの公開キーと秘密キーです。環境変数を介して渡すこともできます。

export TIDBCLOUD_PUBLIC_KEY = ${public_key}
export TIDBCLOUD_PRIVATE_KEY = ${private_key}

これで、 TiDB Cloud Terraform プロバイダーを使用できるようになりました。

次のステップ

クラスターリソースを使用してクラスターを管理することから始めます。