Page History

Wiki to track the design requirements for Helm generator to support 

USECASES

1. 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:

configmap.yaml

deployment.yaml

service.yaml

secret.yaml

Chart.yaml

requirements.yaml

values.yaml

(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 as tar - DONE 04 Jun 2021 

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

<Need to add from ppt>

                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/initialdelaySeconds into auxillary.healthcheck on component spec schema as optional parameter for mapping into readiness check

Image Removed

•  globalNodeportPrefix - make default from base template. (It should be already supported)

...

3. Identify Component-spec schema changes for ENV setting mapping  (refer REQ #1 below) DONE - 08 Jun 2021 

•  04 Jun 2021  - Spec schema sample to be added under REQ1 section and also updated component spec schema file - Nick
•  04 Jun 2021  - Verify if the service configuration can be supported as list under common/service - Vijay Venkatesh Kumar

List is not supported in current common/service template

4. Identify Component-spec schema changes for Service mapping (and nodeport) (refer REQ #7 below) DONE - 11 Jun 2021 

•  Spec schema sample to be added under REQ1 section and also updated component spec schema file; submit to gerrit with new updates (including #2, #3, #4) 

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. - No longer applicable; based on design 17 Jun 2021 

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) - DONE - 11 Jun 2021 1.0.0

Schema Validation to be integrated - tracked separately under task #24

7. Support MAPPING requirement – CMPv2 Certificates (refer REQ #3 for details)  - Target 06/24 

Include support for base + addon chart structure (certificate.yaml will be optional)  - DONE 

Add validation if enabled in spec and certificate.yaml not provided - tool must error - switch to use use_external_tls/flag  - DONE 30 Jun 2021 1.3.2

8. Support MAPPING requirement – Postgres (refer REQ #5 for details) - Target 06/30 DONE 30 Jun 2021 1.3.2

9. Support MAPPING requirement – Policy Sidecar (refer REQ #4  for details)  Target 06/17  DONE 30 Jun 2021 1.3.2

 Format written out into values.yaml not as expected

10. Support SERVICE MAPPING based on spec file (refer REQ #7 for details)   - DONE - 11 Jun 2021 1.0.0

Schema Validation to be integrated - tracked separately under task #24

11. Support MAPPING requirement – ConfigMap support (refer REQ #2 for details)  Target 06/30   DONE 30 Jun 2021 1.3.2

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  - Vijay Venkatesh Kumar - Target 06/30  REQ DONE30 Jun 2021

      - CMPv2 + application_env

       Option 1: Change spec schema to include secret name as additional input and use that for helm values.yaml setting

       Option 2: Have tool set the secret name as <component-name>-cmpv2-keystore-password   -  Current chosen option  - Target07 Jul 2021   - DONE - 08 Jul 2021

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 )

24. Add schema validator module; keep the schema definiton overriddable (either through CI or api parameter); this should be configurable  - default enabled (added on 11 Jun 2021  based on svc mapping test)  - DONE 14 Jul 2021 

           - default schema to be included in tool (optional override support) -  Target by 12 Jul 2021 - Nick

           - validation NPE for schema missing (pick up from resource folder) - 1.3.6 

           -  Update gerrit with latest spec schema (initialdelayseconds = integer)

           - Add wrapper class to consolidate the error - Dhrumin (moved to task #30)

           - Trial with different version  - Target by 12 Jul 2021 - Nick

      <groupId>com.networknt</groupId>  - Moved to task #30
      <artifactId>json-schema-validator</artifactId>
      <version>1.0.49</version>

    Current library- https://github.com/everit-org/json-schema

25. Testing with ONAP spec files on ONAP lab with componen-spec (ves, pm-mapper, dfc, tcagen2, hv-ves, prh) - Sivakumar Santharam ONGOING

• Modify spec to align with new schema
  • https://git.onap.org/dcaegen2/collectors/hv-ves/tree/dpo/spec/hv-ves-collector.componentspec.json
  • https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json
  • https://git.onap.org/dcaegen2/analytics/tca-gen2/tree/dcae-analytics/dpo/tcagen2_spec.json  
  • https://git.onap.org/dcaegen2/services/pm-mapper/tree/dpo/spec/pmmapper-component-spec.json
  • https://git.onap.org/dcaegen2/collectors/datafile/tree/datafile-app-server/dpo/spec/datafile-component-spec.json
  • https://git.onap.org/dcaegen2/services/prh/tree/dpo/spec/prh.componentspec.json
• Generate charts and deploy and check if component comes up clean
• Environment for test to be setup/checked (onap5) - Vijay Venkatesh Kumar - ENV DONE (06/17/2021) 
• Verify spec can be run through bp-gen and deployed (backward compatibility) - 12 Jul 2021 - Sivakumar Santharam   DONE
  • New spec schema not backward compatible; bp-gen and onboardingAPI needs to be updated to reflect schema + onboardingAPI?
  • New spec schame will be added under v3 directory

        26. Submit updates on each spec json update to gerrit (to be verified if updated spec breaks bp-gen creation - incase new fields introduced are not ignored)

27. Support for readinesscheck for script based execution (e.g PMMapper/hv-ves); port/endpoint flagged as mandatory fields which are required only for HTTP  - added 30 Jun 2021 

28. Dynamic secret creation and mapping to env variable - support from Helm tool - added 30 Jun 2021 

29.  Postgres should be enabled/disabled based on requirement.yaml and take values from values.yaml - added 08 Jul 2021 

             Require base template change (requirement.yaml) & values.yaml setting to true when PG is enabled 

30. Spec schame validator (current library- https://github.com/everit-org/json-schema) validation error not verbose. Evaluate internal validator class or below library used for VEScollector  - added on 12 Jul 2021 

     <groupId>com.networknt</groupId>
      <artifactId>json-schema-validator</artifactId>
      <version>1.0.49</version>

31.  OnboardingAPI changes to use V3 spec files for supporting helm spec files - added 12 Jul 2021  

TEST ISSUES TRACKED UNDER 

REQUIREMENTS

1. ENV SETTING SUPPORT

...

#dcaePolicySyncImage: onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1  → From base template
policies:
  duration: 300  → default

  policyRelease: onap
  policyID: |
    '["tca_policy_id_11","tca_policy_id_10"]'  → coming from spec file

5. POSTGRES SUPPORT

Component Spec

...

service:
  type: NodePort
  name: dcae-ves-collector
  has_internal_only_ports: true
  ports:
    - name: http
      port: 8443
      plain_port: 8080
      port_protocol: http
      nodePort: 17
      useNodePortExt: true
    - name: metrics
      port: 4444
      internal_only: true

REVISED V3 SPEC

REFERENCE

Discussed ppt slides  Helm_deployment.pptx

...