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

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

前提条件

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

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

TiDB Cloud Terraform Provider がTerraform レジストリにリリースされました。Terraform (>=1.0) をインストールするだけです。

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

必要なすべてのHomebrewパッケージを含むリポジトリである HashiCorp tap をインストールします。
```
brew tap hashicorp/tap
```
hashicorp/tap/terraformで Terraform をインストールします。
```
brew install hashicorp/tap/terraform
```

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

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

TiDB Cloud APIはHTTPダイジェスト認証を使用します。これにより、秘密鍵がネットワーク経由で送信されるのを防ぎます。

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

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

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

main.tfファイルを作成します。
```
terraform {
  required_providers {
    tidbcloud = {
      source = "tidbcloud/tidbcloud"
      version = "~> 0.3.0"
    }
  }
  required_version = ">= 1.0.0"
}
```
- source属性は、 Terraform レジストリからダウンロードする対象の Terraform プロバイダーを指定します。
- version属性はオプションで、Terraformプロバイダのバージョンを指定します。指定されていない場合は、デフォルトで最新のプロバイダバージョンが使用されます。
- required_versionはオプションで、Terraform のバージョンを指定します。指定されていない場合は、デフォルトで最新の Terraform バージョンが使用されます。

terraform initコマンドを実行して、Terraform Registry から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 Providerを構成する

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 プロバイダーを使用できるようになります。

ステップ5. 同期構成でTiDB Cloud Terraform Providerを構成する

Terraform プロバイダー (>= 0.3.0) は、オプションのパラメーターsyncサポートします。

syncをtrueに設定すると、リソースを同期的に作成、更新、削除できます。以下に例を示します。

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

sync ～ true設定が推奨されますが、 sync現在クラスターリソースでのみ機能することに注意してください。他のリソースに対して同期操作が必要な場合は、 TiDB Cloudサポートにお問い合わせくださいしてください。

次のステップ

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