From 103f9252588057cc9af1fc648b331451a48aff7c Mon Sep 17 00:00:00 2001 From: Adriaan de Beer <adebeer42@gmail.com> Date: Sun, 25 Jul 2021 22:09:28 +0200 Subject: [PATCH] AT-47 ska- prefix in all template files --- .gitignore | 6 +++++ charts/ska-tango-base/templates/_helpers.tpl | 12 ++++----- .../ska-tango-base/templates/databaseds.yaml | 4 +-- charts/ska-tango-base/templates/ingress.yaml | 8 +++--- charts/ska-tango-base/templates/itango.yaml | 2 +- charts/ska-tango-base/templates/jive.yaml | 2 +- .../ska-tango-base/templates/logviewer.yaml | 2 +- .../ska-tango-base/templates/tango-rest.yaml | 4 +-- .../ska-tango-base/templates/tangodb-pv.yaml | 6 ++--- charts/ska-tango-base/templates/tangodb.yaml | 8 +++--- charts/ska-tango-base/templates/vnc.yaml | 6 ++--- docs/src/helm_charts.rst | 26 +++++++++---------- 12 files changed, 46 insertions(+), 40 deletions(-) diff --git a/.gitignore b/.gitignore index 5a0a1efb..d7ac328d 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,9 @@ charts/ska-tango-images/Chart.lock charts/repository/* charts/tango-base/charts/* charts/tango-base/Chart.lock + +charts/ska-tango-base/secrets/tls.crt +charts/ska-tango-base/secrets/tls.key +charts/ska-tango-base/charts/tango-util-0.1.0.tgz +charts/ska-tango-base/charts/* +charts/ska-tango-base/Chart.lock \ No newline at end of file diff --git a/charts/ska-tango-base/templates/_helpers.tpl b/charts/ska-tango-base/templates/_helpers.tpl index 8ce68512..943d73a3 100644 --- a/charts/ska-tango-base/templates/_helpers.tpl +++ b/charts/ska-tango-base/templates/_helpers.tpl @@ -2,7 +2,7 @@ {{/* Expand the name of the chart. */}} -{{- define "tango-base.name" -}} +{{- define "ska-tango-base.name" -}} {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} {{- end -}} {{/* @@ -14,7 +14,7 @@ Create a default fully qualified app name. We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). If release name contains chart name it will be used as a full name. */}} -{{- define "tango-base.fullname" -}} +{{- define "ska-tango-base.fullname" -}} {{- if .Values.fullnameOverride -}} {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} {{- else -}} @@ -29,9 +29,9 @@ If release name contains chart name it will be used as a full name. {{/* Common labels */}} -{{- define "tango-base.labels" }} -app: {{ template "tango-base.name" . }} -chart: {{ template "tango-base.chart" . }} +{{- define "ska-tango-base.labels" }} +app: {{ template "ska-tango-base.name" . }} +chart: {{ template "ska-tango-base.chart" . }} release: {{ .Release.Name }} heritage: {{ .Release.Service }} system: {{ .Values.system }} @@ -40,6 +40,6 @@ telescope: {{ .Values.telescope }} {{/* Create chart name and version as used by the chart label. */}} -{{- define "tango-base.chart" -}} +{{- define "ska-tango-base.chart" -}} {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} {{- end -}} diff --git a/charts/ska-tango-base/templates/databaseds.yaml b/charts/ska-tango-base/templates/databaseds.yaml index 3e8e7109..755bde13 100644 --- a/charts/ska-tango-base/templates/databaseds.yaml +++ b/charts/ska-tango-base/templates/databaseds.yaml @@ -72,7 +72,7 @@ spec: - --sleep={{$sleep}} - -- - /usr/local/bin/wait-for-it.sh - - {{ template "tango-base.name" . }}-{{ .Values.tangodb.component }}:3306 + - {{ template "ska-tango-base.name" . }}-{{ .Values.tangodb.component }}:3306 - --timeout=60 - --strict - -- @@ -82,7 +82,7 @@ spec: - giop:tcp::10000 env: - name: MYSQL_HOST - value: "{{ template "tango-base.name" . }}-{{ .Values.tangodb.component }}:3306" + value: "{{ template "ska-tango-base.name" . }}-{{ .Values.tangodb.component }}:3306" - name: MYSQL_DATABASE value: "{{ .Values.tangodb.db.db }}" - name: MYSQL_USER diff --git a/charts/ska-tango-base/templates/ingress.yaml b/charts/ska-tango-base/templates/ingress.yaml index af038416..87456e04 100644 --- a/charts/ska-tango-base/templates/ingress.yaml +++ b/charts/ska-tango-base/templates/ingress.yaml @@ -4,7 +4,7 @@ apiVersion: networking.k8s.io/v1 kind: Ingress metadata: - name: rest-api-{{ template "tango-base.name" . }}-{{ .Release.Name }} + name: rest-api-{{ template "ska-tango-base.name" . }}-{{ .Release.Name }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} @@ -24,7 +24,7 @@ spec: pathType: Prefix backend: service: - name: {{ template "tango-base.name" . }}-{{ .Values.tangorest.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangorest.component }} port: number: 8080 {{ else }} @@ -32,7 +32,7 @@ spec: apiVersion: extensions/v1 kind: Ingress metadata: - name: rest-api-{{ template "tango-base.name" . }}-{{ .Release.Name }} + name: rest-api-{{ template "ska-tango-base.name" . }}-{{ .Release.Name }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} @@ -52,7 +52,7 @@ spec: pathType: Prefix backend: service: - name: {{ template "tango-base.name" . }}-{{ .Values.tangorest.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangorest.component }} port: number: 8080 diff --git a/charts/ska-tango-base/templates/itango.yaml b/charts/ska-tango-base/templates/itango.yaml index becf701e..731c59be 100644 --- a/charts/ska-tango-base/templates/itango.yaml +++ b/charts/ska-tango-base/templates/itango.yaml @@ -8,7 +8,7 @@ apiVersion: v1 kind: Pod metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.itango.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.itango.component }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} diff --git a/charts/ska-tango-base/templates/jive.yaml b/charts/ska-tango-base/templates/jive.yaml index 6e500ce7..1b49dee4 100644 --- a/charts/ska-tango-base/templates/jive.yaml +++ b/charts/ska-tango-base/templates/jive.yaml @@ -4,7 +4,7 @@ apiVersion: v1 kind: Pod metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.jive.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.jive.component }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} diff --git a/charts/ska-tango-base/templates/logviewer.yaml b/charts/ska-tango-base/templates/logviewer.yaml index 8979d6fd..890df9f0 100644 --- a/charts/ska-tango-base/templates/logviewer.yaml +++ b/charts/ska-tango-base/templates/logviewer.yaml @@ -4,7 +4,7 @@ apiVersion: v1 kind: Pod metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.logviewer.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.logviewer.component }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} diff --git a/charts/ska-tango-base/templates/tango-rest.yaml b/charts/ska-tango-base/templates/tango-rest.yaml index e8ab8b06..ef8f8734 100644 --- a/charts/ska-tango-base/templates/tango-rest.yaml +++ b/charts/ska-tango-base/templates/tango-rest.yaml @@ -8,7 +8,7 @@ apiVersion: v1 kind: Service metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.tangorest.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangorest.component }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} @@ -32,7 +32,7 @@ spec: apiVersion: apps/v1 kind: Deployment metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.tangorest.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangorest.component }} namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} diff --git a/charts/ska-tango-base/templates/tangodb-pv.yaml b/charts/ska-tango-base/templates/tangodb-pv.yaml index a2b54a35..2b485d04 100644 --- a/charts/ska-tango-base/templates/tangodb-pv.yaml +++ b/charts/ska-tango-base/templates/tangodb-pv.yaml @@ -6,7 +6,7 @@ kind: PersistentVolume apiVersion: v1 metadata: - name: {{ template "tango-base.name" . }}-tangodb-storage + name: {{ template "ska-tango-base.name" . }}-tangodb-storage namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} @@ -20,14 +20,14 @@ spec: accessModes: - ReadWriteOnce hostPath: - path: {{ template "tango-base.name" . }}-tangodb-storage-{{ .Release.Name }}/ + path: {{ template "ska-tango-base.name" . }}-tangodb-storage-{{ .Release.Name }}/ {{ end }} --- apiVersion: v1 kind: PersistentVolumeClaim metadata: - name: {{ template "tango-base.name" . }}-tangodb-storage + name: {{ template "ska-tango-base.name" . }}-tangodb-storage namespace: {{ .Release.Namespace }} labels: {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 4 }} diff --git a/charts/ska-tango-base/templates/tangodb.yaml b/charts/ska-tango-base/templates/tangodb.yaml index 208b3883..40be53f8 100644 --- a/charts/ska-tango-base/templates/tangodb.yaml +++ b/charts/ska-tango-base/templates/tangodb.yaml @@ -4,7 +4,7 @@ apiVersion: v1 kind: Service metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.tangodb.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangodb.component }} namespace: {{ .Release.Namespace }} labels: component: {{ .Values.tangodb.component }} @@ -31,7 +31,7 @@ spec: apiVersion: apps/v1 kind: StatefulSet metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.tangodb.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.tangodb.component }} namespace: {{ .Release.Namespace }} labels: component: {{ .Values.tangodb.component }} @@ -49,7 +49,7 @@ spec: domain: {{ .Values.tangodb.domain }} intent: {{ .Values.tangodb.intent }} {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 6 }} - serviceName: {{ template "tango-base.name" . }}-{{ .Values.tangodb.component }} + serviceName: {{ template "ska-tango-base.name" . }}-{{ .Values.tangodb.component }} replicas: 1 template: metadata: @@ -111,7 +111,7 @@ spec: {{ if .Values.tangodb.use_pv }} - name: data persistentVolumeClaim: - claimName: {{ template "tango-base.name" . }}-tangodb-storage + claimName: {{ template "ska-tango-base.name" . }}-tangodb-storage {{ end }} {{- with .Values.nodeSelector }} nodeSelector: diff --git a/charts/ska-tango-base/templates/vnc.yaml b/charts/ska-tango-base/templates/vnc.yaml index 2cdb235b..c1dde00f 100644 --- a/charts/ska-tango-base/templates/vnc.yaml +++ b/charts/ska-tango-base/templates/vnc.yaml @@ -4,7 +4,7 @@ apiVersion: v1 kind: Service metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.vnc.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.vnc.component }} namespace: {{ .Release.Namespace }} labels: component: {{ .Values.vnc.component }} @@ -40,7 +40,7 @@ spec: apiVersion: apps/v1 kind: StatefulSet metadata: - name: {{ template "tango-base.name" . }}-{{ .Values.vnc.component }} + name: {{ template "ska-tango-base.name" . }}-{{ .Values.vnc.component }} namespace: {{ .Release.Namespace }} labels: component: {{ .Values.vnc.component }} @@ -58,7 +58,7 @@ spec: domain: {{ .Values.vnc.domain }} intent: {{ .Values.vnc.intent }} {{ toYaml (coalesce .Values.global.labels .Values.labels "label:none") | indent 6 }} - serviceName: {{ template "tango-base.name" . }}-{{ .Values.vnc.component }} + serviceName: {{ template "ska-tango-base.name" . }}-{{ .Values.vnc.component }} replicas: {{ .Values.vnc.replicas }} template: metadata: diff --git a/docs/src/helm_charts.rst b/docs/src/helm_charts.rst index 0cd1b1fe..34b1a2e2 100644 --- a/docs/src/helm_charts.rst +++ b/docs/src/helm_charts.rst @@ -44,8 +44,8 @@ Below there is an example of a values file that can be used with the tango-util deviceServers: theexample: name: "theexample-{{.Release.Name}}" - function: tango-example-powersupply - domain: tango-example + function: ska-tango-example-powersupply + domain: ska-tango-example instances: ["test"] polling: 1000 entrypoints: @@ -134,7 +134,7 @@ The device server configuration, like the above one, needs to be added to the va file: "data/theexample.yaml" Fields explained: - - **file** : This field specifies the path of the device server configuration block as shown above. Note:. This file should be included in a `data folder <https://gitlab.com/ska-telescope/tango-example/-/tree/master/charts/tango-example/data>`__ inside the chart. + - **file** : This field specifies the path of the device server configuration block as shown above. Note:. This file should be included in a `data folder <https://gitlab.com/ska-telescope/ska-tango-example/-/tree/master/charts/ska-tango-example/data>`__ inside the chart. - **polling** : This field is referenced in the above device server configuration block. In fact the tango-util device server definition template some of the field composing it (like the properties). In the above example the *polled_attr* property of the *test/motor/1* device takes its value from this field. As a consequence, this field allows us to change the value of the *polled_attr* property in the parent chart. - **instances** : If **instances** has values in the value file, this takes precedence over the data file **instances** field. @@ -145,8 +145,8 @@ The helm template multidevice-config creates a ConfigMap which contains the gene How to use the defined helm named template ++++++++++++++++++++++++++++++++++++++++++ -A example on how to set up your k8s namespace with the helm named templates, described in the beginning of this `section <#the-tango-util-helm-chart>`_, can be seen on `tango-example <https://gitlab.com/ska-telescope/tango-example>`_ repository. -This templates are called by the below `template <https://gitlab.com/ska-telescope/tango-example/-/blob/master/charts/tango-example/templates/deviceservers.yaml>`_ present on the tango-example repository: +A example on how to set up your k8s namespace with the helm named templates, described in the beginning of this `section <#the-tango-util-helm-chart>`_, can be seen on `ska-tango-example <https://gitlab.com/ska-telescope/ska-tango-example>`_ repository. +This templates are called by the below `template <https://gitlab.com/ska-telescope/ska-tango-example/-/blob/master/charts/ska-tango-example/templates/deviceservers.yaml>`_ present on the ska-tango-example repository: .. code-block:: console :linenos: @@ -160,19 +160,19 @@ This templates are called by the below `template <https://gitlab.com/ska-telesco {{- $filedeviceserver := $.Files.Get $deviceserver.file | fromYaml }} {{- $_ := set $filedeviceserver "instances" (coalesce $localchart.Values.global.instances $deviceserver.instances $filedeviceserver.instances) }} {{- $context := dict "name" $key "deviceserver" $filedeviceserver "image" $deviceserver.image "local" $localchart }} - {{ template "tango-util.multidevice-config.tpl" $context }} - {{ template "tango-util.multidevice-sacc-role.tpl" $context }} - {{ template "tango-util.multidevice-job.tpl" $context }} - {{ template "tango-util.multidevice-svc.tpl" $context }} + {{ template "ska-tango-util.multidevice-config.tpl" $context }} + {{ template "ska-tango-util.multidevice-sacc-role.tpl" $context }} + {{ template "ska-tango-util.multidevice-job.tpl" $context }} + {{ template "ska-tango-util.multidevice-svc.tpl" $context }} {{- else }} {{- $_ := set $deviceserver "instances" (coalesce $localchart.Values.global.instances $deviceserver.instances) }} {{- $context := dict "name" $key "deviceserver" $deviceserver "image" $deviceserver.image "local" $localchart }} - {{ template "tango-util.multidevice-config.tpl" $context }} - {{ template "tango-util.multidevice-sacc-role.tpl" $context }} - {{ template "tango-util.multidevice-job.tpl" $context }} - {{ template "tango-util.multidevice-svc.tpl" $context }} + {{ template "ska-tango-util.multidevice-config.tpl" $context }} + {{ template "ska-tango-util.multidevice-sacc-role.tpl" $context }} + {{ template "ska-tango-util.multidevice-job.tpl" $context }} + {{ template "ska-tango-util.multidevice-svc.tpl" $context }} {{- end }} -- GitLab