Zum Hauptinhalt springen

Casdoor auf Kubernetes betreiben: Offizielles Helm Chart und Configuration as Code

· 6 Minuten Lektüre
Yang Luo
Casdoor Maintainer

Casdoor verfügt über ein offizielles Helm Chart. Es befindet sich im Hauptrepository unter manifests/casdoor, wird bei jedem Casdoor-Release im GHCR veröffentlicht und ist auf Artifact Hub gelistet. Ab Casdoor v4.18.0 kann das Chart auch Ihre Organisationen, Anwendungen, Benutzer und Provider als deklarative Konfiguration enthalten: Ändern Sie diese in der values-Datei, führen Sie helm upgrade aus, und die laufenden Pods wenden die Änderung ohne Neustart an.

Dieser Beitrag führt durch eine Kubernetes-Bereitstellung vom ersten helm install bis hin zu einem Setup, das Sie in Git speichern können.

Installation​

Sie benötigen Helm v3.8+ und einen Cluster:

helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor

Die Chart-Version entspricht der Casdoor-Version, daher installiert --version 4.18.0 Casdoor 4.18.0. Ohne Ingress oder Gateway ist der Dienst nur innerhalb des Clusters erreichbar. Um es auszuprobieren, leiten Sie einen Port weiter:

kubectl port-forward svc/casdoor 8000:8000

Öffnen Sie dann http://localhost:8000. Beim ersten Besuch fragt Casdoor Sie nach dem Passwort für built-in/admin; melden Sie sich dann damit an. Siehe Anmeldung in der Admin-Konsole.

Eine Produktionsumgebung​

Die Standardeinstellungen sind für einen schnellen Test gedacht: Casdoor speichert seine Daten in SQLite im Container, sodass sie verloren gehen, wenn der Pod ersetzt wird. Für eine echte Bereitstellung legen Sie die folgenden Einstellungen in einer values.yaml-Datei ab und installieren Sie mit helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor -f values.yaml.

Externe Datenbank​

database:
driver: postgres # or mysql, cockroachdb
host: postgres.db.svc.cluster.local
user: casdoor
password: change-me
databaseName: casdoor
sslMode: require

Um das Datenbankpasswort nicht in der values-Datei abzulegen, setzen Sie die gesamte app.conf in ein Secret und definieren Sie configFromSecret mit dessen Namen.

Casdoor verfügbar machen​

Das Chart unterstützt sowohl ein klassisches Ingress als auch die Gateway API. Mit einem Ingress-Controller und 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

Mit der Gateway API (Istio, Envoy Gateway, Cilium, Kong, NGINX Gateway Fabric und andere) hängen Sie eine HTTPRoute an ein vorhandenes Gateway an:

gatewayApi:
enabled: true
parentRefs:
- name: my-gateway
namespace: gateway-system
hostnames:
- door.example.com

Das Chart kann auch das Gateway selbst erstellen und eine HTTP-zu-HTTPS-Umleitung hinzufügen, siehe den Helm-Leitfaden.

Mehr als eine Replik​

Casdoor speichert Anmelde-Sitzungen standardmäßig lokal auf der Festplatte. Bevor Sie mehr als eine Replik betreiben, verweisen Sie alle auf denselben Redis, damit ein Benutzer angemeldet bleibt, unabhängig davon, welcher Pod die Anfrage bearbeitet. Jede app.conf-Einstellung kann als Umgebungsvariable übergeben werden, sodass der Endpunkt aus einem Secret stammen kann:

replicaCount: 3

envFromSecret:
- name: redisEndpoint
secretName: casdoor-redis
key: endpoint # host:port, or host:port,db,password

Derselbe Redis wird für den Status des OAuth-Geräteflusses verwendet. Sobald Redis eingerichtet ist, fügt autoscaling.enabled: true einen HorizontalPodAutoscaler hinzu.

Configuration as Code​

Organisationen und Anwendungen in der Web-Oberfläche zusammenzuklicken ist für einen ersten Test in Ordnung, aber die meisten Teams möchten das Setup ihres Identitätsanbieters wie den Rest ihrer Infrastruktur überprüfen und versionieren. Die initData-Werte tun genau das:

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

Das Chart speichert die Daten in einem Secret und bindet sie in die Pods ein. Casdoor wendet sie beim Start an und prüft sie dann alle 30 Sekunden (initData.watchInterval). Wenn Sie die Daten ändern und helm upgrade ausführen, aktualisiert kubelet das eingebundene Secret, und die laufenden Pods wenden es ohne Neustart an.

Einige Regeln machen die parallele Nutzung neben der Web-Oberfläche sicher:

  • Nur die von Ihnen geschriebenen Felder werden verwaltet. Ein bereits vorhandenes Objekt erhält die in der Datei festgelegten Felder; seine anderen Felder behalten die Werte bei, die in der Benutzeroberfläche bearbeitet wurden. Sie können nur die Redirect URIs einer Anwendung verwalten und den Rest der Admin-Konsole überlassen.
  • Passwörter sind initiale Passwörter. Das password eines Benutzers wird nur bei der Erstellung des Benutzers verwendet, sodass Benutzer ihr Passwort danach ändern können.
  • Nichts wird gelöscht. Wenn ein Objekt aus der Datei entfernt wird, wird es nicht aus Casdoor entfernt.
  • Fehler bringen Casdoor nicht zum Absturz. Wenn die Anwendung eines Objekts fehlschlägt, wird der Fehler protokolliert und Casdoor bleibt im Dienst; die Daten werden bei jeder Überprüfung erneut versucht, bis sie angewendet werden.

Das Dateiformat ist dasjenige, das Casdoor seit jeher für Dateninitialisierung verwendet: Organisationen, Anwendungen, Benutzer, Anbieter, Zertifikate, Rollen, Berechtigungen, Gruppen, LDAP-Server, Webhooks, Pläne, Preise und mehr, mit denselben Feldnamen wie die REST-API. Ein schneller Einstiegsweg besteht darin, eine bestehende Instanz mit casdoor -export zu exportieren und die Objekte beizubehalten, die verwaltet werden sollen.

Um die Daten aus der values-Datei herauszuhalten, z. B. wenn sie von Sealed Secrets oder External Secrets verwaltet wird, erstellen Sie das Secret selbst:

initData:
enabled: true
existingSecret: casdoor-init-data
existingSecretKey: init_data.yaml

Dieselbe Funktion funktioniert auch ohne Kubernetes. Mounten Sie eine JSON- oder YAML-Datei und setzen Sie:

initDataFile = /init-data/init_data.yaml
initDataMerge = true
initDataWatchInterval = 30

Oder verwenden Sie Terraform​

Wenn Sie terraform plan, Importe vorhandener Objekte und Drift-Erkennung bevorzugen, verwaltet der offizielle Terraform-Anbieter dieselben Objekte über die Casdoor-API:

resource "casdoor_application" "portal" {
name = "app-acme-portal"
organization = "acme"
redirect_uris = ["https://portal.acme.example.com/callback"]
}

Verwenden Sie Helm values, wenn die Konfiguration zusammen mit dem Deployment ausgeliefert werden soll, und Terraform, wenn Casdoor eines von vielen Systemen ist, die Sie bereits damit verwalten. Siehe den Terraform-Leitfaden.

Migration vom alten Chart​

Bis v4.15.0 wurde das Chart als oci://registry-1.docker.io/casbin/casdoor-helm-charts veröffentlicht, und das separate Repository casdoor/casdoor-helm ist nun archiviert. Das Docker-Hub-Chart erhält weiterhin jede Veröffentlichung, aber neue Installationen sollten das GHCR-Chart verwenden. Die Migration einer bestehenden Release ist ein reguläres Upgrade, und die Ressourcennamen bleiben gleich:

helm upgrade casdoor oci://ghcr.io/casdoor/helm-charts/casdoor --version <version>