From 0ba7ff5aa6b92d01f644393e905b59bd7dbee24e Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Fri, 24 Apr 2020 13:21:30 +0800 Subject: [PATCH 01/10] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ec862a..345694f 100644 --- a/README.md +++ b/README.md @@ -704,7 +704,7 @@ The `common.serviceMonitor.secret` template accepts a list of three values: - `$serviceMonitor`, a dictionary of values used in the service account template - [optional] the template name of the overrides -It creates a `Secret` resource contains the BasicAuth information for the `SecretMonitor`. +It creates a `Secret` resource contains the BasicAuth information for the `ServiceMonitor`. An example `values.yaml` for your `ServiceMonitor` could look like: From a9680a40cf7d0ec3eafcae0d34ae5e911cd2fe6a Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Fri, 24 Apr 2020 13:23:04 +0800 Subject: [PATCH 02/10] docs: refine example for `common.container` --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 345694f..b3d5249 100644 --- a/README.md +++ b/README.md @@ -802,11 +802,13 @@ Example use: {{- include "common.deployment" (list . .Values .Values.autoscaling "mychart.deployment") -}} {{- define "mychart.deployment" -}} ## Define overrides for your Deployment resource here, e.g. +{{- $top := first . -}} +{{- $deployment := index . 1 -}} spec: template: spec: containers: - - {{- include "common.container" (append . "mychart.deployment.container") | nindent 8 }} + - {{- include "common.container" (list $top $deployment "mychart.deployment.container") | nindent 8 }} {{- end -}} {{- define "mychart.deployment.container" -}} ## Define overrides for your Container here, e.g. From dd6822704c1d0536e0e0fb303fc3fd907c3e1ea7 Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 09:40:34 +0800 Subject: [PATCH 03/10] feat: add `$pod.podAnnotations` --- README.md | 1 + templates/_pod.tpl | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/README.md b/README.md index b3d5249..3743b15 100644 --- a/README.md +++ b/README.md @@ -1054,6 +1054,7 @@ It also uses the following configuration from the `$pod`: | Value | Description | | ----- | ----------- | | `$pod.imagePullSecrets` | Names of secrets containing private registry credentials | +| `$pod.podAnnotations` | Pod annotations | | `$pod.podSecurityContext` | Security options | | `$pod.nodeSelector ` | Node labels for pod assignment | | `$pod.affinity ` | Expressions for affinity | diff --git a/templates/_pod.tpl b/templates/_pod.tpl index 72d4c7c..e1015b6 100644 --- a/templates/_pod.tpl +++ b/templates/_pod.tpl @@ -5,6 +5,10 @@ {{- $pod := index . 1 -}} {{- $serviceAccount := index . 2 -}} metadata: + {{- with $pod.podAnnotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} labels: {{- include "common.selectorLabels" $top | nindent 4 }} spec: From a0bfeb4cf632d6a39cfecd147289c6d1ce6e831b Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 10:27:26 +0800 Subject: [PATCH 04/10] style: remove most right whitespace chomps except those directly following a template definition --- README.md | 82 +++++++++++++-------------- templates/_configmap.yaml | 8 +-- templates/_container.yaml | 12 ++-- templates/_cronjob.yaml | 16 +++--- templates/_deployment.yaml | 14 ++--- templates/_hpa.yaml | 18 +++--- templates/_ingress.yaml | 30 +++++----- templates/_metadata.tpl | 16 +++--- templates/_name.tpl | 46 +++++++-------- templates/_pdb.yaml | 22 +++---- templates/_pod.tpl | 12 ++-- templates/_secret.yaml | 8 +-- templates/_service.yaml | 10 ++-- templates/_serviceaccount.yaml | 20 +++---- templates/_servicemonitor-secret.yaml | 20 +++---- templates/_servicemonitor.yaml | 26 ++++----- templates/_utils.tpl | 30 +++++----- 17 files changed, 195 insertions(+), 195 deletions(-) diff --git a/README.md b/README.md index 3743b15..6b1d4f9 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ The resource kind templates are designed to make it much faster for you to defin To make use of these templates you must define a template that will extend the base template (though it can be empty). The name of this template is then passed to the base template, for example: ```yaml -{{- include "common.service" (list . .Values.service "mychart.service") -}} +{{- include "common.service" (list . .Values.service "mychart.service") }} {{- define "mychart.service" -}} ## Define overrides for your Service resource here, e.g. # metadata: @@ -74,7 +74,7 @@ To make use of these templates you must define a template that will extend the b # targetPort: http # protocol: TCP # name: http -{{- end -}} +{{- end }} ``` Note that the [`common.service`](#commonservice) template defines three parameters: @@ -103,7 +103,7 @@ It creates an empty `ConfigMap` resource that you can override with your configu Example use: ```yaml -{{- include "common.configMap" (list . "mychart.configMap") -}} +{{- include "common.configMap" (list . "mychart.configMap") }} {{- define "mychart.configMap" -}} data: zeus: cat @@ -111,7 +111,7 @@ data: julius: cat one: |- {{ .Files.Get "file1.txt" }} -{{- end -}} +{{- end }} ``` Output: @@ -165,12 +165,12 @@ Underneath the hood, it invokes [`common.pod.template`](#commonpodtemplate) temp Example use: ```yaml -{{- include "common.cronJob" (list . .Values.cronJob .Values .Values.serviceAccount) -}} +{{- include "common.cronJob" (list . .Values.cronJob .Values .Values.serviceAccount) }} ## The following is the same as above: -# {{- include "common.cronJob" (list . .Values.cronJob .Values .Values.serviceAccount "mychart.cronJob") -}} +# {{- include "common.cronJob" (list . .Values.cronJob .Values .Values.serviceAccount "mychart.cronJob") }} # {{- define "mychart.cronJob" -}} -# {{- end -}} +# {{- end }} ``` @@ -203,12 +203,12 @@ Underneath the hood, it invokes [`common.pod.template`](#commonpodtemplate) temp Example use: ```yaml -{{- include "common.deployment" (list . .Values .Values.autoscaling .Values.serviceAccount) -}} +{{- include "common.deployment" (list . .Values .Values.autoscaling .Values.serviceAccount) }} ## The following is the same as above: -# {{- include "common.deployment" (list . .Values .Values.autoscaling .Values.serviceAccount "mychart.deployment") -}} +# {{- include "common.deployment" (list . .Values .Values.autoscaling .Values.serviceAccount "mychart.deployment") }} # {{- define "mychart.deployment" -}} -# {{- end -}} +# {{- end }} ``` @@ -239,12 +239,12 @@ autoscaling: Example use: ```yaml -{{- include "common.hpa" (list . .Values.autoscaling) -}} +{{- include "common.hpa" (list . .Values.autoscaling) }} ## The following is the same as above: -# {{- include "common.hpa" (list . .Values.autoscaling "mychart.hpa") -}} +# {{- include "common.hpa" (list . .Values.autoscaling "mychart.hpa") }} # {{- define "mychart.hpa" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -317,12 +317,12 @@ service: Example use: ```yaml -{{- include "common.ingress" (list . .Values.ingress .Values.service) -}} +{{- include "common.ingress" (list . .Values.ingress .Values.service) }} ## The following is the same as above: -# {{- include "common.ingress" (list . .Values.ingress .Values.service "mychart.ingress") -}} +# {{- include "common.ingress" (list . .Values.ingress .Values.service "mychart.ingress") }} # {{- define "mychart.ingress" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -384,12 +384,12 @@ podDisruptionBudget: Example use: ```yaml -{{- include "common.pdb" (list . .Values.podDisruptionBudget .Values .Values.autoscaling) -}} +{{- include "common.pdb" (list . .Values.podDisruptionBudget .Values .Values.autoscaling) }} ## The following is the same as above: -# {{- include "common.pdb" (list . .Values.podDisruptionBudget .Values .Values.autoscaling "mychart.pdb") -}} +# {{- include "common.pdb" (list . .Values.podDisruptionBudget .Values .Values.autoscaling "mychart.pdb") }} # {{- define "mychart.pdb" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -427,7 +427,7 @@ It creates an empty `Secret` resource that you can override with your secrets. Example use: ```yaml -{{- include "common.secret" (list . "mychart.secret") -}} +{{- include "common.secret" (list . "mychart.secret") }} {{- define "mychart.secret" -}} data: zeus: {{ print "cat" | b64enc }} @@ -435,7 +435,7 @@ data: julius: {{ print "cat" | b64enc }} one: |- {{ .Files.Get "file1.txt" | b64enc }} -{{- end -}} +{{- end }} ``` Output: @@ -478,9 +478,9 @@ It creates a basic `Service` resource with the following defaults: Example template: ```yaml -{{- include "common.service" (list . .Values.service "mychart.mail.service") -}} +{{- include "common.service" (list . .Values.service "mychart.mail.service") }} {{- define "mychart.mail.service" -}} -{{- $top := first . -}} +{{- $top := first . }} metadata: name: {{ include "common.fullname" $top }}-mail # overrides the default name to add a suffix labels: # appended to the labels section @@ -497,9 +497,9 @@ spec: protocol: mail {{- end }} --- -{{ include "common.service" (list . .Values.service "mychart.web.service") -}} +{{ include "common.service" (list . .Values.service "mychart.web.service") }} {{- define "mychart.web.service" -}} -{{- $top := first . -}} +{{- $top := first . }} metadata: name: {{ include "common.fullname" $top }}-www # overrides the default name to add a suffix labels: # appended to the labels section @@ -509,7 +509,7 @@ spec: - name: www port: 80 targetPort: 8080 -{{- end -}} +{{- end }} ``` The above template defines _two_ services: a web service and a mail service. @@ -593,12 +593,12 @@ serviceAccount: Example use: ```yaml -{{- include "common.serviceAccount" (list . .Values.serviceAccount) -}} +{{- include "common.serviceAccount" (list . .Values.serviceAccount) }} ## The following is the same as above: -# {{- include "common.serviceAccount" (list . .Values.serviceAccount "mychart.serviceAccount") -}} +# {{- include "common.serviceAccount" (list . .Values.serviceAccount "mychart.serviceAccount") }} # {{- define "mychart.serviceAccount" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -650,12 +650,12 @@ serviceMonitor: Example use: ```yaml -{{- include "common.serviceMonitor" (list . .Values.serviceMonitor) -}} +{{- include "common.serviceMonitor" (list . .Values.serviceMonitor) }} ## The following is the same as above: -# {{- include "common.serviceMonitor" (list . .Values.serviceMonitor "mychart.serviceMonitor") -}} +# {{- include "common.serviceMonitor" (list . .Values.serviceMonitor "mychart.serviceMonitor") }} # {{- define "mychart.serviceMonitor" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -719,12 +719,12 @@ serviceMonitor: Example use: ```yaml -{{- include "common.serviceMonitor.secret" (list . .Values.serviceMonitor) -}} +{{- include "common.serviceMonitor.secret" (list . .Values.serviceMonitor) }} ## The following is the same as above: -# {{- include "common.serviceMonitor.secret" (list . .Values.serviceMonitor "mychart.serviceMonitor.secret") -}} +# {{- include "common.serviceMonitor.secret" (list . .Values.serviceMonitor "mychart.serviceMonitor.secret") }} # {{- define "mychart.serviceMonitor.secret" -}} -# {{- end -}} +# {{- end }} ``` Output: @@ -799,17 +799,17 @@ It creates a basic `Container` spec to be used within a `Deployment` or `CronJob Example use: ```yaml -{{- include "common.deployment" (list . .Values .Values.autoscaling "mychart.deployment") -}} +{{- include "common.deployment" (list . .Values .Values.autoscaling "mychart.deployment") }} {{- define "mychart.deployment" -}} ## Define overrides for your Deployment resource here, e.g. -{{- $top := first . -}} -{{- $deployment := index . 1 -}} +{{- $top := first . }} +{{- $deployment := index . 1 }} spec: template: spec: containers: - {{- include "common.container" (list $top $deployment "mychart.deployment.container") | nindent 8 }} -{{- end -}} +{{- end }} {{- define "mychart.deployment.container" -}} ## Define overrides for your Container here, e.g. ports: @@ -824,7 +824,7 @@ readinessProbe: httpGet: path: / port: http -{{- end -}} +{{- end }} ``` The above example creates a `Deployment` resource which makes use of the `common.container` template to populate the `PodSpec`'s container list. The usage of this template is similar to the other resources, you must define and reference a template that contains overrides for the container object. @@ -986,7 +986,7 @@ metadata: # metadata: # {{- include "common.metadata" (list . "mychart.metadata") | nindent 2 }} # {{- define "mychart.metadata" -}} -# {{- end -}} +# {{- end }} ``` Example output: diff --git a/templates/_configmap.yaml b/templates/_configmap.yaml index c583a83..b1bbe5e 100644 --- a/templates/_configmap.yaml +++ b/templates/_configmap.yaml @@ -1,14 +1,14 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.configMap.tpl" -}} -{{- $top := first . -}} +{{- $top := first . }} apiVersion: v1 kind: ConfigMap metadata: {{- include "common.metadata" (list $top) | nindent 2 }} data: {} -{{- end -}} +{{- end }} {{- define "common.configMap" -}} -{{- include "common.utils.merge" (append . "common.configMap.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.configMap.tpl") }} +{{- end }} diff --git a/templates/_container.yaml b/templates/_container.yaml index 3a6c310..7abb331 100644 --- a/templates/_container.yaml +++ b/templates/_container.yaml @@ -1,9 +1,9 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.container.tpl" -}} -{{- $top := first . -}} -{{- $container := index . 1 -}} -{{- $image := $container.image | default (dict) -}} +{{- $top := first . }} +{{- $container := index . 1 }} +{{- $image := $container.image | default (dict) }} name: {{ $top.Chart.Name }} securityContext: {{- toYaml $container.securityContext | nindent 2 }} @@ -11,8 +11,8 @@ image: "{{ $image.repository }}:{{ $image.tag | default $top.Chart.AppVersion }} imagePullPolicy: {{ $container.image.pullPolicy }} resources: {{- toYaml $container.resources | nindent 2 }} -{{- end -}} +{{- end }} {{- define "common.container" -}} -{{- include "common.utils.merge" (append . "common.container.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.container.tpl") }} +{{- end }} diff --git a/templates/_cronjob.yaml b/templates/_cronjob.yaml index 4864d5e..70c16f7 100644 --- a/templates/_cronjob.yaml +++ b/templates/_cronjob.yaml @@ -3,13 +3,13 @@ {{- define "common.cronJob.pod" -}} spec: restartPolicy: OnFailure -{{- end -}} +{{- end }} {{- define "common.cronJob.tpl" -}} -{{- $top := first . -}} -{{- $cronJob := index . 1 -}} -{{- $pod := index . 2 -}} -{{- $serviceAccount := index . 3 -}} +{{- $top := first . }} +{{- $cronJob := index . 1 }} +{{- $pod := index . 2 }} +{{- $serviceAccount := index . 3 }} apiVersion: batch/v1beta1 kind: CronJob metadata: @@ -32,8 +32,8 @@ spec: spec: template: {{- include "common.pod.template" (list $top $pod $serviceAccount "common.cronJob.pod") | nindent 8 }} -{{- end -}} +{{- end }} {{- define "common.cronJob" -}} -{{- include "common.utils.merge" (append . "common.cronJob.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.cronJob.tpl") }} +{{- end }} diff --git a/templates/_deployment.yaml b/templates/_deployment.yaml index b26f079..c7fabce 100644 --- a/templates/_deployment.yaml +++ b/templates/_deployment.yaml @@ -1,10 +1,10 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.deployment.tpl" -}} -{{- $top := first . -}} -{{- $deployment := index . 1 -}} -{{- $autoscaling := index . 2 -}} -{{- $serviceAccount := index . 3 -}} +{{- $top := first . }} +{{- $deployment := index . 1 }} +{{- $autoscaling := index . 2 }} +{{- $serviceAccount := index . 3 }} apiVersion: apps/v1 kind: Deployment metadata: @@ -18,8 +18,8 @@ spec: {{- include "common.selectorLabels" $top | nindent 6 }} template: {{- include "common.pod.template" (list $top $deployment $serviceAccount) | nindent 4 }} -{{- end -}} +{{- end }} {{- define "common.deployment" -}} -{{- include "common.utils.merge" (append . "common.deployment.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.deployment.tpl") }} +{{- end }} diff --git a/templates/_hpa.yaml b/templates/_hpa.yaml index c135600..f347532 100644 --- a/templates/_hpa.yaml +++ b/templates/_hpa.yaml @@ -1,8 +1,8 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.hpa.tpl" -}} -{{- $top := first . -}} -{{- $autoscaling := index . 1 -}} +{{- $top := first . }} +{{- $autoscaling := index . 1 }} apiVersion: autoscaling/v2beta2 kind: HorizontalPodAutoscaler metadata: @@ -30,12 +30,12 @@ spec: target: type: Utilization averageUtilization: {{ . }} - {{- end -}} -{{- end -}} + {{- end }} +{{- end }} {{- define "common.hpa" -}} -{{- $autoscaling := index . 1 -}} -{{- if $autoscaling.enabled -}} - {{- include "common.utils.merge" (append . "common.hpa.tpl") -}} -{{- end -}} -{{- end -}} +{{- $autoscaling := index . 1 }} +{{- if $autoscaling.enabled }} + {{- include "common.utils.merge" (append . "common.hpa.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_ingress.yaml b/templates/_ingress.yaml index 8f4f0e6..d16fa9b 100644 --- a/templates/_ingress.yaml +++ b/templates/_ingress.yaml @@ -1,22 +1,22 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.ingress.metadata" -}} -{{- $ingress := index . 1 -}} +{{- $ingress := index . 1 }} {{- with $ingress.annotations }} annotations: {{- toYaml . | nindent 2 }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.ingress.tpl" -}} -{{- $top := first . -}} -{{- $ingress := index . 1 -}} -{{- $service := index . 2 -}} -{{- $fullName := include "common.fullname" $top -}} -{{- $svcPort := $service.port -}} -{{- if semverCompare ">=1.14-0" $top.Capabilities.KubeVersion.GitVersion -}} +{{- $top := first . }} +{{- $ingress := index . 1 }} +{{- $service := index . 2 }} +{{- $fullName := include "common.fullname" $top }} +{{- $svcPort := $service.port }} +{{- if semverCompare ">=1.14-0" $top.Capabilities.KubeVersion.GitVersion }} apiVersion: networking.k8s.io/v1beta1 -{{- else -}} +{{- else }} apiVersion: extensions/v1beta1 {{- end }} kind: Ingress @@ -45,11 +45,11 @@ spec: servicePort: {{ $svcPort }} {{- end }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.ingress" -}} -{{- $ingress := index . 1 -}} -{{- if $ingress.enabled -}} - {{- include "common.utils.merge" (append . "common.ingress.tpl") -}} -{{- end -}} -{{- end -}} +{{- $ingress := index . 1 }} +{{- if $ingress.enabled }} + {{- include "common.utils.merge" (append . "common.ingress.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_metadata.tpl b/templates/_metadata.tpl index 23f3506..0cd6faa 100644 --- a/templates/_metadata.tpl +++ b/templates/_metadata.tpl @@ -10,7 +10,7 @@ helm.sh/chart: {{ include "common.chart" . }} app.kubernetes.io/version: {{ . | quote }} {{- end }} app.kubernetes.io/managed-by: {{ .Release.Service }} -{{- end -}} +{{- end }} {{/* Selector labels @@ -18,18 +18,18 @@ Selector labels {{- define "common.selectorLabels" -}} app.kubernetes.io/name: {{ include "common.name" . }} app.kubernetes.io/instance: {{ .Release.Name }} -{{- end -}} +{{- end }} {{- define "common.metadata.tpl" -}} {{- $top := first . -}} name: {{ include "common.fullname" $top }} labels: - {{- include "common.labels" $top | nindent 2 -}} -{{- end -}} + {{- include "common.labels" $top | nindent 2 }} +{{- end }} -{{- /* +{{/* Create a standard metadata header -*/ -}} +*/}} {{- define "common.metadata" -}} -{{- include "common.utils.merge" (append . "common.metadata.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.metadata.tpl") }} +{{- end }} diff --git a/templates/_name.tpl b/templates/_name.tpl index 9e6d873..b06b6ad 100644 --- a/templates/_name.tpl +++ b/templates/_name.tpl @@ -4,8 +4,8 @@ Expand the name of the chart. */}} {{- define "common.name" -}} -{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} -{{- end -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} {{/* Create a default fully qualified app name. @@ -13,34 +13,34 @@ We truncate at 63 chars because some Kubernetes name fields are limited to this If release name contains chart name it will be used as a full name. */}} {{- define "common.fullname" -}} -{{- if .Values.fullnameOverride -}} - {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} -{{- else -}} - {{- $name := default .Chart.Name .Values.nameOverride -}} - {{- if contains $name .Release.Name -}} - {{- .Release.Name | trunc 63 | trimSuffix "-" -}} - {{- else -}} - {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} - {{- end -}} -{{- end -}} -{{- end -}} +{{- if .Values.fullnameOverride }} + {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} + {{- $name := default .Chart.Name .Values.nameOverride }} + {{- if contains $name .Release.Name }} + {{- .Release.Name | trunc 63 | trimSuffix "-" }} + {{- else }} + {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} + {{- end }} +{{- end }} +{{- end }} {{/* Create chart name and version as used by the chart label. */}} {{- define "common.chart" -}} -{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} -{{- end -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} {{/* Create the name of the service account to use. */}} {{- define "common.serviceAccountName" -}} -{{- $top := first . -}} -{{- $serviceAccount := index . 1 -}} -{{- if $serviceAccount.create -}} - {{ default (include "common.fullname" $top) $serviceAccount.name }} -{{- else -}} - {{ default "default" $serviceAccount.name }} -{{- end -}} -{{- end -}} +{{- $top := first . }} +{{- $serviceAccount := index . 1 }} +{{- if $serviceAccount.create }} + {{- default (include "common.fullname" $top) $serviceAccount.name }} +{{- else }} + {{- default "default" $serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/templates/_pdb.yaml b/templates/_pdb.yaml index 815997b..f10f26d 100644 --- a/templates/_pdb.yaml +++ b/templates/_pdb.yaml @@ -1,8 +1,8 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.pdb.tpl" -}} -{{- $top := first . -}} -{{- $pdb := index . 1 -}} +{{- $top := first . }} +{{- $pdb := index . 1 }} apiVersion: policy/v1beta1 kind: PodDisruptionBudget metadata: @@ -11,22 +11,22 @@ spec: selector: matchLabels: {{- include "common.selectorLabels" $top | nindent 6 }} - {{- if not (or (empty $pdb.minAvailable) (empty $pdb.maxUnavailable)) -}} + {{- if not (or (empty $pdb.minAvailable) (empty $pdb.maxUnavailable)) }} {{- fail "minAvailable and maxUnavailable can not be set together" }} - {{- end -}} + {{- end }} {{- with $pdb.minAvailable }} minAvailable: {{ . }} {{- end }} {{- with $pdb.maxUnavailable }} maxUnavailable: {{ . }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.pdb" -}} -{{- $top := first . -}} -{{- $deployment := index . 2 -}} -{{- $autoscaling := index . 3 -}} +{{- $top := first . }} +{{- $deployment := index . 2 }} +{{- $autoscaling := index . 3 }} {{- if or (and $autoscaling.enabled (gt ($autoscaling.minReplicas | int) 1)) (and (not $autoscaling.enabled) (gt ($deployment.replicaCount | int) 1)) }} - {{- include "common.utils.merge" (append . "common.pdb.tpl") -}} -{{- end -}} -{{- end -}} + {{- include "common.utils.merge" (append . "common.pdb.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_pod.tpl b/templates/_pod.tpl index e1015b6..502690c 100644 --- a/templates/_pod.tpl +++ b/templates/_pod.tpl @@ -1,9 +1,9 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.pod.template.tpl" -}} -{{- $top := first . -}} -{{- $pod := index . 1 -}} -{{- $serviceAccount := index . 2 -}} +{{- $top := first . }} +{{- $pod := index . 1 }} +{{- $serviceAccount := index . 2 }} metadata: {{- with $pod.podAnnotations }} annotations: @@ -33,8 +33,8 @@ spec: tolerations: {{- toYaml . | nindent 4 }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.pod.template" -}} -{{- include "common.utils.merge" (append . "common.pod.template.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.pod.template.tpl") }} +{{- end }} diff --git a/templates/_secret.yaml b/templates/_secret.yaml index 46fcfdd..fd3c5ed 100644 --- a/templates/_secret.yaml +++ b/templates/_secret.yaml @@ -1,15 +1,15 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.secret.tpl" -}} -{{- $top := first . -}} +{{- $top := first . }} apiVersion: v1 kind: Secret metadata: {{- include "common.metadata" (list $top) | nindent 2 }} type: Opaque data: {} -{{- end -}} +{{- end }} {{- define "common.secret" -}} -{{- include "common.utils.merge" (append . "common.secret.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.secret.tpl") }} +{{- end }} diff --git a/templates/_service.yaml b/templates/_service.yaml index 6ac2548..91f5436 100644 --- a/templates/_service.yaml +++ b/templates/_service.yaml @@ -1,8 +1,8 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.service.tpl" -}} -{{- $top := first . -}} -{{- $service := index . 1 -}} +{{- $top := first . }} +{{- $service := index . 1 }} apiVersion: v1 kind: Service metadata: @@ -16,8 +16,8 @@ spec: name: http selector: {{- include "common.selectorLabels" $top | nindent 4 }} -{{- end -}} +{{- end }} {{- define "common.service" -}} -{{- include "common.utils.merge" (append . "common.service.tpl") -}} -{{- end -}} +{{- include "common.utils.merge" (append . "common.service.tpl") }} +{{- end }} diff --git a/templates/_serviceaccount.yaml b/templates/_serviceaccount.yaml index ff0c9bb..d36478f 100644 --- a/templates/_serviceaccount.yaml +++ b/templates/_serviceaccount.yaml @@ -1,26 +1,26 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.serviceAccount.metadata" -}} -{{- $top := first . -}} -{{- $serviceAccount := index . 1 -}} +{{- $top := first . }} +{{- $serviceAccount := index . 1 }} name: {{ include "common.serviceAccountName" . }} {{- with $serviceAccount.annotations }} annotations: {{- toYaml . | nindent 2 }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.serviceAccount.tpl" -}} apiVersion: v1 kind: ServiceAccount metadata: {{- include "common.metadata" (append . "common.serviceAccount.metadata") | nindent 2 }} -{{- end -}} +{{- end }} {{- define "common.serviceAccount" -}} -{{- $top := first . -}} -{{- $serviceAccount := index . 1 -}} -{{- if $serviceAccount.create -}} - {{- include "common.utils.merge" (append . "common.serviceAccount.tpl") -}} -{{- end -}} -{{- end -}} +{{- $top := first . }} +{{- $serviceAccount := index . 1 }} +{{- if $serviceAccount.create }} + {{- include "common.utils.merge" (append . "common.serviceAccount.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_servicemonitor-secret.yaml b/templates/_servicemonitor-secret.yaml index 21f60c6..a133a32 100644 --- a/templates/_servicemonitor-secret.yaml +++ b/templates/_servicemonitor-secret.yaml @@ -1,9 +1,9 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.serviceMonitor.secret.tpl" -}} -{{- $top := first . -}} -{{- $serviceMonitor := index . 1 -}} -{{- $basicAuth := $serviceMonitor.basicAuth | default (dict) -}} +{{- $top := first . }} +{{- $serviceMonitor := index . 1 }} +{{- $basicAuth := $serviceMonitor.basicAuth | default (dict) }} metadata: name: {{ $basicAuth.secretName | default (include "common.fullname" $top) }} {{- with $serviceMonitor.namespace }} @@ -14,12 +14,12 @@ data: {{ $basicAuth.usernameKey | default "username" }}: {{ $basicAuth.username | toString | b64enc | quote }} {{ $basicAuth.passwordKey | default "password" }}: {{ $basicAuth.password | toString | b64enc | quote }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.serviceMonitor.secret" -}} -{{- $top := first . -}} -{{- $serviceMonitor := index . 1 -}} -{{- if $serviceMonitor.enabled -}} - {{- include "common.secret" (append . "common.serviceMonitor.secret.tpl") -}} -{{- end -}} -{{- end -}} +{{- $top := first . }} +{{- $serviceMonitor := index . 1 }} +{{- if $serviceMonitor.enabled }} + {{- include "common.secret" (append . "common.serviceMonitor.secret.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_servicemonitor.yaml b/templates/_servicemonitor.yaml index 21815a1..35863ea 100644 --- a/templates/_servicemonitor.yaml +++ b/templates/_servicemonitor.yaml @@ -1,15 +1,15 @@ {{/* vim: set filetype=mustache: */}} {{- define "common.serviceMonitor.metadata" -}} -{{- $serviceMonitor := index . 1 -}} +{{- $serviceMonitor := index . 1 }} {{- with $serviceMonitor.namespace }} namespace: {{ . }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.serviceMonitor.tpl" -}} -{{- $top := first . -}} -{{- $serviceMonitor := index . 1 -}} +{{- $top := first . }} +{{- $serviceMonitor := index . 1 }} apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: @@ -32,8 +32,8 @@ spec: {{- with $serviceMonitor.scrapeTimeout }} scrapeTimeout: {{ . }} {{- end }} - {{- $basicAuth := $serviceMonitor.basicAuth | default (dict) -}} - {{- $name := $basicAuth.secretName | default (include "common.fullname" $top) -}} + {{- $basicAuth := $serviceMonitor.basicAuth | default (dict) }} + {{- $name := $basicAuth.secretName | default (include "common.fullname" $top) }} {{- if $basicAuth.enabled }} basicAuth: username: @@ -43,12 +43,12 @@ spec: name: {{ $name }} key: {{ $basicAuth.passwordKey | default "password" }} {{- end }} -{{- end -}} +{{- end }} {{- define "common.serviceMonitor" -}} -{{- $top := first . -}} -{{- $serviceMonitor := index . 1 -}} -{{- if $serviceMonitor.enabled -}} - {{- include "common.utils.merge" (append . "common.serviceMonitor.tpl") -}} -{{- end -}} -{{- end -}} +{{- $top := first . }} +{{- $serviceMonitor := index . 1 }} +{{- if $serviceMonitor.enabled }} + {{- include "common.utils.merge" (append . "common.serviceMonitor.tpl") }} +{{- end }} +{{- end }} diff --git a/templates/_utils.tpl b/templates/_utils.tpl index 834979c..61ef0cc 100644 --- a/templates/_utils.tpl +++ b/templates/_utils.tpl @@ -1,24 +1,24 @@ {{/* vim: set filetype=mustache: */}} -{{- /* +{{/* Merge one or more YAML templates and output the result. This takes an list of values: - the top context - [optional] zero or more template args - [optional] the template name of the overrides (destination) - the template name of the base (source) -*/ -}} +*/}} {{- define "common.utils.merge" -}} -{{- $top := first . -}} -{{- $tplName := last . -}} -{{- $args := initial . -}} -{{- if typeIs "string" (last $args) -}} - {{- $overridesName := last $args -}} - {{- $args = initial $args -}} - {{- $tpl := fromYaml (include $tplName $args) | default (dict) -}} - {{- $overrides := fromYaml (include $overridesName $args) | default (dict) -}} - {{- toYaml (merge $overrides $tpl) -}} -{{- else -}} - {{- include $tplName $args -}} -{{- end -}} -{{- end -}} +{{- $top := first . }} +{{- $tplName := last . }} +{{- $args := initial . }} +{{- if typeIs "string" (last $args) }} + {{- $overridesName := last $args }} + {{- $args = initial $args }} + {{- $tpl := fromYaml (include $tplName $args) | default (dict) }} + {{- $overrides := fromYaml (include $overridesName $args) | default (dict) }} + {{- toYaml (merge $overrides $tpl) }} +{{- else }} + {{- include $tplName $args }} +{{- end }} +{{- end }} From a6fab55d7d62e31f03c6873e002f4bf9198b6f1f Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 10:50:33 +0800 Subject: [PATCH 05/10] style: normalize indentations for list items --- templates/_hpa.yaml | 24 ++++++++++++------------ templates/_ingress.yaml | 28 ++++++++++++++-------------- templates/_pod.tpl | 2 +- templates/_service.yaml | 8 ++++---- 4 files changed, 31 insertions(+), 31 deletions(-) diff --git a/templates/_hpa.yaml b/templates/_hpa.yaml index f347532..0ff4230 100644 --- a/templates/_hpa.yaml +++ b/templates/_hpa.yaml @@ -16,20 +16,20 @@ spec: maxReplicas: {{ $autoscaling.maxReplicas }} metrics: {{- with $autoscaling.cpuUtilizationPercentage }} - - type: Resource - resource: - name: cpu - target: - type: Utilization - averageUtilization: {{ . }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ . }} {{- end }} {{- with $autoscaling.memoryUtilizationPercentage }} - - type: Resource - resource: - name: memory - target: - type: Utilization - averageUtilization: {{ . }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ . }} {{- end }} {{- end }} diff --git a/templates/_ingress.yaml b/templates/_ingress.yaml index d16fa9b..f55a8df 100644 --- a/templates/_ingress.yaml +++ b/templates/_ingress.yaml @@ -26,24 +26,24 @@ spec: {{- if $ingress.tls }} tls: {{- range $ingress.tls }} - - hosts: - {{- range .hosts }} - - {{ . | quote }} - {{- end }} - secretName: {{ .secretName }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} {{- end }} {{- end }} rules: {{- range $ingress.hosts }} - - host: {{ .host | quote }} - http: - paths: - {{- range .paths }} - - path: {{ . }} - backend: - serviceName: {{ $fullName }} - servicePort: {{ $svcPort }} - {{- end }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ . }} + backend: + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} {{- end }} {{- end }} diff --git a/templates/_pod.tpl b/templates/_pod.tpl index 502690c..5fb3d15 100644 --- a/templates/_pod.tpl +++ b/templates/_pod.tpl @@ -20,7 +20,7 @@ spec: securityContext: {{- toYaml $pod.podSecurityContext | nindent 4 }} containers: - - {{- include "common.container" (list $top $pod) | nindent 6 }} + - {{- include "common.container" (list $top $pod) | nindent 4 }} {{- with $pod.nodeSelector }} nodeSelector: {{- toYaml . | nindent 4 }} diff --git a/templates/_service.yaml b/templates/_service.yaml index 91f5436..b82f18a 100644 --- a/templates/_service.yaml +++ b/templates/_service.yaml @@ -10,10 +10,10 @@ metadata: spec: type: {{ $service.type }} ports: - - port: {{ $service.port }} - targetPort: http - protocol: TCP - name: http + - port: {{ $service.port }} + targetPort: http + protocol: TCP + name: http selector: {{- include "common.selectorLabels" $top | nindent 4 }} {{- end }} From a57a1f7e099742d6470fa07bab22397b4c59568f Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 11:46:24 +0800 Subject: [PATCH 06/10] feat: add starter --- starter/.helmignore | 23 ++++++ starter/Chart.yaml | 28 +++++++ starter/templates/NOTES.txt | 21 ++++++ starter/templates/deployment.yaml | 26 +++++++ starter/templates/ingress.yaml | 3 + starter/templates/service.yaml | 3 + starter/templates/serviceaccount.yaml | 3 + starter/templates/tests/test-connection.yaml | 15 ++++ starter/values.yaml | 79 ++++++++++++++++++++ 9 files changed, 201 insertions(+) create mode 100644 starter/.helmignore create mode 100644 starter/Chart.yaml create mode 100644 starter/templates/NOTES.txt create mode 100644 starter/templates/deployment.yaml create mode 100644 starter/templates/ingress.yaml create mode 100644 starter/templates/service.yaml create mode 100644 starter/templates/serviceaccount.yaml create mode 100644 starter/templates/tests/test-connection.yaml create mode 100644 starter/values.yaml diff --git a/starter/.helmignore b/starter/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/starter/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/starter/Chart.yaml b/starter/Chart.yaml new file mode 100644 index 0000000..9e25321 --- /dev/null +++ b/starter/Chart.yaml @@ -0,0 +1,28 @@ +apiVersion: v2 +name: +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.1.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +appVersion: 1.16.0 + +dependencies: +- name: common + version: "0.3.0" + repository: "https://hahow-helm-charts.storage.googleapis.com/" diff --git a/starter/templates/NOTES.txt b/starter/templates/NOTES.txt new file mode 100644 index 0000000..28adba6 --- /dev/null +++ b/starter/templates/NOTES.txt @@ -0,0 +1,21 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "common.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + 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 {{ .Release.Namespace }} svc -w {{ include "common.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "common.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "common.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/starter/templates/deployment.yaml b/starter/templates/deployment.yaml new file mode 100644 index 0000000..031199e --- /dev/null +++ b/starter/templates/deployment.yaml @@ -0,0 +1,26 @@ +{{/* vim: set filetype=mustache: */}} + +{{- include "common.deployment" (list . .Values .Values.autoscaling .Values.serviceAccount ".deployment") }} + +{{- define ".deployment" -}} +spec: + template: + spec: + containers: + - {{- include "common.container" (append . ".container") | nindent 8 }} +{{- end }} + +{{- define ".container" -}} +ports: + - name: http + containerPort: 80 + protocol: TCP +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http +{{- end }} diff --git a/starter/templates/ingress.yaml b/starter/templates/ingress.yaml new file mode 100644 index 0000000..9ef603f --- /dev/null +++ b/starter/templates/ingress.yaml @@ -0,0 +1,3 @@ +{{/* vim: set filetype=mustache: */}} + +{{- include "common.ingress" (list . .Values.ingress .Values.service) }} diff --git a/starter/templates/service.yaml b/starter/templates/service.yaml new file mode 100644 index 0000000..1c98585 --- /dev/null +++ b/starter/templates/service.yaml @@ -0,0 +1,3 @@ +{{/* vim: set filetype=mustache: */}} + +{{- include "common.service" (list . .Values.service) }} diff --git a/starter/templates/serviceaccount.yaml b/starter/templates/serviceaccount.yaml new file mode 100644 index 0000000..fbf3410 --- /dev/null +++ b/starter/templates/serviceaccount.yaml @@ -0,0 +1,3 @@ +{{/* vim: set filetype=mustache: */}} + +{{- include "common.serviceAccount" (list . .Values.serviceAccount) }} diff --git a/starter/templates/tests/test-connection.yaml b/starter/templates/tests/test-connection.yaml new file mode 100644 index 0000000..cb5e8d4 --- /dev/null +++ b/starter/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "common.fullname" . }}-test-connection" + labels: + {{- include "common.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test-success +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "common.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/starter/values.yaml b/starter/values.yaml new file mode 100644 index 0000000..126ee0e --- /dev/null +++ b/starter/values.yaml @@ -0,0 +1,79 @@ +# Default values for . +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: nginx + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 80 + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: [] + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} From 4248e9d373688df6fd4c334e987ff0ce8a685e2b Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 11:46:47 +0800 Subject: [PATCH 07/10] chore: update .helmignore --- .helmignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.helmignore b/.helmignore index 37eb3d3..b6679a4 100644 --- a/.helmignore +++ b/.helmignore @@ -21,5 +21,8 @@ .idea/ *.tmproj .vscode/ -# Secrets +# Others +starter/ +.github/ gcloud_auth_key.json +README.md From 2b7cc4a22ec016a5684589e38001e1e203b13976 Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 16:21:51 +0800 Subject: [PATCH 08/10] feat: add `create.sh` --- .helmignore | 1 + create.sh | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100755 create.sh diff --git a/.helmignore b/.helmignore index b6679a4..6156b21 100644 --- a/.helmignore +++ b/.helmignore @@ -25,4 +25,5 @@ starter/ .github/ gcloud_auth_key.json +create.sh README.md diff --git a/create.sh b/create.sh new file mode 100755 index 0000000..df28493 --- /dev/null +++ b/create.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +set -exu + +if [[ $# -eq 0 ]] +then + echo "No argument supplied" + exit 1 +fi + +mkdir "$1" +curl --proto '=https' --tlsv1.2 -sSf https://codeload.github.com/hahow/common-chart/tar.gz/master | \ + tar -xz -C "$1" --strip=2 common-chart-master/starter +find "$1" -type f | xargs sed -i "" "s//$1/g" + +helm dep build "$1" From f4aae8e2e6a8f5647eccd9c50b22ba5a024a3529 Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 17:05:09 +0800 Subject: [PATCH 09/10] docs: section "Getting Started" --- README.md | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6b1d4f9..7e8819c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,10 @@ It provides utilities that reflect best practices of Kubernetes chart developmen ## Contents -- [Installation](#installation) +- [Getting Started](#getting-started) + * [Adding Repository](#adding-repository) + * [Adding Dependency](#adding-dependency) + * [Using Starter](#using-starter) - [Resource Kinds](#resource-kinds) * [`common.configMap`](#commonconfigmap) * [`common.cronJob`](#commoncronjob) @@ -34,7 +37,17 @@ It provides utilities that reflect best practices of Kubernetes chart developmen -## Installation +## Getting Started + +### Adding Repository + +The following command allows you to download and install all the charts from our repository: + +```shell +$ helm repo add hahow https://hahow-helm-charts.storage.googleapis.com/ +``` + +### Adding Dependency To use the library chart, `common` should be listed in `dependencies` field in your `Chart.yaml`: @@ -48,9 +61,29 @@ dependencies: Once you have defined dependencies, you should run the following command to download this chart into your `charts/` directory: ```shell -$ helm dependency update +$ helm dep build ``` +### Using Starter + +The best way to get started is to use the [`create` script](create.sh) to generate a new chart. + +You can fetch that script, and then execute it locally: + +```shell +$ curl -fsSL -o create.sh https://raw.githubusercontent.com/hahow/common-chart/master/create.sh +$ chmod 700 create.sh +$ ./create.sh mychart +``` + +or simply + +```shell +$ curl https://raw.githubusercontent.com/hahow/common-chart/master/create.sh | bash -s -- mychart +``` + +Now, there is a chart in `./mychart`. You can edit it and create your own templates. + ## Resource Kinds From fa725196840593b037b7f1762fad32f2293755e9 Mon Sep 17 00:00:00 2001 From: Chi-En Wu Date: Mon, 27 Apr 2020 17:15:30 +0800 Subject: [PATCH 10/10] chore: bump to version 0.4.0 --- Chart.yaml | 2 +- README.md | 2 +- starter/Chart.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Chart.yaml b/Chart.yaml index b6da369..9324cc1 100644 --- a/Chart.yaml +++ b/Chart.yaml @@ -14,4 +14,4 @@ type: library # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. -version: 0.3.0 +version: 0.4.0 diff --git a/README.md b/README.md index 7e8819c..b68c155 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ To use the library chart, `common` should be listed in `dependencies` field in y ```yaml dependencies: - name: common - version: 0.3.0 + version: 0.4.0 repository: https://hahow-helm-charts.storage.googleapis.com/ ``` diff --git a/starter/Chart.yaml b/starter/Chart.yaml index 9e25321..6c5f5fc 100644 --- a/starter/Chart.yaml +++ b/starter/Chart.yaml @@ -24,5 +24,5 @@ appVersion: 1.16.0 dependencies: - name: common - version: "0.3.0" + version: "0.4.0" repository: "https://hahow-helm-charts.storage.googleapis.com/"