Files
service-catalog/manifests/helm/etcd/1.1.12/CUSTOM-README.md
T
wbsong111 9e5b6633db 자체 빌드 이미지 레포명을 security-images에서 hardened-containers로 정정한다
실제 레포명은 hardened-containers인데 이관 커밋 이후 문서·워크플로·차트 주석에
잘못된 이름 security-images가 남아 있었다. 텍스트 참조 전체를 정정하고
doc/migrations/의 이관 핸드오프 문서도 파일명까지 리네임했다. env var/secret
이름(SECURITY_IMAGES_REPO, SECURITY_IMAGES_DISPATCH_TOKEN)은 GitHub Secret
재등록이 필요한 별도 운영 작업이라 이번 텍스트 정정 범위에서 제외했다.

덧붙여 scripts/build/patch-catalog-tag.py의 docstring이 삭제된 build-image.yml을
호출자로 여전히 가리키고 있던 것도 실제 호출 경로(check-rebuild-needed.py /
apply-published-tags.py → catalog-tag-update.yml)로 고쳤다.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-26 08:16:37 +09:00

108 lines
5.6 KiB
Markdown

# etcd 배포
차트 버전 `1.1.12` (`groundhog2k/etcd`) / etcd 버전 `v3.7.1`
etcd 는 분산 key-value 저장소다. 이 차트는 오퍼레이터 없이 StatefulSet 으로 직접
멀티노드 클러스터를 구성한다(cnpg 처럼 operator + CR 구조가 아니다).
## 1. 배포 방법
### 1) 배포 시 주의 사항
- **`replicas` 는 최초 배포 후 변경할 수 없다.** 업스트림 차트가 명시하는 제약이다
(`values.yaml` 주석 — "Automatic scaling or manually scaling the etcd cluster after
first deployment is not supported"). 클러스터 크기를 바꾸려면 재배포(새 클러스터 생성
+ 데이터 마이그레이션)가 필요하다. 배포 전에 티어(`dip-resources-quotas.yaml`)를 반드시
확정한다.
- **자동 백업이 없다.** cnpg 의 `barmanObjectStore`/`scheduledBackup` 같은 내장 기능이
없다. 스냅샷은 운영자가 수동으로 실행한다.
```sh
kubectl -n <ns> exec <pod-0> -- etcdctl snapshot save /tmp/snapshot.db
kubectl -n <ns> cp <pod-0>:/tmp/snapshot.db ./snapshot.db
```
정기 백업이 필요하면 별도 CronJob 을 구성해야 한다 — 이 차트 범위 밖이다.
- **TLS 는 기본 비활성이다.** `custom-values.yaml` 은 업스트림 기본값(평문 클라이언트/피어
통신)을 그대로 쓴다. 운영 배포는 `dip-values.yaml` 로 `settings.https.autoTls: true` 를
켠다(자체 서명 인증서 자동 생성). CA 발급 인증서로 교체하려면 `extraSecrets` 로 마운트하고
`settings.https.autoTls` 를 `false` 로 내린 뒤 인증서 경로를 직접 지정해야 한다
(차트 `values.yaml` 의 `settings.https` 주석 참고).
- init 컨테이너(`busybox`)가 데이터 디렉토리(`/data/etcd`)를 `chmod 700` 으로 생성한다.
`securityContext`(uid/gid 999, non-root, RO rootfs)와 함께 이 권한이 맞물려야 정상
기동한다 — 배포 검증에서 이미지가 실제로 uid 999 로 뜨는지 확인 완료
(`scripts/deploy-test/deploy-test-etcd.sh`).
### 2) 배포
```sh
git clone https://github.com/paasup/dip-catalog.git
cd dip-catalog/manifests/helm/etcd/1.1.12
helm upgrade etcd ./ -f custom-values.yaml --install -n etcd-system --create-namespace --wait
```
### 3) 확인
```sh
kubectl -n etcd-system get pods -l app.kubernetes.io/name=etcd
kubectl -n etcd-system exec etcd-0 -- etcdctl endpoint health --cluster
```
## 2. custom-values.yaml 설명
### 1) 이미지 설정
| Name | 설명 | 기본값 |
| --- | --- | --- |
| `image.registry` / `image.repository` / `image.tag` | etcd 본체 이미지. **자체 빌드**(`docker.io/paasup/etcd:3.7.1-security-hardened-20260820`) — 업스트림 `quay.io/coreos/etcd:v3.7.1` 이 게이트 차단 HIGH 1건(`CVE-2026-56852`, `golang.org/x/text`)으로 막혀 대체했다. 빌드 정의·근거·채택 결정 배경은 별도 레포 `hardened-containers` 의 `images/etcd/README.md` 와 `docs/decisions/0004-etcd-image-self-build.md`(이 레포에는 없다). 상위 태그가 나오거나 `release-3.7` 에 백포트되면 업스트림으로 되돌리는 것이 우선(대응 우선순위 a) | 업스트림 `quay.io/coreos/etcd` (태그 미지정) |
| `initImage.registry` / `initImage.repository` / `initImage.tag` | 데이터 디렉토리 초기화용 init 컨테이너. 업스트림 기본값(`busybox:stable`)은 롤링 태그라 `busybox:1.38.0-uclibc` 로 고정 | 업스트림 `busybox:stable` |
### 2) 클러스터 크기
| Name | 설명 | 기본값 |
| --- | --- | --- |
| `replicas` | 최초 배포 후 변경 불가(위 주의사항). 이 카탈로그 항목은 단일 APISIX 인스턴스의 설정 저장소 용도라 쿼럼 HA 대신 단일 노드로 둔다(결정 배경: security-catalog 프로젝트 decisions/0006, dip-catalog 미이관) — 노드 장애 시 단일 장애점이 되는 트레이드오프를 받아들인 것. 쿼럼 HA가 필요하면 `dip-values.yaml`(3, 홀수 권장) 사용 | 1 |
### 3) 스토리지
| Name | 설명 | 기본값 |
| --- | --- | --- |
| `storage.requestedSize` | PVC 크기. 티어별 값은 `dip-volumes-quotas.yaml` 참고 | `5Gi` |
| `storage.className` | `longhorn` | `longhorn` |
etcd 는 권장 데이터 크기 상한이 있다(기본 `--quota-backend-bytes` 2GB, 업스트림도 8GB 초과를
권장하지 않음). 볼륨을 과하게 키우는 것이 능사가 아니다.
### 4) TLS
| Name | 설명 | 기본값 |
| --- | --- | --- |
| `settings.https.enabled` | 클라이언트/피어 통신 TLS 사용 여부 | `false`(custom-values) / `true`(dip-values) |
| `settings.https.autoTls` | etcd 자체 서명 인증서 자동 생성 | `false`(custom-values) / `true`(dip-values) |
### 5) 리소스
| Name | 설명 | 기본값 |
| --- | --- | --- |
| `resources` | 티어별 값은 `dip-resources-quotas.yaml` 참고 | 업스트림은 `{}`(무제한) |
## 3. 업그레이드
버전 갱신 절차는 `BUILD-README.md` 참고. etcd 는 마이너 버전 간 데이터 포맷 호환성을
공식 문서에서 보장하는 범위 내에서만 순차 업그레이드해야 한다(예: 3.6→3.7). 여러 마이너
버전을 건너뛰지 않는다.
## 4. 제거
```sh
helm uninstall etcd -n etcd-system
kubectl -n etcd-system delete pvc -l app.kubernetes.io/name=etcd
```
PVC 는 helm uninstall 로 지워지지 않는다(StatefulSet 볼륨클레임 기본 동작). 데이터를
보존할 필요가 없다면 위처럼 명시적으로 삭제한다. `longhorn` 은 `reclaimPolicy: Retain` 이므로
PV 자체가 남을 수 있다 — `.claude/pitfalls.md` 참고.
## 5. 검증 이력
`scripts/deploy-test/deploy-test-etcd.sh` 로 검증한다 — 절차와 통과 기준은
`.claude/deploy-test-procedure.md`.