📗 프로비저닝 - custom Helm chart

🏳️‍🌈 [궁금한점]

• Helm 직접 만들어 사용하는 방법

---

🔗[목차]

• 커스텀 Helm 차트를 사용하는 이유
• Helm 커스텀 차트 생성
  • 1. Helm Chart 생성
  • 2. Chart.yaml 수정
  • 3. values.yaml 설정
  • 4. templates/ 디렉토리 수정
  • 5. 로컬에서 렌더링 확인
  • 6. 클러스터에 배포
  • 7. 필요 시 Chart 패키징
• 기존에 존재하는 chart를 받아 수정한 후 관리하는 절차
  • 1. 기존 Chart 다운로드
  • 2. Chart 디렉터리 구조 이해 및 수정
  • 3. Git으로 버전 관리 시작 (선택사항)
  • 4. 이름 변경 및 충돌 방지 (선택사항)
  • 5. 커스터마이징된 Chart 배포

커스텀 Helm 차트를 사용하는 이유

커스텀 Helm 차트를 사용하는 이유는 표준화, 재사용성, 운영 효율성, 그리고 환경에 맞는 최적화 때문

목적/이유	설명
환경 맞춤 구성	조직의 네이밍 규칙, 라벨, 어노테이션, 리소스 제한 등 내부 정책에 맞춘 설정을 반영할 수 있음
반복 배포 자동화	동일한 구성의 서비스를 여러 번, 여러 환경(dev/stage/prod)에 배포 가능
표준화된 배포 방식	모든 팀이 동일한 형식으로 배포를 진행하므로 운영 및 관리가 쉬움
유지보수 용이	한 번 작성한 차트를 여러 서비스에 공통으로 적용하고, 버전 관리 및 업데이트가 쉬움
템플릿화 및 재사용성	YAML 중복 없이 템플릿(_helpers.tpl)을 사용하여 구조를 간단하게 유지 가능
GitOps 및 CI/CD 통합	ArgoCD, Flux, Jenkins 등과 쉽게 통합되어 배포 자동화 구현 가능
보안 및 접근 제어	Secret, ConfigMap, ServiceAccount 등을 통합 관리할 수 있어 보안 통제가 쉬움
서드파티 차트 확장	공식 Helm 차트를 포크 후 일부 커스터마이징하여 조직에 최적화된 형태로 재사용 가능

Helm 커스텀 차트 생성

Helm으로 Custom Chart를 만드는 과정은 Kubernetes 애플리케이션을 템플릿화하여 손쉽게 배포하고 재사용할 수 있게 해주는 방법이다.

1. Helm Chart 생성

helm create mychart

이 명령을 실행하면 mychart/ 디렉터리가 생성되고, Helm Chart의 기본 구조가 생성된다

├── Chart.yaml
├── charts
├── templates
│   ├── NOTES.txt
│   ├── _helpers.tpl
│   ├── deployment.yaml
│   ├── hpa.yaml
│   ├── ingress.yaml
│   ├── service.yaml
│   ├── serviceaccount.yaml
│   └── tests
│       └── test-connection.yaml
└── values.yaml

2. Chart.yaml 수정

이 파일은 Chart의 메타데이터를 정의한다.

apiVersion: v2
name: mychart
description: A Helm chart for Kubernetes
type: application
version: 0.1.0
appVersion: "1.16.0"

속성	설명
apiVersion	Helm 차트의 API 버전 (예: v2) 현재 Helm 3에서는 v2 사용
name	차트의 이름 디렉토리 이름과 동일하게 생성됨
description	차트에 대한 간단한 설명
type	차트의 유형 (선택사항) 일반적으로 생략되며 application 또는 library 사용 가능
version	차트의 버전 차트 자체의 버전으로, 패키징 시 사용됨 (helm package)
appVersion	배포되는 실제 애플리케이션의 버전 예: 컨테이너 이미지의 버전
keywords	(선택사항) Helm Hub 등에서 검색 시 사용할 키워드 리스트
home	(선택사항) 프로젝트 홈페이지 URL
sources	(선택사항) 소스코드 저장소 URL 목록
maintainers	(선택사항) 차트 유지보수자 목록 이름, 이메일 등 포함 가능
icon	(선택사항) 차트에 사용될 아이콘 이미지 URL
annotations	(선택사항) 키-값 쌍의 주석 정보로, CI/CD 자동화 등에서 사용됨
dependencies	(선택사항) 다른 차트에 대한 의존성 정의 (requirements.yaml 대신 사용)

필요 시 dependencies 필드도 여기에 추가하여 다른 차트를 의존성으로 포함할 수 있다.

3. values.yaml 설정

이 파일은 템플릿에 넘겨줄 기본 변수 값을 정의한다.

replicaCount: 2

image:
  repository: nginx
  tag: "1.21"
  pullPolicy: IfNotPresent

service:
  type: ClusterIP
  port: 80

이 값들은 templates/ 내의 yaml 파일들에서 {{ .Values.xxx }} 형태로 참조된다.

4. templates/ 디렉토리 수정

Helm의 핵심은 이 템플릿 파일들이다. Kubernetes 리소스를 Go 템플릿 문법으로 작성하며, values.yaml에서 정의한 값들을 참조한다.

예: templates/deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels:
      app: {{ .Release.Name }}
  template:
    metadata:
      labels:
        app: {{ .Release.Name }}
    spec:
      containers:
        - name: {{ .Chart.Name }}
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          imagePullPolicy: {{ .Values.image.pullPolicy }}
          ports:
            - containerPort: 80

5. 로컬에서 렌더링 확인

템플릿이 의도대로 생성되는지 확인한다.

helm template mychart

• value 파일 사용

helm template mychart --values myvalues.yaml

6. 클러스터에 배포

helm install myrelease ./mychart

• 설치된 리소스를 업데이트

helm upgrade myrelease ./mychart
``
- 삭제
``` bash
helm uninstall my-release-name

7. 필요 시 Chart 패키징

helm package mychart

.tgz 형태의 패키지가 생성되어 Helm repository에 업로드

기존에 존재하는 chart를 받아 수정한 후 관리하는 절차

1. 기존 Chart 다운로드

Helm Hub 또는 특정 Helm 리포지토리에서 원하는 Chart를 다운로드한다.

helm pull <repo>/<chart-name> --untar

• nginx의 경우 다음처럼 다운로드 할 수 있다.

helm repo add bitnami https://charts.bitnami.com/bitnami
helm pull bitnami/nginx --untar

• nginx/ 디렉토리가 생성된다.

2. Chart 디렉터리 구조 이해 및 수정

예를 들어 다운로드한 nginx/ 디렉토리는 다음과 같은 구조를 가질 수 있다

nginx/
├── Chart.yaml
├── values.yaml
├── templates/
│   ├── deployment.yaml
│   ├── service.yaml
│   └── ...
└── ...

수정 가능한 부분

• values.yaml: 기본 설정 값 수정 (포트, 이미지, 리소스 등)
• templates/*.yaml: 리소스 템플릿 구조 자체 수정 (env, volumeMounts 추가 등)
• Chart.yaml: Chart 이름이나 버전 등을 커스터마이즈할 수 있음

3. Git으로 버전 관리 시작 (선택사항)

Chart를 자체적으로 관리하려면 Git에 넣는 것이 좋다.

git init
git add .
git commit -m "커스터마이징한 nginx Helm Chart 초기 커밋"

4. 이름 변경 및 충돌 방지 (선택사항)

원래 Chart 이름이나 Release 이름이 기존과 겹치지 않도록 변경하면 안전하다.

# Chart.yaml
name: mynginx
version: 1.0.0

5. 커스터마이징된 Chart 배포

helm install mynginx ./nginx

• 수정한 내용을 반영

helm upgrade mynginx ./nginx