Keycloak: 使用 CLI 自動化操作

透過 Stackhero CLI 程式化啟動 Keycloak、取得其認證資訊並變更其設定

👋 歡迎來到 Stackhero 文件中心！

Stackhero 提供 Keycloak cloud 服務，讓您只需 2 分鐘即可輕鬆部署可用於生產環境的身分識別服務：

無限制的使用者、realm 及 client 數量

支援 OpenID Connect、OAuth 2.0、SAML 2.0、社群登入、LDAP 及 Active Directory 聯邦整合

自訂網域名稱，內建 HTTPS，確保安全存取（例如 https://login.your-company.com）

自訂主題：透過內建線上編輯器，輕鬆自訂登入頁面、帳號主控台及電子郵件的品牌風格

專屬 Email 伺服器，支援 SPF、DKIM 及 DMARC，協助您自動處理帳號確認與密碼重設

內建 PostgreSQL 資料庫，管理主控台可於獨立且可關閉的連接埠上存取

一鍵更新，讓您的系統隨時保持最新，無需手動操作

專注於開發，而非設定：您可以在 5 分鐘內體驗 Stackhero 的 Keycloak cloud 解決方案。

本指南將說明如何從命令列全程建立 Keycloak 服務、讀取其認證資訊並更新其設定，完全不需在控制台點擊操作。這非常適合用於腳本、自動化流程（CI pipeline）及 AI agent。

我們將全程使用 Stackhero CLI。如果您尚未安裝，可以透過以下指令安裝：

curl -fsSL https://www.stackhero.io/install.sh | sh

1. 驗證身份

最簡單的開始方式是透過瀏覽器登入。當您執行登入指令時，CLI 會自動開啟網頁，讓您授權存取權限。您不需要在 CLI 輸入密碼或 2FA 驗證碼。

stackhero login

登入後，您的認證資訊會儲存在本地端，後續 CLI 指令會自動使用。

若是在完全自動化的環境（如腳本或 CI pipeline），建議使用非互動式的 access token。您可以在控制台（帳戶 > Access tokens）建立一組，然後將其匯出為環境變數。CLI 及所有腳本都會自動讀取這個變數。

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

2. 查找 Keycloak 服務商店

接下來，您可以列出帳戶下可用的 Keycloak 服務商店。CLI 可直接接受商店名稱（keycloak），無需查找或複製任何 ID。

# 列出 Keycloak 服務商店（如管理多個組織可加上 --organization）
stackhero services-store-list --name="keycloak"

您可以在後續指令中直接使用商店名稱 keycloak，或從清單中選擇特定的 svs-xxxxxx ID。

3. 選擇實例規格與區域

# 列出服務商店可用的實例規格（請使用 NAME 欄位作為 --instance）
stackhero instances-store-list --service-store=keycloak

# 列出可用區域（如 "europe"）
stackhero regions-list

4. 建立服務

以下是一個範例腳本，會建立一個 stack，將您的 Keycloak 服務加入其中，等待服務啟動，取得其設定（包含自動產生的認證資訊），然後套用新的設定。

#!/bin/bash
set -e

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

serviceStore="keycloak"   # Keycloak 服務商店名稱（見步驟 2）
instance="..."                # 步驟 3 選擇的實例規格
region="europe"               # 步驟 3 選擇的區域名稱

# 建立服務專用的 stack（預設使用您的主要組織；如需指定請加 --organization）
stackId=$(stackhero --format=script stack-create \
  --name="My Keycloak stack")
echo "Stack created: ${stackId}"

# 將 Keycloak 加入 stack（名稱會自動解析）
serviceId=$(stackhero --format=script service-add \
  --stack="My Keycloak stack" \
  --service-store="${serviceStore}" \
  --instance="${instance}" \
  --region="${region}")
echo "Service added: keycloak"

# 等待服務完全啟動（可能需數分鐘）
stackhero service-wait-for --service="keycloak"

# 取得服務設定，包含自動產生的認證資訊
stackhero service-configuration-get --service="keycloak" --format=json

5. 取得認證資訊

service-configuration-get 指令會回傳服務的完整設定，包括自動產生的密碼與連線資訊。輸出為 JSON 格式，方便腳本與自動化流程使用。

stackhero service-configuration-get --service=svc-xxxxxx --format=json

6. 變更設定

您可以先檢視範例設定結構，然後套用自訂設定。當您更新設定時，服務可能會自動重啟以套用變更。

# 檢視服務的設定結構與範例
stackhero service-configuration-example --service=svc-xxxxxx

# 套用自訂設定（如有需要服務會自動重啟）
stackhero service-configuration-set \
  --service=svc-xxxxxx \
  --configuration='{ "...": "..." }'

# 等待新設定套用完成
stackhero service-wait-for --service=svc-xxxxxx

就是這樣，您已經完整體驗了：啟動服務、取得認證資訊、並重新設定，全程可用腳本自動化。若想深入了解，請參考完整 CLI 文件，其中也包含本指南介紹的非互動式 STACKHERO_TOKEN 驗證方式。