Helm Generator for DCAE MS

Wiki to track the design requirements for Helm generator to support DCAEGEN2-2694 - Getting issue details... STATUS

USECASES

Build helm chart generator taking following inputs (values.yaml) and templates to generate chart package and perform lint for consolidated charts.

Helm Chart directory structure

templates:

(Include dependent charts along with main chart so that the validation can be done)

Helm lint (checks for syntax) – Initial validation can be just done with lint.

Validation needs to be configured (default – enabled and can be disabled) - DONE - 20 May 2021

a. Run it as standalone tool - so that it can be run with the given input and generate helm chart package.

Note: This is for testing purpose only until the integration with Catalog Service is done.

tool parameters are Input template directory and output chart directory - IN PROGRESS

2. Separate Values.yaml into separate templates and verify dynamic values.yaml generation (and parameter substitution

Configuration/parameters required common across MS ( highlighted in yellow in ppt)

Configuration/parameters to be templatized and values sourced from ComponentSpec ( highlighed in Red )

~~Note : Optional configuration/parameters to be templatized and included based on flags/properties from ComponentSpec~~ (Covered under 6 to 10)

The generator must consolidate these separate base values.template and created required values.yaml

TEST: Generated charts must be validated in ONAP lab K8S environment

Refer Sample Chart Yaml mapping from component spec and Sample Values yaml mapping from component spec in the requirements document.

Outstanding - 06/01/2021

stream_publish/stream_subscribe handle as string; change VES spec and test
readiness mapping Include PORT into auxillary.healthcheck on component spec schema as optional parameter for mapping into readiness check
globalNodeportPrefix - make default and override based on input

3. Identify Component-spec schema changes for ENV setting mapping (refer REQ #1 below) IN PROGRESS

Spec schema sample to be added under REQ1 section and also updated component spec schema file

4. Identify Component-spec schema changes for Service mapping (and nodeport) (refer REQ #7 below) IN PROGRESS

Spec schema sample to be added under REQ1 section and also updated component spec schema file

5. Build helm chart generator taking as inputs template directory and template list file to be used for chart generation and perform lint for consolidated charts.

Note: Use base/default template if corresponding template not found on specified template directory

6. Support MAPPING requirement – ENV SETTING (refer REQ #1 for details)

7. Support MAPPING requirement – CMPv2 Certificates (refer REQ #3 for details)

8. Support MAPPING requirement – Postgres (refer REQ #5 for details)

9. Support MAPPING requirement – Policy Sidecar (refer REQ #4 for details)

10. Support SERVICE MAPPING based on spec file (refer REQ #7 for details)

11. Support MAPPING requirement – ConfigMap support (refer REQ #2 for details)

12. Support MAPPING requirement – DMAAP Secure Topic/Feed (refer REQ #6 for details)

13. Create user guide for the tool detailing all command-line options/override

14. Submit code to ONAP; ensure compliance to ONAP coding standard and test coverage requirement (atleast 80%) and verify the library build/pushed to ONAP:nexus

15. Integrate tool into MOD/Runtime or MOD2/CatalogService

16. Verify E2E for ONAP DCAE MS spec file (TCA w/policy, PM-Mapper, VES, and validate corresponding charts generated in ONAP lab if components can be successfully deployed

17. Add distribution support in tool. Additional configuration support needed for below parameters either in tool property file or CMD line options

DistributionEnabled

DistributionURL

DistributionUsername

DistributionPwd

DistributionFormat - tgz or as directory

18. Provide REST interface to support HELM generation

19. Input Spec validation

20. Comments should be cascaded from template and when new yaml is generator and also preserve order

21. Secret mapping requirement TBD and pv mapping

22. Support chart generation as directory (instead of tgz) via configuration (added on 01 Jun 2021 )

23. Support dependency download (helm dep up) from repo/access based on deployment configration (added on 01 Jun 2021 )

REQUIREMENTS

1. ENV SETTING SUPPORT

Component Spec

Need spec schema update to include list of parameters (key/value for applicationEnv) -->https://git.onap.org/dcaegen2/platform/tree/mod/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json

"auxilary": {
.
.
"application_env": {
      "PMSH_PG_URL": "dcae-pmsh-pg-primary",
      "PMSH_PG_USERNAME": {
         "secretUid": "*pgUserCredsSecretUid",
         "key": "login"
      },
      "PMSH_PG_PASSWORD": {
         "secretUid": "*pgUserCredsSecretUid",
         "key": "password"
      }
    }
.
.
}

Values.yaml specification

applicationEnv:
PMSH_PG_URL: dcae-pmsh-pg-primary
PMSH_PG_USERNAME:
     secretUid: *pgUserCredsSecretUid
     key: login
PMSH_PG_PASSWORD:
     secretUid: *pgUserCredsSecretUid
     key: password

Note: Text in blue should be mapped from component-spec. If using secret UID, its responsibility of MS developer to include them also on values.yaml

Example

  - uid: &pgUserCredsSecretUid pg-user-creds
    name: &pgUserCredsSecretName '{{ include "common.release" . }}-pmsh-pg-user-creds'
    type: basicAuth
    externalSecret: '{{ ternary "" (tpl (default "" .Values.postgres.config.pgUserExternalSecret) .) (hasSuffix "pmsh-pg-user-creds" .Values.postgres.config.pgUserExternalSecret) }}'
    login: '{{ .Values.postgres.config.pgUserName }}'
    password: '{{ .Values.postgres.config.pgUserPassword }}'
    passwordPolicy: generate

2. CONFIG-MAP SUPPORT (WIP)

Component Spec

  "config_map_volume": {
      "type": "object",
      "properties": {
        "config_volume": {
          "type": "object",
          "name": {
            "type": "string"
          }
        },
        "container": {
          "type": "object",
          "bind": {
            "type": "string"
          },
          "mode": {
            "type": "string"
          }
        }
      },
      "required": ["config_volume", "container"]
    },

Example:

"volumes": [{      
	"config_volume": {        
		"name": "dcae-external-repo-configmap-schema-map"      
		},      
	"container": {        
		"bind": "/opt/app/VESCollector/etc/externalRepo/"      
	}    
}, 
{      
	"config_volume": {        
		"name": "dcae-external-repo-configmap-sa88-rel16"      
		},      
	"container": {       
		 "bind": "/opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/"      
	}
  }
],

https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json

Values.yaml specification

TBA

3. CMVP2 Certificates support

Component Spec

         "tls_info": {
          "description": "Component information to use tls certificates",
          "type": "object",
          "properties": {
            "cert_directory": {
              "description": "The path in the container where the component certificates will be placed by the init container",
              "type": "string"
            },
            "use_tls": {
              "description": "Boolean flag to determine if the application is using tls certificates",
              "type": "boolean"
            },
            "use_external_tls": {
              "description": "Boolean flag to determine if the application is using tls certificates for external communication",
              "type": "boolean"
            }
          },
          "required": [
            "cert_directory","use_tls"
          ],
          "additionalProperties": false
        },

Example:

    "tls_info":{
	"cert_directory":"/opt/app/dcae-certificate/",
	"use_tls":true,
        "use_external_tls": true
     }

https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json

Values.yaml specification

# CMPv2 certificate
certificates:
  - mountPath: /opt/app/dcae-certificate/external
    commonName: dcae-ves-collector
    dnsNames:
      - dcae-ves-collector
      - ves-collector
      - ves
    keystore:
      outputType:
        - jks
      passwordSecretRef:
        name: ves-cmpv2-keystore-password
        key: password
        create: true

requirement.yaml

     - name: certManagerCertificate
       version: ~8.x-0
       repository: '@local'

templates/certificates.yaml

{{ if and .Values.certDirectory .Values.global.cmpv2Enabled .Values.global.CMPv2CertManagerIntegration }}
{{ include "certManagerCertificate.certificate" . }}
{{ end }}

4. POLICY SIDECAR SUPPORT

Component Spec

    "policy_info": {
      "type": "object",
      "properties": {
        "policy":
        {
          "type": "array",
          "items":
          {
            "type": "object",
            "properties":
            {
              "node_label":
              {
                "type": "string"
              },
              "policy_id":
              {
                "type": "string"
              },
              "policy_model_id":
              {
                "type": "string"
              }
            },
            "required": ["node_label", "policy_model_id"]
          }
        }
      },
      "additionalProperties": false
    }
  }

Example:

TBA

Values.yaml specification

#dcaePolicySyncImage: onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1
policies:
duration: 300
policyID: |
'["onap.vfirewall.tca","abc"]'
# filter: |
# '["DCAE.Config_vfirewall_.*"]'

5. POSTGRES SUPPORT

Component Spec

        "databases": {
          "description": "The databases the application is connecting to using the pgaas",
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "enum": [
              "postgres"
            ]
          }
        },

Need secret suffix or retrieve from spec-name?

Values.yaml specification

#################################################################
# Secrets Configuration.
#################################################################
secrets:
  - uid: &pgUserCredsSecretUid pg-user-creds
    name: &pgUserCredsSecretName '{{ include "common.release" . }}-pmsh-pg-user-creds'
    type: basicAuth
    externalSecret: '{{ ternary "" (tpl (default "" .Values.postgres.config.pgUserExternalSecret) .) (hasSuffix "pmsh-pg-user-creds" .Values.postgres.config.pgUserExternalSecret) }}'
    login: '{{ .Values.postgres.config.pgUserName }}'
    password: '{{ .Values.postgres.config.pgUserPassword }}'
    passwordPolicy: generate


postgres:
  nameOverride: dcae-pmsh-postgres
  service:
    name: dcae-pmsh-postgres
    name2: dcae-pmsh-pg-primary
    name3: dcae-pmsh-pg-replica
  container:
    name:
      primary: dcae-pmsh-pg-primary
      replica: dcae-pmsh-pg-replica
  persistence:
    mountSubPath: pmsh/data
    mountInitPath: pmsh
  config:
    pgUserName: pmsh
    pgDatabase: pmsh
    pgUserExternalSecret: *pgUserCredsSecretName

Note: applicationEnv setting if required should be mapped from spec as-is (req#1). Example above contains <pmsh> part of secret name and PG name which should be mapped to component-name from spec file

6. DMAAP – Secure Topic/Feed (WIP)

Component Spec

TBD

Values.yaml specification

#################################################################
# Secrets Configuration.
#################################################################
secrets:
  - uid: &aafCredsUID aafcreds
    type: basicAuth
    login: '{{ .Values.aafCreds.identity }}'
    password: '{{ .Values.aafCreds.password }}'
    passwordPolicy: required


# AAF Credentials
aafCreds:
  identity: dcae@dcae.onap.org
  password: demo123456!

credentials:
- name: AAF_USER
  uid: *aafCredsUID
  key: login
- name: AAF_PASSWORD
  uid: *aafCredsUID
  key: password

Note: applicationConfig should use same names as defined under credentials

Example:

enable_tls: true
aaf_identity: ${AAF_USER}
aaf_password: ${AAF_PASSWORD}
streams_publishes:
      ves-3gpp-fault-supervision:
      type: kafka
      aaf_credentials:
        username: ${AAF_USER}
        password: ${AAF_PASSWORD}
      kafka_info:
        bootstrap_servers: message-router-kafka:9092
        topic_name: SEC_3GPP_FAULTSUPERVISION_OUTPUT

7. SERVICE MAPPING

Component Spec

"auxilary": {
.
.
"helm": {
      "services": [
        {
          "type": "NodePort",
          "name": "dcae-ves-collector",
          "ports": [
             {
                "name": "http",
                "port": 8443,
                "plain_port": 8080,
                "port_protocol": "http",
                "nodePort": 17,
                "useNodePortExt": true
             }
          ]
       }
      ]
    }
  }
.
.
}

Schema change required need to determine if nodeport vs clusterip
- Require nodeport as inputReference
- Protocol

https://git.onap.org/dcaegen2/platform/tree/mod/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json

Values.yaml specification

service:
  type: ClusterIP
  name: dcae-tcagen2
  ports:
    - port: 9091
      name: http

OR

global:
  nodePortPrefix: 302
  nodePortPrefixExt: 304

	# service configuration
service:
  type: NodePort
  name: dcae-ves-collector
  ports:
    - name: http
      port: 8443
      plain_port: 8080
      port_protocol: http
      nodePort: 17
      useNodePortExt: true

REFERENCE

Discussed ppt slides Helm_deployment.pptx

MOD-HelmGenerator-Requirements_v0.2.docx

MOD-HelmGenerator-Usecase_v0.2.docx

Space shortcuts

Page tree

USECASES

REQUIREMENTS

1. ENV SETTING SUPPORT

Component Spec

Values.yaml specification

2. CONFIG-MAP SUPPORT (WIP)

Component Spec

Values.yaml specification

3. CMVP2 Certificates support

Component Spec

Values.yaml specification

requirement.yaml

templates/certificates.yaml

4. POLICY SIDECAR SUPPORT

Component Spec

Values.yaml specification

5. POSTGRES SUPPORT

Component Spec

Values.yaml specification

6. DMAAP – Secure Topic/Feed (WIP)

Component Spec

Values.yaml specification

7. SERVICE MAPPING

Component Spec

Values.yaml specification

REFERENCE