service-catalog/manifests/helm/keycloakx/7.2.2/CUSTOM-README.md

# keycloakx 배포

## 1. 배포 방법

### 1) 배포 시 주의 사항

- keycloakx를 배포하려면 외부 postgresql이 필요하다(이 차트는 내장 DB를 지원하지 않는다 — 서브차트 의존성 없음).
- `custom-values.yaml`의 `database.*` 를 배포된 DB 정보로 변경한다.
- **`http.relativePath: "/"` 를 지우거나 값을 바꾸지 말 것.** 이 차트의 기본값은 구버전 WildFly Keycloak 호환을 위한 `"/auth"`다. `"/"`로 명시하지 않으면 Quarkus 네이티브 경로 규칙과 달라져, OIDC issuer URL(`/realms/{realm}`)이나 admin REST API(`/admin/realms/...`)를 경로 접미사 없이 호출하는 소비 앱들의 연동이 조용히 깨진다.
- **`command`를 반드시 지정할 것.** 차트 기본값(`command: []`, `args: []`)만으로는 컨테이너가 인자 없는 `kc.sh`(도움말 출력, exit 0)로 끝나 CrashLoopBackOff가 된다(실측 확인). `custom-values.yaml`의 `command: ["/opt/keycloak/bin/kc.sh", "start"]`를 유지한다.
- **`extraEnv`에 `KC_HOSTNAME`을 반드시 지정할 것.** 미지정 시 `hostname is not configured; either configure hostname, or set hostname-strict to false`로 기동이 실패한다(실측 확인, hostname-strict 기본값 true).
- **이미지는 업스트림이 아니라 자체 빌드 하드닝 이미지다** — 아래 "3. 자체 빌드 이미지" 참조. `kcadm.sh`/`kcreg.sh`(`bin/client`)가 들어 있지 않다.

### 2) 배포 방법

``` sh
git clone https://github.com/paasup/dip-catalog.git
cd manifests/helm/keycloakx/7.2.2
helm upgrade keycloak ./ -f custom-values.yaml --install -n platform --create-namespace
```

## 2. custom-values.yaml 설명

### 1) pod 설정

| Name | 설명 | 기본값 |
| --- | --- | --- |
| `image.repository`/`image.tag` | **자체 빌드 하드닝 이미지**(아래 3절). 오프라인 설치 시에는 사설 미러 레지스트리로 변경. | `custom-values.yaml 참조` |
| `resources` | keycloak pod의 자원 설정. | `custom-values.yaml 참조` |

### 2) Postgresql 연동 설정

`database.*` 구조화 필드를 사용한다(구버전 `keycloak` 차트의 `DB_VENDOR`/`DB_ADDR` 같은 extraEnv 방식이 아니다).

``` yaml
database:
  vendor: postgres
  hostname: keycloak-postgresql   # 배포된 DB 서비스명으로 변경
  port: 5432
  database: keycloak
  username: keycloak
  existingSecret: keycloak-db     # kubernetes.io/basic-auth 시크릿 이름
  existingSecretKey: password     # 시크릿 안의 비밀번호 키 (기본값 "password")

extraEnv: |
  - name: KC_HOSTNAME              # 필수 — 미지정 시 hostname-strict 검증으로 기동 실패
    value: keycloak.example.org
  - name: KC_DB_SCHEMA             # public 이 아닌 전용 스키마를 쓸 때 지정
    value: keycloak
  - name: KC_BOOTSTRAP_ADMIN_USERNAME
    value: admin
  - name: KC_BOOTSTRAP_ADMIN_PASSWORD
    value: ChangeMe1234!        # 예시 값 — 배포 전 교체한다
  - name: TZ
    value: Asia/Seoul
```

- `existingSecret`으로 지정한 시크릿은 미리 생성해야 한다(이 차트는 시크릿을 만들어주지 않고 참조만 한다):
  ``` sh
  kubectl create secret generic keycloak-db \
    --type=kubernetes.io/basic-auth \
    --from-literal=username=keycloak \
    --from-literal=password=<비밀번호> \
    -n platform
  ```
- `KC_BOOTSTRAP_ADMIN_USERNAME`/`KC_BOOTSTRAP_ADMIN_PASSWORD`(Keycloak 25+ 표준 부트스트랩 메커니즘)는 **master realm이 완전히 비어있는 최초 부팅에만** admin 계정을 생성한다. 재설치·재기동 시 비밀번호를 바꿔주지 않는다 — 정상 동작이다.

### 3) Ingress 설정

#### 3.1) tls 시크릿 직접 생성

``` yaml
ingress:
  enabled: true
  ingressClassName: apisix          # 사용하는 ingress controller 클래스로 변경
  rules:
    - host: keycloak.example.org    # keycloak에서 사용할 도메인으로 변경
      paths:
        - path: /
          pathType: Prefix
  tls:
    - hosts:
        - keycloak.example.org      # keycloak에서 사용할 도메인으로 변경
      secretName: keycloak-tls
```

인증서를 secret으로 직접 제공하는 경우:

``` sh
kubectl create secret tls keycloak-tls --cert=<path-to-cert-file> --key=<path-to-key-file> -n <namespace>
```

#### 3.2) cert-manager를 이용한 자동 생성

`custom-values.yaml`의 `ingress.annotations.cert-manager.io/cluster-issuer`를 미리 배포된 ClusterIssuer 이름으로 변경한다.

``` yaml
ingress:
  enabled: true
  ingressClassName: apisix
  annotations:
    cert-manager.io/cluster-issuer: "root-ca-issuer"
  rules:
    - host: keycloak.example.org
      paths:
        - path: /
          pathType: Prefix
  tls:
    - hosts:
        - keycloak.example.org
      secretName: keycloak-tls
```

### 4) Proxy 설정

ingress/리버스 프록시 뒤에 배포하는 표준 구성:

``` yaml
proxy:
  enabled: true
  mode: forwarded
```

## 3. 자체 빌드 이미지

`image.repository`/`image.tag` 는 업스트림 `quay.io/keycloak/keycloak` 이 아니라
`docker.io/paasup/keycloak` 자체 빌드 하드닝 이미지를 가리킨다. 빌드 정의는
[`images/keycloak/`](../../../../images/keycloak/) 에 있고, 왜 자체 빌드인지·업스트림과
무엇이 다른지는 [`images/keycloak/README.md`](../../../../images/keycloak/README.md) 가
단일 출처다. 배포 관점에서 알아야 할 것만 아래에 적는다.

### 앱 버전이 차트 `appVersion` 과 다르다

차트 `appVersion` 은 `26.6.4` 지만 이미지는 **Keycloak 26.7.1** 이다.

- `appVersion` 은 `image.tag` 미지정 시의 기본값일 뿐이고, `custom-values.yaml` 이
  태그를 명시하므로 실제 배포 버전은 26.7.1 이다.
- codecentric `keycloakx` 는 7.2.2 가 최신 차트이고 아직 26.7.x 를 따라잡지 못했다 —
  릴리스 캐던스 지연이지 차트 결함이 아니다.
- 26.6.4 를 쓰지 않는 이유: 26.7.1(및 26.6.5)에서만 패치된 `keycloak-services`
  HIGH 5건(CVE-2026-16102 / 16442 / 16443 / 15572 / 15573)에 취약하다.

### 업스트림 이미지와의 차이 — `kcadm.sh`/`kcreg.sh` 없음

`/opt/keycloak/bin/client/` 를 제거했다. 이 디렉토리의 `keycloak-admin-cli-*.jar` 가
취약한 jackson 을 shade 로 품은 uber-jar 라 교체가 불가능해서다. **서버 런타임은 이
디렉토리를 쓰지 않으므로 배포 동작에는 영향이 없다.**

파드에 exec 해서 `kcadm.sh` 를 쓰던 절차가 있다면 대안이 필요하다.

- 권장: admin REST API 직접 호출 (`/admin/realms/...`, 토큰은
  `/realms/master/protocol/openid-connect/token` 에서 발급)
- 또는 업스트림 이미지(`quay.io/keycloak/keycloak:26.7.1`)를 일회성 잡/디버그
  컨테이너로 띄워 `kcadm.sh` 만 쓴다 (서버로 쓰지 않는다)

### 이미지 갱신

`images/keycloak/suse.build.env` 의 `KEYCLOAK_VERSION` 과 jar 오버레이 버전을 사람이
고쳐 PR 을 여는 것이 갱신 트리거다. `build-image.yml` 을 `workflow_dispatch` 로 돌리면
빌드·게이트 통과 후 이 파일의 `image.tag` 가 자동 갱신된 브랜치가 생성된다.