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 Mission and intro
   8 -----------------
   9
  10 The mission of the Anuket project is to empower the global communications community by creating and developing reference
  11 cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
  12 securely.
  13
  14 Anuket approaches its mission by providing a set of cloud infrastructure reference
  15 specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
  16 projects.
  17
  18 .. image:: /images/Anuket-structure.png
  19    :alt: Project structure of Anuket
  20
  21
  22 Participation is open to anyone, whether you are an employee of a member company or just passionate about network
  23 transformation.
  24
  25 Documentation for Anuket users
  26 ------------------------------
  27
  28 These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
  29 sub-project categories.
  30
  31 Anuket specifications
  32 ~~~~~~~~~~~~~~~~~~~~~
  33
  34 :doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
  35 workloads. The specifications are organized to the following documents:
  36
  37 * Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
  38 * Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
  39   infrastructure based on the requirements of the Reference Model
  40 * Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
  41   conformance of OpenStack cloud infrastrucutres and their workloads
  42 * Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
  43   requirements of the RA1 specifications
  44 * Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
  45   orchestration platform based on the requirements of the Reference Model
  46 * Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
  47   conformance of OpenStack cloud infrastrucutres and their workloads
  48 * Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
  49   platform based on the RA2 specificcations.
  50
  51 .. toctree::
  52    :maxdepth: 1
  53    :hidden:
  54
  55    release/installation.introduction
  56    release/userguide.introduction
  57    release/release-notes
  58
  59 Implementation projects
  60 ~~~~~~~~~~~~~~~~~~~~~~~
  61
  62 Implementation projects address specific needs in the cloud technology relevant for the community and provide a
  63 reuseable implementation. The implementation projects have their release notes, installation and user guides in the
  64 aggregated documentation set referred here:
  65
  66 - :doc:`Installation Introduction<release/installation.introduction>`
  67 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  68 - :doc:`Release Notes<release/release-notes>`
  69
  70 Testing projects and frameworks
  71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  72
  73 Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
  74 the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
  75 and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
  76
  77 - :doc:`Installation Introduction<release/installation.introduction>`
  78 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  79 - :doc:`Release Notes<release/release-notes>`
  80
  81 Integration projects
  82 ~~~~~~~~~~~~~~~~~~~~
  83
  84 The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
  85 and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
  86 set referred here:
  87
  88 - :doc:`Installation Introduction<release/installation.introduction>`
  89 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
  90 - :doc:`Release Notes<release/release-notes>`
  91
  92 Documentation for Anuket contributors
  93 -------------------------------------
  94
  95 Contribution guide for the documentation
  96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 .. toctree::
  99    :maxdepth: 1
 100
 101    how-to-use-docs/index
 102
 103 Software and hardware infrastructure guide
 104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 105
 106 .. toctree::
 107    :maxdepth: 1
 108
 109    infrastructure/overview
 110    infrastructure/ci
 111
 112 Glossary
 113 --------
 114
 115 .. toctree::
 116    :maxdepth: 1
 117
 118    glossary/index
 119
 120 Found a typo or any other feedback? Send us an email_ or
 121 talk to us on Slack_.
 122
 123 .. _email: mailto:users@opnfv.org
 124 .. _Slack: https://anuketworkspace.slack.com/