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 # Copyright (c) 2021 Nordix Foundation.
8 # ================================================================================
9 # Licensed under the Apache License, Version 2.0 (the "License");
10 # you may not use this file except in compliance with the License.
11 # You may obtain a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 # See the License for the specific language governing permissions and
19 # limitations under the License.
20 # ============LICENSE_END=========================================================
23 For internal use only!
25 dcaegen2-services-common._ms-specific-env-vars:
26 This template generates a list of microservice-specific environment variables
27 as specified in .Values.applicationEnv. The
28 dcaegen2-services-common.microServiceDeployment uses this template
29 to add the microservice-specific environment variables to the microservice's container.
30 These environment variables are in addition to a standard set of environment variables
31 provided to all microservices.
33 The template expects a single argument, pointing to the caller's global context.
35 Microservice-specific environment variables can be specified in two ways:
36 1. As literal string values.
37 2. As values that are sourced from a secret, identified by the secret's
38 uid and the key within the secret that provides the value.
40 The following example shows an example of each type. The example assumes
41 that a secret has been created using the OOM common secret mechanism, with
42 a secret uid "example-secret" and a key called "password".
46 secretUid: example-secret
48 APPLICATION_EXAMPLE: "An example value"
50 The example would set two environment variables on the microservice's container,
51 one called "APPLICATION_PASSWORD" with the value set from the "password" key in
52 the secret with uid "example-secret", and one called "APPLICATION_EXAMPLE" set to
53 the the literal string "An example value".
55 {{- define "dcaegen2-services-common._ms-specific-env-vars" -}}
57 {{- if .Values.applicationEnv }}
58 {{- range $envName, $envValue := .Values.applicationEnv }}
59 {{- if kindIs "string" $envValue }}
60 - name: {{ $envName }}
61 value: {{ $envValue | quote }}
63 {{ if or (not $envValue.secretUid) (not $envValue.key) }}
64 {{ fail (printf "Env %s definition is not a string and does not contain secretUid or key fields" $envName) }}
66 - name: {{ $envName }}
67 {{- include "common.secret.envFromSecretFast" (dict "global" $global "uid" $envValue.secretUid "key" $envValue.key) | indent 2 }}
73 For internal use only!
75 dcaegen2-services-common._externalVolumes:
76 This template generates a list of volumes associated with the pod,
77 based on information provided in .Values.externalVolumes. This
78 template works in conjunction with dcaegen2-services-common._externalVolumeMounts
79 to give the microservice access to data in volumes created else.
80 This initial implementation supports ConfigMaps only, as this is the only
81 external volume mounting required by current microservices.
83 .Values.externalVolumes is a list of objects. Each object has 3 required fields and 2 optional fields:
84 - name: the name of the resource (in the current implementation, it must be a ConfigMap)
85 that is to be set up as a volume. The value is a case sensitive string. Because the
86 names of resources are sometimes set at deployment time (for instance, to prefix the Helm
87 release to the name), the string can be a Helm template fragment that will be expanded at
89 - type: the type of the resource (in the current implementation, only "ConfigMap" is supported).
90 The value is a case-INsensitive string.
91 - mountPoint: the path to the mount point for the volume in the container file system. The
92 value is a case-sensitive string.
93 - readOnly: (Optional) Boolean flag. Set to true to mount the volume as read-only.
95 - optional: (Optional) Boolean flag. Set to true to make the configMap optional (i.e., to allow the
96 microservice's pod to start even if the configMap doesn't exist). If set to false, the configMap must
97 be present in order for the microservice's pod to start. Defaults to true. (Note that this
98 default is the opposite of the Kubernetes default. We've done this to be consistent with the behavior
99 of the DCAE Cloudify plugin for Kubernetes [k8splugin], which always set "optional" to true.)
101 Here is an example fragment from a values.yaml file for a microservice:
104 - name: my-example-configmap
106 mountPath: /opt/app/config
107 - name: '{{ include "common.release" . }}-another-example'
109 mountPath: /opt/app/otherconfig
112 {{- define "dcaegen2-services-common._externalVolumes" -}}
114 {{- if .Values.externalVolumes }}
115 {{- range $vol := .Values.externalVolumes }}
116 {{- if eq (lower $vol.type) "configmap" }}
117 {{- $vname := (tpl $vol.name $global) -}}
118 {{- $opt := hasKey $vol "optional" | ternary $vol.optional true }}
129 For internal use only!
131 dcaegen2-services-common._externalVolumeMounts:
132 This template generates a list of volume mounts for the microservice container,
133 based on information provided in .Values.externalVolumes. This
134 template works in conjunction with dcaegen2-services-common._externalVolumes
135 to give the microservice access to data in volumes created else.
136 This initial implementation supports ConfigMaps only, as this is the only
137 external volume mounting required by current microservices.
139 See the documentation for dcaegen2-services-common._externalVolumes for
140 details on how external volumes are specified in the values.yaml file for
143 {{- define "dcaegen2-services-common._externalVolumeMounts" -}}
145 {{- if .Values.externalVolumes }}
146 {{- range $vol := .Values.externalVolumes }}
147 {{- if eq (lower $vol.type) "configmap" }}
148 {{- $vname := (tpl $vol.name $global) -}}
149 {{- $readOnly := $vol.readOnly | default false }}
150 - mountPath: {{ $vol.mountPath }}
152 readOnly: {{ $readOnly }}
158 dcaegen2-services-common.microserviceDeployment:
159 This template produces a Kubernetes Deployment for a DCAE microservice.
161 All DCAE microservices currently use very similar Deployments. Having a
162 common template eliminates a lot of repetition in the individual charts
163 for each microservice.
165 The template expects the full chart context as input. A chart for a
166 DCAE microservice references this template using:
167 {{ include "dcaegen2-services-common.microserviceDeployment" . }}
168 The template directly references data in .Values, and indirectly (through its
169 use of templates from the ONAP "common" collection) references data in
172 The exact content of the Deployment generated from this template
173 depends on the content of .Values.
175 The Deployment always includes a single Pod, with a container that uses
176 the DCAE microservice image.
178 The Deployment Pod may also include a logging sidecar container.
179 The sidecar is included if .Values.logDirectory is set. The
180 logging sidecar and the DCAE microservice container share a
181 volume where the microservice logs are written.
183 The Deployment includes an initContainer that pushes the
184 microservice's initial configuration (from .Values.applicationConfig)
185 into Consul. All DCAE microservices retrieve their initial
186 configurations by making an API call to a DCAE platform component called
187 the config-binding-service. The config-binding-service currently
188 retrieves configuration information from Consul.
190 The Deployment also includes an initContainer that checks for the
191 readiness of other components that the microservice relies on.
192 This container is generated by the "common.readinessCheck.waitfor"
195 If the microservice acts as a TLS client or server, the Deployment will
196 include an initContainer that retrieves certificate information from
197 the AAF certificate manager. The information is mounted at the
198 mount point specified in .Values.certDirectory. If the microservice is
199 a TLS server (indicated by setting .Values.tlsServer to true), the
200 certificate information will include a server cert and key, in various
201 formats. It will also include the AAF CA cert. If the microservice is
202 a TLS client only (indicated by setting .Values.tlsServer to false), the
203 certificate information includes only the AAF CA cert.
205 Deployed POD may also include a Policy-sync sidecar container.
206 The sidecar is included if .Values.policies is set. The
207 Policy-sync sidecar polls PolicyEngine (PDP) periodically based
208 on .Values.policies.duration and configuration retrieved is shared with
209 DCAE Microservice container by common volume. Policy can be retrieved based on
210 list of policyID or filter
213 {{- define "dcaegen2-services-common.microserviceDeployment" -}}
214 {{- $logDir := default "" .Values.logDirectory -}}
215 {{- $certDir := default "" .Values.certDirectory . -}}
216 {{- $tlsServer := default "" .Values.tlsServer -}}
217 {{- $policy := default "" .Values.policies -}}
218 {{- $drFeedConfig := default "" .Values.drFeedConfig -}}
222 metadata: {{- include "common.resourceMetadata" . | nindent 2 }}
225 selector: {{- include "common.selectors" . | nindent 4 }}
227 metadata: {{- include "common.templateMetadata" . | nindent 6 }}
230 {{- if not $drFeedConfig }}
236 {{- range $var := .Values.customEnvVars }}
237 export {{ $var.name }}="{{ $var.value }}";
239 cd /config-input && for PFILE in `ls -1`; do envsubst <${PFILE} >/config/${PFILE}; done
241 {{- range $cred := .Values.credentials }}
242 - name: {{ $cred.name }}
243 {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
246 - mountPath: /config-input
247 name: app-config-input
250 image: {{ include "repositoryGenerator.image.envsubst" . }}
251 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
252 name: {{ include "common.name" . }}-update-config
254 {{ include "common.readinessCheck.waitFor" . | indent 6 | trim }}
255 {{- include "common.dmaap.provisioning.initContainer" . | nindent 6 }}
257 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.consulLoaderImage }}
258 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
261 - "{{ include "common.name" . }}|/app-config/application_config.yaml"
262 resources: {{ include "common.resources" . | nindent 2 }}
264 - mountPath: /app-config
268 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.tlsImage }}
269 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
272 value: {{ $tlsServer | quote }}
277 fieldPath: status.podIP
278 resources: {{ include "common.resources" . | nindent 2 }}
280 - mountPath: /opt/app/osaaf
283 {{ include "dcaegen2-services-common._certPostProcessor" . | nindent 4 }}
285 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.image }}
286 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
287 name: {{ include "common.name" . }}
289 {{- range $cred := .Values.credentials }}
290 - name: {{ $cred.name }}
291 {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
294 - name: DCAE_CA_CERTPATH
295 value: {{ $certDir }}/cacert.pem
298 value: consul-server.onap
299 - name: CONFIG_BINDING_SERVICE
300 value: config-binding-service
301 - name: CBS_CONFIG_URL
302 value: https://config-binding-service:10443/service_component_all/{{ include "common.name" . }}
307 fieldPath: status.podIP
308 {{- include "dcaegen2-services-common._ms-specific-env-vars" . | nindent 8 }}
309 {{- if .Values.service }}
310 ports: {{ include "common.containerPorts" . | nindent 10 }}
312 {{- if .Values.readiness }}
314 initialDelaySeconds: {{ .Values.readiness.initialDelaySeconds | default 5 }}
315 periodSeconds: {{ .Values.readiness.periodSeconds | default 15 }}
316 timeoutSeconds: {{ .Values.readiness.timeoutSeconds | default 1 }}
317 {{- $probeType := .Values.readiness.type | default "httpGet" -}}
318 {{- if eq $probeType "httpGet" }}
320 scheme: {{ .Values.readiness.scheme }}
321 path: {{ .Values.readiness.path }}
322 port: {{ .Values.readiness.port }}
324 {{- if eq $probeType "exec" }}
327 {{- range $cmd := .Values.readiness.command }}
332 resources: {{ include "common.resources" . | nindent 2 }}
334 - mountPath: /app-config
336 - mountPath: /app-config-input
337 name: app-config-input
339 - mountPath: {{ $logDir}}
343 - mountPath: {{ $certDir }}
345 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
346 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 8 -}}
350 - name: policy-shared
351 mountPath: /etc/policies
353 {{- include "dcaegen2-services-common._externalVolumeMounts" . | nindent 8 }}
355 - image: {{ include "repositoryGenerator.image.logging" . }}
356 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
363 fieldPath: status.podIP
364 resources: {{ include "common.resources" . | nindent 2 }}
366 - mountPath: /var/log/onap/{{ include "common.name" . }}
368 - mountPath: /usr/share/filebeat/data
370 - mountPath: /usr/share/filebeat/filebeat.yml
372 subPath: filebeat.yml
375 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.dcaePolicySyncImage }}
376 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
383 fieldPath: status.podIP
384 - name: POLICY_SYNC_PDP_USER
387 name: onap-policy-xacml-pdp-api-creds
389 - name: POLICY_SYNC_PDP_PASS
392 name: onap-policy-xacml-pdp-api-creds
394 - name: POLICY_SYNC_PDP_URL
395 value : http{{ if (include "common.needTLS" .) }}s{{ end }}://policy-xacml-pdp:6969
396 - name: POLICY_SYNC_OUTFILE
397 value : "/etc/policies/policies.json"
398 - name: POLICY_SYNC_V1_DECISION_ENDPOINT
399 value : "policy/pdpx/v1/decision"
400 {{- if $policy.filter }}
401 - name: POLICY_SYNC_FILTER
402 value: {{ $policy.filter }}
404 {{- if $policy.policyID }}
405 - name: POLICY_SYNC_ID
406 value: {{ $policy.policyID }}
408 {{- if $policy.duration }}
409 - name: POLICY_SYNC_DURATION
410 value: {{ $policy.duration }}
412 resources: {{ include "common.resources" . | nindent 2 }}
414 - mountPath: /etc/policies
417 - mountPath: /opt/ca-certificates/
421 hostname: {{ include "common.name" . }}
425 name: {{ include "common.fullname" . }}-application-config-configmap
426 name: app-config-input
437 name: {{ include "common.fullname" . }}-filebeat-configmap
443 {{ if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
444 {{ include "common.certManager.volumesReadOnly" . | nindent 6 }}
448 - name: policy-shared
451 {{- include "common.dmaap.provisioning._volumes" . | nindent 6 -}}
452 {{- include "dcaegen2-services-common._externalVolumes" . | nindent 6 }}
454 - name: "{{ include "common.namespace" . }}-docker-registry-key"
460 Template to attach CertPostProcessor which merges CMPv2 truststore with AAF truststore
461 and swaps keystore files.
463 {{- define "dcaegen2-services-common._certPostProcessor" -}}
464 {{- $certDir := default "" .Values.certDirectory . -}}
465 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
466 {{- $cmpv2Certificate := (index .Values.certificates 0) -}}
467 {{- $cmpv2CertificateDir := $cmpv2Certificate.mountPath -}}
468 {{- $certType := "pem" -}}
469 {{- if $cmpv2Certificate.keystore -}}
470 {{- $certType = (index $cmpv2Certificate.keystore.outputType 0) -}}
472 {{- $truststoresPaths := printf "%s/%s:%s/%s" $certDir "cacert.pem" $cmpv2CertificateDir "cacert.pem" -}}
473 {{- $truststoresPasswordPaths := ":" -}}
474 {{- $keystoreSourcePaths := printf "%s/%s:%s/%s" $cmpv2CertificateDir "cert.pem" $cmpv2CertificateDir "key.pem" -}}
475 {{- $keystoreDestinationPaths := printf "%s/%s:%s/%s" $certDir "cert.pem" $certDir "key.pem" -}}
476 {{- if not (eq $certType "pem") -}}
477 {{- $truststoresPaths = printf "%s/%s:%s/%s.%s" $certDir "trust.jks" $cmpv2CertificateDir "truststore" $certType -}}
478 {{- $truststoresPasswordPaths = printf "%s/%s:%s/%s" $certDir "trust.pass" $cmpv2CertificateDir "truststore.pass" -}}
479 {{- $keystoreSourcePaths = printf "%s/%s.%s:%s/%s" $cmpv2CertificateDir "keystore" $certType $cmpv2CertificateDir "keystore.pass" -}}
480 {{- $keystoreDestinationPaths = printf "%s/%s.%s:%s/%s.pass" $certDir "cert" $certType $certDir $certType -}}
482 - name: cert-post-processor
483 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.certPostProcessorImage }}
484 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
486 {{- include "common.resources" . | nindent 4 }}
488 - mountPath: {{ $certDir }}
490 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 4 }}
492 - name: TRUSTSTORES_PATHS
493 value: {{ $truststoresPaths | quote}}
494 - name: TRUSTSTORES_PASSWORDS_PATHS
495 value: {{ $truststoresPasswordPaths | quote }}
496 - name: KEYSTORE_SOURCE_PATHS
497 value: {{ $keystoreSourcePaths | quote }}
498 - name: KEYSTORE_DESTINATION_PATHS
499 value: {{ $keystoreDestinationPaths | quote }}
504 Template returns string "true" if CMPv2 certificates should be used and nothing (so it can be used in with statements)
505 when they shouldn't. Example use:
506 {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
509 {{- define "dcaegen2-services-common.shouldUseCmpv2Certificates" -}}
510 {{- $certDir := default "" .Values.certDirectory . -}}
511 {{- if (and $certDir .Values.certificates .Values.global.cmpv2Enabled .Values.useCmpv2Certificates) -}}