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 The mission of the Anuket project is to empower the global communications community by creating and developing reference
   8 cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
   9 securely.
  10
  11 Anuket approaches its mission by providing a set of cloud infrastructure reference
  12 specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
  13 projects.
  14
  15 .. image:: /images/Anuket-structure.png
  16    :alt: Project structure of Anuket
  17
  18
  19 Participation is open to anyone, whether you are an employee of a member company or just passionate about network
  20 transformation.
  21
  22 Documentation for Anuket Users
  23 ------------------------------
  24
  25 These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
  26 sub-project categories.
  27
  28 Anuket Specifications
  29 ~~~~~~~~~~~~~~~~~~~~~
  30
  31 :doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
  32 workloads. The specifications are organized to the following documents:
  33
  34 * Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
  35 * Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
  36   infrastructure based on the requirements of the Reference Model
  37 * Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
  38   conformance of OpenStack cloud infrastrucutres and their workloads
  39 * Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
  40   requirements of the RA1 specifications
  41 * Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
  42   orchestration platform based on the requirements of the Reference Model
  43 * Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
  44   conformance of OpenStack cloud infrastrucutres and their workloads
  45 * Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
  46   platform based on the RA2 specificcations.
  47
  48
  49 Implementation projects
  50 ~~~~~~~~~~~~~~~~~~~~~~~
  51
  52 Implementation projects address specific needs in the cloud technology relevant for the community and provide a
  53 reuseable implementation. The implementation projects have their release notes, installation and user guides in the
  54 aggregated documentation set referred here:
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    release/installation.introduction
  60    release/userguide.introduction
  61    release/release-notes
  62
  63
  64 Testing Projects and Frameworks
  65 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  66
  67 Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
  68 the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
  69 and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:
  70
  71 .. toctree::
  72    :maxdepth: 1
  73
  74    release/installation.introduction
  75    release/userguide.introduction
  76    release/release-notes
  77
  78 Integration projects
  79 ~~~~~~~~~~~~~~~~~~~~
  80
  81 The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
  82 and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
  83 set referred here:
  84
  85 .. toctree::
  86    :maxdepth: 1
  87
  88    release/installation.introduction
  89    release/userguide.introduction
  90    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/