Ejecutar Casdoor en Kubernetes: Chart de Helm oficial y configuración como código
Casdoor tiene un chart de Helm oficial. Vive en el repositorio principal bajo manifests/casdoor, se publica con cada versión de Casdoor en GHCR y está listado en Artifact Hub. A partir de Casdoor v4.18.0, el chart también puede contener sus organizaciones, aplicaciones, usuarios y proveedores como configuración declarativa: cámbielos en el archivo de valores, ejecute helm upgrade, y los pods en ejecución aplican el cambio sin reiniciar.
Esta publicación recorre una implementación en Kubernetes desde el primer helm install hasta una configuración que puede mantenerse en Git.
Instalación
Necesita Helm v3.8+ y un clúster:
helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor
La versión del chart es la versión de Casdoor, por lo que --version 4.18.0 instala Casdoor 4.18.0. Sin un Ingress o Gateway, el servicio solo es accesible dentro del clúster. Para probarlo, reenvíe un puerto:
kubectl port-forward svc/casdoor 8000:8000
Luego abra http://localhost:8000. En la primera visita, Casdoor le pide que establezca la contraseña de built-in/admin; luego inicie sesión con ella. Vea Iniciar sesión en la consola de administración.
Una configuración de producción
Los valores predeterminados están pensados para una prueba rápida: Casdoor almacena sus datos en SQLite dentro del contenedor, por lo que se pierden cuando se reemplaza el pod. Para una implementación real, coloque la configuración siguiente en un archivo values.yaml e instale con helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor -f values.yaml.
Base de datos externa
database:
driver: postgres # or mysql, cockroachdb
host: postgres.db.svc.cluster.local
user: casdoor
password: change-me
databaseName: casdoor
sslMode: require
Para mantener la contraseña de la base de datos fuera del archivo de valores, coloque todo el app.conf en un Secret y establezca configFromSecret en su nombre.
Exponer Casdoor
El chart soporta tanto un Ingress clásico como la API de Gateway. Con un controlador de Ingress y 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
Con la API de Gateway (Istio, Envoy Gateway, Cilium, Kong, NGINX Gateway Fabric y otros), adjunte un HTTPRoute a un Gateway existente:
gatewayApi:
enabled: true
parentRefs:
- name: my-gateway
namespace: gateway-system
hostnames:
- door.example.com
El chart también puede crear el Gateway mismo y añadir una redirección de HTTP a HTTPS, vea la guía de Helm.
Más de una réplica
Casdoor mantiene las sesiones de inicio de sesión en el disco local por defecto. Antes de ejecutar más de una réplica, apunte todas ellas al mismo Redis, para que un usuario permanezca conectado independientemente del pod que atienda la solicitud. Cada ajuste de app.conf puede pasarse como variable de entorno, por lo que el endpoint puede provenir de un Secret:
replicaCount: 3
envFromSecret:
- name: redisEndpoint
secretName: casdoor-redis
key: endpoint # host:port, or host:port,db,password
El mismo Redis se usa para el estado del flujo de dispositivo OAuth. Una vez que Redis esté en su lugar, autoscaling.enabled: true añade un HorizontalPodAutoscaler.
Configuración como código
Hacer clic en organizaciones y aplicaciones juntos en la interfaz web está bien para una primera prueba, pero la mayoría de los equipos quieren que la configuración de su proveedor de identidad sea revisada y versionada como el resto de su infraestructura. Los valores de initData hacen eso:
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
El chart almacena los datos en un Secret y los monta en los pods. Casdoor los aplica al iniciar, luego los verifica cada 30 segundos (initData.watchInterval). Cuando cambie los datos y ejecute helm upgrade, kubelet actualiza el Secret montado y los pods en ejecución lo aplican sin reiniciar.
Algunas reglas hacen que esto sea seguro de usar junto con la interfaz web:
- Solo se gestionan los campos que escribe. Un objeto que ya existe obtiene los campos establecidos en el archivo; sus otros campos conservan los valores editados en la UI. Puede gestionar solo las URIs de redirección de una aplicación y dejar el resto a la consola de administración.
- Las contraseñas son contraseñas iniciales. La
passwordde un usuario solo se utiliza cuando se crea el usuario, por lo que los usuarios pueden cambiarla después. - No se elimina nada. Eliminar un objeto del archivo no lo elimina de Casdoor.
- Los errores no derriban Casdoor. Si un objeto falla al aplicarse, el error se registra y Casdoor sigue sirviendo; los datos se reintentan en cada verificación hasta que se apliquen.
El formato del archivo es el que Casdoor siempre ha usado para la inicialización de datos: organizaciones, aplicaciones, usuarios, proveedores, certificados, roles, permisos, grupos, servidores LDAP, webhooks, planes, precios y más, con los mismos nombres de campos que la API REST. Una forma rápida de empezar es exportar una instancia existente con casdoor -export y conservar los objetos que desea gestionar.
Para mantener los datos fuera del archivo de valores, por ejemplo cuando son gestionados por Sealed Secrets o External Secrets, cree el Secret usted mismo:
initData:
enabled: true
existingSecret: casdoor-init-data
existingSecretKey: init_data.yaml
La misma característica funciona sin Kubernetes. Monte un archivo JSON o YAML y establezca:
initDataFile = /init-data/init_data.yaml
initDataMerge = true
initDataWatchInterval = 30
O use Terraform
Si prefiere terraform plan, importaciones de objetos existentes y detección de desviaciones, el proveedor de Terraform oficial gestiona los mismos objetos a través de la API de Casdoor:
resource "casdoor_application" "portal" {
name = "app-acme-portal"
organization = "acme"
redirect_uris = ["https://portal.acme.example.com/callback"]
}
Use los valores de Helm cuando la configuración deba incluirse con la implementación, y Terraform cuando Casdoor sea uno de los muchos sistemas que ya gestiona con él. Vea la guía de Terraform.
Procedente del antiguo chart
Hasta la versión v4.15.0, el chart se publicaba en oci://registry-1.docker.io/casbin/casdoor-helm-charts, y el repositorio independiente casdoor/casdoor-helm está ahora archivado. El chart de Docker Hub sigue recibiendo cada versión, pero las nuevas instalaciones deben usar el de GHCR. Migrar una instalación existente es una actualización regular y los nombres de los recursos permanecen iguales:
helm upgrade casdoor oci://ghcr.io/casdoor/helm-charts/casdoor --version <version>
Enlaces
- Chart de Helm: Artifact Hub · código fuente
- Guías: Prueba con Helm · Inicialización de datos y configuración como código · Terraform
- ¿No quieres ejecutarlo tú mismo? Casdoor Cloud te ofrece una instancia dedicada de Casdoor que nosotros alojamos y mantenemos actualizada por ti.