Skip to content

Commit fd4ac35

Browse files
kty1965kty1965
kty1965
and
kty1965
authored
refactor(application-template): update common, component labels (#7)
* refactor(application-template): update common, component labels * feat(application-template): convention 문서 분리 * chore(application-template): remove test files * refactor(application-template): rename matchLabels to selectorLabels & env labels * feat(application-template): destinationRules.subset tpl function으로 변경 --------- Co-authored-by: kty1965 <[email protected]>
1 parent 09d82dd commit fd4ac35

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+289
-111
lines changed

‎.editorconfig

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
##########################################
2+
# Common Settings
3+
##########################################
4+
5+
# This file is the top-most EditorConfig file
6+
root = true
7+
8+
# All files
9+
[*]
10+
charset = utf-8
11+
end_of_line = lf
12+
indent_size = 2
13+
indent_style = space
14+
insert_final_newline = true
15+
trim_trailing_whitespace = true
16+
max_line_length = 140
17+
18+
#########################################
19+
# File Extension Settings
20+
##########################################
21+
[*.{tf,tfvars}]
22+
indent_size = 2
23+
indent_style = space
24+
25+
[*.{yml,yaml}]
26+
indent_size = 2
27+
indent_style = space
28+
29+
[*.md]
30+
max_line_length = 0
31+
trim_trailing_whitespace = false
32+
33+
[*.json]
34+
indent_size = 2
35+
indent_style = space
36+
37+
[*.sh]
38+
indent_size = 2
39+
indent_style = space
40+
41+
[Makefile]
42+
tab_width = 2
43+
indent_style = tab
44+
45+
[COMMIT_EDITMSG]
46+
max_line_length = 0

‎.gitignore

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Local .terraform directories
2+
**/.terraform/*
3+
4+
# .tfstate files
5+
*.tfstate
6+
*.tfstate.*
7+
8+
# Crash log files
9+
crash.log
10+
11+
# Ignore any .tfvars files that are generated automatically for each Terraform run. Most
12+
# .tfvars files are managed as part of configuration and so should be included in
13+
# version control.
14+
#
15+
# example.tfvars
16+
17+
# Ignore override files as they are usually used to override resources locally and so
18+
# are not checked in
19+
override.tf
20+
override.tf.json
21+
*_override.tf
22+
*_override.tf.json
23+
24+
# Include override files you do wish to add to version control using negated pattern
25+
#
26+
# !example_override.tf
27+
28+
# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
29+
# example: *tfplan*
30+
.terraform.lock.hcl
31+
.build
32+
.idea/
33+
.DS_Store
34+
src/kubeconfig/
35+
live/**/kubeconfig_*
36+
.envrc
37+
38+
secrets.tfvars
39+
40+
node_modules

‎.pre-commit-config.yaml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.0.1
4+
hooks:
5+
- id: check-yaml
6+
exclude: '((charts|chart)/(.*)|(.*).tpl(.*)|(.*).tmpl(.*))'
7+
- id: end-of-file-fixer
8+
- id: trailing-whitespace
9+
- id: check-case-conflict
10+
- id: check-added-large-files
11+
args:
12+
- '--maxkb=5120'
13+
- repo: https://github.com/pre-commit/pre-commit-hooks
14+
rev: v3.4.0
15+
hooks:
16+
- id: check-merge-conflict
17+
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
18+
rev: v5.0.0
19+
hooks:
20+
- id: commitlint
21+
stages: [commit-msg]
22+
additional_dependencies: ['@commitlint/config-conventional']
23+
- repo: https://github.com/jumanjihouse/pre-commit-hooks
24+
rev: 2.1.5 # or specific git tag
25+
hooks:
26+
- id: shfmt
27+
name: shfmt
28+
- repo: https://github.com/gruntwork-io/pre-commit
29+
hooks:
30+
- id: helmlint
31+
rev: v0.1.17
32+
- repo: https://github.com/norwoodj/helm-docs
33+
hooks:
34+
- id: helm-docs
35+
files: (README\.md\.gotmpl|(Chart|requirements|values)\.yaml)$
36+
args:
37+
- --template-files=README.md.gotmpl
38+
rev: v1.6.0

‎charts/application-template/CONVENTION.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Convention
2+
3+
## Application Labels
4+
5+
### Common Labels
6+
7+
| Name | Required | Description | Example |
8+
| ---- | ------ | --- | --- |
9+
| app.kubernetes.io/name | true | 차트 내 실행단위(`Deployment`, `StatefulSet`, `Rollout` 등)에 Specific 하도록 사용 | `document-server`, `document-worker`, `document-scheduler` |
10+
| helm.sh/chart | true | 해당 차트를 만든 정보 `{{ .Chart.Name }}-{{ .Chart.Version \| replace "+" "_" }}` | `application-template-1.3.0` |
11+
| app.kubernetes.io/managed-by | true | 항상 `{{ .Release.Service }}` 로 설정해야 한다. 헬름이 관리하는 모든 것을 찾기 위한 것| `Helm` |
12+
| app.kubernetes.io/instance | true | `{{ .Release.Name }}` 이어야 한다. 최상위 애플리케이션의 다른 인스턴스들을 구별하기 위해 사용 | `document`, `user` |
13+
| app.kubernetes.io/version | true | 차트 내 실행단위(`Deployment`, `StatefulSet`, `Rollout` 등)의 Version, 현재 1개의 image로 3개의 component를 실행하기에 모두 같음 | `7.3.1` |
14+
| app.kubernetes.io/component | true | 차트 내 실행 단위와 연관된 HighLevel 컴포넌트를 사용, 현재는 `app.kubernetes.io/name`과 유사 | `server`, `scheduler`, `worker` |
15+
| app.kubernetes.io/part-of | true | 최상위 애플리케이션의 이름 | `document`, `user` |
16+
17+
### Customize Labels
18+
19+
| Name | Required | Description | Example |
20+
| ---- | ------ | --- | --- |
21+
| app.modusign.co.kr/zone | true | [Customize] 애플리케이션 env 하위 환경 실행 Zone | `default`, `dev`, `org3`, etc |
22+
| app.kubernetes.io/env | true | [Customize] 애플리케이션 실행환경 | `prod`, `stage`, `dev` |
23+
| app | true | [Customize] 애플리케이션 Name | `document-server` |
24+
| version | true | [Customize] 애플리케이션 Name | `7.3.1` |
25+
| env | true | [Customize] 애플리케이션 실행환경 | `prod`, `stage`, `dev` |
26+
| tags.datadoghq.com/env | true | [Datadog] 애플리케이션 실행환경 | `prod`, `stage`, `dev` |
27+
| tags.datadoghq.com/service | true | [Datadog] 최상위 애플리케이션의 이름 | `document`, `user` |
28+
| tags.datadoghq.com/version | true | [Datadog] 애플리케이션 버전 정보, 현재 1개의 image로 3개의 component를 실행하기에 모두 같음 | `7.3.1` |

‎charts/application-template/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ maintainers:
99
- name: modusign
1010
url: https://github.com/modusign
1111
name: application-template
12-
version: 1.2.0
12+
version: 1.3.0

‎charts/application-template/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# application-template
22

3-
![Version: 1.2.0](https://img.shields.io/badge/Version-1.2.0-informational?style=flat-square) ![AppVersion: v1.0.0](https://img.shields.io/badge/AppVersion-v1.0.0-informational?style=flat-square)
3+
![Version: 1.3.0](https://img.shields.io/badge/Version-1.3.0-informational?style=flat-square) ![AppVersion: v1.0.0](https://img.shields.io/badge/AppVersion-v1.0.0-informational?style=flat-square)
44

55
A Helm chart for Modusign Applications
66

@@ -37,6 +37,7 @@ Kubernetes: `>=1.23`
3737
| global.podLabels | object | `{}` | Labels for the all deployed pods |
3838
| global.revisionHistoryLimit | int | `3` | Number of old deployment ReplicaSets to retain. The rest will be garbage collected. |
3939
| global.rolloutAnalysis | object | `{}` | Rollout analysis to be added to the all Rollout |
40+
| global.runtimeEnv | string | `"stage"` | Runtime env for app.kubernetes.io/env, env, tags.datadoghq.com/env labels |
4041
| global.serviceAccount.annotations | object | `{}` | Annotations applied to created service account |
4142
| global.serviceAccount.automountServiceAccountToken | bool | `false` | Automount API credentials for the Service Account |
4243
| global.serviceAccount.imagePullSecrets | list | `[]` | Image pull Secrets for the Service Account |
@@ -71,7 +72,6 @@ Kubernetes: `>=1.23`
7172
| scheduler.istio.ingressGateways | list | `[]` | ingress gateway configuration |
7273
| scheduler.istio.virtualServices | list | `[]` | virtualService configuration |
7374
| scheduler.lifecycle | object | `{}` | Specify postStart and preStop lifecycle hooks for your container |
74-
| scheduler.name | string | `"application-template-scheduler"` | scheduler name |
7575
| scheduler.nodeSelector | object | `{}` (defaults to global.nodeSelector) | [Node selector] |
7676
| scheduler.pdb.annotations | object | `{}` | Annotations to be added to scheduler pdb |
7777
| scheduler.pdb.enabled | bool | `false` | Deploy a [PodDisruptionBudget] for the scheduler |
@@ -127,7 +127,6 @@ Kubernetes: `>=1.23`
127127
| server.istio.ingressGateways | list | `[]` | ingress gateway configuration |
128128
| server.istio.virtualServices | list | `[]` | virtualService configuration |
129129
| server.lifecycle | object | `{}` | Specify postStart and preStop lifecycle hooks for your container |
130-
| server.name | string | `"application-template"` | server name |
131130
| server.nodeSelector | object | `{}` (defaults to global.nodeSelector) | [Node selector] |
132131
| server.pdb.annotations | object | `{}` | Annotations to be added to server pdb |
133132
| server.pdb.enabled | bool | `true` | Deploy a [PodDisruptionBudget] for the server |
@@ -181,7 +180,6 @@ Kubernetes: `>=1.23`
181180
| worker.istio.ingressGateways | list | `[]` | ingress gateway configuration |
182181
| worker.istio.virtualServices | list | `[]` | virtualService configuration |
183182
| worker.lifecycle | object | `{}` | Specify postStart and preStop lifecycle hooks for your container |
184-
| worker.name | string | `"application-template-worker"` | worker name |
185183
| worker.nodeSelector | object | `{}` (defaults to global.nodeSelector) | [Node selector] |
186184
| worker.pdb.annotations | object | `{}` | Annotations to be added to worker pdb |
187185
| worker.pdb.enabled | bool | `false` | Deploy a [PodDisruptionBudget] for the worker |

‎charts/application-template/templates/_helpers.tpl

+54-29
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
Expand the name of the chart.
33
*/}}
44
{{- define "application.name" -}}
5-
{{- default .Chart.Name .Values.server.name | trunc 63 | trimSuffix "-" }}
5+
{{- .Values.server.name | default (printf "%s-%s" .Release.Name "server") | trunc 63 | trimSuffix "-" }}
66
{{- end }}
77

88
{{- define "application.server.name" -}}
9-
{{- default .Chart.Name .Values.server.name | trunc 63 | trimSuffix "-" }}
9+
{{- .Values.server.name | default (printf "%s-%s" .Release.Name "server") | trunc 63 | trimSuffix "-" }}
1010
{{- end }}
1111

1212
{{- define "application.worker.name" -}}
13-
{{- default .Chart.Name .Values.worker.name | trunc 63 | trimSuffix "-" }}
13+
{{- .Values.worker.name | default (printf "%s-%s" .Release.Name "worker") | trunc 63 | trimSuffix "-" }}
1414
{{- end }}
1515

1616
{{- define "application.scheduler.name" -}}
17-
{{- default .Chart.Name .Values.scheduler.name | trunc 63 | trimSuffix "-" }}
17+
{{- .Values.scheduler.name | default (printf "%s-%s" .Release.Name "scheduler" ) | trunc 63 | trimSuffix "-" }}
1818
{{- end }}
1919

2020
{{/*
@@ -45,56 +45,81 @@ Create chart name and version as used by the chart label.
4545
{{/*
4646
Common labels
4747
*/}}
48-
{{- define "application.labels" -}}
49-
helm.sh/chart: {{ .Release.Name }}
50-
app.kubernetes.io/version: {{ .Release.Revision | quote }}
48+
{{- define "application.commonLabels" -}}
49+
helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
5150
app.kubernetes.io/managed-by: {{ .Release.Service }}
5251
app.modusign.co.kr/zone: {{ .Release.Namespace }}
52+
app.kubernetes.io/env: {{ .Values.global.runtimeEnv | default "stage" }}
53+
env: {{ .Values.global.runtimeEnv | default "stage" }}
54+
app.kubernetes.io/instance: {{ .Release.Name }}
55+
app.kubernetes.io/part-of: {{ .Release.Name }}
5356
{{- if .Values.global.observability.datadog.admissionController.enabled }}
54-
tags.datadoghq.com/env: {{ default "stage" .Values.global.env.DD_ENV}}
57+
tags.datadoghq.com/env: {{ .Values.global.env.DD_ENV | .Values.global.runtimeEnv | default "stage" }}
5558
tags.datadoghq.com/service: {{ .Release.Name }}
56-
tags.datadoghq.com/version: {{ .Release.Revision | quote }}
59+
tags.datadoghq.com/version: {{ .Values.global.image.tag | quote }}
5760
{{- end }}
5861
{{- with .Values.global.additionalLabels }}
5962
{{ toYaml . }}
6063
{{- end }}
6164
{{- end }}
6265

6366
{{/*
64-
Selector labels
67+
Each Component labels
6568
*/}}
66-
{{- define "application.server.selectorLabels" -}}
67-
app: {{ (.Values.server.name | default .Chart.Name )| lower}}
68-
version: {{ .Chart.Version }}
69+
{{- define "application.server.labels" -}}
70+
{{ include "application.commonLabels" . }}
71+
app.kubernetes.io/name: {{ include "application.server.name" . }}
72+
app.kubernetes.io/version: {{ include "application.server.image.tag" . }}
73+
app.kubernetes.io/component: server
74+
6975
{{- end }}
7076

71-
{{- define "application.scheduler.selectorLabels" -}}
72-
app: {{ (.Values.scheduler.name | default .Chart.Name )| lower}}
73-
version: {{ .Chart.Version | quote }}
77+
{{- define "application.scheduler.labels" -}}
78+
{{ include "application.commonLabels" . }}
79+
app.kubernetes.io/name: {{ include "application.scheduler.name" . }}
80+
app.kubernetes.io/version: {{ include "application.scheduler.image.tag" . }}
81+
app.kubernetes.io/component: scheduler
7482
{{- end }}
7583

76-
{{- define "application.worker.selectorLabels" -}}
77-
app: {{ (.Values.worker.name | default .Chart.Name )| lower}}
78-
version: {{ .Chart.Version | quote }}
84+
{{- define "application.worker.labels" -}}
85+
{{ include "application.commonLabels" . }}
86+
app.kubernetes.io/name: {{ include "application.worker.name" . }}
87+
app.kubernetes.io/version: {{ include "application.worker.image.tag" . }}
88+
app.kubernetes.io/component: worker
7989
{{- end }}
8090

8191

8292
{{/*
83-
matchLabels labels
93+
Image tags(version)
8494
*/}}
85-
{{- define "application.server.matchLabels" -}}
86-
app: {{ (.Values.server.name | default .Chart.Name )| lower}}
87-
version: {{ .Chart.Version }}
95+
{{- define "application.server.image.tag" -}}
96+
{{ .Values.server.image.tag | default .Values.global.image.tag }}
8897
{{- end }}
8998

90-
{{- define "application.scheduler.matchLabels" -}}
91-
app: {{ (.Values.scheduler.name | default .Chart.Name )| lower}}
92-
version: {{ .Chart.Version | quote }}
99+
{{- define "application.scheduler.image.tag" -}}
100+
{{ .Values.scheduler.image.tag | default .Values.global.image.tag }}
93101
{{- end }}
94102

95-
{{- define "application.worker.matchLabels" -}}
96-
app: {{ (.Values.worker.name | default .Chart.Name )| lower}}
97-
version: {{ .Chart.Version | quote }}
103+
{{- define "application.worker.image.tag" -}}
104+
{{ .Values.worker.image.tag | default .Values.global.image.tag }}
105+
{{- end }}
106+
107+
{{/*
108+
Selector labels
109+
*/}}
110+
{{- define "application.server.selectorLabels" -}}
111+
app: {{ include "application.server.name" . }}
112+
version: {{ include "application.server.image.tag" . }}
113+
{{- end }}
114+
115+
{{- define "application.scheduler.selectorLabels" -}}
116+
app: {{ include "application.scheduler.name" . }}
117+
version: {{ include "application.scheduler.image.tag" . }}
118+
{{- end }}
119+
120+
{{- define "application.worker.selectorLabels" -}}
121+
app: {{ include "application.worker.name" . }}
122+
version: {{ include "application.worker.image.tag" . }}
98123
{{- end }}
99124

100125

‎charts/application-template/templates/scheduler/config-map.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ kind: ConfigMap
55
metadata:
66
name: {{ include "application.scheduler.name" . }}-env
77
labels:
8-
{{- include "application.labels" . | nindent 4 }}
8+
{{- include "application.scheduler.labels" . | nindent 4 }}
99
data:
1010
{{- toYaml .Values.global.env | nindent 2 }}
1111
{{- end }}
@@ -18,7 +18,7 @@ kind: ConfigMap
1818
metadata:
1919
name: {{ .name }}
2020
labels:
21-
{{- include "application.labels" $ | nindent 4 }}
21+
{{- include "application.scheduler.labels" $ | nindent 4 }}
2222
data:
2323
{{- toYaml .data | nindent 2 }}
2424
{{- end }}

0 commit comments

Comments
 (0)