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.
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)
2. Separate Values.yaml into separate templates and verify dynamic values.yaml generation (and parameter substitution)
Configuration/parameters required common across MS
Configuration/parameters to be templatized and values sourced from ComponentSpec
Optional configuration/parameters to be templatized and included based on flags/properties from ComponentSpec
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.
3. Identify Component-spec schema changes for ENV setting mapping
4. Identify Component-spec schema changes for Service mapping (and nodeport)
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 DOC for details)
7. Support MAPPING requirement – CMPv2 Certificates (refer REQ DOC for details)
8. Support MAPPING requirement – Postgres (refer REQ DOC for details)
9. Support MAPPING requirement – Policy Sidecar (refer REQ DOC for details)
10. Support SERVICE MAPPING based on spec file (refer REQ DOC for details)
11. Support MAPPING requirement – ConfigMap support (refer REQ DOC for details)
12. Support MAPPING requirement – DMAAP Secure Topic/Feed (refer REQ DOC 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
REQUIREMENTS
Attached is the draft requirements for Helm Generator
MOD-HelmGenerator-Requirements_v0.2.docx
REFERENCE
Discussed ppt slides Helm_deployment.pptx