summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: 391be47f043d7d8a95045e0ff75e007d53ee7dfa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0

Anuket Documentation
====================

Remembrance of the late Al Morton
---------------------------------

The Orinoco Anuket Release is dedicated in remembrance of the late Al Morton who was instrumental for the establishment
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
PTL on the ViNePERF project, he contributed so much to the success of the project.  Al was a tireless believer in Open
Source and standards, who spent his entire career at Bell Labs and AT&T Laboratories as a researcher and engineer
extraordinaire.  He will be missed.

Mission and intro
-----------------

The mission of the Anuket project is to empower the global communications community by creating and developing reference
cloud infrastructure models, architectures, tools, and programs to deliver network services faster, more reliably, and
securely.

Anuket approaches its mission by providing a set of cloud infrastructure reference
specifications, reference implementations, conformance tests, testing tools, testing frameworks and implementation
projects.

.. image:: /images/Anuket-structure.png
   :alt: Project structure of Anuket


Participation is open to anyone, whether you are an employee of a member company or just passionate about network
transformation.

Documentation for Anuket users
------------------------------

These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
sub-project categories.

Anuket specifications
~~~~~~~~~~~~~~~~~~~~~

:doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
workloads. The specifications are organized to the following documents:

* Reference Model (RM) - a technology independent specification of cloud infrastructures for telecom workloads
* Reference Architecture (RA1) for OpenStack based cloud infrastructure - a specification of an OpenStack cloud
  infrastructure based on the requirements of the Reference Model 
* Reference Conformance (RC1) for RA1 based Implementations - an automatic conformance testing framework to test RA1
  conformance of OpenStack cloud infrastrucutres and their workloads
* Reference Implementation based on RA1 specifications (RI1) - a blueprint to build an OpenStack cloud based on the
  requirements of the RA1 specifications
* Reference Architecture (RA2) for Kubernetes based cloud infrastructure - a specification of a Kubernetes container
  orchestration platform based on the requirements of the Reference Model
* Reference Conformance (RC2) for RA2 based Implementations - an automatic conformance testing framework to test RA2
  conformance of OpenStack cloud infrastrucutres and their workloads
* Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration
  platform based on the RA2 specificcations.

.. toctree::
   :maxdepth: 1
   :hidden:

   release/installation.introduction
   release/userguide.introduction
   release/release-notes

Implementation projects
~~~~~~~~~~~~~~~~~~~~~~~

Implementation projects address specific needs in the cloud technology relevant for the community and provide a
reuseable implementation. The implementation projects have their release notes, installation and user guides in the
aggregated documentation set referred here:

- :doc:`Installation Introduction<release/installation.introduction>`
- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
- :doc:`Release Notes<release/release-notes>`

Testing projects and frameworks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while
the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects
and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here:

- :doc:`Installation Introduction<release/installation.introduction>`
- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
- :doc:`Release Notes<release/release-notes>`

Integration projects
~~~~~~~~~~~~~~~~~~~~

The integration projects integrate OpenStack and Kubernetes based cloud infrastructures based on the blueprints of RI1
and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation
set referred here:

- :doc:`Installation Introduction<release/installation.introduction>`
- :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
- :doc:`Release Notes<release/release-notes>`

Documentation for Anuket contributors
-------------------------------------

Contribution guide for the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   how-to-use-docs/index

Software and hardware infrastructure guide
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. toctree::
   :maxdepth: 1

   infrastructure/overview
   infrastructure/ci

Glossary
--------

.. toctree::
   :maxdepth: 1

   glossary/index

Found a typo or any other feedback? Send us an email_ or
talk to us on Slack_.

.. _email: mailto:users@opnfv.org
.. _Slack: https://anuketworkspace.slack.com/