1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
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
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
18 .. image:: /images/Anuket-structure.png
19 :alt: Project structure of Anuket
22 Participation is open to anyone, whether you are an employee of a member company or just passionate about network
25 Documentation for Anuket users
26 ------------------------------
28 These documents are targeted to the users of the different Anuket sub-projects and here they are organized by
29 sub-project categories.
34 :doc:`Anuket Specifications <cntt:index>` provide reference specifications for cloud infrastructures and their
35 workloads. The specifications are organized to the following documents:
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.
55 release/installation.introduction
56 release/userguide.introduction
59 Implementation projects
60 ~~~~~~~~~~~~~~~~~~~~~~~
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:
66 - :doc:`Installation Introduction<release/installation.introduction>`
67 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
68 - :doc:`Release Notes<release/release-notes>`
70 Testing projects and frameworks
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:
77 - :doc:`Installation Introduction<release/installation.introduction>`
78 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
79 - :doc:`Release Notes<release/release-notes>`
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
88 - :doc:`Installation Introduction<release/installation.introduction>`
89 - :doc:`User Guide and Configuration Guide<release/userguide.introduction>`
90 - :doc:`Release Notes<release/release-notes>`
92 Documentation for Anuket contributors
93 -------------------------------------
95 Contribution guide for the documentation
96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101 how-to-use-docs/index
103 Software and hardware infrastructure guide
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 infrastructure/overview
120 Found a typo or any other feedback? Send us an email_ or
121 talk to us on Slack_.
123 .. _email: mailto:users@opnfv.org
124 .. _Slack: https://anuketworkspace.slack.com/