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 dcaegen2-services-common.microserviceDeployment:
73 This template produces a Kubernetes Deployment for a DCAE microservice.
75 All DCAE microservices currently use very similar Deployments. Having a
76 common template eliminates a lot of repetition in the individual charts
77 for each microservice.
79 The template expects the full chart context as input. A chart for a
80 DCAE microservice references this template using:
81 {{ include "dcaegen2-services-common.microserviceDeployment" . }}
82 The template directly references data in .Values, and indirectly (through its
83 use of templates from the ONAP "common" collection) references data in
86 The exact content of the Deployment generated from this template
87 depends on the content of .Values.
89 The Deployment always includes a single Pod, with a container that uses
90 the DCAE microservice image.
92 The Deployment Pod may also include a logging sidecar container.
93 The sidecar is included if .Values.logDirectory is set. The
94 logging sidecar and the DCAE microservice container share a
95 volume where the microservice logs are written.
97 The Deployment includes an initContainer that pushes the
98 microservice's initial configuration (from .Values.applicationConfig)
99 into Consul. All DCAE microservices retrieve their initial
100 configurations by making an API call to a DCAE platform component called
101 the config-binding-service. The config-binding-service currently
102 retrieves configuration information from Consul.
104 The Deployment also includes an initContainer that checks for the
105 readiness of other components that the microservice relies on.
106 This container is generated by the "common.readinessCheck.waitfor"
109 If the microservice acts as a TLS client or server, the Deployment will
110 include an initContainer that retrieves certificate information from
111 the AAF certificate manager. The information is mounted at the
112 mount point specified in .Values.certDirectory. If the microservice is
113 a TLS server (indicated by setting .Values.tlsServer to true), the
114 certificate information will include a server cert and key, in various
115 formats. It will also include the AAF CA cert. If the microservice is
116 a TLS client only (indicated by setting .Values.tlsServer to false), the
117 certificate information includes only the AAF CA cert.
119 Deployed POD may also include a Policy-sync sidecar container.
120 The sidecar is included if .Values.policies is set. The
121 Policy-sync sidecar polls PolicyEngine (PDP) periodically based
122 on .Values.policies.duration and configuration retrieved is shared with
123 DCAE Microservice container by common volume. Policy can be retrieved based on
124 list of policyID or filter
127 {{- define "dcaegen2-services-common.microserviceDeployment" -}}
128 {{- $logDir := default "" .Values.logDirectory -}}
129 {{- $certDir := default "" .Values.certDirectory . -}}
130 {{- $tlsServer := default "" .Values.tlsServer -}}
131 {{- $policy := default "" .Values.policies -}}
135 metadata: {{- include "common.resourceMetadata" . | nindent 2 }}
138 selector: {{- include "common.selectors" . | nindent 4 }}
140 metadata: {{- include "common.templateMetadata" . | nindent 6 }}
148 {{- range $var := .Values.customEnvVars }}
149 export {{ $var.name }}="{{ $var.value }}";
151 cd /config-input && for PFILE in `ls -1`; do envsubst <${PFILE} >/config/${PFILE}; done
153 {{- range $cred := .Values.credentials }}
154 - name: {{ $cred.name }}
155 {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
158 - mountPath: /config-input
159 name: app-config-input
162 image: {{ include "repositoryGenerator.image.envsubst" . }}
163 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
164 name: {{ include "common.name" . }}-update-config
166 {{ include "common.readinessCheck.waitFor" . | indent 6 | trim }}
168 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.consulLoaderImage }}
169 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
172 - "{{ include "common.name" . }}|/app-config/application_config.yaml"
173 resources: {{ include "common.resources" . | nindent 2 }}
175 - mountPath: /app-config
179 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.tlsImage }}
180 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
183 value: {{ $tlsServer | quote }}
188 fieldPath: status.podIP
189 resources: {{ include "common.resources" . | nindent 2 }}
191 - mountPath: /opt/app/osaaf
194 {{ include "dcaegen2-services-common._certPostProcessor" . | nindent 4 }}
196 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.image }}
197 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
198 name: {{ include "common.name" . }}
201 - name: DCAE_CA_CERTPATH
202 value: {{ $certDir }}/cacert.pem
205 value: consul-server.onap
206 - name: CONFIG_BINDING_SERVICE
207 value: config-binding-service
208 - name: CBS_CONFIG_URL
209 value: https://config-binding-service:10443/service_component_all/{{ include "common.name" . }}
214 fieldPath: status.podIP
215 {{- include "dcaegen2-services-common._ms-specific-env-vars" . | nindent 8 }}
216 {{- if .Values.service }}
217 ports: {{ include "common.containerPorts" . | nindent 10 }}
219 {{- if .Values.readiness }}
221 initialDelaySeconds: {{ .Values.readiness.initialDelaySeconds | default 5 }}
222 periodSeconds: {{ .Values.readiness.periodSeconds | default 15 }}
223 timeoutSeconds: {{ .Values.readiness.timeoutSeconds | default 1 }}
224 {{- $probeType := .Values.readiness.type | default "httpGet" -}}
225 {{- if eq $probeType "httpGet" }}
227 scheme: {{ .Values.readiness.scheme }}
228 path: {{ .Values.readiness.path }}
229 port: {{ .Values.readiness.port }}
231 {{- if eq $probeType "exec" }}
234 {{- range $cmd := .Values.readiness.command }}
239 resources: {{ include "common.resources" . | nindent 2 }}
241 - mountPath: /app-config
244 - mountPath: {{ $logDir}}
248 - mountPath: {{ $certDir }}
250 {{- if and .Values.certificates .Values.global.cmpv2Enabled .Values.global.CMPv2CertManagerIntegration -}}
251 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 8 -}}
255 - name: policy-shared
256 mountPath: /etc/policies
259 - image: {{ include "repositoryGenerator.image.logging" . }}
260 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
267 fieldPath: status.podIP
268 resources: {{ include "common.resources" . | nindent 2 }}
270 - mountPath: /var/log/onap/{{ include "common.name" . }}
272 - mountPath: /usr/share/filebeat/data
274 - mountPath: /usr/share/filebeat/filebeat.yml
276 subPath: filebeat.yml
279 - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.dcaePolicySyncImage }}
280 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
287 fieldPath: status.podIP
288 - name: POLICY_SYNC_PDP_USER
291 name: onap-policy-xacml-pdp-api-creds
293 - name: POLICY_SYNC_PDP_PASS
296 name: onap-policy-xacml-pdp-api-creds
298 - name: POLICY_SYNC_PDP_URL
299 value : http{{ if (include "common.needTLS" .) }}s{{ end }}://policy-xacml-pdp:6969
300 - name: POLICY_SYNC_OUTFILE
301 value : "/etc/policies/policies.json"
302 - name: POLICY_SYNC_V1_DECISION_ENDPOINT
303 value : "policy/pdpx/v1/decision"
304 {{- if $policy.filter }}
305 - name: POLICY_SYNC_FILTER
306 value: {{ $policy.filter }}
308 {{- if $policy.policyID }}
309 - name: POLICY_SYNC_ID
310 value: {{ $policy.policyID }}
312 {{- if $policy.duration }}
313 - name: POLICY_SYNC_DURATION
314 value: {{ $policy.duration }}
316 resources: {{ include "common.resources" . | nindent 2 }}
318 - mountPath: /etc/policies
321 - mountPath: /opt/ca-certificates/
325 hostname: {{ include "common.name" . }}
329 name: {{ include "common.fullname" . }}-application-config-configmap
330 name: app-config-input
341 name: {{ include "common.fullname" . }}-filebeat-configmap
347 {{ if and .Values.certificates .Values.global.cmpv2Enabled .Values.global.CMPv2CertManagerIntegration -}}
348 {{ include "common.certManager.volumesReadOnly" . | nindent 6 }}
352 - name: policy-shared
356 - name: "{{ include "common.namespace" . }}-docker-registry-key"
362 Template to attach CertPostProcessor which merges CMPv2 truststore with AAF truststore
363 and swaps keystore files.
365 {{- define "dcaegen2-services-common._certPostProcessor" -}}
366 {{- $certDir := default "" .Values.certDirectory . -}}
367 {{- if and $certDir .Values.certificates .Values.global.cmpv2Enabled .Values.global.CMPv2CertManagerIntegration -}}
368 {{- $cmpv2Certificate := (index .Values.certificates 0) -}}
369 {{- $cmpv2CertificateDir := $cmpv2Certificate.mountPath -}}
370 {{- $certType := "pem" -}}
371 {{- if $cmpv2Certificate.keystore -}}
372 {{- $certType = (index $cmpv2Certificate.keystore.outputType 0) -}}
374 {{- $truststoresPaths := printf "%s/%s:%s/%s" $certDir "cacert.pem" $cmpv2CertificateDir "cacert.pem" -}}
375 {{- $truststoresPasswordPaths := ":" -}}
376 {{- $keystoreSourcePaths := printf "%s/%s:%s/%s" $cmpv2CertificateDir "cert.pem" $cmpv2CertificateDir "key.pem" -}}
377 {{- $keystoreDestinationPaths := printf "%s/%s:%s/%s" $certDir "cert.pem" $certDir "key.pem" -}}
378 {{- if not (eq $certType "pem") -}}
379 {{- $truststoresPaths = printf "%s/%s:%s/%s.%s" $certDir "trust.jks" $cmpv2CertificateDir "truststore" $certType -}}
380 {{- $truststoresPasswordPaths = printf "%s/%s:%s/%s" $certDir "trust.pass" $cmpv2CertificateDir "truststore.pass" -}}
381 {{- $keystoreSourcePaths = printf "%s/%s.%s:%s/%s" $cmpv2CertificateDir "keystore" $certType $cmpv2CertificateDir "keystore.pass" -}}
382 {{- $keystoreDestinationPaths = printf "%s/%s.%s:%s/%s.pass" $certDir "cert" $certType $certDir $certType -}}
384 - name: cert-post-processor
385 image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.certPostProcessorImage }}
386 imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
388 {{- include "common.resources" . | nindent 4 }}
390 - mountPath: {{ $certDir }}
392 {{- include "common.certManager.volumeMountsReadOnly" . | nindent 4 }}
394 - name: TRUSTSTORES_PATHS
395 value: {{ $truststoresPaths | quote}}
396 - name: TRUSTSTORES_PASSWORDS_PATHS
397 value: {{ $truststoresPasswordPaths | quote }}
398 - name: KEYSTORE_SOURCE_PATHS
399 value: {{ $keystoreSourcePaths | quote }}
400 - name: KEYSTORE_DESTINATION_PATHS
401 value: {{ $keystoreDestinationPaths | quote }}