Перейти до основного вмісту

Керування Casdoor за допомогою Terraform

Цей посібник пояснює, як керувати об'єктами сервера Casdoor як кодом за допомогою офіційного провайдера Casdoor Terraform, щоб ви могли переглядати, версіонувати та застосовувати конфігурацію до кількох середовищ.


Результати навчання​

  • Налаштуйте провайдер Casdoor Terraform.
  • Створюйте організації, застосунки, користувачів та інші об'єкти з конфігурації Terraform.
  • Імпортуйте вже існуючі об'єкти в Terraform.
  • Зрозумійте, які поля записує Terraform, а які залишає без змін.

Що вам потрібно​

  • Terraform або OpenTofu
  • Запущений екземпляр Casdoor
  • Client ID і client secret застосунку Casdoor. Для керування всіма організаціями використовуйте застосунок організації built-in, наприклад app-built-in.

Про провайдер​

Провайдер викликає API Casdoor як застосунок, використовуючи 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

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, застосунок, що використовує обидва, користувач, роль та право доступу:

    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 генерує ідентифікатор клієнта (client ID) та секрет клієнта (client secret) для додатка. Ресурс експортує їх як client_id та client_secret, які позначені як чутливі дані, щоб ви могли передати їх додатку, який виконує вхід користувачів через Casdoor.

Імпорт існуючих об'єктів​

Щоб перевести об'єкт, створений в адмін-консолі, під керування Terraform, виконайте команду terraform import з використанням ID імпорту з таблиці ресурсів:

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.

Див. також​