Saltar al contenido principal

Gestionar Casdoor con Terraform

Esta guía explica cómo gestionar los objetos de un servidor Casdoor como código mediante el proveedor oficial de Casdoor para Terraform, para que pueda revisar, versionar y aplicar la configuración en varios entornos.


Objetivos de aprendizaje​

  • Configurar el proveedor de Casdoor para Terraform.
  • Crear organizaciones, aplicaciones, usuarios y otros objetos desde una configuración de Terraform.
  • Incorporar objetos existentes bajo la gestión de Terraform.
  • Comprender qué campos escribe Terraform y cuáles deja intactos.

Requisitos​

  • Terraform u OpenTofu
  • Una instancia de Casdoor en ejecución
  • El ID de cliente y el secreto de cliente de una aplicación de Casdoor. Para gestionar todas las organizaciones, utilice una aplicación de la organización built-in, como app-built-in.

Acerca del proveedor​

El proveedor llama a la API de Casdoor como una aplicación, utilizando el ID de cliente y el secreto de cliente de dicha aplicación. Admite los siguientes recursos:

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

El owner de un proveedor o un certificado es admin para un objeto global que comparten todas las organizaciones, o el nombre de la organización que lo posee.

Configurar el proveedor​

  1. En la consola de administración de Casdoor, vaya a Applications, abra app-built-in y copie su Client ID y Client secret.

  2. Declare el proveedor en su configuración de 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
    }

    Para mantener el secreto fuera de la configuración, omita los ajustes y páselos como variables de entorno en su lugar:

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

Crear objetos​

  1. Agregue recursos a la configuración. El siguiente ejemplo crea una organización, un certificado, un proveedor de identidad de GitHub, una aplicación que usa ambos, un usuario, un rol y un permiso:

    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. Vista previa de los cambios:

    terraform plan
  3. Aplicar los cambios:

    terraform apply

Casdoor genera el client ID y el client secret de la aplicación. El recurso los exporta como client_id y client_secret, que está marcado como sensible, para que pueda pasarlos a la aplicación que inicia sesión con Casdoor.

Importar objetos existentes​

Para incorporar bajo Terraform un objeto creado en la consola de administración, ejecute terraform import con el ID de importación de la tabla de recursos:

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

Después de una importación, el primer terraform apply escribe los atributos password y client_secret una vez, porque Terraform no puede leer sus valores actuales desde Casdoor.

Entender qué campos escribe Terraform​

  • Atributos en la configuración: Terraform los escribe en Casdoor.
  • Campos que la configuración no establece: Conservan los valores que tienen en Casdoor. Esto incluye campos que el proveedor aún no admite. Por lo tanto, un recurso puede gestionar parte de un objeto que también edita en la consola de administración.
  • Atributos que elimina de la configuración: Conservan su último valor en Casdoor.
  • Contraseñas y secretos: Casdoor nunca devuelve valores como la password de un usuario o el client_secret de un proveedor. Terraform no detecta cambios realizados en ellos fuera de Terraform.

Vea también​