docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3
   4 Anuket Documentation
   5 ====================
   6
   7 Remembrance of the late Al Morton
   8 ---------------------------------
   9
  10 The Orinoco Anuket Release is dedicated in remembrance of the late Al Morton who was instrumental for the establishment
  11 of the OPNFV project and in the formation of Anuket from the merger of CNTT and OPNFV.  As  a co-chair of the TSC and
  12 PTL on the ViNePERF project, he contributed so much to the success of the project.  Al was a tireless believer in Open
  13 Source and standards, who spent his entire career at Bell Labs and AT&T Laboratories as a researcher and engineer
  14 extraordinaire.  He will be missed.
  15
  16 Mission and intro
  17 -----------------
  18
  19 The mission of the Anuket project is to empower the global communications community by creating and developing reference
  20 cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
  21 securely.
  22
  23 Anuket approaches its mission by providing a set of cloud infrastructure reference
  24 specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
  25 projects.
  26
  27 .. image:: /images/Anuket-structure.png
  28    :alt: Project structure of Anuket
  29
  30
  31 Participation is open to anyone, whether you are an employee of a member company or just passionate about network
  32 transformation.
  33
  34 Documentation for Anuket users
  35 ------------------------------
  36
  37 These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
  38 sub-project categories.
  39
  40 Anuket specifications
  41 ~~~~~~~~~~~~~~~~~~~~~
  42
  43 :doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
  44 workloads. The specifications are organized to the following documents:
  45
  46 * Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
  47 * Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
  48   infrastructure based on the requirements of the Reference Model
  49 * Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
  50   conformance of OpenStack cloud infrastrucutres and their workloads
  51 * Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
  52   requirements of the RA1 specifications
  53 * Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
  54   orchestration platform based on the requirements of the Reference Model
  55 * Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
  56   conformance of OpenStack cloud infrastrucutres and their workloads
  57 * Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
  58   platform based on the RA2 specificcations.
  59
  60 .. toctree::
  61    :maxdepth: 1
  62    :hidden:
  63
  64    release/installation.introduction
  65    release/userguide.introduction
  66    release/release-notes
  67
  68 Implementation projects
  69 ~~~~~~~~~~~~~~~~~~~~~~~
  70
  71 Implementation projects address specific needs in the cloud technology relevant for the community and provide a
  72 reuseable implementation. The implementation projects have their release notes, installation and user guides in the
  73 aggregated documentation set referred here:
  74
  75 - :doc:`Installation Introduction<release/installation.introduction>`
  76 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  77 - :doc:`Release Notes<release/release-notes>`
  78
  79 Testing projects and frameworks
  80 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  81
  82 Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
  83 the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
  84 and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
  85
  86 - :doc:`Installation Introduction<release/installation.introduction>`
  87 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  88 - :doc:`Release Notes<release/release-notes>`
  89
  90 Integration projects
  91 ~~~~~~~~~~~~~~~~~~~~
  92
  93 The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
  94 and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
  95 set referred here:
  96
  97 - :doc:`Installation Introduction<release/installation.introduction>`
  98 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  99 - :doc:`Release Notes<release/release-notes>`
 100
 101 Documentation for Anuket contributors
 102 -------------------------------------
 103
 104 Contribution guide for the documentation
 105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 .. toctree::
 108    :maxdepth: 1
 109
 110    how-to-use-docs/index
 111
 112 Software and hardware infrastructure guide
 113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 114
 115 .. toctree::
 116    :maxdepth: 1
 117
 118    infrastructure/overview
 119    infrastructure/ci
 120
 121 Glossary
 122 --------
 123
 124 .. toctree::
 125    :maxdepth: 1
 126
 127    glossary/index
 128
 129 Found a typo or any other feedback? Send us an email_ or
 130 talk to us on Slack_.
 131
 132 .. _email: mailto:users@opnfv.org
 133 .. _Slack: https://anuketworkspace.slack.com/