ナレッジベース

Terraform プロバイダー (zinn-digital/zinn) の使用

Terraform Registry から zinn-digital/zinn プロバイダーを追加し、API キーを作成して、DNS レコードをコードとして管理 (作成、更新、インポート) し、サイト、ドメイン、プラン、ホスティングリージョンをデータソースとして読み取ります。

zinn-digital/zinn は当社の公式 Terraform プロバイダーであり、署名付きリリースとともに Terraform Registry で公開されています。お客様の組織内のドメインにおける DNS レコード を管理し、サイト、ドメイン、プラン、および ホスティング地域 をデータソースとして読み取ります。サイト、メールボックス、プラン自体は現在 Terraform では管理されません。これらにはダッシュボード、API、SDK、または Zinnector® CLI をご使用ください。

インストール

terraform {
  required_providers {
    zinn = {
      source = "zinn-digital/zinn"
    }
  }
}

# api_key falls back to ZINN_API_KEY.
provider "zinn" {}

terraform init を実行します。Terraform はレジストリからプロバイダーをダウンロードし、その署名を検証します。

API キーの作成

ダッシュボードの API キー ページ (app.zinndigital.com/api-keys) を開き、キーを作成 を押してください。DNS を管理するには、権限の下にある sites.view と domains.dns.manage にチェックを入れます。Terraform を実行する前にエクスポートしてください:

export ZINN_API_KEY=zdk_live_…

zinn_regions および zinn_plans データソースにはキーは不要です。

DNS レコードの管理

data "zinn_regions" "all" {}
data "zinn_domains" "all" {}

resource "zinn_dns_record" "www" {
  domain_id = one([for d in data.zinn_domains.all.domains : d.id if d.fqdn == "example.com"])
  name      = "www"
  type      = "CNAME"
  value     = "example.com."
  ttl       = 3600
}

output "regions" { value = [for r in data.zinn_regions.all.regions : r.slug] }

terraform apply はレコードを作成します。value または ttl を変更するとその場で更新され、ブロックを削除するとレコードが削除されます。name には、apex を表す @、www などの相対名、または完全修飾名を指定できます。

既存のレコードを Terraform の管理下に置く

terraform import zinn_dns_record.www <domain_id>/<record_id>

ドメイン ID は data.zinn_domains から取得されます。レコード ID は API の DNS レコード一覧に表示されます。

インベントリを確認する

data "zinn_sites" "all" {}
data "zinn_plans" "agency" { product_line = "agency" }

output "site_count" { value = length(data.zinn_sites.all.sites) }
output "agency_plans" { value = [for p in data.zinn_plans.agency.plans : p.code] }