diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/index.rxt | 17 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | docs/valid.rst | 28 |
5 files changed, 28 insertions, 28 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..b281a51 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,6 @@ +""" for docs +""" + +# pylint: disable=import-error +# flake8: noqa +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..0045179 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: CIRV diff --git a/docs/index.rxt b/docs/index.rxt new file mode 100644 index 0000000..0f96854 --- /dev/null +++ b/docs/index.rxt @@ -0,0 +1,17 @@ +.. 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. + +OPNFV CIRV +========== + +Please refer to the documentation of the individual tools. + +`CIRV-HDV`_ + +`CIRV-SDV`_ + + + +.. _CIRV-HDV: https://opnfv-cirv-hdv.readthedocs.io/en/latest/ +.. _CIRV-SDV: https://opnfv-cirv-hdv.readthedocs.io/en/latest/ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme diff --git a/docs/valid.rst b/docs/valid.rst deleted file mode 100644 index 6aeb8a2..0000000 --- a/docs/valid.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. 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] |