メインコンテンツにスキップ

Terraform で Casdoor を管理する

このガイドでは、公式 Casdoor Terraform プロバイダー を使用して Casdoor サーバーのオブジェクトをコードとして管理する方法について説明します。これにより、構成をレビュー、バージョン管理、および複数の環境へ適用することができます。


学習目標​

  • Casdoor Terraform プロバイダーを設定します。
  • Terraform 構成から組織、アプリケーション、ユーザーなどのオブジェクトを作成します。
  • 既存のオブジェクトを Terraform の管理下に置きます。
  • Terraform が書き込むフィールドと書き込まないフィールドを理解します。

必要なもの​

  • Terraform または OpenTofu
  • 実行中の Casdoor インスタンス
  • Casdoor アプリケーションのクライアント ID とクライアントシークレット。すべての組織を管理するには、built-in 組織の app-built-in などのアプリケーションを使用します。

プロバイダーについて​

プロバイダーは、アプリケーションのクライアント ID とクライアントシークレットを使用して、アプリケーションとして Casdoor API を呼び出します。以下のリソースをサポートしています:

ResourceCasdoor objectImport ID
casdoor_organizationOrganizationname
casdoor_applicationApplication, with its providersname
casdoor_userUserorganization/name
casdoor_providerProviderowner/name
casdoor_certCertowner/name
casdoor_roleRoleorganization/name
casdoor_permissionPermissionorganization/name
casdoor_groupGrouporganization/name

プロバイダーまたは証明書の owner は、すべての組織で共有されるグローバルオブジェクトの場合は admin、所有する組織の名前のいずれかです。

プロバイダーの設定​

  1. Casdoor 管理コンソールで Applications に移動し、app-built-in を開いて Client ID と Client secret をコピーします。

  2. Terraform 構成でプロバイダーを宣言します:

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

    provider "casdoor" {
    endpoint = "https://door.casdoor.com"
    client_id = var.casdoor_client_id
    client_secret = var.casdoor_client_secret
    }

    シークレットを構成ファイルに残さないようにするには、設定を省略し、代わりに環境変数として渡します:

    export CASDOOR_ENDPOINT=https://door.casdoor.com
    export CASDOOR_CLIENT_ID=<client ID>
    export CASDOOR_CLIENT_SECRET=<client secret>
    terraform init

オブジェクトの作成​

  1. 構成にリソースを追加します。次の例では、組織、証明書、GitHub ID プロバイダー、両方を使用するアプリケーション、ユーザー、ロール、権限を作成します:

    resource "casdoor_organization" "acme" {
    name = "acme"
    display_name = "Acme"
    password_type = "bcrypt"
    country_codes = ["US"]
    }

    resource "casdoor_cert" "acme" {
    name = "cert-acme"
    crypto_algorithm = "RS256"
    bit_size = 4096
    expire_in_years = 20
    }

    resource "casdoor_provider" "github" {
    name = "provider-acme-github"
    category = "OAuth"
    type = "GitHub"
    client_id = var.github_client_id
    client_secret = var.github_client_secret
    }

    resource "casdoor_application" "portal" {
    name = "app-acme-portal"
    organization = casdoor_organization.acme.name
    cert = casdoor_cert.acme.name
    redirect_uris = ["https://portal.acme.example.com/callback"]

    providers = [
    {
    name = casdoor_provider.github.name
    owner = "admin"
    can_sign_in = true
    can_sign_up = true
    },
    ]
    }

    resource "casdoor_user" "alice" {
    owner = casdoor_organization.acme.name
    name = "alice"
    email = "alice@acme.example.com"
    password = var.alice_password
    }

    resource "casdoor_role" "admins" {
    owner = casdoor_organization.acme.name
    name = "admins"
    users = ["acme/alice"]
    }

    resource "casdoor_permission" "portal_admin" {
    owner = casdoor_organization.acme.name
    name = "portal-admin"
    roles = ["acme/admins"]
    resource_type = "Application"
    resources = [casdoor_application.portal.name]
    actions = ["Read", "Write"]
    effect = "Allow"
    }

    output "portal_client_id" {
    value = casdoor_application.portal.client_id
    }
  2. 変更内容をプレビューします:

    terraform plan
  3. 変更を適用します:

    terraform apply

Casdoor はアプリケーションのクライアント ID とクライアント シークレットを生成します。リソースはこれらを client_id および client_secret としてエクスポートし、sensitive 属性にマークするため、Casdoor でユーザー認証を行うアプリケーションに渡すことができます。

既存オブジェクトのインポート​

管理コンソールで作成されたオブジェクトを Terraform の管理下に置くには、リソース テーブル のインポート ID を指定して terraform import を実行します:

terraform import casdoor_organization.acme acme
terraform import casdoor_application.portal app-acme-portal
terraform import casdoor_user.alice acme/alice
terraform import casdoor_provider.github admin/provider-acme-github

インポート後、最初の terraform apply では password および client_secret 属性が一度書き込まれます。これは、Terraform が Casdoor からこれらの現在の値を読み取れないためです。

Terraform が書き込むフィールドを理解する​

  • 設定内の属性: Terraform はそれらを Casdoor に書き込みます。
  • 設定で指定されていないフィールド: これらは Casdoor 内の現在の値を保持します。プロバイダーがまだサポートしていないフィールドも含まれます。したがって、リソースは管理コンソールでも編集されるオブジェクトの一部のみを管理できます。
  • 設定から削除した属性: これらは Casdoor 内の最後の値を保持します。
  • パスワードとシークレット: Casdoor は、ユーザーの password やプロバイダーの client_secret などの値を返しません。Terraform は、Terraform の外部で行われたこれらの変更を検出できません。

関連項目​