跳到主内容

使用 Terraform 管理 Casdoor

本指南介绍如何使用官方 Casdoor Terraform provider 以代码方式管理 Casdoor 服务器的对象,以便你可以审查、版本控制并将配置应用到多个环境。


学习目标​

  • 配置 Casdoor Terraform provider。
  • 从 Terraform 配置创建组织、应用、用户和其他对象。
  • 将已存在的对象纳入 Terraform 管理。
  • 了解 Terraform 会写入哪些字段,又会忽略哪些字段。

所需条件​

  • Terraform 或 OpenTofu
  • 正在运行的 Casdoor 实例
  • Casdoor 应用的 client ID 和 client secret。要管理所有组织,请使用 built-in 组织的应用,例如 app-built-in。

关于 provider​

该 provider 作为应用调用 Casdoor API,使用应用的 client ID 和 client secret。它支持以下资源:

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

provider 或 cert 的 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
    }

    为了不让密钥出现在配置文件中,请省略 settings 字段,转而通过环境变量传递它们:

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

创建对象​

  1. 向配置中添加资源。以下示例创建一个组织、一个证书、一个 GitHub 身份提供商、一个使用这两者的应用、一个用户、一个角色和一个权限:

    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(后者被标记为敏感信息),以便你可以将它们传递给使用 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 之外对它们所做的更改。

另请参阅​