aboutsummaryrefslogtreecommitdiffstats
path: root/tools/sdv/docs
diff options
context:
space:
mode:
authorMICHAEL FIX <michael.fix@att.com>2020-03-10 12:43:30 +0000
committerGerrit Code Review <gerrit@opnfv.org>2020-03-10 12:43:30 +0000
commitcc26e0bcc7aa87acb22a46e99fb9e9604e556f3d (patch)
tree4f62d0b587d3a7344f75cc35ec131930e80f0400 /tools/sdv/docs
parent48ee46e8461ee5a6cce56c89bb791dee004e6300 (diff)
parent4f234b8fd2012d1c7c26effefdd41e7636a35738 (diff)
Merge "Tools: Version-1 of SDV Added."
Diffstat (limited to 'tools/sdv/docs')
-rw-r--r--tools/sdv/docs/valid.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/tools/sdv/docs/valid.rst b/tools/sdv/docs/valid.rst
new file mode 100644
index 0000000..6aeb8a2
--- /dev/null
+++ b/tools/sdv/docs/valid.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+CIRV Software Validation Tool
+=============================
+This tool is designed to perform Software Configuration Validation, which covers:
+
+1. Pre-Deployment (of VIM or Container Management Software) Validation of Software Configuration
+2. Post-Deployment (of VIM or Container Management Software) Validation of Software Configuration
+3. Network-Link Checking - Validating VLAN and IP configurations
+
+
+Installation
+************
+This tool does not have any installation. However, there are requirements in terms of Python packages, which can be installed using pip3. Refer to requirements.txt file for the package list.
+
+Usage
+*****
+Example Commands:
+
+1. To run all the validations: ./valid
+2. Help: ./valid --help
+3. Version Check: ./valid --version
+4. List Sofware Pre-Deployment validators: ./valid --list-swpredepv
+5. List Sofware Post-Deployment validators: ./valid --list-swpostdepv
+6. List all validations: ./valid --list-validations
+7. Run only single validation [WORK IN PROGRESS]