Gerenciar o Casdoor com Terraform
Este guia explica como gerenciar os objetos de um servidor Casdoor como código com o provedor Terraform do Casdoor oficial, para que você possa revisar, versionar e aplicar a configuração em vários ambientes.
Resultados de aprendizagem
- Configurar o provedor Terraform do Casdoor.
- Criar organizações, aplicações, usuários e outros objetos a partir de uma configuração do Terraform.
- Importar objetos que já existem para o Terraform.
- Entender quais campos o Terraform escreve e quais ele deixa intactos.
O que você precisa
- Terraform ou OpenTofu
- Uma instância do Casdoor em execução
- O ID do cliente e o segredo do cliente de uma aplicação do Casdoor. Para gerenciar todas as organizações, use uma aplicação da organização
built-in, comoapp-built-in.
Sobre o provedor
- Terraform Registry:
casdoor/casdoor - Código-fonte: casdoor/terraform-provider-casdoor
O provedor chama a API do Casdoor como uma aplicação, usando o ID do cliente e o segredo do cliente da aplicação. Ele suporta os seguintes recursos:
| Resource | Casdoor object | Import ID |
|---|---|---|
casdoor_organization | Organization | name |
casdoor_application | Application, with its providers | name |
casdoor_user | User | organization/name |
casdoor_provider | Provider | owner/name |
casdoor_cert | Cert | owner/name |
casdoor_role | Role | organization/name |
casdoor_permission | Permission | organization/name |
casdoor_group | Group | organization/name |
O owner de um provedor ou de um certificado é admin para um objeto global compartilhado por todas as organizações, ou o nome da organização que o possui.
Configurar o provedor
-
No console de administração do Casdoor, vá para Applications, abra
app-built-ine copie seu Client ID e Client secret. -
Declare o provedor na sua configuração do 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 manter o segredo fora da configuração, omita as configurações e passe-as como variáveis de ambiente:
export CASDOOR_ENDPOINT=https://door.casdoor.com
export CASDOOR_CLIENT_ID=<client ID>
export CASDOOR_CLIENT_SECRET=<client secret>
terraform init
Criar objetos
-
Adicione recursos à configuração. O exemplo a seguir cria uma organização, um certificado, um provedor de identidade GitHub, uma aplicação que usa ambos, um usuário, uma função e uma permissão:
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
} -
Visualize previamente as alterações:
terraform plan -
Aplique as alterações:
terraform apply
O Casdoor gera o ID do cliente e o segredo do cliente da aplicação. O recurso exporta-os como client_id e client_secret, que são marcados como sensíveis, para que você possa passá-los à aplicação que autentica usuários com o Casdoor.
Importar objetos existentes
Para trazer um objeto criado no console de administração para o Terraform, execute terraform import com o ID de importação da tabela 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
Após uma importação, o primeiro terraform apply grava os atributos password e client_secret uma vez, porque o Terraform não consegue ler seus valores atuais do Casdoor.
Entender quais campos o Terraform grava
- Atributos na configuração: O Terraform os grava no Casdoor.
- Campos que a configuração não define: Eles mantêm os valores que têm no Casdoor. Isso inclui campos que o provedor ainda não suporta. Portanto, um recurso pode gerenciar parte de um objeto que você também edita no console de administração.
- Atributos que você remove da configuração: Eles mantêm seu último valor no Casdoor.
- Senhas e segredos: O Casdoor nunca retorna valores como a
passwordde um usuário ou oclient_secretde um provedor. O Terraform não detecta alterações feitas neles fora do Terraform.
Veja também
- Inicializar e gerenciar dados com um arquivo: Carregue objetos de um arquivo quando um novo servidor Casdoor inicia.
- Executar o Casdoor com o operador Kubernetes: Declare organizações e aplicações como recursos do Kubernetes.
- Chamar a API do Casdoor
- Plugins do Casdoor