쿠버네티스 패키지 매니저 Helm #2-1. Chart
쿠버네티스 패키지 매니저 HELM
Helm Chart
차트는 helm의 패키지 포맷으로, 하나의 애플리케이션을 설치하기 위한 파일들로 구성되어 있다. 예를 들어 tomcat을 설치하기 위한 쿠버네티스의 pod,service,deployment를 위한 YAML 파일등을 포함한다.
템플릿과 밸류
Helm 은 기본적으로 템플릿의 개념을 사용한다. 템플릿 파일을 만들어놓은 후에, 밸류 값을 채워 넣어서 쿠버네티스 리소스를 정의한 YAML 파일을 생성한다. 예제를 살펴보자
Helm 은 기본적으로 템플릿의 개념을 사용한다. 템플릿 파일을 만들어놓은 후에, 밸류 값을 채워 넣어서 쿠버네티스 리소스를 정의한 YAML 파일을 생성한다. 예제를 살펴보자.
먼저 templates/helloworld.yaml 파일을 정의한다.
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: {{ .Values.name }}-deployment
spec:
replicas: {{ .Values.replicaCount }}
minReadySeconds: 5
selector:
matchLabels:
app: {{ .Values.name }}
template:
metadata:
name: {{ .Values.name }}-pod
labels:
app: {{ .Values.name }}
spec:
containers:
- name: {{ .Values.name }}
image: gcr.io/terrycho-sandbox/helloworlds:v1
imagePullPolicy: Always
ports:
- containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
name: {{ .Values.name }}-svc
spec:
selector:
app: {{ .Values.name }}
ports:
- name: http
port: 80
protocol: TCP
targetPort: 8080
type: LoadBalancer
그리고 ./values.yaml 파일을 아래와 같이 정의한다.
name: "helloworld"
replicaCount: 3
템플릿은 값을 채울 수 있는 말 그대로 템플릿이고, Value의 값을 이용해서 값을 채운다.
이를 개념적으로 표현해보면 다음과 같은 형태가 된다.
좌측은 템플릿 파일이고, 템플릿에서 밸류값은 별도의 파일에 정의한다.
정의한 키/밸류 형식으로 name:”helloworld”로 정의하였고, replicaCount: 2로 정의하였다
그리고 이 밸류값을 불러들이기 위해서는 {{.Value.키이름}} 식으로 템플릿내에 정의한다.
위의 예제에서 보면 name등에 {{.Value.name}} 으로 정의하였고, replicas 수는 {{ .Value.replicaCount }} 로 정의한다.
이렇게 정의된 템플릿에 밸류 내용을 정의하면 오른쪽 처럼 YAML 파일을 생성할 수 있다.
외부에서 Value를 받는 방법
Value값을 values,yaml에 지정해놨지만, 설치에 따라서 각 값을 변경하고 싶은 경우가 있다. 예를 들어 replicaCount를 3이 아니라 10으로 변경하고 싶을 경우에는 values.yaml 파일을 일일이 에디트 해야 한다. 나중에, 차트를 차트 리파지토리에 등록하기 위해서는 압축된 파일 형태를 사용하는데, 이 경우에는 그러면 차트 압축 파일을 다운로드 받은 후에 압축을 풀고나서, 내용을 수정하고 설치에 사용해야 하는 불편함이 있다.
이렇게 일일이 수정하지 않고 CLI에서 변경하고 싶은 인자만 간단하게 지정할 수 있는 방법이 없을까?
helm install 이나 upgrade시에 --set 옵션을 사용하면 된다. 예를 들어 values.yaml에 정의된 replicaCount를 10으로 변경하고자 하면 다음과 같이 하면 된다. %helm template --name myrelease --set replicaCount=10 ./helloworld
아래는 template 명령을 이용해서 테스트한 결과이다. replicas가 10으로 변경된것을 볼 수 있다.
---
# Source: helloworld/templates/helloworld.yaml
apiVersion: apps/v1beta2
kind: Deployment
만약 설정값이 많아서 --set 을 이용해서 parameter로 넘기기가 어렵다면, 필요한 변수만 파일로 만들어서 넘길 수 있다.
예를 들어 myvalue.yaml 에 아래와 같이 name만 “fromValuefile” 로 정의를 한후에,
name: "fromValuefile"
helm install에서 -f 옵션으로 value 파일을 지정할 수 있다.
%helm install -f myvalues.yaml --name newrelease --dry-run --debug ./helloworld
결과를 보면 다음과 같다.
# Source: helloworld/templates/helloworld.yaml
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: fromValuefile-deployment
spec:
replicas: 3
:
myvalues.yaml에 지정한 name에 의해서 Deployment name이 fromValuefile-deployment로 변경되고, replica 수는 원래 values.yaml에 지정한대로 3을 사용한 것을 확인할 수 있다.
디렉토리 구조
개념을 이해 하였으면, 파일을 어디에 저장하는지 디렉토리 구조를 살펴보자, helloworld라는 차트를 만들 것인데, helloworld라는 디렉토리를 만든다.
그리고 그 아래 템플릿들은 templates 라는 디렉토리에 yaml 로 정의한다. 여기에 채울 value들은 helloworld/values.yaml 파일내에 저장한다.
그리고 helloworlds/Chart.yaml 이라는 파일을 생성해야 하는데, 이 파일에는 이 헬름 차트에 대한 버전이나 작성자, 차트 이름과 같은 메타 정보를 정의한다.
다음은 Chart.yaml 의 내용이다.
apiVersion: v1
appVersion: "1.0"
description: A Helm chart for Kubernetes
name: helloworld
version: 0.1.0
테스트(검증)
헬름 차트 작성이 끝났으면 제대로 작동하는지 검증을 해볼 수 있다. 먼저 문법적인 오류가 없는지 확인 하는 명령은 helm lint 명령을 사용하면 된다. 명령어 실행은 차트 디렉토리 위에서 해야 한다. 이 예제에서는 ../helloworld 디렉토리가 된다.
실행하면 다음과 같은 결과를 볼 수 있다.
%helm linit ./helloworld
==> Linting ./helloworld/
[INFO] Chart.yaml: icon is recommended
1 chart(s) linted, no failures
문법적인 오류가 없는지 점검을 해준다. 다음으로 탬플릿에 밸류가 제대로 적용되서 원하는 YAML을 제대로 생성해나가는지 검증해야 하는데, helm template이라는 명령어를 사용하면 된다. helm lint 명령과 마찬가지로 차트가 저장된 디렉토리의 상위 디렉토리 (../helloworld)에서 실행한다.
다음은 helm template 명령을 실행한 결과이다.
%helm template ./helloworld
# Source: helloworld/templates/helloworld.yaml
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: helloworld-deployment
spec:
replicas: 2
minReadySeconds: 5
selector:
matchLabels:
app: helloworld
template:
metadata:
name: helloworld-pod
labels:
app: helloworld
spec:
containers:
- name: helloworld
image: gcr.io/terrycho-sandbox/helloworlds:v1
imagePullPolicy: Always
ports:
- containerPort: 8080
내용 처럼 Value.name과 Value.replicaCount 값이 채워져서 Deployment 리소스에 대한 YAML 파일이 생성된것을 확인할 수 있다.
helm template 명령을 helm 클라이언트에서 tiller 서버 접속없이 template에 값이 채워지는지만 테스트를 하는 것이고, tiller 서버에 연결해서 테스트 할 경우에는 helm install --dry-run 옵션을 사용한다. 그리고, 내용을 확인하기 위해서 --debug 옵션을 추가한다.
helm install --name myrelease --dry-run --debug ./helloworld 이렇게 명령어를 사용하면 되는데, 장점은, 실제 서버에 연결해서 같은 릴리즈 버전이 있는지 등의 체크를 해주기 때문에, 실수를 막을 수 있다.
아래는 같은 릴리즈 버전으로 설치하는 것을 --dry-run으로 테스트한 결과이다.
% helm install --name myrelease --dry-run --debug ./helloworld
[debug] Created tunnel using local port: '56274'
[debug] SERVER: "127.0.0.1:56274"
[debug] Original chart version: ""
[debug] CHART PATH: /Users/terrycho/dev/workspace/kube/kubernetes-tutorial/31.helm/helloworld
Error: a release named myrelease already exists.
Run: helm ls --all myrelease; to check the status of the release
Or run: helm del --purge myrelease; to delete it
차트를 같은 이름(릴리즈명/뒤에서 다시 설명함)이 있기 때문에 설치할 수 없다 것을 테스트 단계에서 미리 확인할 수 있다.
실제 설치
그러면 생성한 헬름 차트를 이용해서 쿠버네티스에 리소스를 실제로 설치해보자. 설치 방법은 차트가 있는 디렉토리에서 helm install 명령을 이용해서 인스톨을 하면 된다. 이때 --name이라는 이름으로 설치된 차트 인스턴스의 이름을 설정해줘야 한다. 만약에 이름을 정해주지 않으면 임의의 이름이 자동으로 생성되어 사용된다.
%helm install --name helloworld ./helloworld/
명령을 실행하면 아래와 같이 deployment가 생성되는 것을 확인할 수 있다. 예제에서 설명은 하지 않았지만, 테스트에 사용된 코드에는 Service를 배포하는 부분이 함께 포함되어 있기 때문에 아래 실행결과를 보면 Service까지 같이 생성된것을 확인할 수 있다.
NAME: helloworld
LAST DEPLOYED: Fri Jun 7 23:01:44 2019
NAMESPACE: default
STATUS: DEPLOYED
RESOURCES:
==> v1beta2/Deployment
NAME AGE
helloworld-deployment 1s
==> v1/Pod(related)
NAME READY STATUS RESTARTS AGE
helloworld-deployment-696fc568f9-mc6mz 0/1 ContainerCreating 0 0s
helloworld-deployment-696fc568f9-nsw48 0/1 ContainerCreating 0 0s
==> v1/Service
NAME AGE
helloworld-svc 1s
설치가 완료되었으면 리소스가 제대로 생성되었는지 확인을 해보기 위해서 kubectl get deploy 명령을 실행한다.
%kubectl get deploy
kubectl get deploy
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
helloworld-deployment 2 2 2 2 10m
위와 같이 Deployment 리소스가 생성 된것을 확인할 수 있다.
헬름을 통해서 설치된 차트들은 helm list 명령을 이용해서, 설치 상태를 확인할 수 있다.
helm list 명령을 실행해보면 아래와 같이 helloworld 차트가 설치된것을 확인할 수 있다.
%helm list
NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE
helloworld 1 Fri Jun 7 23:01:44 2019 DEPLOYED helloworld-0.1.0 1.0