2 #============LICENSE_START========================================================
3 # ================================================================================
4 # Copyright (c) 2021 J. F. Lucas. All rights reserved.
5 # Copyright (c) 2021 AT&T Intellectual Property. All rights reserved.
6 # Copyright (c) 2021 Nokia. All rights reserved.
7 # ================================================================================
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
19 # ============LICENSE_END=========================================================
22 For internal use only!
24 dcaegen2-services-common._ms-specific-env-vars:
25 This template generates a list of microservice-specific environment variables
26 as specified in .Values.applicationEnv. The
27 dcaegen2-services-common.microServiceDeployment uses this template
28 to add the microservice-specific environment variables to the microservice's container.
29 These environment variables are in addition to a standard set of environment variables
30 provided to all microservices.
32 The template expects a single argument, pointing to the caller's global context.
34 Microservice-specific environment variables can be specified in two ways:
35 1. As literal string values.
36 2. As values that are sourced from a secret, identified by the secret's
37 uid and the key within the secret that provides the value.
39 The following example shows an example of each type. The example assumes
40 that a secret has been created using the OOM common secret mechanism, with
41 a secret uid "example-secret" and a key called "password".
45 secretUid: example-secret
47 APPLICATION_EXAMPLE: "An example value"
49 The example would set two environment variables on the microservice's container,
50 one called "APPLICATION_PASSWORD" with the value set from the "password" key in
51 the secret with uid "example-secret", and one called "APPLICATION_EXAMPLE" set to
52 the the literal string "An example value".
54 {{- define "dcaegen2-services-common._ms-specific-env-vars" -}}
56 {{- if .Values.applicationEnv }}
57 {{- range $envName, $envValue := .Values.applicationEnv }}
58 {{- if kindIs "string" $envValue }}
59 - name: {{ $envName }}
60 value: {{ $envValue | quote }}
62 {{ if or (not $envValue.secretUid) (not $envValue.key) }}
63 {{ fail (printf "Env %s definition is not a string and does not contain secretUid or key fields" $envName) }}
65 - name: {{ $envName }}
66 {{- include "common.secret.envFromSecretFast" (dict "global" $global "uid" $envValue.secretUid "key" $envValue.key) | indent 2 }}
72 For internal use only!
74 dcaegen2-services-common._externalVolumes:
75 This template generates a list of volumes associated with the pod,
76 based on information provided in .Values.externalVolumes. This
77 template works in conjunction with dcaegen2-services-common._externalVolumeMounts
78 to give the microservice access to data in volumes created else.
79 This initial implementation supports ConfigMaps only, as this is the only
80 external volume mounting required by current microservices.
82 .Values.externalValues is a list of objects. Each object has 3 required fields and 1 optional field:
83 - name: the name of the resource (in the current implementation, it must be a ConfigMap)
84 that is to be set up as a volume. The value is a case sensitive string. Because the
85 names of resources are sometimes set at deployment time (for instance, to prefix the Helm
86 release to the name), the string can be a Helm template fragment that will be expanded at
88 - type: the type of the resource (in the current implementation, only "ConfigMap" is supported).
89 The value is a case-INsensitive string.
90 - mountPoint: the path to the mount point for the volume in the container file system. The
91 value is a case-sensitive string.
92 - readOnly: (Optional) Boolean flag. Set to true to mount the volume as read-only.
95 Here is an example fragment from a values.yaml file for a microservice:
98 - name: my-example-configmap
100 mountPath: /opt/app/config
101 - name: '{{ include "common.release" . }}-another-example'
103 mountPath: /opt/app/otherconfig
105 {{- define "dcaegen2-services-common._externalVolumes" -}}
107 {{- if .Values.externalVolumes }}
108 {{- range $vol := .Values.externalVolumes }}
109 {{- if eq (lower $vol.type) "configmap" }}
110 {{- $vname := (tpl $vol.name $global) }}
120 For internal use only!
122 dcaegen2-services-common._externalVolumeMounts:
123 This template generates a list of volume mounts for the microservice container,
124 based on information provided in .Values.externalVolumes. This
125 template works in conjunction with dcaegen2-services-common._externalVolumes
126 to give the microservice access to data in volumes created else.
127 This initial implementation supports ConfigMaps only, as this is the only
128 external volume mounting required by current microservices.
130 See the documentation for dcaegen2-services-common._externalVolumes for
131 details on how external volumes are specified in the values.yaml file for
134 {{- define "dcaegen2-services-common._externalVolumeMounts" -}}
136 {{- if .Values.externalVolumes }}
137 {{- range $vol := .Values.externalVolumes }}
138 {{- if eq (lower $vol.type) "configmap" }}
139 {{- $vname := (tpl $vol.name $global) -}}
140 {{- $readOnly := $vol.readOnly | default false }}
141 - mountPath: {{ $vol.mountPath }}
143 readOnly: {{ $readOnly }}
149 dcaegen2-services-common.microserviceDeployment:
150 This template produces a Kubernetes Deployment for a DCAE microservice.
152 All DCAE microservices currently use very similar Deployments. Having a
153 common template eliminates a lot of repetition in the individual charts
154 for each microservice.
156 The template expects the full chart context as input. A chart for a
157 DCAE microservice references this template using:
158 {{ include "dcaegen2-services-common.microserviceDeployment" . }}
159 The template directly references data in .Values, and indirectly (through its
160 use of templates from the ONAP "common" collection) references data in
163 The exact content of the Deployment generated from this template
164 depends on the content of .Values.
166 The Deployment always includes a single Pod, with a container that uses
167 the DCAE microservice image.
169 The Deployment Pod may also include a logging sidecar container.
170 The sidecar is included if .Values.logDirectory is set. The
171 logging sidecar and the DCAE microservice container share a
172 volume where the microservice logs are written.
174 The Deployment includes an initContainer that pushes the
175 microservice's initial configuration (from .Values.applicationConfig)
176 into Consul. All DCAE microservices retrieve their initial
177 configurations by making an API call to a DCAE platform component called
178 the config-binding-service. The config-binding-service currently
179 retrieves configuration information from Consul.
181 The Deployment also includes an initContainer that checks for the
182 readiness of other components that the microservice relies on.
183 This container is generated by the "common.readinessCheck.waitfor"
186 If the microservice acts as a TLS client or server, the Deployment will
187 include an initContainer that retrieves certificate information from
188 the AAF certificate manager. The information is mounted at the
189 mount point specified in .Values.certDirectory. If the microservice is
190 a TLS server (indicated by setting .Values.tlsServer to true), the
191 certificate information will include a server cert and key, in various
192 formats. It will also include the AAF CA cert. If the microservice is
193 a TLS client only (indicated by setting .Values.tlsServer to false), the
194 certificate information includes only the AAF CA cert.
196 Deployed POD may also include a Policy-sync sidecar container.
197 The sidecar is included if .Values.policies is set. The
198 Policy-sync sidecar polls PolicyEngine (PDP) periodically based
199 on .Values.policies.duration and configuration retrieved is shared with
200 DCAE Microservice container by common volume. Policy can be retrieved based on
201 list of policyID or filter
204 {{- define "dcaegen2-services-common.microserviceDeployment" -}}
205 {{- $logDir := default "" .Values.logDirectory -}}
206 {{- $certDir := default "" .Values.certDirectory . -}}
207 {{- $tlsServer := default "" .Values.tlsServer -}}
208 {{- $policy := default "" .Values.policies -}}
212 metadata: {{- include "common.resourceMetadata" . | nindent 2 }}
215 selector: {{- include "common.selectors" . | nindent 4 }}
217 metadata: {{- include "common.templateMetadata" . | nindent 6 }}
225 {{- range $var := .Values.customEnvVars }}
226 export {{ $var.name }}="{{ $var.value }}";
228 cd /config-input && for PFILE in `ls -1`; do envsubst <${PFILE} >/config/${PFILE}; done
230 {{- range $cred := .Values.credentials }}
231 - name: {{ $cred.name }}
232 {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
235 - mountPath: /config-input
236 name: app-config-input
239 image: {{ include "repositoryGenerator.image.envsubst" . }}
240 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
241 name: {{ include "common.name" . }}-update-config
243 {{ include "common.readinessCheck.waitFor" . | indent 6 | trim }}
245 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.consulLoaderImage }}
246 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
249 - "{{ include "common.name" . }}|/app-config/application_config.yaml"
250 resources: {{ include "common.resources" . | nindent 2 }}
252 - mountPath: /app-config
256 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.tlsImage }}
257 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
260 value: {{ $tlsServer | quote }}
265 fieldPath: status.podIP
266 resources: {{ include "common.resources" . | nindent 2 }}
268 - mountPath: /opt/app/osaaf
271 {{ include "dcaegen2-services-common._certPostProcessor" . | nindent 4 }}
273 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.image }}
274 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
275 name: {{ include "common.name" . }}
277 {{- range $cred := .Values.credentials }}
278 - name: {{ $cred.name }}
279 {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
282 - name: DCAE_CA_CERTPATH
283 value: {{ $certDir }}/cacert.pem
286 value: consul-server.onap
287 - name: CONFIG_BINDING_SERVICE
288 value: config-binding-service
289 - name: CBS_CONFIG_URL
290 value: https://config-binding-service:10443/service_component_all/{{ include "common.name" . }}
295 fieldPath: status.podIP
296 {{- include "dcaegen2-services-common._ms-specific-env-vars" . | nindent 8 }}
297 {{- if .Values.service }}
298 ports: {{ include "common.containerPorts" . | nindent 10 }}
300 {{- if .Values.readiness }}
302 initialDelaySeconds: {{ .Values.readiness.initialDelaySeconds | default 5 }}
303 periodSeconds: {{ .Values.readiness.periodSeconds | default 15 }}
304 timeoutSeconds: {{ .Values.readiness.timeoutSeconds | default 1 }}
305 {{- $probeType := .Values.readiness.type | default "httpGet" -}}
306 {{- if eq $probeType "httpGet" }}
308 scheme: {{ .Values.readiness.scheme }}
309 path: {{ .Values.readiness.path }}
310 port: {{ .Values.readiness.port }}
312 {{- if eq $probeType "exec" }}
315 {{- range $cmd := .Values.readiness.command }}
320 resources: {{ include "common.resources" . | nindent 2 }}
322 - mountPath: /app-config
324 - mountPath: /app-config-input
325 name: app-config-input
327 - mountPath: {{ $logDir}}
331 - mountPath: {{ $certDir }}
333 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
334 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 8 -}}
338 - name: policy-shared
339 mountPath: /etc/policies
341 {{- include "dcaegen2-services-common._externalVolumeMounts" . | nindent 8 }}
343 - image: {{ include "repositoryGenerator.image.logging" . }}
344 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
351 fieldPath: status.podIP
352 resources: {{ include "common.resources" . | nindent 2 }}
354 - mountPath: /var/log/onap/{{ include "common.name" . }}
356 - mountPath: /usr/share/filebeat/data
358 - mountPath: /usr/share/filebeat/filebeat.yml
360 subPath: filebeat.yml
363 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.dcaePolicySyncImage }}
364 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
371 fieldPath: status.podIP
372 - name: POLICY_SYNC_PDP_USER
375 name: onap-policy-xacml-pdp-api-creds
377 - name: POLICY_SYNC_PDP_PASS
380 name: onap-policy-xacml-pdp-api-creds
382 - name: POLICY_SYNC_PDP_URL
383 value : http{{ if (include "common.needTLS" .) }}s{{ end }}://policy-xacml-pdp:6969
384 - name: POLICY_SYNC_OUTFILE
385 value : "/etc/policies/policies.json"
386 - name: POLICY_SYNC_V1_DECISION_ENDPOINT
387 value : "policy/pdpx/v1/decision"
388 {{- if $policy.filter }}
389 - name: POLICY_SYNC_FILTER
390 value: {{ $policy.filter }}
392 {{- if $policy.policyID }}
393 - name: POLICY_SYNC_ID
394 value: {{ $policy.policyID }}
396 {{- if $policy.duration }}
397 - name: POLICY_SYNC_DURATION
398 value: {{ $policy.duration }}
400 resources: {{ include "common.resources" . | nindent 2 }}
402 - mountPath: /etc/policies
405 - mountPath: /opt/ca-certificates/
409 hostname: {{ include "common.name" . }}
413 name: {{ include "common.fullname" . }}-application-config-configmap
414 name: app-config-input
425 name: {{ include "common.fullname" . }}-filebeat-configmap
431 {{ if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
432 {{ include "common.certManager.volumesReadOnly" . | nindent 6 }}
436 - name: policy-shared
439 {{- include "dcaegen2-services-common._externalVolumes" . | nindent 6 }}
441 - name: "{{ include "common.namespace" . }}-docker-registry-key"
447 Template to attach CertPostProcessor which merges CMPv2 truststore with AAF truststore
448 and swaps keystore files.
450 {{- define "dcaegen2-services-common._certPostProcessor" -}}
451 {{- $certDir := default "" .Values.certDirectory . -}}
452 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
453 {{- $cmpv2Certificate := (index .Values.certificates 0) -}}
454 {{- $cmpv2CertificateDir := $cmpv2Certificate.mountPath -}}
455 {{- $certType := "pem" -}}
456 {{- if $cmpv2Certificate.keystore -}}
457 {{- $certType = (index $cmpv2Certificate.keystore.outputType 0) -}}
459 {{- $truststoresPaths := printf "%s/%s:%s/%s" $certDir "cacert.pem" $cmpv2CertificateDir "cacert.pem" -}}
460 {{- $truststoresPasswordPaths := ":" -}}
461 {{- $keystoreSourcePaths := printf "%s/%s:%s/%s" $cmpv2CertificateDir "cert.pem" $cmpv2CertificateDir "key.pem" -}}
462 {{- $keystoreDestinationPaths := printf "%s/%s:%s/%s" $certDir "cert.pem" $certDir "key.pem" -}}
463 {{- if not (eq $certType "pem") -}}
464 {{- $truststoresPaths = printf "%s/%s:%s/%s.%s" $certDir "trust.jks" $cmpv2CertificateDir "truststore" $certType -}}
465 {{- $truststoresPasswordPaths = printf "%s/%s:%s/%s" $certDir "trust.pass" $cmpv2CertificateDir "truststore.pass" -}}
466 {{- $keystoreSourcePaths = printf "%s/%s.%s:%s/%s" $cmpv2CertificateDir "keystore" $certType $cmpv2CertificateDir "keystore.pass" -}}
467 {{- $keystoreDestinationPaths = printf "%s/%s.%s:%s/%s.pass" $certDir "cert" $certType $certDir $certType -}}
469 - name: cert-post-processor
470 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.certPostProcessorImage }}
471 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
473 {{- include "common.resources" . | nindent 4 }}
475 - mountPath: {{ $certDir }}
477 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 4 }}
479 - name: TRUSTSTORES_PATHS
480 value: {{ $truststoresPaths | quote}}
481 - name: TRUSTSTORES_PASSWORDS_PATHS
482 value: {{ $truststoresPasswordPaths | quote }}
483 - name: KEYSTORE_SOURCE_PATHS
484 value: {{ $keystoreSourcePaths | quote }}
485 - name: KEYSTORE_DESTINATION_PATHS
486 value: {{ $keystoreDestinationPaths | quote }}
491 Template returns string "true" if CMPv2 certificates should be used and nothing (so it can be used in with statements)
492 when they shouldn't. Example use:
493 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
496 {{- define "dcaegen2-services-common.shouldUseCmpv2Certificates" -}}
497 {{- $certDir := default "" .Values.certDirectory . -}}
498 {{- if (and $certDir .Values.certificates .Values.global.cmpv2Enabled .Values.global.CMPv2CertManagerIntegration .Values.useCmpv2Certificates) -}}