FPT Cloud provider の概要
FPT Cloud provider(fpt-corp/fptcloud)は、Terraform と FPT Cloud をつなぐ役割を果たします。provider は FPT Cloud の API を呼び出し、記述した設定どおりにリソースを作成、読み取り、更新、削除します。このページでは、最初の設定を記述する前に、provider がどのように動作するかを説明します。
このセクションで扱うリソース
ガイドページでは、FPT Cloud Server、FPT Storage、FPT Network のリソースを中心に扱います。
| グループ | Resource | Data source |
|---|---|---|
| Compute | fptcloud_instance、fptcloud_instance_group、fptcloud_ssh_key、fptcloud_snapshot | fptcloud_instance、fptcloud_instances、fptcloud_flavor、fptcloud_image、fptcloud_instance_group_policy、fptcloud_ssh_key |
| Storage | fptcloud_storage | fptcloud_storage、fptcloud_storages、fptcloud_storage_policy |
| Network | fptcloud_subnet、fptcloud_security_group、fptcloud_security_group_rule、fptcloud_floating_ip、fptcloud_floating_ip_association | fptcloud_vpc、fptcloud_subnet、fptcloud_security_group、fptcloud_floating_ip |
| Tag | fptcloud_tagging | fptcloud_tagging |
provider は、FPT Kubernetes Engine、FPT Database Engine、FPT Object Storage、Load Balancer など、他の多くのサービスにも対応しています。各バージョンの resource と引数の完全な一覧は、provider のリファレンスドキュメントに記載されています。
provider がリソースを識別する方法
provider は API を呼び出すたびに、次の 3 つの情報を使います。
- Token — 利用者を識別します。Token には Portal 上のアカウントと同じ権限があるため、Terraform で Portal 上の操作を超えることはできません。
- Tenant(
tenant_name)— リソースが属する組織で、Portal の上部で選択する tenant です。 - VPC(
vpc_id)— ほとんどのリソースは VPC に属します。VPC の ID は、data sourcefptcloud_vpcを使って名前から参照します。
provider の region 引数は、FPT Kubernetes Engine や FPT Database Engine など一部のサービスでのみ使われます。Instance、disk、network は vpc_id に従います。ただし、これらのサービスを追加したときにも設定が動作するように、region は常に VPC の Region と一致させることをお勧めします。
インプレース変更と再作成を伴う変更
設定を変更すると、Terraform は次の 3 つのいずれかの方法で処理します。
| plan での表示 | 意味 |
|---|---|
~ update in-place | リソースが更新され、データは保持されます。例:Instance の名前変更、disk 容量の拡張。 |
-/+ ... must be replaced | リソースが削除されてから再作成されます。原因となる行には # forces replacement という注記が付きます。 |
| 変更なし | その引数はリソースの作成時にのみ使われます。例:Instance の private_ip。作成後に変更しても効果はありません。 |
Instance が再作成されると、root disk とその上のデータはすべて削除されます。fptcloud_instance では、vpc_id、subnet_id、image_name、ssh_key、password のいずれかを変更すると Instance が再作成されます。apply の前に必ず plan を確認してください。
Terraform と Portal の併用
- Terraform が管理するのは、自身の state に含まれるリソースだけです。Portal で作成したリソースは、インポートしない限り Terraform の影響を受けません。
- Terraform で管理しているリソースを Portal で変更すると、次回の
terraform planで差分が報告され、terraform applyでリソースが設定どおりの状態に戻されます。 - 互いの変更が上書きされないように、リソースごとに変更する場所を 1 つ(Terraform または Portal)に決めてください。
provider のバージョン
provider は頻繁に更新されます。required_providers ブロックでバージョンを固定し、バージョンを上げる前に changelog を確認してください。
terraform {
required_providers {
fptcloud = {
source = "fpt-corp/fptcloud"
version = "~> 0.3"
}
}
}
~> 0.3 は 0.3.x のすべてのバージョンを許可しますが、0.4 には自動で上がりません。より厳密に管理するには、version = "0.3.90" のように特定のバージョンを指定します。