kubernetes/common/readinessCheck/templates/_readinessCheck.tpl

   1 {{/*
   2 # Copyright © 2020 Orange
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #       http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 */}}
  16
  17 {{/*
  18   Generate readiness part for a pod
  19   Will look by default to .Values.wait_for
  20   There are two formats available.
  21
  22   The simple one (where wait_for is just list of containers):
  23
  24   wait_for:
  25     - aaf-locate
  26     - aaf-cm
  27     - aaf-service
  28
  29   The powerful one (where wait_for is a map):
  30
  31   wait_for:
  32     name: myname
  33     containers:
  34       - aaf-locate
  35       - aaf-cm
  36       - aaf-service
  37
  38   the powerful one allows also to wait for jobs with this:
  39   wait_for:
  40     name: myname
  41     jobs:
  42       - '{{ include "common.release" . }}-the-job'
  43
  44   Be careful, as on the example above, the job name may have a "non fixed" name
  45   and thus don't forget to use templates if needed
  46
  47   The function can takes below arguments (inside a dictionary):
  48      - .dot : environment (.)
  49      - .initRoot : the root dictionary of readinessCheck submodule
  50                    (default to .Values.readinessCheck)
  51      - .wait_for : list of containers / jobs to wait for (default to
  52                    .Values.wait_for)
  53
  54   Example calls:
  55     {{ include "common.readinessCheck.waitFor" . }}
  56     {{ include "common.readinessCheck.waitFor" (dict "dot" . "wait_for" .Values.where.my.wait_for.is ) }}
  57 */}}
  58 {{- define "common.readinessCheck.waitFor" -}}
  59 {{-   $dot := default . .dot -}}
  60 {{-   $initRoot := default $dot.Values.readinessCheck .initRoot -}}
  61 {{/*  Our version of helm doesn't support deepCopy so we need this nasty trick */}}
  62 {{-   $subchartDot := fromJson (include "common.subChartDot" (dict "dot" $dot "initRoot" $initRoot)) }}
  63 {{-   $wait_for := default $initRoot.wait_for .wait_for -}}
  64 {{-   $containers := index (ternary (dict "containers" $wait_for) $wait_for (kindIs "slice" $wait_for)) "containers" -}}
  65 {{-   $namePart := index (ternary (dict) $wait_for (kindIs "slice" $wait_for)) "name" -}}
  66 {{-   $jobs := index (ternary (dict) $wait_for (kindIs "slice" $wait_for)) "jobs" -}}
  67 - name: {{ include "common.name" $dot }}{{ ternary "" (printf "-%s" $namePart) (empty $namePart) }}-readiness
  68   image: {{ include "repositoryGenerator.image.readiness" $subchartDot }}
  69   imagePullPolicy: {{ $subchartDot.Values.global.pullPolicy | default $subchartDot.Values.pullPolicy }}
  70   securityContext:
  71     runAsUser: {{ $subchartDot.Values.user }}
  72     runAsGroup: {{ $subchartDot.Values.group }}
  73   command:
  74   - /app/ready.py
  75   args:
  76   {{- range $container := default (list) $containers }}
  77   - --container-name
  78   - {{ tpl $container $dot }}
  79   {{- end }}
  80   {{- range $job := $jobs }}
  81   - --job-name
  82   - {{ tpl $job $dot }}
  83   {{- end }}
  84   env:
  85   - name: NAMESPACE
  86   {{- if $subchartDot.Values.namespace }}
  87     value: {{ $subchartDot.Values.namespace }}
  88   {{- else }}
  89     valueFrom:
  90       fieldRef:
  91         apiVersion: v1
  92         fieldPath: metadata.namespace
  93   {{- end }}
  94   resources:
  95     limits:
  96       cpu: {{ $subchartDot.Values.limits.cpu }}
  97       memory: {{ $subchartDot.Values.limits.memory }}
  98     requests:
  99       cpu: {{ $subchartDot.Values.requests.cpu }}
 100       memory: {{ $subchartDot.Values.requests.memory }}
 101 {{- end -}}