diff options
Diffstat (limited to 'docs/humaninterfaces.rst')
| -rw-r--r-- | docs/humaninterfaces.rst | 35 |
1 files changed, 25 insertions, 10 deletions
diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst index 8f8ccc3..63e148a 100644 --- a/docs/humaninterfaces.rst +++ b/docs/humaninterfaces.rst @@ -64,13 +64,22 @@ This maps to the ``--category`` command-line option. | | specifying ``--category=environment_file`` from the | | | command-line. | +----------------------+-------------------------------------------------------+ +| OpenStack Heat | When selected, will validate the Heat templates are | +| Testing | valid per OpenStack specifications (using the | +| | latest version of OpenStack available). If not | +| | selected, then VVP will only validate that the Heat | +| | is compliant with ONAP rules. | ++----------------------+-------------------------------------------------------+ + Settings ~~~~~~~~ -**Verbosity** - Controls the level of comparison output displayed in the -underlying pytest validation output. Default maps to pytest ``-v`` level of -verbosity. +**Preload Template** - Determines the format of the preload template that will +be generated by VVP. The preload template can be completed to load per-instance +values into SDNC. This allows the SDC model to be generic and re-used across +environments. There are currently two formats supported by ONAP (VNF-API and +GR-API) **Report Format** - Controls the format of the output report generated after validation. The options are: HTML (the default), Excel, and CSV. This is @@ -90,22 +99,28 @@ a report of this single failure. This can be useful in reducing the number of errors to sift through in these situations. De-selecting this option is the equivalent of specifying ``--continue-on-failure`` as a command-line option. +**Create Preloads from Env Files** - When selected, the Env Files file selection +box will be enabled allow the user to select a directory of .env file definitions +that can be used to populate a preload template. See +:ref:`Preload Generation <vvp-preload-gen>` for more details + Running Validations ~~~~~~~~~~~~~~~~~~~ -1. Select the desired input format in the settings (ZIP or Directory) -2. Select the [...] button next to the Template Location input box -3. Select the directory or ZIP file containing the Heat templates, and then +1. Select the desired preload format (VNF-API or GR-API) +2. Select the desired input format in the settings (ZIP or Directory) +3. Select the [...] button next to the Template Location input box +4. Select the directory or ZIP file containing the Heat templates, and then click Open -4. Once the input is selected, select the "Validate Templates" button to +5. Once the input is selected, select the "Validate Templates" button to start the validation process. The white box to the right will display output as the validations are executed. -5. Once validation is complete a summary of pass and fail will be written +6. Once validation is complete a summary of pass and fail will be written to the output window, and a "View Report" option will appear on the left-hand control panel. -6. Select the "View Report" option, and the report will be opened in the +7. Select the "View Report" option, and the report will be opened in the the appropriate application based on report format. -7. If you have questions about report output, please refer to the +8. If you have questions about report output, please refer to the :ref:`Validation Report reference material <vvp-report>` for more information. |