| 최신판 |
당신의 편집 |
| 72번째 줄: |
72번째 줄: |
| [https://github.com/helm/helm/releases/tag/v3.3.2 v3.3.2] 버전부터 추가 필드는 허용되지 않습니다. 권장되는 방법은 <code>annotations</code>에 커스텀 메타데이터를 추가하는 것입니다. | | [https://github.com/helm/helm/releases/tag/v3.3.2 v3.3.2] 버전부터 추가 필드는 허용되지 않습니다. 권장되는 방법은 <code>annotations</code>에 커스텀 메타데이터를 추가하는 것입니다. |
|
| |
|
| ===차트와 버전 관리=== | | ===차트와 버전 부여=== |
| 모든 차트에는 버전 번호가 있어야 합니다. 버전은 [https://semver.org/spec/v2.0.0.html SemVer 2] 표준을 따라야 합니다. Helm Classic과 달리, Helm v2 및 이후 버전에서는 버전 번호를 릴리스 마커로 사용합니다. 리포지토리의 패키지는 이름과 버전으로 식별됩니다.
| |
| | |
| 예를 들어, 버전 필드가 <code>version: 1.2.3</code>로 설정된 <code>nginx</code> 차트는 다음과 같이 명명됩니다:
| |
| | |
| <syntaxhighlight lang='text'>
| |
| nginx-1.2.3.tgz
| |
| </syntaxhighlight>
| |
| | |
| 더 복잡한 SemVer 2 이름도 지원되며, 예를 들어 <code>version: 1.2.3-alpha.1+ef365</code>와 같은 이름도 사용할 수 있습니다. 그러나 비-SemVer 이름은 시스템에서 명시적으로 금지됩니다.
| |
| | |
| 참고: Helm Classic과 Deployment Manager는 차트와 관련하여 GitHub 지향적이었지만, Helm v2 및 이후 버전에서는 GitHub이나 Git을 요구하지 않습니다. 따라서 Git SHA를 버전 관리에 사용하지 않습니다.
| |
| | |
| <code>Chart.yaml</code> 내부의 <code>version</code> 필드는 CLI를 포함한 많은 Helm 도구에서 사용됩니다. 패키지를 생성할 때 <code>helm package</code> 명령어는 <code>Chart.yaml</code>에서 찾은 버전 번호를 패키지 이름의 토큰으로 사용합니다. 시스템은 차트 패키지 이름의 버전 번호가 <code>Chart.yaml</code>의 버전 번호와 매치한다고 가정합니다. 이 가정을 충족하지 않으면 오류가 발생합니다.
| |
| | |
| ===<code>apiVersion</code> 필드===
| |
| Helm 3 이상이 필요한 Helm 차트의 경우 <code>apiVersion</code> 필드는 <code>v2</code>여야 합니다. 이전 Helm 버전을 지원하는 차트는 <code>apiVersion</code>이 <code>v1</code>로 세팅되어 있으며, 여전히 Helm 3으로 설치가능합니다.
| |
| | |
| <code>v1</code>에서 <code>v2</code>로의 변경사항:
| |
| | |
| * 차트 의존성을 정의하는 <code>dependencies</code> 필드가 추가되었습니다. <code>v1</code> 차트에서는 이 필드가 별도의 <code>requirements.yaml</code> 파일에 있었습니다([[#차트 의존성|차트 의존성]] 참조).
| |
| * 차트 유형을 구분하는 <code>type</code> 필드가 추가되었습니다. 이를 통해 애플리케이션 차트와 라이브러리 차트를 구별할 수 있습니다([[#차트 유형|차트 유형]] 참조).
| |
| | |
| ===<code>appVersion</code> 필드===
| |
| <code>appVersion</code> 필드는 <code>version</code> 필드와 관련이 없습니다. 이 필드는 애플리케이션의 버전을 지정하는 방법입니다. 예를 들어, <code>drupal</code> 차트는 <code>appVersion: "8.2.1"</code>을 가질 수 있으며, 이는 기본적으로 포함된 Drupal 버전이 <code>8.2.1</code>임을 나타냅니다. 이 필드는 정보 제공용이며 차트 버전 계산에는 영향을 미치지 않습니다. 버전을 따옴표로 묶는 것이 매우 권장됩니다. 이는 YAML 파서가 버전 번호를 문자열로 처리하도록 강제합니다. 따옴표 없이 두면 일부 경우에 파싱 문제가 발생할 수 있습니다. 예를 들어, YAML은 <code>1.0</code>을 부동 소수점 값으로 해석하고, <code>1234e10</code> 같은 git 커밋 SHA를 과학적 표기법으로 해석합니다.
| |
| | |
| Helm v3.5.0부터 <code>helm create</code> 명령어는 기본적으로 <code>appVersion</code> 필드를 따옴표로 묶습니다.
| |
| | |
| ===<code>kubeVersion</code> 필드===
| |
| 선택적인 <code>kubeVersion</code> 필드는 지원되는 Kubernetes 버전에 대한 semver 제약조건을 정의할 수 있습니다. Helm은 차트를 설치할 때 버전 제약조건을 확인하고 클러스터가 지원되지 않는 Kubernetes 버전을 실행하는 경우 실패합니다.
| |
| | |
| 버전 제약조건은 다음과 같이 공백으로 구분된 AND 비교로 구성될 수 있습니다.
| |
| | |
| <syntaxhighlight lang='text'>
| |
| >= 1.13.0 < 1.15.0
| |
| </syntaxhighlight>
| |
| | |
| 이 비교는 OR <code>||</code> 연산자로 결합될 수 있습니다. 예를 들어
| |
| | |
| <syntaxhighlight lang='text'>
| |
| >= 1.13.0 < 1.14.0 || >= 1.14.1 < 1.15.0
| |
| </syntaxhighlight>
| |
| | |
| 이 예시에서는 <code>1.14.0</code> 버전이 제외되는데, 이는 특정 버전의 버그로 인해 차트가 제대로 실행되지 않는 경우 유용할 수 있습니다.
| |
| | |
| <code>=</code>, <code>!=</code>, <code>></code>, <code><</code>, <code>>=</code>, <code><=</code> 연산자를 사용하는 버전 제약조건 외에도 다음과 같은 축약 표기법이 지원됩니다:
| |
| | |
| * 폐쇄 구간에 대한 하이픈 범위: <code>1.1 - 2.3.4</code>는 <code>>= 1.1 <= 2.3.4</code>와 동등합니다.
| |
| * 와일드카드 <code>x</code>, <code>X</code>, <code>*</code>: <code>1.2.x</code>는 <code>>= 1.2.0 < 1.3.0</code>와 동등합니다.
| |
| * 틸드 범위 (패치 버전 변경 허용): <code>~1.2.3</code>는 <code>>= 1.2.3 < 1.3.0</code>와 동등합니다.
| |
| * 캐럿 범위 (마이너 버전 변경 허용): <code>^1.2.3</code>는 <code>>= 1.2.3 < 2.0.0</code>와 동등합니다.
| |
| | |
| 지원되는 semver 제약조건에 대한 자세한 설명은 [https://github.com/Masterminds/semver Masterminds/semver]를 참조하십시오.
| |
|
| |
|
| | ===apiVersion 필드=== |
| | ===appVersion 필드=== |
| | ===kubeVersion 필드=== |
| ===차트 지원중단=== | | ===차트 지원중단=== |
| 차트 리포지토리에서 차트를 관리할 때, 때로는 차트를 지원중단해야 할 필요가 있습니다. <code>Chart.yaml</code>의 선택적 필드인 <code>deprecated</code>를 사용하여 차트를 지원중단 상태로 표시할 수 있습니다. 리포지토리 내의 최신 버전의 차트가 지원중단된 것으로 표시되면, 해당 차트는 전체적으로 지원중단된 것으로 간주됩니다. 이후에 지원중단 상태로 표시되지 않은 최신 버전을 게시함으로써 차트 이름을 다시 사용할 수 있습니다. 차트를 지원중단하는 워크플로우는 다음과 같습니다:
| |
|
| |
| * 1. 차트의 <code>Chart.yaml</code>을 업데이트하여 차트를 지원중단 상태로 표시하고, 버전을 올립니다.
| |
| * 2. 새 차트 버전을 차트 리포지토리에 릴리스합니다.
| |
| * 3. 소스 리포지토리(예: git)에서 차트를 제거합니다.
| |
|
| |
| ===차트 유형=== | | ===차트 유형=== |
| <code>type</code> 필드는 차트의 유형을 정의합니다. <code>application</code>과 <code>library</code>의 두 가지 유형이 있습니다. 애플리케이션이 기본 유형이며, 이는 완전히 조작할 수 있는 표준 차트입니다. [[라이브러리 차트]]는 차트 빌더에 유틸리티나 함수를 제공합니다. 라이브러리 차트는 설치할 수 없으며 일반적으로 리소스 객체를 포함하지 않는다는 점에서 애플리케이션 차트와 다릅니다.
| |
|
| |
| 참고: 애플리케이션 차트는 라이브러리 차트로 사용할 수 있습니다. type을 <code>library</code>로 세팅하면 이 차트는 라이브러리 차트로 렌더링되어 모든 유틸리티와 함수를 활용할 수 있습니다. 차트의 모든 리소스 객체는 렌더링되지 않습니다.
| |
|
| |
|
| ==차트 LICENSE, README, NOTES== | | ==차트 LICENSE, README, NOTES== |
| 315번째 줄: |
257번째 줄: |
| ====전역 Values==== | | ====전역 Values==== |
| ===스키마 파일=== | | ===스키마 파일=== |
| 때로는 차트 유지관리자가 값(values)에 구조를 정의하고 싶어할 수 있습니다. 이는 <code>values.schema.json</code> 파일에 스키마를 정의하여 수행할 수 있습니다. 스키마는 [https://json-schema.org/ JSON Schema]로 표현되며, 다음과 같이 생겼습니다:
| |
|
| |
| <syntaxhighlight lang='json'>
| |
| {
| |
| "$schema": "https://json-schema.org/draft-07/schema#",
| |
| "properties": {
| |
| "image": {
| |
| "description": "Container Image",
| |
| "properties": {
| |
| "repo": {
| |
| "type": "string"
| |
| },
| |
| "tag": {
| |
| "type": "string"
| |
| }
| |
| },
| |
| "type": "object"
| |
| },
| |
| "name": {
| |
| "description": "Service name",
| |
| "type": "string"
| |
| },
| |
| "port": {
| |
| "description": "Port",
| |
| "minimum": 0,
| |
| "type": "integer"
| |
| },
| |
| "protocol": {
| |
| "type": "string"
| |
| }
| |
| },
| |
| "required": [
| |
| "protocol",
| |
| "port"
| |
| ],
| |
| "title": "Values",
| |
| "type": "object"
| |
| }
| |
| </syntaxhighlight>
| |
|
| |
| 이 스키마는 값(values)을 검증하기 위해 적용됩니다. 다음 명령어들이 실행될 때 검증이 이루어집니다:
| |
|
| |
| * <code>helm install</code>
| |
| * <code>helm upgrade</code>
| |
| * <code>helm lint</code>
| |
| * <code>helm template</code>
| |
|
| |
| 이 스키마 요구사항을 충족하는 <code>values.yaml</code> 파일 예시는 다음과 같습니다:
| |
|
| |
| <syntaxhighlight lang='yaml'>
| |
| name: frontend
| |
| protocol: https
| |
| port: 443
| |
| </syntaxhighlight>
| |
|
| |
| 스키마는 최종 <code>.Values</code> 객체에 적용되며, 단순히 <code>values.yaml</code> 파일에만 적용되는 것은 아닙니다. 이는 아래와 같이 <code>--set</code> 옵션을 사용하여 차트를 설치하면 다음 <code>yaml</code> 파일이 유효함을 의미합니다.
| |
|
| |
| <syntaxhighlight lang='yaml'>
| |
| name: frontend
| |
| protocol: https
| |
| </syntaxhighlight>
| |
| <syntaxhighlight lang='bash'>
| |
| helm install --set port=443
| |
| </syntaxhighlight>
| |
|
| |
| 또한, 최종 <code>.Values</code> 객체는 모든 하위 차트 스키마에 대해 검증됩니다. 이는 상위 차트에서 하위 차트의 제한을 회피할 수 없음을 의미합니다. 이 역방향도 마찬가지로 작동합니다. 하위 차트의 <code>values.yaml</code> 파일에서 요구사항이 충족되지 않은 경우, 상위 차트는 유효하기 위해 해당 제약사항을 만족해야 합니다.
| |
|
| |
| ===참고자료=== | | ===참고자료=== |
| 템플릿 작성, 값 설정, 스키마 파일 작업에 있어 도움이 되는 여러 표준 참고 자료가 있습니다.
| | ==커스텀 리소스 정의 (CRD)== |
| | |
| * [https://godoc.org/text/template Go 템플릿]
| |
| * [https://godoc.org/github.com/Masterminds/sprig 부가 템플릿 함수]
| |
| * [https://yaml.org/spec/ YAML 형식]
| |
| * [https://json-schema.org/ JSON 스키마]
| |
| | |
| ==커스텀 리소스 정의(CRD)== | |
| Kubernetes는 새로운 유형의 Kubernetes 객체를 선언할 수 있는 메커니즘을 제공합니다. CustomResourceDefinitions(CRD)를 사용하여 Kubernetes 개발자는 커스텀 리소스 타입을 선언할 수 있습니다.
| |
| | |
| Helm 3에서는 CRD를 특별한 종류의 객체로 취급합니다. CRD는 차트의 나머지 부분이 설치되기 전에 설치되며 몇 가지 제한사항이 있습니다.
| |
| | |
| CRD YAML 파일은 차트 내부의 <code>crds/</code> 디렉토리에 배치해야 합니다. 여러 CRD는 YAML 시작 및 종료 마커로 구분하여 동일한 파일에 배치할 수 있습니다. Helm은 CRD 디렉토리의 모든 파일을 Kubernetes에 로드하려고 시도합니다.
| |
| | |
| CRD 파일은 템플릿화할 수 없습니다. 즉, 단순한 YAML 문서여야 합니다.
| |
| | |
| Helm이 새 차트를 설치할 때, CRD를 업로드하고 API 서버에 의해 CRD가 사용가능해질 때까지 잠시 대기한 후 템플릿 엔진을 시작하여 나머지 차트를 렌더링하고 이를 Kubernetes에 업로드합니다. 이러한 순서 때문에 CRD 정보는 Helm 템플릿의 <code>.Capabilities</code> 객체에 제공되며, Helm 템플릿은 CRD에서 선언된 객체의 새 인스턴스를 만들 수 있습니다.
| |
| | |
| 예를 들어, 차트에 <code>crds/</code> 디렉토리에 대한 <code>CronTab</code> CRD가 있는 경우 <code>templates/</code> 디렉토리에서 <code>CronTab</code> 종류의 인스턴스를 만들 수 있습니다:
| |
| | |
| <syntaxhighlight lang='text'>
| |
| crontabs/
| |
| Chart.yaml
| |
| crds/
| |
| crontab.yaml
| |
| templates/
| |
| mycrontab.yaml
| |
| </syntaxhighlight>
| |
| | |
| <code>crontab.yaml</code> 파일에는 템플릿 지시어 없이 CRD가 포함되어야 합니다:
| |
| | |
| <syntaxhighlight lang='yaml'>
| |
| kind: CustomResourceDefinition
| |
| metadata:
| |
| name: crontabs.stable.example.com
| |
| spec:
| |
| group: stable.example.com
| |
| versions:
| |
| - name: v1
| |
| served: true
| |
| storage: true
| |
| scope: Namespaced
| |
| names:
| |
| plural: crontabs
| |
| singular: crontab
| |
| kind: CronTab
| |
| </syntaxhighlight>
| |
| | |
| 그런 다음 템플릿 <code>mycrontab.yaml</code>은 새 <code>CronTab</code>을 다음과 같이 생성할 수 있습니다(일반적인 템플릿 사용):
| |
| | |
| <syntaxhighlight lang='yaml'>
| |
| apiVersion: stable.example.com
| |
| kind: CronTab
| |
| metadata:
| |
| name: {{ .Values.name }}
| |
| spec:
| |
| # ...
| |
| </syntaxhighlight>
| |
| | |
| Helm은 <code>CronTab</code> 종류가 설치되어 Kubernetes API 서버에서 사용가능해질 때까지 기다렸다가 <code>templates/</code> 내의 항목들을 설치합니다.
| |
| | |
| ===CRD 제한사항=== | | ===CRD 제한사항=== |
| 다른 대부분의 Kubernetes 객체와 달리, CRD는 전역적으로 설치됩니다. 이 때문에 Helm은 CRD를 관리할 때 매우 신중한 접근방식을 취합니다. CRD는 다음과 같은 제한사항이 적용됩니다:
| |
|
| |
| * CRD는 절대 재설치되지 않습니다. Helm이 <code>crds/</code> 디렉토리에 있는 CRD가 이미 존재한다고 판단하면(버전과 관계없이), Helm은 설치 또는 업그레이드를 시도하지 않습니다.
| |
| * CRD는 업그레이드 또는 롤백 시 설치되지 않습니다. Helm은 설치 작업에서만 CRD를 생성합니다.
| |
| * CRD는 절대 삭제되지 않습니다. CRD를 삭제하면 클러스터의 모든 네임스페이스에서 해당 CRD의 모든 내용이 자동으로 삭제됩니다. 따라서 Helm은 CRD를 삭제하지 않습니다.
| |
|
| |
| 운영자는 CRD를 업그레이드하거나 삭제할 때 수동으로 수행하고 매우 신중하게 처리해야 합니다.
| |
|
| |
| ==헬름을 사용한 차트 관리== | | ==헬름을 사용한 차트 관리== |
| <code>helm</code> 도구는 차트 작업을 위해 여러 명령어를 제공합니다.
| |
|
| |
| 새 차트를 생성할 수 있습니다:
| |
| <syntaxhighlight lang='console'>
| |
| $ helm create mychart
| |
| Created mychart/
| |
| </syntaxhighlight>
| |
|
| |
| 차트를 편집한 후, <code>helm</code>을 사용하여 차트를 아카이브로 패키징할 수 있습니다:
| |
|
| |
| <syntaxhighlight lang='console'>
| |
| $ helm package mychart
| |
| Archived mychart-0.1.-.tgz
| |
| </syntaxhighlight>
| |
|
| |
| 또한 <code>helm</code>을 사용하여 차트의 형식이나 정보에 문제가 있는지 확인할 수 있습니다:
| |
|
| |
| <syntaxhighlight lang='console'>
| |
| $ helm lint mychart
| |
| No issues found
| |
| </syntaxhighlight>
| |
|
| |
| ==차트 리포지토리== | | ==차트 리포지토리== |
| 차트 리포지토리는 하나 이상의 패키지 차트를 보유한 HTTP 서버입니다. <code>helm</code>을 사용하여 로컬 차트 디렉토리를 관리할 수 있지만, 차트를 공유할 때 선호되는 메커니즘은 차트 리포지토리입니다.
| |
|
| |
| YAML 파일과 tar 파일을 제공하고 GET 요청에 응답할 수 있는 모든 HTTP 서버는 리포지토리 서버로 사용될 수 있습니다. 헬름 팀은 Google Cloud Storage와 웹사이트 모드가 활성화된 S3를 포함한 일부 서버를 테스트했습니다.
| |
|
| |
| 리포지토리는 제공하는 모든 패키지 목록과 이러한 패키지를 검색하고 검증할 수 있는 메타데이터가 포함된 특수 파일인 <code>index.yaml</code>의 존재로 특징지어집니다.
| |
|
| |
| 클라이언트 측에서는 <code>helm repo</code> 명령어로 리포지토리를 관리합니다. 그러나 헬름은 원격 리포지토리 서버에 차트를 업로드하는 도구를 제공하지 않습니다. 이는 구현 서버에 상당한 요구사항을 추가하고, 리포지토리 설정의 장벽을 높일 수 있기 때문입니다.
| |
|
| |
| ==차트 스타터 팩== | | ==차트 스타터 팩== |
| <code>helm create</code> 명령어는 선택적인 <code>--starter</code> 옵션을 사용하여 "스타터 차트"를 지정할 수 있습니다. 또한, <code>--starter</code> 옵션의 짧은 별칭으로 <code>-p</code>를 사용할 수 있습니다.
| |
|
| |
| 사용 예시:
| |
| <syntaxhighlight lang='bash'>
| |
| helm create my-chart --starter starter-name
| |
| helm create my-chart -p starter-name
| |
| helm create my-chart -p /absolute/path/to/starter-name
| |
| </syntaxhighlight>
| |
|
| |
| 스타터는 그냥 일반 차트지만 <code>$XDG_DATA_HOME/helm/starters</code>에 위치합니다. 차트 개발자로서, 스타터로 사용하기 위해 특별히 설계된 차트를 작성할 수 있습니다. 이러한 차트는 다음 사항을 염두에 두고 설계되어야 합니다:
| |
| * Chart.yaml은 생성기에 의해 덮어쓰여집니다.
| |
| * 사용자는 그러한 차트의 내용을 수정할 것으로 예상되므로, 사용자가 이를 어떻게 수정할 수 있는지에 대한 문서를 제공해야 합니다.
| |
| * 모든 <code><CHARTNAME></code>은 지정된 차트 이름으로 대체되어 스타터 차트를 템플릿으로 사용할 수 있습니다. 단, 일부 변수 파일에서는 제외됩니다. 예를 들어, <code>vars</code> 디렉토리나 특정 <code>README.md</code> 파일에서 사용되는 커스텀 파일에서는 <code><CHARTNAME></code>이 대체되지 않습니다. 추가적으로, 차트 설명은 상속되지 않습니다.
| |
