diff options
-rw-r--r-- | docs/conf.py | 6 | ||||
-rw-r--r-- | docs/conf.yaml | 3 | ||||
-rw-r--r-- | docs/development/index.rst | 6 | ||||
-rw-r--r-- | docs/index.rst | 17 | ||||
-rw-r--r-- | docs/release/configguide/index.rst | 6 | ||||
-rw-r--r-- | docs/release/release-notes/index.rst | 17 | ||||
-rw-r--r-- | docs/release/release-notes/release-notes.rst | 12 | ||||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/developer/devguide.rst (renamed from sdv/docs/docker/sdvconfig/developer/devguide.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/developer/extrapolation-flow.png (renamed from sdv/docs/docker/sdvconfig/developer/extrapolation-flow.png) | bin | 48637 -> 48637 bytes | |||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/developer/extrapolation.png (renamed from sdv/docs/docker/sdvconfig/developer/extrapolation.png) | bin | 6923 -> 6923 bytes | |||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/developer/validation-flow.png (renamed from sdv/docs/docker/sdvconfig/developer/validation-flow.png) | bin | 73615 -> 73615 bytes | |||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/developer/validation.png (renamed from sdv/docs/docker/sdvconfig/developer/validation.png) | bin | 17281 -> 17281 bytes | |||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/user/configguide.rst (renamed from sdv/docs/docker/sdvconfig/user/configguide.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/sdvconfig/user/userguide.rst (renamed from sdv/docs/docker/sdvconfig/user/userguide.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/development/design/index.rst (renamed from sdv/docs/docker/state/development/design/index.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/development/overview/index.rst (renamed from sdv/docs/docker/state/development/overview/index.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/development/overview/result-api-architecture.png (renamed from sdv/docs/docker/state/development/overview/result-api-architecture.png) | bin | 24756 -> 24756 bytes | |||
-rw-r--r-- | docs/release/userguide/docker/state/development/overview/result_api.rst (renamed from sdv/docs/docker/state/development/overview/result_api.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/development/overview/settings.rst (renamed from sdv/docs/docker/state/development/overview/settings.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/release/configguide/index.rst (renamed from sdv/docs/docker/state/release/configguide/index.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/state/release/userguide/index.rst (renamed from sdv/docs/docker/state/release/userguide/index.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/docker/urls/userguide.rst (renamed from sdv/docs/docker/urls/userguide.rst) | 0 | ||||
-rw-r--r-- | docs/release/userguide/index.rst | 6 | ||||
-rw-r--r-- | docs/release/userguide/pdf/user/userguide.rst (renamed from sdv/docs/pdf/user/userguide.rst) | 0 | ||||
-rw-r--r-- | docs/requirements.txt | 2 | ||||
-rw-r--r-- | sdv/docs/valid.rst | 28 |
26 files changed, 75 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..f0aa8cc --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: CIRV-SDV diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 0000000..b9226ab --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent Communications, University of Delhi and others. + +CIRV-SDV Developer Guide +======================== diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..08fb3bd --- /dev/null +++ b/docs/index.rst @@ -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, Spirent Communications, University of Delhi and others. + +.. _cirv-sdv: + +************** +OPNFV CIRV-SDV +************** +.. toctree:: + :numbered: + :maxdepth: 3 + + release/release-notes/index + release/userguide/results/index + release/configguide/index + development/index diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..73ef396 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent Communications, University of Delhi and others. + +CIRV-SDV Configuration Guide +============================ diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..8063a63 --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -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, Spirent Communicatios, University of Delhi and others. + +.. _cirvsdv-releasenotes: + +================================================== +CIRV-SDV Release Notes +================================================== + +.. toctree:: + :numbered: + :maxdepth: 2 + + release-notes.rst + +Build date: |today| diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..1257fb5 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent Communications, University of Delhi and others. + +OPNFV Jerma Release +==================== + +* Platform Definition File Templates and Tools. +* Resource Modelling. +* Pre-Deployment Validation +* Post-Deployment Validation + diff --git a/sdv/docs/docker/sdvconfig/developer/devguide.rst b/docs/release/userguide/docker/sdvconfig/developer/devguide.rst index 7c1fc15..7c1fc15 100644 --- a/sdv/docs/docker/sdvconfig/developer/devguide.rst +++ b/docs/release/userguide/docker/sdvconfig/developer/devguide.rst diff --git a/sdv/docs/docker/sdvconfig/developer/extrapolation-flow.png b/docs/release/userguide/docker/sdvconfig/developer/extrapolation-flow.png Binary files differindex 5b220af..5b220af 100644 --- a/sdv/docs/docker/sdvconfig/developer/extrapolation-flow.png +++ b/docs/release/userguide/docker/sdvconfig/developer/extrapolation-flow.png diff --git a/sdv/docs/docker/sdvconfig/developer/extrapolation.png b/docs/release/userguide/docker/sdvconfig/developer/extrapolation.png Binary files differindex 1a0f777..1a0f777 100644 --- a/sdv/docs/docker/sdvconfig/developer/extrapolation.png +++ b/docs/release/userguide/docker/sdvconfig/developer/extrapolation.png diff --git a/sdv/docs/docker/sdvconfig/developer/validation-flow.png b/docs/release/userguide/docker/sdvconfig/developer/validation-flow.png Binary files differindex de4853e..de4853e 100644 --- a/sdv/docs/docker/sdvconfig/developer/validation-flow.png +++ b/docs/release/userguide/docker/sdvconfig/developer/validation-flow.png diff --git a/sdv/docs/docker/sdvconfig/developer/validation.png b/docs/release/userguide/docker/sdvconfig/developer/validation.png Binary files differindex f6d2dc3..f6d2dc3 100644 --- a/sdv/docs/docker/sdvconfig/developer/validation.png +++ b/docs/release/userguide/docker/sdvconfig/developer/validation.png diff --git a/sdv/docs/docker/sdvconfig/user/configguide.rst b/docs/release/userguide/docker/sdvconfig/user/configguide.rst index d8bb3c2..d8bb3c2 100644 --- a/sdv/docs/docker/sdvconfig/user/configguide.rst +++ b/docs/release/userguide/docker/sdvconfig/user/configguide.rst diff --git a/sdv/docs/docker/sdvconfig/user/userguide.rst b/docs/release/userguide/docker/sdvconfig/user/userguide.rst index f38303d..f38303d 100644 --- a/sdv/docs/docker/sdvconfig/user/userguide.rst +++ b/docs/release/userguide/docker/sdvconfig/user/userguide.rst diff --git a/sdv/docs/docker/state/development/design/index.rst b/docs/release/userguide/docker/state/development/design/index.rst index e69de29..e69de29 100644 --- a/sdv/docs/docker/state/development/design/index.rst +++ b/docs/release/userguide/docker/state/development/design/index.rst diff --git a/sdv/docs/docker/state/development/overview/index.rst b/docs/release/userguide/docker/state/development/overview/index.rst index e69de29..e69de29 100644 --- a/sdv/docs/docker/state/development/overview/index.rst +++ b/docs/release/userguide/docker/state/development/overview/index.rst diff --git a/sdv/docs/docker/state/development/overview/result-api-architecture.png b/docs/release/userguide/docker/state/development/overview/result-api-architecture.png Binary files differindex e464187..e464187 100644 --- a/sdv/docs/docker/state/development/overview/result-api-architecture.png +++ b/docs/release/userguide/docker/state/development/overview/result-api-architecture.png diff --git a/sdv/docs/docker/state/development/overview/result_api.rst b/docs/release/userguide/docker/state/development/overview/result_api.rst index 12fd62c..12fd62c 100644 --- a/sdv/docs/docker/state/development/overview/result_api.rst +++ b/docs/release/userguide/docker/state/development/overview/result_api.rst diff --git a/sdv/docs/docker/state/development/overview/settings.rst b/docs/release/userguide/docker/state/development/overview/settings.rst index c70f21e..c70f21e 100644 --- a/sdv/docs/docker/state/development/overview/settings.rst +++ b/docs/release/userguide/docker/state/development/overview/settings.rst diff --git a/sdv/docs/docker/state/release/configguide/index.rst b/docs/release/userguide/docker/state/release/configguide/index.rst index e69de29..e69de29 100644 --- a/sdv/docs/docker/state/release/configguide/index.rst +++ b/docs/release/userguide/docker/state/release/configguide/index.rst diff --git a/sdv/docs/docker/state/release/userguide/index.rst b/docs/release/userguide/docker/state/release/userguide/index.rst index e69de29..e69de29 100644 --- a/sdv/docs/docker/state/release/userguide/index.rst +++ b/docs/release/userguide/docker/state/release/userguide/index.rst diff --git a/sdv/docs/docker/urls/userguide.rst b/docs/release/userguide/docker/urls/userguide.rst index 15d0724..15d0724 100644 --- a/sdv/docs/docker/urls/userguide.rst +++ b/docs/release/userguide/docker/urls/userguide.rst diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..6e36402 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,6 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent Communications, University of Delhi and others. + +CIRV-SDV User Guide +=================== diff --git a/sdv/docs/pdf/user/userguide.rst b/docs/release/userguide/pdf/user/userguide.rst index 2394888..2394888 100644 --- a/sdv/docs/pdf/user/userguide.rst +++ b/docs/release/userguide/pdf/user/userguide.rst 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/sdv/docs/valid.rst b/sdv/docs/valid.rst deleted file mode 100644 index 6aeb8a2..0000000 --- a/sdv/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] |