[겉핥기 시리즈] k8s의 리소스를 위해 치얼스 - Helm 편

왜 Helm 을 사용하나요?

---

Helm 이 무엇인지 알아보기 전에 왜 필요한지 먼저 알아보죠 ! 🧐

 

Consistency

쿠버네티스에 리소스를 배포하려면 아래 이미지처럼 yaml 로 작성해주어야합니다.

yaml 이 1,2 개라면 관리가 어렵지 않겠지만 10개 정도만 되도 관리하기가 매우 힘들고 불편해집니다.

 

 

 

또한 kubectl edit을 통해 쿠버네티스의 리소스를 업데이트 해줄 수 있는데, 여러 개발자가 관리를 하게 된다면 일관성(Consistency) 문제가 발생할 수 있습니다.

 

Revision History

어떠한 애플리케이션이 Deploy, ConfigMap, Service, Ingress yaml 로 배포된다고 가정해보죠.

이때 ConfigMap 과 Service 가 업데이트 되어서 yaml 이 변경되었습니다.

 

 

하지만 업데이트 결과 애플리케이션이 작동하지 않아 이전 버전으로 롤백으로 하고 싶은데, yaml 로만 구성되어있다면 롤백하는 작업이 결코 쉬운 작업은 아닐겁니다.

 

CNCF - Graduated

CNCF 는 Cloud Native Computing Foundation 의 약자로, 여러 회사들이 모여 서로 친화적인 프로젝트를 진행하는 그룹입니다. 대표적인 회사가 구글이며, 쿠버네티스 또한 CNCF 프로젝트 중 일부죠.

 

Helm 또한 CNCF 프로젝트이기 때문에 쿠버네티스와 굉장히 친화적입니다.

 

여담으로 LogStash 대신 요즘 FluentBit 을 더 많이 사용하는 이유가 FluentBit 은 CNCF 프로젝트이기 때문이죠

 

이외 더 많은 이유가 있겠지만 크게 위 3가지 이유만으로도 Helm 은 충분히 매력적이라고 생각합니다.

 

 

그럼 Helm 이 무엇이죠?

---

Helm 은 다른 패키지 매니저와 다를게 없습니다.

 

우분투 환경에선 apt 를 이용해 패키지를 관리할 수 있고, CentOS 는 yum, 자바스크립트는 npm 을 통해 패키지를 관리할 수 있는 것처럼 쿠버네티스 환경에선 helm 을 통해 패키지를 관리합니다.

 

 

helm 명령어를 통해 패키지를 설치하고, 롤백하고 삭제할 수 있습니다.

 

 

Helm 을 통해 얻을 수 있는 장점은 뭐가 있을까요?

---

Helm 의 장점은 7가지로 말할 수 있습니다.

1. Simple
2. Revision History
3. Dynamic Configuration
4. Consistency
5. Intelligent Deploy
6. Life Cycle Hooks
7. Security

하나하나씩 알아보죠!

 

Simple

Helm 이 없다면 MongDB 를 설치할 때마다 관련 yaml 을 하나하나 kube-apiserver 에 전달해주어야 합니다.

하지만 Helm 을 이용하여 차트로 구성한다면 아주 쉽게 설치가 가능하죠!

 

 

Revision History

Helm 은 install 이나 upgrade 할 때마다 버전을 기록하기 때문에 버전 관리가 용이합니다.

 

 

Dynamic Configuration

Helm 은 value 로 시작하는 yaml 에 있는 매개변수들을 사용합니다. 때문에 values-dev.yaml values-staging.yaml 로 나누어 동적으로 매개변수 전달이 가능하죠!

 

 

Consistency

항상 클러스터와 일관성을 유지할 수 있습니다.

 

 

Intelligent Deploy

Helm 을 통해 yaml 를 배포할 때 순서를 지정할 수 있습니다.

ConfigMap.yaml 을 배포하고 deployment.yaml 를 배포하는 것처럼 말이죠.

 

하지만 Helm 은 똑똑하기 때문에 본인이 알아서 배포합니다.

 

 

Life Cycle Hooks

다양한 Helm 명령어를 통해 쿠버네티스 리소스의 라이프 사이클을 관리할 수 있습니다.

 

 

Security

Helm 차트는 중앙 서버에서 관리되기 때문에 전자 서명 방식으로 보안을 강화할 수 있습니다.

 

 

Install

---

brew 를 통해 아주 쉽게 helm 을 설치할 수 있습니다.

$ brew install helm

 

helm 은 쿠버네티스 정보를 가져오기 위해 가장 먼저 환경 변수 KUBECONFIG 를 찾으려 하고, 만약 찾지 못한다면 ~/.kube/config 에서 정보를 가져옵니다.

 

즉, kubectl 를 사용하는 호스트에서 helm 을 사용하면 됩니다. Helm 이 알아서 쿠버네티스 클러스터를 찾아줍니다!

 

더 다양한 환경에서 설치하고 싶다면 여기를 참고해주세요

 

 

Getting Started

---

간단하게 Chart 를 구성하고 직접 만든 Chart 를 Helm Chart Repo 등록 한 후 쿠버네티스 환경에 설치해보죠!

Chart 의 구조는 아래와 같습니다.

 

apps 라는 Main Chart 가 있고, 안에 firstapp 과 secondapp 이라는 Sub Chart 가 있는 구조입니다.

 

 

Main Chart 와 Sub Chart 가 존재하는 것을 Helm 에선 Umbrella 차트라고 합니다.

 

Main Chart 는 apps 를 생성합니다.

$ helm create apps

 

apps 라는 Main Chart 가 생성되었습니다.

  Chart.yaml          # 차트에 대한 정보를 가진 YAML 파일
  README.md           # 옵션: README 파일
  values.yaml         # 차트에 대한 기본 환경설정 값들
  charts/             # 이 차트에 종속된 차트들을 포함하는 디렉터리
  templates/          # values와 결합될 때, 유효한 쿠버네티스 manifest 파일들이 생성될 템플릿들의 디렉터리
  templates/NOTES.txt # 옵션: 간단한 사용법을 포함하는 텍스트 파일

 

Sub Chart 는 charts 라는 디렉터리 밑에 생성하면 됩니다.

$ cd ./charts
$ helm create firstapp
$ helm create secondapp

 

firstapp 과 secondapp 이라는 Sub Chart 가 생성되었습니다.

 

이후 Main Chart 에 Sub Chart 를 종속시켜줍시다!

Main Chart 에 있는 Chart.yaml 을 켜줍니다.

$ vi Chart.yaml

 

이후 아래와 같이 작성합니다.

apiVersion: v2
name: apps
description: A Helm chart for Kubernetes

type: application

version: 0.1.0

appVersion: "1.16.0"

# firstapp 과 secondapp 을 종속시켜줍니다
dependencies:
  - name: firstapp
    version: 0.1.0
    repository: "file://../charts/firstapp"

  - name: secondapp
    version: 0.1.0
    repository: "file://../charts/secondapp"

 

그러면 이제 Helm Chart 에 문제가 없는지 확인합니다.

# ./ 는 apps 위치입니다

$ helm template ./
# 실제로 어떻게 Helm Chart 가 배포될 것인지 예측할 수 있습니다
# template 가 문제없이 출력되었다고 해서 실제 쿠버네티스 환경에서 잘 동작하는지 보장할 수 없습니다

$ helm lint ./ 
# chart 의 문법을 검사합니다
# 문제가 없다면 아래와 같이 출력됩니다
#==> Linting ./
#[INFO] Chart.yaml: icon is recommended

#1 chart(s) linted, 0 chart(s) failed

 

Chart 에 문제가 없어보이니 한번 install 해볼까요?

$ helm install apps ./
# helm install <생성할 Chart 이름> <Chart 위치>

 

성공적으로 Chart 를 설치했기 때문에 아래처럼 NOTES.txt 의 문구가 출력됩니다.

NAME: apps
LAST DEPLOYED: Wed Dec 21 22:07:30 2022
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
1. Get the application URL by running these commands:
  export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=apps,app.kubernetes.io/instance=apps" -o jsonpath="{.items[0].metadata.name}")
  export CONTAINER_PORT=$(kubectl get pod --namespace default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
  echo "Visit <http://127.0.0.1:8080> to use your application"
  kubectl --namespace default port-forward $POD_NAME 8080:$CONTAINER_PORT

 

아래 명령어를 통해 추가적으로 확인할 수 있습니다.

$ helm ls
#NAME	 NAMESPACE	REVISION	UPDATED                             	STATUS  	CHART     	APP VERSION
#apps	 default  	1       	2022-12-21 22:07:30.146251 +0900 KST	deployed	apps-0.1.0	1.16.0

$ kubectl get pods
#NAME                                                     READY   STATUS    RESTARTS   AGE
#apps-7d9c49f99d-zx59c                                    1/1     Running   0          2m8s
#apps-firstapp-7d9bc9d5b-prdpj                            1/1     Running   0          2m8s
#apps-secondapp-76f48d5b64-p2zkn                          1/1     Running   0          2m8s

 

그럼 이번엔 로컬이 아닌 Helm Chart Repo 를 통해서 설치해보죠!

로컬에서 설치한 Chart 를 우선 삭제합니다.

$ helm uninstall apps

 

Helm Chart Repo 는 GitHub, S3, Nexus 등을 사용할 수 있지만 여기선 GitHub 을 통해서 진행하겠습니다.

GitHub 에서 Helm Chart 용 Repo 를 생성합니다.

 

apps 라는 Main Chart 를 패키징 합니다.

$ helm package apps
#Successfully packaged chart and saved it to: /helm-playground/apps-0.1.0.tgz

 

그러면 apps-0.1.0.tgz 라는 압축파일이 생성되는데 tgz 는 index.yaml 이라는 파일에 의해 관리됩니다.

아래 명령어를 수행하여 index.yaml 을 생성합니다.

$ helm repo index ./

 

자동으로 생성된 index.yaml 은 아래와 같습니다.

apiVersion: v1
entries:
  apps:
  - apiVersion: v2
    appVersion: 1.16.0
    created: "2022-12-21T22:19:30.987083+09:00"
    dependencies:
    - name: firstapp
      repository: file://../charts/firstapp
      version: 0.1.0
    - name: secondapp
      repository: file://../charts/secondapp
      version: 0.1.0
    description: A Helm chart for Kubernetes
    digest: c5fd3210cacdbd7f28eecd319aa47a939dc82b29f96b45ff052b04e06a80b565
    name: apps
    type: application
    urls:
    - apps-0.1.0.tgz
    version: 0.1.0
generated: "2022-12-21T22:19:30.985545+09:00"

 

그러면 이제 생성한 tgz 와 index.yaml 을 Github 에 올려줍니다.

$ git add .
$ git commit -m "Fix: upload chart"
$ git push origin main

 

성공적으로 올라간 것을 볼 수 있습니다.

 

Helm Chart Repo 는 index.yaml 기반으로 동작을 하게 됩니다. index.yaml 로 이동한 후 Raw 버튼을 눌러줍니다.

 

그럼 위와 같이 이동이 되고, URL 를 복사해줍니다.

 

뒤에 index.yaml 만 지워주고, repo 로 등록해줍니다. 그 후 등록이 잘되었는 지 확인해줍니다.

$ helm search repo helm-chart-repo
#NAME                	CHART VERSION	APP VERSION	DESCRIPTION
#helm-chart-repo/apps	0.1.0        	1.16.0     	A Helm chart for Kubernetes

$ helm repo add helm-chart-repo <https://raw.githubusercontent.com/kingbj940429/helm-chart-repo/main>

$ helm repo ls
#NAME           	URL
#helm-chart-repo	<https://raw.githubusercontent.com/kingbj940429/helm-chart-repo/main>

 

성공적으로 잘 등록되었습니다. 그러면 설치해보죠!

$ helm install apps helm-chart-repo/apps
# helm install <설치할 chart name> <helm repo name>/<chart name>

 

apps 는 helm ls 했을 때 표시될 이름이고, helm repo name 은 helm repo add helm-chart-repo 와 일치하고, chart name 은 helm repo 에 존재하는 chart 의 이름입니다.

 

실제로 쿠버네티스에 배포되었는 지 확인합니다.

$ kubectl get pods 
#NAME                              READY   STATUS    RESTARTS   AGE
#apps-696bf7b659-dbkfg             1/1     Running   0          3m10s
#apps-firstapp-68bb56df87-jtjjv    1/1     Running   0          3m10s
#apps-secondapp-687bcbccbf-thq6t   1/1     Running   0          3m10s

 

모든 것이 정상적으로 동작하는 걸 확인할 수 있습니다.

이후 chart 와 repo 를 삭제합니다.

$ helm uninstall apps
$ helm repo remove helm-chart-repo

 

마무리

---

간단히 Helm 이 무엇이고, 왜 필요한지를 알아보았고, Helm Repo 를 만들고 배포까지 해보았습니다.

 

여기서는 알아보진 않았지만 Chart Template 문법, Security, Startets, Plugins 등 더 많은 기능들이 있는데 이 부분은 다음에 알아보도록 하겠습니다.

 

감사합니다 😀