Helm

💡 Helm이란?

• helm은 쿠버네티스 패키지 매니저이다. apt, yum, pip 툴과 비슷하게 플랫폼의 패키지를 관리한다.
• helm을 이용하여 원하는 소프트웨어(패키지)를 쿠버네티스에 손쉽게 설치할 수 있다.
• helm 패키지 또한 YAML 형식으로 구성되어 있으며, 이것을 Chart라고 한다.
• Chart 디렉토리 안에는 Deployment, Service 등과 같은 쿠버네티스 리소스가 YAML 파일 형태로 들어가 있다. 각 파일들의 설정값은 비워져 있고(placeholder) values.yaml의 설정값들로 채워진다. 패키지가 설치될 시점에 values.yaml 파일의 설정값들을 이용하여 templates 디렉토리에 들어있는 YAML 파일의 구멍난 부분을 채운다. values.yaml 파일에는 자주 바뀌거나 사용자마다 달라지는 설정값들을 입력하는 용도로 사용하고 templates 디렉토리는 패키지의 뼈대를 이룬다.

 

📌 차트 구조

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

 

🎈 Chart.yaml Fields

apiVersion: 차트 API 버전 (필수)
name: 차트명 (필수)
version: SemVer 2 버전 (필수)
kubeVersion: 호환되는 쿠버네티스 버전의 SemVer 범위 (선택)
description: 이 프로젝트에 대한 간략한 설명 (선택)
type: 차트 타입 (선택)
keywords:
  - 이 프로젝트에 대한 키워드 리스트 (선택)
home: 프로젝트 홈페이지의 URL (선택)
sources:
  - 이 프로젝트의 소스코드 URL 리스트 (선택)
dependencies: # 차트 필요조건들의 리스트 (optional)
  - name: 차트명 (nginx)
    version: 차트의 버전 ("1.2.3")
    repository: 저장소 URL ("https://example.com/charts") 또는 ("@repo-name")
    condition: (선택) 차트들의 활성/비활성을 결정하는 boolean 값을 만드는 yaml 경로 (예시: subchart1.enabled)
    tags: # (선택)
      - 활성화 / 비활성을 함께하기 위해 차트들을 그룹화 할 수 있는 태그들
    enabled: (선택) 차트가 로드될수 있는지 결정하는 boolean
    import-values: # (선택)
      - ImportValues 는 가져올 상위 키에 대한 소스 값의 맵핑을 보유한다. 각 항목은 문자열이거나 하위 / 상위 하위 목록 항목 쌍일 수 있다.
    alias: (선택) 차트에 대한 별명으로 사용된다. 같은 차트를 여러번 추가해야할때 유용하다.
maintainers: # (선택)
  - name: maintainer들의 이름 (각 maintainer마다 필수)
    email: maintainer들의 email (각 maintainer마다 선택)
    url: maintainer에 대한 URL (각 maintainer마다 선택)
icon: 아이콘으로 사용될 SVG나 PNG 이미지 URL (선택)
appVersion: 이 앱의 버전 (선택). SemVer인 필요는 없다.
deprecated: 차트의 deprecated 여부 (선택, boolean)
annotations:
  example: 키로 매핑된 주석들의 리스트 (선택).

 

1.1. Helm 설치

$ brew install helm

 

1.2. Chart 생성

$ helm create <CHART_NAME>

$ helm create mychart
Creating mychart
$ ls mychart
Chart.yaml   charts   templates   values.yaml
- Chart.yaml: chart 이름, 버전 정보 등 chart의 전반적인 정보를 담고 있다.
- charts: chart 속에 또 다른 여러 chart들을 넣을 수 있다. 기본적으로는 비어있다.
- templates/: chart의 뼈대가 되는 쿠버네티스 리소스가 들어있는 폴더이다.
- values.yaml: 사용자가 정의하는 설정값을 가진 YAML 파일이다.

 

1.3 templates/service.yaml

apiVersion: v1
kind: Service
metadata:
    name: {{ include "mychart.fullname" . }}
    labels:
      {{- include "mychart.labels" . | nindent 4 }}
spec:
    type: {{ .Values.service.type }}                 # 서비스 타입 지정
    ports:
      - port: {{ .Values.service.port }}             # 서비스 포트 지정
        targetPort: http
        protocol: TCP
        name: http
    selector:
      {{- include "mychart.selectorLabels" . | nindent 4 }}

• service.yaml 내용을 보면 placeholder({{ key }})가 있는 것을 확인해볼 수 있다.
  
  

1.4 values.yaml

replicaCount: 1

image:
  repository: nginx
  pullPolicy: IfNotPresent

imagePullSecrets: []
nameOverride: ""
fullnameOverried: ""

...

service:
  type: LoadBalancer
  port: 8888
...

• YAML 형식에 따라 설정값들이 적혀있다. 위 service.yaml에 지정되어 있던 service.type과 service.port 확인(example) service.type과 service.port를 각각 로드밸런서와 8888로 수정한다.
  
  

1.5 Chart 설치

helm install <CHART_NAME> <CHART_PATH>

$ helm install foo ./mychart
NAME: foo
LAST DEPLOYED: Mon May 30 13:22:06 2022
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
1. Get the application URL by running these commands:
     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
           You can watch the status of by running 'kubectl get --namespace default svc -w foo-mychart'
  export SERVICE_IP=$(kubectl get svc --namespace default foo-mychart --template "{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}")
  echo http://$SERVICE_IP:8888
 

 

1.6 Service 조회

$ kubectl get svc
NAME          TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
foo-mychart   LoadBalancer   10.108.49.163   <pending>     8888:30633/TCP   28s
kubernetes    ClusterIP      10.96.0.1       <none>        443/TCP          19m

• Type과 Port를 보면 values.yaml에서 정의한대로 LoadBalancer와 8888 포트로 지정되어 있는것을 확인할 수 있다.
  
  

2-1. Helm Repository

• helm을 사용할 때의 가장 큰 장점은 외부에 잘 구축된 애프릴케이션을 손쉽게 가져올 수 있게 해준다는 점이다. helm만 잘 사용해도 쿠버네티스 생태계에서 지원하는 다양하고 강력한 애플리케이션들을 활용할 수 있다.
• helm에는 chart 원격 저장소인 Repository 있다. Repository는 여러 chart를 한 곳에 묶어서 보관해놓은 저장소이다. 사용자가 온라인상에 제공되는 Repository를 추가해서 원격 저장소로부터 chart를 로컬 클러스터에 설치할 수도 있다.
  
  

2-2. Repository 추가

$ helm repo add nginx-stable https://helm.nginx.com/stable

 

2-3. Repository 업데이트

$ helm repo update
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "nginx-stable" chart repository
Update Complete. ⎈Happy Helming!⎈

• 추가한 레파지토리의 인덱스 정보를 최신으로 업데이트 하는것이 필요하다. helm은 레파지토리 정보를 기본적으로 캐싱해서, 신규 chart를 설치하기 위해서 업데이트를 수행한다.

 

2-4. 외부 Chart 설치

$ helm install nginx nginx-stable/nginx-ingress --set rbac.create=true

• 로컬 디렉토리에 chart가 존재하지 않더라도 원격 리파지토리에 있는 chart를 설치 할 수 있다.
• 위에서 설치한 nginx-stable 레파지토리에서 nginx-ingress chart를 설치한다.
  
  

2-5. Nginx-ingress 조회

$ kubectl get svc
NAME                  TYPE           CLUSTER-IP       EXTERNAL-IP                                                                    PORT(S)                      AGE
kubernetes            ClusterIP      172.20.0.1       <none>                                                                         443/TCP                      18m
nginx-nginx-ingress   LoadBalancer   172.20.206.178   ac935cd6f67ab42128f5d46606b76e7f-1861304753.ap-northeast-2.elb.amazonaws.com   80:32472/TCP,443:32499/TCP   4m40s

• 이렇듯 클러스터 위에 Nginx 관련된 소프트웨어 하나 없어도 레파지토리를 추가하고 helm install 명령 하나로 순식간에 만들 수 있다.

 

References
https://helm.sh/ko/docs/chart_template_guide/getting_started/