Add README file for opnfvdocs repo
[opnfvdocs.git] / docs / release / installation.introduction.rst
index 4243fc7..22ccd55 100644 (file)
@@ -1,84 +1,38 @@
+.. _opnfv-installation:
+
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. (c) Sofia Wallin Ericsson AB
-
-====================
-OPNFV Installation
-====================
-
-Abstract
-========
-
-The following document provides an overview of the instructions required for the installation
-of the Danube release of OPNFV.
-
-The Danube release can be installed using a tool from the following integration projects in OPNFV:
-Apex, Compass4Nfv, Fuel and JOID.  Each installer provides the ability to install a common OPNFV
-platform as well as integrating additional features delivered through a variety of scenarios by
-the OPNFV community.
-
-
-Introduction
-============
-
-The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical
-infrastructure.  A composition of components, tools and configurations is identified in OPNFV as a
-deployment scenario.
+.. (c) Anuket CCC, AT&T, and other contributors
 
-The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and
-it is important to understand your required target platform capabilities before installing and
-configuring your scenarios.
+=========================
+Installation Introduction
+=========================
 
-An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
-in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`.
-When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
+This is the collection of installation documents for Anuket. Use this document for further reference.
 
+Anuket specifications
+=====================
 
-Scenarios
-=========
-
-OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
-architectures and locations. Each scenario provides specific capabilities and/or components aimed at
-solving specific problems for the deployment of VNF’s.
-
-A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc.,
-where each scenario will include different source components or configurations.
-
-To learn more about the scenarios supported in the Danube release refer to the scenario
-description documents provided:
-
-- Links to scenario description documents need to be added here.  (todo)
-
-Installation Procedure
-======================
-
-Detailed step by step instructions for working with an installation toolchain and installing
-the required scenario are provided by each installation project.  The four projects providing installation
-support for the OPNFV Danube release are; Apex, Compass4nfv, Fuel and Joid.
+It is recommended to use the online version of the :doc:`Anuket Specifications <cntt:index>`.
 
-The instructions for each toolchain can be found in these links:
+Implementation projects
+=======================
 
-- :ref:`Apex installation instruction <apex-installation>`
-- :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
-- :ref:`Fuel installation instruction <fuel-installation>`
-- :ref:`Joid installation instruction <joid-installation>`
+- :ref:`Barometer Installation Guide <barometer-docker-userguide>`
 
+Testing projects and frameworks
+===============================
 
-OPNFV Test Frameworks
-=====================
+- :ref:`ViNePERF installation Guide <vineperf-installation>`
+- :doc:`Functest Installation Guide <functest:testing/user/configguide/index>`
 
-If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
-your system will have been validated once the installation is completed.
-The basic deployment validation only addresses a small part of capabilities provided in
-the 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 is 
+required to select the right test suites to run.
 
-Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`
+For more instructions on using the Anuket testing projects after installation, see :ref:`this document <testing-userguide>`.
 
-Security Notes
-==============
-
-The following patches were applied to fix security issues discovered in OPNFV
-projects, during the Danube release cycle.
+Integration projects
+====================
 
-- Links to security patches need to be added here.  (todo)
+- :ref:`Kuberef Installation Guide <kuberef-installation>`