Exécution de Casdoor sur Kubernetes : Helm Chart officiel et Configuration as Code
Casdoor dispose d'un Helm chart officiel. Il se trouve dans le dépôt principal sous manifests/casdoor, est publié avec chaque version de Casdoor sur GHCR, et est référencé sur Artifact Hub. À partir de Casdoor v4.18.0, le chart peut également contenir vos organisations, applications, utilisateurs et fournisseurs comme configuration déclarative : modifiez-les dans le fichier values, exécutez helm upgrade, et les pods en cours appliquent la modification sans redémarrage.
Cet article détaille un déploiement Kubernetes depuis le premier helm install jusqu'à une configuration que vous pouvez conserver dans Git.
Installation
Vous avez besoin de Helm v3.8+ et d'un cluster :
helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor
La version du chart correspond à la version de Casdoor, donc --version 4.18.0 installe Casdoor 4.18.0. Sans Ingress ou Gateway, le service n'est accessible qu'à l'intérieur du cluster. Pour tester, transférez un port :
kubectl port-forward svc/casdoor 8000:8000
Puis ouvrez http://localhost:8000. Lors de la première visite, Casdoor vous demande de définir le mot de passe de built-in/admin ; connectez-vous ensuite avec celui-ci. Voir Se connecter à la console d'administration.
Une configuration de production
Les paramètres par défaut sont destinés à un essai rapide : Casdoor stocke ses données dans SQLite à l'intérieur du conteneur, elles sont donc perdues lorsque le pod est remplacé. Pour un déploiement réel, placez les paramètres ci-dessous dans un fichier values.yaml et installez avec helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor -f values.yaml.
Base de données externe
database:
driver: postgres # or mysql, cockroachdb
host: postgres.db.svc.cluster.local
user: casdoor
password: change-me
databaseName: casdoor
sslMode: require
Pour éviter de placer le mot de passe de la base de données dans le fichier values, mettez tout le app.conf dans un Secret et définissez configFromSecret sur son nom.
Exposer Casdoor
Le chart supporte à la fois un Ingress classique et l'API Gateway. Avec un contrôleur Ingress et cert-manager :
ingress:
enabled: true
className: nginx
annotations:
cert-manager.io/cluster-issuer: letsencrypt-prod
hosts:
- host: door.example.com
paths:
- path: /
pathType: Prefix
tls:
- secretName: casdoor-tls
hosts:
- door.example.com
Avec l'API Gateway (Istio, Envoy Gateway, Cilium, Kong, NGINX Gateway Fabric et autres), attachez une HTTPRoute à une Gateway existante :
gatewayApi:
enabled: true
parentRefs:
- name: my-gateway
namespace: gateway-system
hostnames:
- door.example.com
Le chart peut également créer la Gateway lui-même et ajouter une redirection HTTP vers HTTPS, voir le guide Helm.
Plusieurs répliques
Par défaut, Casdoor conserve les sessions de connexion sur le disque local. Avant d'exécuter plusieurs répliques, pointez toutes les instances vers le même Redis, afin qu'un utilisateur reste connecté quel que soit le pod servant la requête. Chaque paramètre app.conf peut être passé comme variable d'environnement, donc le point d'accès peut provenir d'un Secret :
replicaCount: 3
envFromSecret:
- name: redisEndpoint
secretName: casdoor-redis
key: endpoint # host:port, or host:port,db,password
Le même Redis est utilisé pour l'état du flux de périphérique OAuth. Une fois Redis en place, autoscaling.enabled: true ajoute un HorizontalPodAutoscaler.
Configuration as code
Cliquer pour assembler les organisations et les applications dans l'interface web convient pour un premier test, mais la plupart des équipes souhaitent que la configuration de leur fournisseur d'identité soit revue et versionnée comme le reste de leur infrastructure. Les valeurs initData permettent cela :
initData:
enabled: true
data:
organizations:
- owner: admin
name: acme
displayName: Acme
passwordType: bcrypt
applications:
- owner: admin
name: app-acme-portal
organization: acme
displayName: Acme Portal
redirectUris:
- https://portal.acme.example.com/callback
users:
- owner: acme
name: alice
displayName: Alice
password: change-me
signupApplication: app-acme-portal
roles:
- owner: acme
name: admins
displayName: Admins
users: [acme/alice]
isEnabled: true
Le chart stocke les données dans un Secret et les monte dans les pods. Casdoor les applique au démarrage, puis les vérifie toutes les 30 secondes (initData.watchInterval). Lorsque vous modifiez les données et exécutez helm upgrade, kubelet met à jour le Secret monté et les pods en cours l'appliquent sans redémarrage.
Quelques règles rendent cette utilisation sûre aux côtés de l'interface web :
- Seuls les champs que vous écrivez sont gérés. Un objet existant reçoit les champs définis dans le fichier ; ses autres champs conservent les valeurs éditées dans l'interface. Vous pouvez gérer uniquement les URI de redirection d'une application, et laisser le reste à la console d'administration.
- Les mots de passe sont des mots de passe initiaux. Le
passwordd'un utilisateur n'est utilisé que lors de la création de l'utilisateur, ce qui permet aux utilisateurs de le modifier par la suite. - Rien n'est supprimé. La suppression d'un objet du fichier ne le supprime pas de Casdoor.
- Les erreurs n'arrêtent pas Casdoor. Si l'application d'un objet échoue, l'erreur est journalisée et Casdoor continue de fonctionner ; les données sont réessayées à chaque vérification jusqu'à leur application réussie.
Le format du fichier est celui que Casdoor a toujours utilisé pour l'initialisation des données : organisations, applications, utilisateurs, fournisseurs, certificats, rôles, permissions, groupes, serveurs LDAP, webhooks, plans, tarifs et plus encore, avec les mêmes noms de champs que l'API REST. Une façon rapide de démarrer consiste à exporter une instance existante avec casdoor -export et à conserver les objets que vous souhaitez gérer.
Pour garder les données hors du fichier values, par exemple lorsqu'elles sont gérées par Sealed Secrets ou External Secrets, créez vous-même le Secret :
initData:
enabled: true
existingSecret: casdoor-init-data
existingSecretKey: init_data.yaml
La même fonctionnalité fonctionne sans Kubernetes. Montez un fichier JSON ou YAML et définissez :
initDataFile = /init-data/init_data.yaml
initDataMerge = true
initDataWatchInterval = 30
Ou utilisez Terraform
Si vous préférez terraform plan, l'importation d'objets existants et la détection de dérives, le provider Terraform officiel gère les mêmes objets via l'API Casdoor :
resource "casdoor_application" "portal" {
name = "app-acme-portal"
organization = "acme"
redirect_uris = ["https://portal.acme.example.com/callback"]
}
Utilisez les valeurs Helm lorsque la configuration doit être livrée avec le déploiement, et Terraform lorsque Casdoor fait partie de nombreux systèmes que vous gérez déjà avec lui. Consultez le guide Terraform.
Migration depuis l'ancien chart
Jusqu'à la v4.15.0, le chart était publié sous oci://registry-1.docker.io/casbin/casdoor-helm-charts, et le dépôt séparé casdoor/casdoor-helm est désormais archivé. Le chart Docker Hub reçoit toujours chaque nouvelle version, mais les nouvelles installations doivent utiliser celui hébergé sur GHCR. Migrer une release existante est une mise à niveau classique, et les noms des ressources restent inchangés :
helm upgrade casdoor oci://ghcr.io/casdoor/helm-charts/casdoor --version <version>
Liens
- Chart Helm : Artifact Hub · source
- Guides : Essayer avec Helm · Initialisation des données et configuration as code · Terraform
- Vous ne souhaitez pas le gérer vous-même ? Casdoor Cloud vous offre une instance Casdoor dédiée que nous hébergeons et maintenons à jour pour vous.