kubernetes/dcaegen2-services/common/dcaegen2-services-common/templates/_deployment.tpl

   1 {{/*
   2 #============LICENSE_START========================================================
   3 # ================================================================================
   4 # Copyright (c) 2021-2023 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
  12 #
  13 #     http://www.apache.org/licenses/LICENSE-2.0
  14 #
  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=========================================================
  21 */}}
  22 {{/*
  23 For internal use only!
  24
  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.
  32
  33 The template expects a single argument, pointing to the caller's global context.
  34
  35 Microservice-specific environment variables can be specified in two ways:
  36   1. As literal string values. (The values can also be Helm template fragments.)
  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.
  39
  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".
  43
  44 applicationEnv:
  45   APPLICATION_PASSWORD:
  46     secretUid: example-secret
  47     key: password
  48   APPLICATION_EXAMPLE: "An example value"
  49
  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".
  54 */}}
  55 {{- define "dcaegen2-services-common._ms-specific-env-vars" -}}
  56   {{- $global := . }}
  57   {{- if .Values.applicationEnv }}
  58     {{- range $envName, $envValue := .Values.applicationEnv }}
  59       {{- if kindIs "string" $envValue }}
  60 - name: {{ $envName }}
  61   value: {{ tpl $envValue $global | quote }}
  62       {{- else }}
  63         {{- if and (hasKey $envValue "externalSecret") ($envValue.externalSecret) }}
  64 - name: {{ $envName }}
  65   valueFrom:
  66     secretKeyRef:
  67       name: {{ tpl $envValue.externalSecretUid $global | quote }}
  68       key: {{ tpl $envValue.key $global | quote }}
  69         {{- else }}
  70           {{ if or (not $envValue.secretUid) (not $envValue.key) }}
  71             {{ fail (printf "Env %s definition is not a string and does not contain secretUid or key fields" $envName) }}
  72           {{- end }}
  73 - name: {{ $envName }}
  74   {{- include "common.secret.envFromSecretFast" (dict "global" $global "uid" $envValue.secretUid "key" $envValue.key) | indent 2 }}
  75         {{- end }}
  76       {{- end -}}
  77     {{- end }}
  78   {{- end }}
  79 {{- end -}}
  80 {{/*
  81 For internal use only!
  82
  83 dcaegen2-services-common._externalVolumes:
  84 This template generates a list of volumes associated with the pod,
  85 based on information provided in .Values.externalVolumes.  This
  86 template works in conjunction with dcaegen2-services-common._externalVolumeMounts
  87 to give the microservice access to data in volumes created else.
  88 This initial implementation supports ConfigMaps only, as this is the only
  89 external volume mounting required by current microservices.
  90
  91 .Values.externalVolumes is a list of objects.  Each object has 3 required fields and 2 optional fields:
  92    - name: the name of the resource (in the current implementation, it must be a ConfigMap)
  93      that is to be set up as a volume.  The value is a case sensitive string.  Because the
  94      names of resources are sometimes set at deployment time (for instance, to prefix the Helm
  95      release to the name), the string can be a Helm template fragment that will be expanded at
  96      deployment time.
  97    - type: the type of the resource (in the current implementation, only "ConfigMap" is supported).
  98      The value is a case-INsensitive string.
  99    - mountPoint: the path to the mount point for the volume in the container file system.  The
 100      value is a case-sensitive string.
 101    - readOnly: (Optional) Boolean flag.  Set to true to mount the volume as read-only.
 102      Defaults to false.
 103    - optional: (Optional) Boolean flag.  Set to true to make the configMap optional (i.e., to allow the
 104      microservice's pod to start even if the configMap doesn't exist).  If set to false, the configMap must
 105      be present in order for the microservice's pod to start. Defaults to true.  (Note that this
 106      default is the opposite of the Kubernetes default.  We've done this to be consistent with the behavior
 107      of the DCAE Cloudify plugin for Kubernetes [k8splugin], which always set "optional" to true.)
 108
 109 Here is an example fragment from a values.yaml file for a microservice:
 110
 111 externalVolumes:
 112   - name: my-example-configmap
 113     type: configmap
 114     mountPath: /opt/app/config
 115   - name: '{{ include "common.release" . }}-another-example'
 116     type: configmap
 117     mountPath: /opt/app/otherconfig
 118     optional: false
 119 */}}
 120 {{- define "dcaegen2-services-common._externalVolumes" -}}
 121   {{- $global := . -}}
 122   {{- if .Values.externalVolumes }}
 123     {{- range $vol := .Values.externalVolumes }}
 124       {{- if eq (lower $vol.type) "configmap" }}
 125         {{- $vname := (tpl $vol.name $global) -}}
 126         {{- $opt := hasKey $vol "optional" | ternary $vol.optional true }}
 127 - configMap:
 128     defaultMode: 420
 129     name: {{ $vname }}
 130     optional: {{ $opt }}
 131   name: {{ $vname }}
 132       {{- end }}
 133     {{- end }}
 134   {{- end }}
 135 {{- end }}
 136 {{/*
 137 For internal use only!
 138
 139 dcaegen2-services-common._externalVolumeMounts:
 140 This template generates a list of volume mounts for the microservice container,
 141 based on information provided in .Values.externalVolumes.  This
 142 template works in conjunction with dcaegen2-services-common._externalVolumes
 143 to give the microservice access to data in volumes created else.
 144 This initial implementation supports ConfigMaps only, as this is the only
 145 external volume mounting required by current microservices.
 146
 147 See the documentation for dcaegen2-services-common._externalVolumes for
 148 details on how external volumes are specified in the values.yaml file for
 149 the microservice.
 150 */}}
 151 {{- define "dcaegen2-services-common._externalVolumeMounts" -}}
 152   {{- $global := . -}}
 153   {{- if .Values.externalVolumes }}
 154     {{- range $vol := .Values.externalVolumes }}
 155       {{- if eq (lower $vol.type) "configmap" }}
 156         {{- $vname := (tpl $vol.name $global) -}}
 157         {{- $readOnly := $vol.readOnly | default false }}
 158 - mountPath: {{ $vol.mountPath }}
 159   name: {{ $vname }}
 160   readOnly: {{ $readOnly }}
 161       {{- end }}
 162     {{- end }}
 163   {{- end }}
 164 {{- end }}
 165 {{/*
 166 dcaegen2-services-common.microserviceDeployment:
 167 This template produces a Kubernetes Deployment for a DCAE microservice.
 168
 169 All DCAE microservices currently use very similar Deployments.  Having a
 170 common template eliminates a lot of repetition in the individual charts
 171 for each microservice.
 172
 173 The template expects the full chart context as input.  A chart for a
 174 DCAE microservice references this template using:
 175 {{ include "dcaegen2-services-common.microserviceDeployment" . }}
 176 The template directly references data in .Values, and indirectly (through its
 177 use of templates from the ONAP "common" collection) references data in
 178 .Release.
 179
 180 The exact content of the Deployment generated from this template
 181 depends on the content of .Values.
 182
 183 The Deployment always includes a single Pod, with a container that uses
 184 the DCAE microservice image.  The image name and tag are specified by
 185 .Values.image.  By default, the image comes from the ONAP repository
 186 (registry) set up by the common repositoryGenerator template.  A different
 187 repository for the microservice image can be set using
 188 .Values.imageRepositoryOverride.   Note that this repository must not
 189 require authentication, because there is no way to specify credentials for
 190 the override repository.  imageRepositoryOverride is intended primarily
 191 for testing purposes.
 192
 193 The Deployment Pod may also include a logging sidecar container.
 194 The sidecar is included if .Values.log.path is set.  The
 195 logging sidecar and the DCAE microservice container share a
 196 volume where the microservice logs are written.
 197
 198 Deployed POD may also include a Policy-sync sidecar container.
 199 The sidecar is included if .Values.policies is set.  The
 200 Policy-sync sidecar polls PolicyEngine (PDP) periodically based
 201 on .Values.policies.duration and configuration retrieved is shared with
 202 DCAE Microservice container by common volume. Policy can be retrieved based on
 203 list of policyID or filter. An optional policyRelease parameter can be specified
 204 to override the default policy helm release (used for retreiving the secret containing
 205 pdp username and password)
 206
 207 Following is example policy config override
 208
 209 dcaePolicySyncImage: onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1
 210 policies:
 211   duration: 300
 212   policyRelease: "onap"
 213   policyID: |
 214     '["onap.vfirewall.tca","onap.vdns.tca"]'
 215
 216 The Deployment includes an initContainer that checks for the
 217 readiness of other components that the microservice relies on.
 218 This container is generated by the "common.readinessCheck.waitfor"
 219 template. See the documentation for this template
 220 (oom/kubernetes/common/readinessCheck/templates/_readinessCheck.tpl).
 221
 222 If the microservice uses a DMaaP Data Router (DR) feed, the Deployment
 223 includes an initContainer that makes provisioning requests to the DMaaP
 224 bus controller (dmaap-bc) to create the feed and to set up a publisher
 225 and/or subscriber to the feed.  The Deployment also includes a second
 226 initContainer that merges the information returned by the provisioning
 227 process into the microservice's configuration.  See the documentation for
 228 the common DMaaP provisioning template
 229 (oom/kubernetes/common/common/templates/_dmaapProvisioning.tpl).
 230
 231 If the microservice uses certificates from an external CMPv2 provider,
 232 the Deployment will include an initContainer that performs certificate
 233 post-processing.
 234 */}}
 235
 236 {{- define "dcaegen2-services-common.microserviceDeployment" -}}
 237 {{- $log := default dict .Values.log -}}
 238 {{- $logDir :=  default "" $log.path -}}
 239 {{- $certDir := (eq "true" (include "common.needTLS" .)) | ternary (default "" .Values.certDirectory . ) "" -}}
 240 {{- $commonRelease :=  print (include "common.release" .) -}}
 241 {{- $policy := default dict .Values.policies -}}
 242 {{- $policyRls := default $commonRelease $policy.policyRelease -}}
 243 {{- $drNeedProvisioning := or .Values.drFeedConfig .Values.drSubConfig -}}
 244 {{- $dcaeName := print (include "common.fullname" .) }}
 245 {{- $dcaeLabel := (dict "dcaeMicroserviceName" $dcaeName) -}}
 246 {{- $dot := . -}}
 247 apiVersion: apps/v1
 248 kind: Deployment
 249 metadata: {{- include "common.resourceMetadata" (dict "dot" $dot "labels" $dcaeLabel) | nindent 2 }}
 250 spec:
 251   replicas: 1
 252   selector: {{- include "common.selectors" . | nindent 4 }}
 253   template:
 254     metadata: {{- include "common.templateMetadata" . | nindent 6 }}
 255     spec:
 256       initContainers:
 257       {{- if .Values.readinessCheck }}
 258       {{ include "common.readinessCheck.waitFor" . | indent 6 | trim }}
 259       {{- end }}
 260       {{- include "common.dmaap.provisioning.initContainer" . | nindent 6 }}
 261       {{ include "dcaegen2-services-common._certPostProcessor" .  | nindent 4 }}
 262       containers:
 263       - image: {{ default ( include "repositoryGenerator.repository" . ) .Values.imageRepositoryOverride }}/{{ .Values.image }}
 264         imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
 265         name: {{ include "common.name" . }}
 266         env:
 267         {{- range $cred := .Values.credentials }}
 268         - name: {{ $cred.name }}
 269           {{- include "common.secret.envFromSecretFast" (dict "global" $ "uid" $cred.uid "key" $cred.key) | indent 10 }}
 270         {{- end }}
 271         {{- if $certDir }}
 272         - name: DCAE_CA_CERTPATH
 273           value: {{ $certDir }}/cacert.pem
 274         {{- end }}
 275         - name: CONSUL_HOST
 276           value: consul-server.onap
 277         - name: CONFIG_BINDING_SERVICE
 278           value: config-binding-service
 279         - name: CBS_CONFIG_URL
 280           value: https://config-binding-service:10443/service_component_all/{{ include "common.name" . }}
 281         - name: POD_IP
 282           valueFrom:
 283             fieldRef:
 284               apiVersion: v1
 285               fieldPath: status.podIP
 286         {{- include "dcaegen2-services-common._ms-specific-env-vars" . | nindent 8 }}
 287         {{- if .Values.service }}
 288         ports: {{ include "common.containerPorts" . | nindent 10 }}
 289         {{- end }}
 290         {{- if .Values.readiness }}
 291         readinessProbe:
 292           initialDelaySeconds: {{ .Values.readiness.initialDelaySeconds | default 5 }}
 293           periodSeconds: {{ .Values.readiness.periodSeconds | default 15 }}
 294           timeoutSeconds: {{ .Values.readiness.timeoutSeconds | default 1 }}
 295           {{- $probeType := .Values.readiness.type | default "httpGet" -}}
 296           {{- if eq $probeType "httpGet" }}
 297           httpGet:
 298             scheme: {{ .Values.readiness.scheme }}
 299             path: {{ .Values.readiness.path }}
 300             port: {{ .Values.readiness.port }}
 301           {{- end }}
 302           {{- if eq $probeType "exec" }}
 303           exec:
 304             command:
 305             {{- range $cmd := .Values.readiness.command }}
 306             - {{ $cmd }}
 307             {{- end }}
 308           {{- end }}
 309         {{- end }}
 310         resources: {{ include "common.resources" . | nindent 10 }}
 311         volumeMounts:
 312         - mountPath: /app-config
 313           name: {{ ternary "app-config-input" "app-config" (not $drNeedProvisioning) }}
 314         - mountPath: /app-config-input
 315           name: app-config-input
 316         {{- if $logDir }}
 317         - mountPath: {{ $logDir}}
 318           name: logs
 319         {{- end }}
 320         {{- if $certDir }}
 321         - mountPath: {{ $certDir }}
 322           name: tls-info
 323           {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
 324           {{- include "common.certManager.volumeMountsReadOnly" . | nindent 8 -}}
 325           {{- end -}}
 326         {{- end }}
 327         {{- if $policy }}
 328         - name: policy-shared
 329           mountPath: /etc/policies
 330         {{- end }}
 331         {{- include "dcaegen2-services-common._externalVolumeMounts" . | nindent 8 }}
 332       {{- if $logDir }}
 333       {{ include "common.log.sidecar" . | nindent 6 }}
 334       {{- end }}
 335       {{- if $policy }}
 336       - image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.dcaePolicySyncImage }}
 337         imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
 338         name: policy-sync
 339         env:
 340         - name: POD_IP
 341           valueFrom:
 342             fieldRef:
 343               apiVersion: v1
 344               fieldPath: status.podIP
 345         - name: POLICY_SYNC_PDP_USER
 346           valueFrom:
 347             secretKeyRef:
 348               name: {{ $policyRls }}-policy-xacml-pdp-restserver-creds
 349               key: login
 350         - name: POLICY_SYNC_PDP_PASS
 351           valueFrom:
 352             secretKeyRef:
 353               name: {{ $policyRls }}-policy-xacml-pdp-restserver-creds
 354               key: password
 355         - name: POLICY_SYNC_PDP_URL
 356           value : http{{ if (include "common.needTLS" .) }}s{{ end }}://policy-xacml-pdp:6969
 357         - name: POLICY_SYNC_OUTFILE
 358           value : "/etc/policies/policies.json"
 359         - name: POLICY_SYNC_V1_DECISION_ENDPOINT
 360           value : "policy/pdpx/v1/decision"
 361         {{- if $policy.filter }}
 362         - name: POLICY_SYNC_FILTER
 363           value: {{ $policy.filter }}
 364         {{- end -}}
 365         {{- if $policy.policyID }}
 366         - name: POLICY_SYNC_ID
 367           value: {{ $policy.policyID }}
 368         {{- end -}}
 369         {{- if $policy.duration }}
 370         - name: POLICY_SYNC_DURATION
 371           value: "{{ $policy.duration }}"
 372         {{- end }}
 373         resources: {{ include "common.resources" . | nindent 10 }}
 374         volumeMounts:
 375         - mountPath: /etc/policies
 376           name: policy-shared
 377       {{- end }}
 378       hostname: {{ include "common.name" . }}
 379       serviceAccountName: {{ include "common.fullname" (dict "suffix" "read" "dot" . )}}
 380       volumes:
 381       - configMap:
 382           defaultMode: 420
 383           name: {{ include "common.fullname" . }}-application-config-configmap
 384         name: app-config-input
 385       - emptyDir:
 386           medium: Memory
 387         name: app-config
 388       {{- if $logDir }}
 389       - emptyDir: {}
 390         name: logs
 391       {{ include "common.log.volumes" (dict "dot" . "configMapNamePrefix" (tpl .Values.logConfigMapNamePrefix . )) | nindent 6 }}
 392       {{- end }}
 393       {{- if $certDir }}
 394       - emptyDir: {}
 395         name: tls-info
 396         {{ if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
 397         {{ include "common.certManager.volumesReadOnly" . | nindent 6 }}
 398         {{- end }}
 399       {{- end }}
 400       {{- if $policy }}
 401       - name: policy-shared
 402         emptyDir: {}
 403       {{- end }}
 404       {{- include "common.dmaap.provisioning._volumes" . | nindent 6 -}}
 405       {{- include "dcaegen2-services-common._externalVolumes" . | nindent 6 }}
 406       {{- include "common.imagePullSecrets" . | nindent 6 }}
 407 {{ end -}}
 408
 409 {{/*
 410   For internal use
 411
 412   Template to attach CertPostProcessor which merges CMPv2 truststore with AAF truststore
 413   and swaps keystore files.
 414 */}}
 415 {{- define "dcaegen2-services-common._certPostProcessor" -}}
 416   {{- $certDir := default "" .Values.certDirectory . -}}
 417   {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
 418     {{- $cmpv2Certificate := (index .Values.certificates 0) -}}
 419     {{- $cmpv2CertificateDir := $cmpv2Certificate.mountPath -}}
 420     {{- $certType := "pem" -}}
 421     {{- if $cmpv2Certificate.keystore -}}
 422       {{- $certType = (index $cmpv2Certificate.keystore.outputType 0) -}}
 423     {{- end -}}
 424     {{- $truststoresPaths := printf "%s/%s:%s/%s" $certDir "cacert.pem" $cmpv2CertificateDir "cacert.pem" -}}
 425     {{- $truststoresPasswordPaths := ":" -}}
 426     {{- $keystoreSourcePaths := printf "%s/%s:%s/%s" $cmpv2CertificateDir "cert.pem" $cmpv2CertificateDir "key.pem" -}}
 427     {{- $keystoreDestinationPaths := printf "%s/%s:%s/%s" $certDir "cert.pem" $certDir "key.pem" -}}
 428     {{- if not (eq $certType "pem") -}}
 429       {{- $truststoresPaths = printf "%s/%s:%s/%s.%s" $certDir "trust.jks" $cmpv2CertificateDir "truststore" $certType -}}
 430       {{- $truststoresPasswordPaths = printf "%s/%s:%s/%s" $certDir "trust.pass" $cmpv2CertificateDir "truststore.pass" -}}
 431       {{- $keystoreSourcePaths = printf "%s/%s.%s:%s/%s" $cmpv2CertificateDir "keystore" $certType $cmpv2CertificateDir "keystore.pass" -}}
 432       {{- $keystoreDestinationPaths = printf "%s/%s.%s:%s/%s.pass" $certDir "cert" $certType $certDir $certType -}}
 433     {{- end }}
 434   - name: cert-post-processor
 435     image: {{ include "repositoryGenerator.repository" . }}/{{ .Values.certPostProcessorImage }}
 436     imagePullPolicy: {{ .Values.global.pullPolicy | default .Values.pullPolicy }}
 437     resources:
 438       {{- include "common.resources" . | nindent 4 }}
 439     volumeMounts:
 440     - mountPath: {{ $certDir }}
 441       name: tls-info
 442       {{- include "common.certManager.volumeMountsReadOnly" . | nindent 4 }}
 443     env:
 444     - name: TRUSTSTORES_PATHS
 445       value: {{ $truststoresPaths | quote}}
 446     - name: TRUSTSTORES_PASSWORDS_PATHS
 447       value: {{ $truststoresPasswordPaths | quote }}
 448     - name: KEYSTORE_SOURCE_PATHS
 449       value: {{ $keystoreSourcePaths | quote }}
 450     - name: KEYSTORE_DESTINATION_PATHS
 451       value: {{ $keystoreDestinationPaths | quote }}
 452   {{- end }}
 453 {{- end -}}
 454
 455 {{/*
 456   Template returns string "true" if CMPv2 certificates should be used and nothing (so it can be used in with statements)
 457   when they shouldn't. Example use:
 458     {{- if (include "dcaegen2-services-common.shouldUseCmpv2Certificates" .) -}}
 459
 460 */}}
 461 {{- define "dcaegen2-services-common.shouldUseCmpv2Certificates" -}}
 462   {{- $certDir := default "" .Values.certDirectory . -}}
 463   {{- if (and $certDir .Values.certificates .Values.global.cmpv2Enabled .Values.useCmpv2Certificates) -}}
 464   true
 465   {{- end -}}
 466 {{- end -}}