diff --git a/manifests/helm/flink-cdc-job/0.1.0/CUSTOM-README.md b/manifests/helm/flink-cdc-job/0.1.0/CUSTOM-README.md index 9b80852..15c7555 100644 --- a/manifests/helm/flink-cdc-job/0.1.0/CUSTOM-README.md +++ b/manifests/helm/flink-cdc-job/0.1.0/CUSTOM-README.md @@ -7,7 +7,7 @@ Session Cluster를 재시작하지 않고 파이프라인만 독립적으로 배 ## 1. 배포 방법 -Release 이름이 Job 및 ConfigMap 이름으로 사용됩니다. +Release 이름이 Job, ConfigMap, ServiceAccount, Role 이름으로 사용됩니다. ```sh helm upgrade --install cdc-job ./ \ @@ -37,17 +37,27 @@ helm install cdc-job ./ -n flink-test -f values.yaml -f custom-values.yaml ## 2. custom-values.yaml 설명 -### 1) Session Cluster 연결 +### 1) ServiceAccount / RBAC | Name | 설명 | 기본값 | |------|------|--------| -| `sessionCluster.restAddress` | Session Cluster REST 서비스명 | `flink-cdc-session-rest` | +| `serviceAccount.create` | ServiceAccount 생성 여부 | `true` | +| `serviceAccount.name` | SA 이름. 비어있으면 Release.Name 사용 | `""` | +| `rbac.create` | Role / RoleBinding 생성 여부 | `true` | + +### 2) Session Cluster 연결 + +| Name | 설명 | 기본값 | +| --- | --- | --- | +| `sessionCluster.restAddress` | Session Cluster REST 서비스명 | `flink-cdc-session-session-rest` | | `sessionCluster.restPort` | REST 포트 | `8081` | > `restAddress`는 FlinkDeployment 이름에 `-rest`를 붙인 값입니다. -> 예: FlinkDeployment `flink-cdc-session` → 서비스명 `flink-cdc-session-rest` +> `flink-cdc-session` chart는 FlinkDeployment를 `{release-name}-session`으로 생성하므로 +> REST 서비스명은 `{release-name}-session-rest`가 됩니다. +> 예: release name `flink-cdc-session` → `sessionCluster.restAddress: flink-cdc-session-session-rest` -### 2) PostgreSQL 소스 +### 3) PostgreSQL 소스 | Name | 설명 | 기본값 | |------|------|--------| @@ -92,6 +102,9 @@ route: ### values-users.yaml (사용자/상품 테이블) ```yaml +sessionCluster: + restAddress: flink-cdc-session-session-rest + pipeline: name: cdc-users parallelism: 2 @@ -116,6 +129,9 @@ route: ### values-orders.yaml (주문 테이블) ```yaml +sessionCluster: + restAddress: flink-cdc-session-session-rest + pipeline: name: cdc-orders parallelism: 4 @@ -139,8 +155,11 @@ route: # Job 상태 확인 kubectl get job -n flink-test -# Job 로그 확인 +# Job 로그 확인 (release name: cdc-job) kubectl logs -n flink-test job/cdc-job + +# Flink REST API로 Job 상태 확인 +kubectl exec -n flink-test -- curl -s http://localhost:8081/jobs ``` ## 5. 삭제 @@ -148,7 +167,8 @@ kubectl logs -n flink-test job/cdc-job ```bash helm uninstall cdc-job -n flink-test ``` -> **삭제 시 주의사항** : `cdc-job`을 삭제하여도 flink session cluster에 제출된 job은 삭제되지 않습니다. + +> **삭제 시 주의사항**: `cdc-job`을 삭제하여도 Flink Session Cluster에 제출된 Job은 삭제되지 않습니다. ## 6. 참고