Gérer Casdoor avec Terraform
Ce guide explique comment gérer les objets d'un serveur Casdoor sous forme de code avec le fournisseur Terraform Casdoor officiel, afin que vous puissiez examiner, versionner et appliquer la configuration à plusieurs environnements.
Objectifs d'apprentissage
- Configurer le fournisseur Terraform Casdoor.
- Créer des organisations, applications, utilisateurs et autres objets à partir d'une configuration Terraform.
- Intégrer des objets existants sous Terraform.
- Comprendre quels champs Terraform écrit et lesquels il laisse intacts.
Prérequis
- Terraform ou OpenTofu
- Une instance Casdoor fonctionnelle
- L'identifiant client (client ID) et le secret client (client secret) d'une application Casdoor. Pour gérer toutes les organisations, utilisez une application de l'organisation
built-in, telle queapp-built-in.
À propos du fournisseur
- Registre Terraform :
casdoor/casdoor - Code source : casdoor/terraform-provider-casdoor
Le fournisseur appelle l'API Casdoor en tant qu'application, avec l'ID client et le secret client de cette application. Il prend en charge les ressources suivantes :
| 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 |
L'owner d'un fournisseur ou d'un certificat est admin pour un objet global partagé par toutes les organisations, ou le nom de l'organisation qui le possède.
Configurer le fournisseur
-
Dans la console d'administration Casdoor, accédez à Applications, ouvrez
app-built-in, et copiez son Client ID et son Client secret. -
Déclarez le fournisseur dans votre configuration 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
}Pour éviter d'inclure le secret dans la configuration, omettez ces paramètres et passez-les via des variables d'environnement à la place :
export CASDOOR_ENDPOINT=https://door.casdoor.com
export CASDOOR_CLIENT_ID=<client ID>
export CASDOOR_CLIENT_SECRET=<client secret>
terraform init
Créer des objets
-
Ajoutez des ressources à la configuration. L'exemple suivant crée une organisation, un certificat, un fournisseur d'identité GitHub, une application utilisant les deux, un utilisateur, un rôle et une permission :
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
} -
Prévisualisez les modifications :
terraform plan -
Appliquez les modifications :
terraform apply
Casdoor génère l'ID client et le secret client de l'application. La ressource les exporte sous forme de client_id et client_secret, ce dernier étant marqué comme sensible, afin que vous puissiez les transmettre à l'application qui authentifie les utilisateurs via Casdoor.
Importer des objets existants
Pour intégrer un objet créé dans la console d'administration sous Terraform, exécutez terraform import avec l'ID d'importation figurant dans le tableau des ressources :
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
Après une importation, le premier terraform apply écrit les attributs password et client_secret une seule fois, car Terraform ne peut pas lire leurs valeurs actuelles depuis Casdoor.
Comprendre quels champs Terraform écrit
- Attributs présents dans la configuration : Terraform les écrit dans Casdoor.
- Champs non définis dans la configuration : Ils conservent les valeurs présentes dans Casdoor. Cela inclut les champs non encore pris en charge par le fournisseur. Une ressource peut donc gérer une partie d'un objet que vous modifiez également dans la console d'administration.
- Attributs retirés de la configuration : Ils conservent leur dernière valeur dans Casdoor.
- Mots de passe et secrets : Casdoor ne renvoie jamais des valeurs telles que le
passwordd'un utilisateur ou leclient_secretd'un fournisseur. Terraform ne détecte pas les modifications apportées à ces éléments en dehors de Terraform.
Voir aussi
- Initialiser et gérer les données avec un fichier : Chargez des objets à partir d'un fichier lors du démarrage d'un nouveau serveur Casdoor.
- Exécuter Casdoor avec l'opérateur Kubernetes : Déclarez les organisations et les applications comme ressources Kubernetes.
- Appeler l'API Casdoor
- Plugins Casdoor