1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2021 NOKIA
5 .. _sdc_helm_validator:
8 ==============================
12 ------------------------------
14 This application can be used to validate CNF Helm charts using a Helm Client. It allows to select Helm version, which will be used to execute validation.
16 More information could be found in project repository, see :ref:`sdc_helm_validator_repository`.
23 .. Latest Open API model: :download:`OpenAPI.yaml <https://gerrit.onap.org/r/gitweb?p=sdc/sdc-helm-validator.git;a=blob_plain;f=OpenAPI.yaml;hb=refs/heads/master>`
26 Latest Open API model: |sdc-helm-validator-open-api|_
31 Application executes two types of validation:
33 * Deployable (basic validation) - verify correct chart rendering.
34 * Lint (optional) - verify syntax of charts, it can be turned on/off by request parameter.
36 **Request parameters:**
38 * versionDesired - Helm Client version, which will be used to validation (list of supported versions can be received */versions* endpoint), available formats:
40 - Semantic version [X.Y.Z] e.g 3.5.2
41 - Major version [vX] - uses latest of available major version, e.g: v3 uses latest 3.Y.Z version.
43 * isLinted - turn on/off lint validation
44 * isStrictLinted - turn on/off strict lint - if lint validation detects any warning, it marks chart as invalid.
50 **Supported versions** (/versions)
56 'http://<host>:<port>/versions' \
64 'http://localhost:8080/versions' \
76 **Validation** (/validate)
83 'http://<HOST>:<PORT>/validate' \
84 -H 'accept: application/json' \
85 -H 'Content-Type: multipart/form-data' \
86 -F 'versionDesired=<Helm client version>' \
87 -F 'file=@<path to file in .tgz format>;type=application/x-compressed-tar' \
89 -F 'isStrictLinted=true'
96 'http://localhost:8080/validate' \
97 -H 'accept: application/json' \
98 -H 'Content-Type: multipart/form-data' \
99 -F 'versionDesired=3.5.2' \
100 -F 'file=@correct-apiVersion-v2.tgz;type=application/x-compressed-tar' \
102 -F 'isStrictLinted=true'
112 "versionUsed": "3.5.2",
122 The Helm validator is triggered by the SDC onboarding BE in CNF package onboarding use-cases.
125 .. _sdc_helm_validator_repository:
130 `SDC Helm Validator repository <https://gerrit.onap.org/r/admin/repos/sdc/sdc-helm-validator>`_