このページでは、Visual Studio Code 用のMongoDB拡張機能に含まれる Terraform ファイルの Atlas テンプレートを使用して Flex クラスターを作成する方法について説明します。
テンプレートを読み込んだ後、クラスターを構成し、Atlas アカウントの詳細を指定します。次に、Terraform コマンドを使用して Atlas クラスターを計画、適用、破棄します。
前提条件
Visual Studio Code 用の MongoDB 拡張機能に含まれる Terraform ファイルの Atlas テンプレートを使用する前に、次の操作を行う必要があります。
|service| でサービス アカウントを持っている
Organization OwnerまたはOrganization Project Creatorロールを持つ組織。
手順
テンプレートを使用して Atlas Terraform ファイルを作成する
VS Code 拡張機能に含まれる Terraform ファイルの Atlas テンプレートを使用して、Atlas クラスターを構成します。
main.tf ファイルに「atlas」と入力し、Enter キーまたは Return キーを押します。
VSCode 用のMongoDB拡張機能は、Flex クラスターを作成するためにMongoDB Atlas Terraform プロバイダーを使用して例構成をファイルに入力します。
Atlas Terraform 構成を更新してクラスターを構成します。
カーソルが移動して、mongodbatlas_project リソースの name 引数の値を選択します。
クラスターを構成するには、次の引数に値を指定します。
Tip
Tab キーを押して、テンプレート内で更新する次の引数を選択します。
属性 | 値 |
|---|---|
| この構成によって作成される Atlas プロジェクトの名前。 |
| この構成によって作成される Atlas Flex クラスターの名前。 |
| この構成で作成される Atlas Flex クラスターがホストされるプロバイダー。許容される次の値のいずれかを選択します。
|
| この構成で作成される Atlas Flex クラスターが配置されるリージョン。選択したリージョンが Flex クラスターをサポートしていることを確認します。 各プロバイダーがサポートするリージョンの詳細については、Atlas ドキュメントの次のセクションを参照してください。 |
local 変数を更新します。
警告
local 変数には機密情報が含まれています。これらの値を、公開されているリポジトリにチェックインしないでください。
次の local 変数に値を指定します。
変数 | 値 |
|---|---|
| Atlas サービス アカウントクライアントID。 |
| Atlas サービス アカウントクライアントシークレット。 |
| プロジェクトを作成する Atlas 組織 ID。 |
| Atlas がクラスター用に作成する MongoDB データベース ユーザーのユーザー名。 |
|
|
| Atlas クラスターにアクセスできる IP アドレスまたは CIDR ブロック。 |
注意
テンプレートは、サービス アカウントを使用して Atlas を認証します。 APIキーもサポートされていますが、認証方法としてはサービス アカウントが推奨されます。どちらの方法についても、「 MongoDB Atlas Terraform プロバイダー認証ガイド 」を参照してください。
例
入力変数ファイルを使用してセキュリティを最大化する
セキュリティを最大限に高めるには、次の手順を実行することを検討してください。
local入力変数ファイルで 変数を定義します。variable "mongodb_atlas_client_id" { default = "my-client-id" } variable "mongodb_atlas_client_secret" { default = "my-client-secret" } 入力変数ファイルをリポジトリから除外します。たとえば、リポジトリの
.gitignoreファイルにファイル名を追加します。main.tfファイル内の入力変数ファイルから変数を参照するには、先頭にvar.を付けます。provider "mongodbatlas" { client_id = var.mongodb_atlas_client_id client_secret = var.mongodb_atlas_client_secret }
main.tf ファイルに任意の構成オプションを追加します。
サポートされている構成オプションの完全なリストについては、MongoDB Atlas Terraform プロバイダーのドキュメント を参照してください。
本番環境の配置については、クラスターリソースを本番環境のベストプラクティスのデフォルトにバンドルされている公式のMongoDB Atlas Cluster モジュールを検討してください。
注意
Flex クラスターは、MongoDB Atlas Terraform プロバイダーで利用可能なすべての構成をサポートしていません。サポートされていない構成のリストについては、 Atlas のドキュメント を参照してください。
Terraform を使用して Atlas クラスターを作成する
テンプレートを使用して Terraform ファイルを作成したら、Atlas クラスターを作成します。
Terraform を使用して Atlas クラスターを削除する
警告
クラスターを削除すると、そのクラスターに保存されているデータベース、コレクション、ドキュメント、およびクラスターを構成した Terraform 構成で定義されているその他すべてのリソースが破棄されます。
慎重に進む必要があります。
Atlas クラスターを削除するには、次の手順に従います。