メインコンテンツにスキップ

Kubernetes での Casdoor 実行:公式 Helm Chart と設定コード化

· 1分読む
Yang Luo
Casdoor Maintainer

Casdoor には公式の Helm chart があります。メインリポジトリの manifests/casdoor にあり、すべての Casdoor リリースと同時に GHCR に公開され、Artifact Hub にも登録されています。Casdoor v4.18.0 以降では、この chart を使用して組織、アプリケーション、ユーザー、プロバイダーを宣言的な設定として保持できます。values ファイルで変更し helm upgrade を実行すると、再起動せずに稼働中の Pod へ変更が適用されます。

この記事では、最初の helm install から Git で管理できるセットアップまで、Kubernetes デプロイメントの手順を解説します。

インストール​

Helm v3.8+ とクラスターが必要です:

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

Chart のバージョンは 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 に保存するため、Pod が置き換わるとデータは失われます。実際のデプロイメントでは、以下の設定を 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 の公開​

この chart は従来の 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 など) を使用する場合、既存の Gateway に HTTPRoute をアタッチします:

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

chart は Gateway 自体を作成し、HTTP から HTTPS へのリダイレクトを追加することも可能です。詳細は Helm ガイド を参照してください。

複数レプリカの実行​

Casdoor はデフォルトでサインインセッションをローカルディスクに保持します。1つ以上のレプリカを実行する前に、すべてを同じ Redis に向けることで、どの Pod がリクエストを処理してもユーザーはサインイン状態を維持できます。すべての 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 が追加されます。

設定コード化​

Web UI で組織とアプリケーションをクリックして設定するのは初回のテストには適していますが、多くのチームはアイデンティティプロバイダーの設定を他のインフラと同様にレビューおよびバージョン管理したいと考えています。initData values はこれを実現します:

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

chart はデータを Secret に保存し、Pod にマウントします。Casdoor は起動時にこれを適用し、その後30秒ごとに (initData.watchInterval) チェックします。データを変更して helm upgrade を実行すると、kubelet がマウントされた Secret を更新し、稼働中の Pod は再起動なしで変更を適用します。

Web UI と併用して安全に使用するためのいくつかのルールがあります:

  • 記述したフィールドのみが管理されます。 既に存在するオブジェクトに対しては、ファイルで設定されたフィールドのみが適用され、他のフィールドは UI で編集された値が保持されます。アプリケーションのリダイレクト URI のみを管理し、残りは管理者コンソールに任せることができます。
  • パスワードは初期パスワードです。 ユーザーの password はユーザー作成時のみに使用されるため、その後はユーザー自身で変更できます。
  • 削除は行われません。 ファイルからオブジェクトを削除しても、Casdoor からは削除されません。
  • エラーによって Casdoor が停止することはありません。 オブジェクトの適用に失敗した場合、エラーがログに記録され、Casdoor はサービスを提供し続けます。データは適用されるまで、チェックごとに再試行されます。

ファイル形式は、Casdoor が従来から データ初期化 で使用しているものです。組織、アプリケーション、ユーザー、プロバイダー、証明書、ロール、権限、グループ、LDAP サーバー、Webhook、プラン、価格設定などを含み、REST API と同じフィールド名を使用します。始めるための簡単な方法は、既存のインスタンスを casdoor -export でエクスポートし、管理したいオブジェクトを残すことです。

値ファイルにデータを含めたくない場合(例えば、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 プロバイダー を使用すると、同じオブジェクトを Casdoor API 経由で管理できます:

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

構成をデプロイメントと一緒に配布する必要がある場合は Helm values を使用し、すでに Terraform で管理している多くのシステムの 1 つとして Casdoor を運用する場合は Terraform を使用します。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>