Adjust the structure for infra documentation
[opnfvdocs.git] / docs / infrastructure / overview.rst
1 .. _overview:
2
3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
5 .. (c) Open Platform for NFV Project, Inc. and its contributors
6
7 =======================
8 Infrastructure Overview
9 =======================
10
11 OPNFV develops, operates, and maintains infrastructure which is used by the OPNFV
12 Community for development, integration, and testing purposes. `OPNFV
13 Infrastructure Working Group (Infra WG) <https://wiki.opnfv.org/display/INF>`_
14 oversees the OPNFV Infrastructure, ensures it is kept in a state which serves
15 the community in best possible way and always up to date.
16
17 Infra WG is working towards a model whereby we have a seamless pipeline
18 for handing resource requests from the OPNFV community for both development and
19 Continuous Integration perspectives. Automation of requests and integration to
20 existing automation tools is a primary driver in reaching this model. In the
21 Infra WG, we imagine a model where the Infrastructure Requirements that are
22 specified by a Feature, Installer or otherrelevant projects within OPNFV are
23 requested, provisioned, used, reported on and subsequently torn down with no (or
24 minimal) user intervention at the physical/infrastructure level.
25
26 Objectives of the Infra WG are
27
28 * Deliver efficiently dimensions resources to OPNFV community needs on request
29 in a timely manner that ensure maximum usage (capacity) and maximum density
30 (distribution of workloads)
31 * Satisfy the needs of the twice-yearly release projects, this includes being
32 able to handle load (amount of projects and requests) as well as need (topology
33 and different layouts)
34 * Support OPNFV community users.  As the INFRA group, we are integral to all
35 aspects of the OPNFV community (since it starts with the Hardware) - this can
36 mean troubleshooting any element within the stack
37 * Provide a method to expand and adapt as OPNFV community needs grow and
38 provide this to Hosting Providers (Lab providers) for input in growth forecast,
39 so they can better judge how best to contribute with their resources.
40 * Work with reporting and other groups to ensure we have adequate feedback to
41 the end-users of the labs on how their systems, code, feature performs.
42
43 The details of what is provided as part of the infrastructure can be seen in
44 following chapters.
45
46 Hardware Infrastructure
47 -----------------------
48
49 TBD
50
51 Software Infrastructure
52 -----------------------
53
54 .. toctree::
55    :maxdepth: 1
56
57    ../submodules/releng/docs/sofware-infrastructure-index
58
59 Continuous Integration (CI)
60 ---------------------------
61
62 .. toctree::
63    :maxdepth: 1
64
65    ../submodules/releng/docs/ci-index
66
67 Cross Community Continuous Integration (XCI)
68 --------------------------------------------
69
70 .. toctree::
71    :maxdepth: 1
72
73    ../submodules/releng/docs/xci-index