Запуск Casdoor на Kubernetes: офіційна Helm Chart та конфігурація як код
Casdoor має офіційну Helm chart. Вона розміщена в головному репозиторії в директорії manifests/casdoor, публікується разом із кожним релізом Casdoor до GHCR та представлена на Artifact Hub. Починаючи з Casdoor v4.18.0, чарт також може містити ваші організації, додатки, користувачів та провайдерів як декларативну конфігурацію: змініть їх у файлі values, запустіть helm upgrade, і працюючі поди застосують зміни без перезапуску.
У цій статті ми пройдемо шлях від першого helm install до налаштування, яке можна зберігати в Git.
Встановити
Вам потрібен Helm v3.8+ та кластер:
helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor
Версія чарта відповідає версії Casdoor, тому --version 4.18.0 встановить Casdoor 4.18.0. Без Ingress або Gateway сервіс буде доступний лише всередині кластера. Для тестування пробросьте порт:
kubectl port-forward svc/casdoor 8000:8000
Потім відкрийте http://localhost:8000. При першому відвідуванні Casdoor попросить вас встановити пароль для built-in/admin; потім увійдіть з ним. Див. Вхід до адмін-консолі.
Продуктивне налаштування
Значення за замовчуванням призначені для швидкого тестування: Casdoor зберігає дані в SQLite всередині контейнера, тому вони втрачаються при заміні пода. Для реального розгортання додайте наведені нижче параметри у файл values.yaml та встановіть за допомогою helm install casdoor oci://ghcr.io/casdoor/helm-charts/casdoor -f values.yaml.
Зовнішня база даних
database:
driver: postgres # or mysql, cockroachdb
host: postgres.db.svc.cluster.local
user: casdoor
password: change-me
databaseName: casdoor
sslMode: require
Щоб не зберігати пароль до бази даних у файлі values, розмістіть весь app.conf у Secret та вкажіть його назву в configFromSecret.
Відкриття доступу до Casdoor
Чарт підтримує як класичний Ingress, так і Gateway API. За наявності контролера Ingress та 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
За допомогою Gateway API (Istio, Envoy Gateway, Cilium, Kong, NGINX Gateway Fabric та інші), прикріпіть HTTPRoute до існуючого Gateway:
gatewayApi:
enabled: true
parentRefs:
- name: my-gateway
namespace: gateway-system
hostnames:
- door.example.com
Чарт також може створити сам Gateway та додати редирект з HTTP на HTTPS, див. Helm guide.
Більше одного репліки
За замовчуванням Casdoor зберігає сесії входу на локальному диску. Перед запуском кількох реплік спрямуйте всі вони до того самого Redis, щоб користувач залишався авторизованим незалежно від того, який под обслуговує запит. Кожне налаштування app.conf можна передати як змінну середовища, тому ендпоінт можна взяти з Secret:
replicaCount: 3
envFromSecret:
- name: redisEndpoint
secretName: casdoor-redis
key: endpoint # host:port, or host:port,db,password
Той самий Redis використовується для стану потоку пристроїв OAuth. Після налаштування Redis опція autoscaling.enabled: true додасть HorizontalPodAutoscaler.
Конфігурація як код
Налаштування організацій та додатків через веб-інтерфейс підходить для перших тестів, але більшість команд хочуть, щоб конфігурація їхнього провайдера ідентичності перевірялася та версіонувалася так само, як решта інфраструктури. Значення initData забезпечують це:
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
Чарт зберігає дані в Secret та монтує їх у поди. Casdoor застосовує їх при запуску, а потім перевіряє кожні 30 секунд (initData.watchInterval). Коли ви змінюєте дані та запускаєте helm upgrade, kubelet оновлює змонтований Secret, і працюючі поди застосовують зміни без перезапуску.
Кілька правил роблять це безпечним для використання поряд із веб-інтерфейсом:
- Керуються лише ті поля, які ви вказали. Об'єкт, який вже існує, отримує поля, задані у файлі; його інші поля зберігають значення, відредаговані в інтерфейсі. Ви можете керувати лише redirect URIs додатка, залишивши решту для адмін-консолі.
- Паролі є початковими паролями. Поле
passwordкористувача використовується лише під час створення користувача, тому пізніше користувачі можуть змінити свій пароль. - Ніщо не видаляється. Видалення об'єкта з файлу не видаляє його з Casdoor.
- Помилки не зупиняють Casdoor. Якщо застосування об'єкта завершується помилкою, ця помилка логується, і Casdoor продовжує працювати; дані повторюються при кожній перевірці, доки не будуть успішно застосовані.
Формат файлу відповідає тому, який Casdoor завжди використовував для ініціалізації даних: організації, додатки, користувачі, провайдери, сертифікати, ролі, дозволи, групи, сервери LDAP, вебхуки, тарифні плани, ціни тощо, з тими самими назвами полів, що й у REST API. Швидкий спосіб почати — експортувати наявний інстанс командою casdoor -export та залишити ті об'єкти, якими хочете керувати.
Щоб зберігати дані поза файлом values, наприклад, коли вони керуються через Sealed Secrets або External Secrets, створіть Secret самостійно:
initData:
enabled: true
existingSecret: casdoor-init-data
existingSecretKey: init_data.yaml
Та сама функціональність працює без Kubernetes. Змонтуйте файл JSON або YAML та встановіть:
initDataFile = /init-data/init_data.yaml
initDataMerge = true
initDataWatchInterval = 30
Або використовуйте Terraform
Якщо вам більше подобається terraform plan, імпорт наявних об'єктів та виявлення дрейфу конфігурації, офіційний провайдер Terraform керує тими самими об'єктами через API Casdoor:
resource "casdoor_application" "portal" {
name = "app-acme-portal"
organization = "acme"
redirect_uris = ["https://portal.acme.example.com/callback"]
}
Використовуйте значення Helm, якщо конфігурація має постачатися разом із розгортанням, і Terraform, якщо Casdoor є однією з багатьох систем, які ви вже керуєте ним. Дивіться посібник з Terraform.
Перехід зі старого чарту
До версії v4.15.0 чарт публікувався як oci://registry-1.docker.io/casbin/casdoor-helm-charts, а окремий репозиторій casdoor/casdoor-helm тепер архівований. Чарт на Docker Hub все ще отримує кожен реліз, але нові встановлення мають використовувати чарт з GHCR. Перенесення наявного релізу — це звичайне оновлення, і назви ресурсів залишаються незмінними:
helm upgrade casdoor oci://ghcr.io/casdoor/helm-charts/casdoor --version <version>
Посилання
- Helm chart: Artifact Hub · джерело
- Посібники: Спробуйте з Helm · Ініціалізація даних та конфігурація як код · Terraform
- Не хочете запускати все самостійно? Casdoor Cloud надає вам виділений інстанс Casdoor, який ми хостимо та підтримуємо в актуальному стані за вас.