diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation.introduction.rst | 31 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 56 |
2 files changed, 36 insertions, 51 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index a226055cf..1a2e6ec21 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -11,38 +11,35 @@ Installation Abstract ======== -This is the installation document for the Anuket Kali release, please use this document for further reference. +This is the collection of installation documents for Anuket, please use this document for further reference. -Installation Procedure -====================== +Installation procedures +======================= -Each of the test Frameworks and other projects will have separate installations procedures: see the individual project documentation. +Each of the sub-projects and test frameworks have their separate installations procedures in their individual +documentation. -- :ref:`Airship Installation Guide <airship-installation>` - :ref:`Barometer Installation Guide <barometer-docker-userguide>` - :ref:`CIRV-SDV Installation Guide <cirv-sdv-installation>` - :ref:`Kuberef Installation Guide <kuberef-installation>` - :ref:`ViNePERF installation Guide <vineperf-installation>` - -* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` - +- :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` Anuket Test Frameworks ====================== -If you have elected to install using the Anuket Kali Release toolchain, -you can begin to test once the installation is completed. -The basic deployment validation only addresses some of the capabilities in -any platform and you may want to execute more exhaustive tests. Some investigation will be required to -select the right test suites to run on your platform. +Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses +some of the generic capabilities of cloud infrastructures. To run more exhaustive tests some investigation will be +required to select the right test suites to run. -Many of the Anuket test projects provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>` +Many of the Anuket test projects provide user-guide documentation and installation instructions in +:ref:`this document <testing-userguide>` -Anuket Reference Specifications -=============================== +Anuket Specifications +===================== There is no need to "install" the Anuket Reference Specifications! You can view them here: .. * :doc:`Anuket Reference Specifications <cntt-cntt:/index>` -* `Anuket Reference Specifications <https://cntt.readthedocs.io/en/stable-kali/index.html>`_ +* `Anuket Specifications <https://cntt.readthedocs.io/en/stable-kali/index.html>`_ diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 29dff1074..7e74a1eab 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -11,62 +11,50 @@ User Guide & Configuration Guide Abstract ======== -One of Anuket's project goals is to reduce time to integrate and deploy NFV infrastructure and onboard VNF/CNFs -for those who supply components and those who operationalize these platforms. The Anuket community -does this by implementing, testing and deploying tools for conformance and performance of NFV infrastructure, aligned -with industry reference architectures. This document provides guidance and instructions for using platform -features designed to support the tools that are made available in the Anuket -Kali release. - -This document is not intended to replace or replicate documentation from other -upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the -features and capabilities delivered through the Anuket project. +One of Anuket's project goals is to reduce time to integrate and deploy cloud infrastructures and onboard VNF/CNFs for +those who supply components and those who operationalize these platforms. The Anuket community does this by +implementing, testing and deploying tools for conformance and performance of cloud infrastructures, aligned with +industry reference architectures. This document provides guidance and instructions for using platform features designed +to support the tools that are made available in the Anuket project. +This document is not intended to replace or replicate documentation from other upstream open source projects such as +KVM, OpenDaylight, OpenStack, etc., but to highlight the features and capabilities delivered through the Anuket project. Introduction ============ -Anuket provides a infrastructure deployment options, which -are able to be installed to host virtualised network functions (VNFs) and cloud network functions (CNFs). -This document intends to help users leverage the features and +Anuket provides infrastructure deployment options, which are able to be installed to host virtualised network functions +(VNFs) and cloud native network functions (CNFs). This document intends to help users leverage the features and capabilities delivered by Anuket. Feature Overview ================ -The following links outline the feature deliverables from participating Anuket -projects in the Kali release. Each of the participating projects provides -detailed descriptions about the features delivered including use cases, -implementation, and configuration specifics in the project documentation. - -The following Configuration Guides and User Guides assume that the reader already has some -knowledge about a given project's specifics and capabilities. These Guides -are intended to allow users to deploy and implement features that are part of the -Anuket Kali release. +The following links outline the feature deliverables from Anuket sub-projects. Each of the sub-projects provide detailed +descriptions about the features delivered including use cases, implementation, and configuration specifics in the +sub-project documentation. -If you are unsure about the specifics of a given project, please refer to the -Anuket wiki page at http://wiki.anuket.io for more details. +The following Configuration Guides and User Guides assume that the reader already has some knowledge about a given +sub-project's specifics and capabilities. These Guides are intended to allow users to deploy and implement features that +are part of the Anuket release. +The `Anuket developer wiki <http://wiki.anuket.io>`_ might contain more details about the specific projects. -Feature Configuration Guides -============================ +Configuration Guides +==================== -* :ref:`AIRSHIP Configuration Guide <airship-installation>` * :ref:`Barometer Configuration Guide <barometer-configguide>` * :ref:`CIRV-SDV Configuration Guide <cirv-sdv-configguide>` * :ref:`Kuberef Configuration Guide <kuberef-configguide>` * :doc:`ViNePERF Configuration Guide <vineperf:testing/user/configguide/index>` -* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` - - - +* :doc:`Functest Configuration Guide <functest:testing/user/configguide/index>` -Feature User Guides -=================== +User Guides +=========== * :ref:`Barometer User Guide <barometer-userguide>` * :ref:`CIRV-SDV User Guide <cirv-sdv-userguide>` * :ref:`Kuberef User Guide <kuberef-userguide>` -* :doc:`ViNePERF User Guide <vineperf:testing/user/configguide/index>` +* :doc:`ViNePerf Configuration and User Guide <vineperf:testing/user/configguide/index>` * :doc:`Functest User Guide <functest:testing/user/userguide/index>` |