From 9fbcfc265bae4634415610bfb033d2cbb0b8773f Mon Sep 17 00:00:00 2001 From: Joanna Jeremicz Date: Tue, 18 May 2021 16:38:03 +0200 Subject: Update documentation with SDC Helm Validator information Issue-ID: SDC-3185 Signed-off-by: Joanna Jeremicz Change-Id: Icea183c12d8983b69387fa0e5eb07cd4d5374204 --- .../onap-user/design/resource-onboarding/index.rst | 40 ++++++++++++++++++++- ...dro-design-onboardcnf-helm-validator-errors.png | Bin 0 -> 150230 bytes ...o-design-onboardcnf-helm-validator-warnings.png | Bin 0 -> 87987 bytes 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png create mode 100644 docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png (limited to 'docs/guides') diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 8e974016e..4c31237d0 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. +.. Copyright 2019-2021 ONAP Contributors. All rights reserved. .. _doc_guide_user_des_res-onb: @@ -220,10 +220,27 @@ for VFs/PNFs. displays the files and a success message. If validation fails, SDC displays the errors in the files. + In case the SDC Helm Validator is enabled in SDC configuration file and the + onboarding package is a CNF which contains any helm charts listed in MANIFEST.json + and marked as type=HELM, there will be an attempt to make a request to the Helm Validator + for each chart, to check its validity. More information on Helm Validator can be found + :ref:`here` + + This validation feature is enabled by default, and checks, if the chart can be deployed by + running helm template command. Helm v3 libraries are used for validation. + Example Heat errors: |image9| + Example helm chart validation warnings: + + |image27| + + Example helm chart validation errors (which caused the *Submit* button to be disabled) + + |image28| + #. Click *Submit* to add the VSP to the catalog. After filling a comment, press *Commit&Submit*. @@ -326,10 +343,27 @@ Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and servi displays the files and a success message. If validation fails, SDC displays the errors in the files. + In case the SDC Helm Validator is enabled in SDC configuration file and the + onboarding package is a CNF which contains any helm charts listed in MANIFEST.json + and marked as type=HELM, there will be an attempt to make a request to the Helm Validator + for each chart, to check its validity. More information on Helm Validator can be found + :ref:`here`. + + This validation feature is enabled by default, and checks, if the chart can be deployed by + running helm template command. Helm v3 libraries are used for validation. + Example Heat errors: |image9| + Example helm chart validation warnings: + + |image27| + + Example helm chart validation errors (which caused the *Submit* button to be disabled) + + |image28| + #. Click *Submit* to add the new VSP version to the catalog. After filling a comment, press *Commit&Submit* and the new version is certified. @@ -409,3 +443,7 @@ the *cert* block in the following values file:: .. |image25| image:: media/sdro-vsp-version.png .. |image26| image:: media/sdro-vsp-version-dialog.png + +.. |image27| image:: media/sdro-design-onboardcnf-helm-validator-warnings.png + +.. |image28| image:: media/sdro-design-onboardcnf-helm-validator-errors.png diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png new file mode 100644 index 000000000..15f59e6fa Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-errors.png differ diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png new file mode 100644 index 000000000..a3518ba49 Binary files /dev/null and b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design-onboardcnf-helm-validator-warnings.png differ -- cgit 1.2.3-korg