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>`
28 Application executes two types of validation:
30 * Deployable (basic validation) - verify correct chart rendering.
31 * Lint (optional) - verify syntax of charts, it can be turned on/off by request parameter.
33 **Request parameters:**
35 * versionDesired - Helm Client version, which will be used to validation (list of supported versions can be received */versions* endpoint), available formats:
37 - Semantic version [X.Y.Z] e.g 3.5.2
38 - Major version [vX] - uses latest of available major version, e.g: v3 uses latest 3.Y.Z version.
40 * isLinted - turn on/off lint validation
41 * isStrictLinted - turn on/off strict lint - if lint validation detects any warning, it marks chart as invalid.
47 **Supported versions** (/versions)
53 'http://<host>:<port>/versions' \
61 'http://localhost:8080/versions' \
73 **Validation** (/validate)
80 'http://<HOST>:<PORT>/validate' \
81 -H 'accept: application/json' \
82 -H 'Content-Type: multipart/form-data' \
83 -F 'versionDesired=<Helm client version>' \
84 -F 'file=@<path to file in .tgz format>;type=application/x-compressed-tar' \
86 -F 'isStrictLinted=true'
93 'http://localhost:8080/validate' \
94 -H 'accept: application/json' \
95 -H 'Content-Type: multipart/form-data' \
96 -F 'versionDesired=3.5.2' \
97 -F 'file=@correct-apiVersion-v2.tgz;type=application/x-compressed-tar' \
99 -F 'isStrictLinted=true'
109 "versionUsed": "3.5.2",
119 The Helm validator is triggered by the SDC onboarding BE in CNF package onboarding use-cases.
122 .. _sdc_helm_validator_repository:
127 `SDC Helm Validator repository <https://gerrit.onap.org/r/admin/repos/sdc/sdc-helm-validator>`_