From 5c0a666e66a04827d54237937de2161ec6ba331f Mon Sep 17 00:00:00 2001 From: Fatih Degirmenci Date: Fri, 29 Sep 2017 13:21:21 +0200 Subject: [PATCH] Adjust the structure for infra documentation Change-Id: Id2901b810a967ecbf8f6af84604e4839890e44e4 Signed-off-by: Fatih Degirmenci --- docs/index.rst | 6 +- docs/infrastructure/ci.rst | 11 ++++ docs/infrastructure/hardware-infrastructure.rst | 11 ++++ docs/infrastructure/infrastructure-overview.rst | 47 ---------------- docs/infrastructure/overview.rst | 73 +++++++++++++++++++++++++ docs/infrastructure/software-infrastructure.rst | 11 ++++ docs/infrastructure/xci.rst | 11 ++++ 7 files changed, 122 insertions(+), 48 deletions(-) create mode 100644 docs/infrastructure/ci.rst create mode 100644 docs/infrastructure/hardware-infrastructure.rst delete mode 100644 docs/infrastructure/infrastructure-overview.rst create mode 100644 docs/infrastructure/overview.rst create mode 100644 docs/infrastructure/software-infrastructure.rst create mode 100644 docs/infrastructure/xci.rst diff --git a/docs/index.rst b/docs/index.rst index 7fe649a47..749d363a7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,4 +51,8 @@ Infrastructure .. toctree:: :maxdepth: 1 - infrastructure/infrastructure-overview + infrastructure/overview + infrastructure/hardware-infrastructure + infrastructure/software-infrastructure + infrastructure/ci + infrastructure/xci diff --git a/docs/infrastructure/ci.rst b/docs/infrastructure/ci.rst new file mode 100644 index 000000000..c779ffcbe --- /dev/null +++ b/docs/infrastructure/ci.rst @@ -0,0 +1,11 @@ +.. _ci: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +====================== +Continuous Integration +====================== + +TBD diff --git a/docs/infrastructure/hardware-infrastructure.rst b/docs/infrastructure/hardware-infrastructure.rst new file mode 100644 index 000000000..f800cdb05 --- /dev/null +++ b/docs/infrastructure/hardware-infrastructure.rst @@ -0,0 +1,11 @@ +.. _hardware-infrastructure: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======================= +Hardware Infrastructure +======================= + +TBD diff --git a/docs/infrastructure/infrastructure-overview.rst b/docs/infrastructure/infrastructure-overview.rst deleted file mode 100644 index 879d3dbe4..000000000 --- a/docs/infrastructure/infrastructure-overview.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _infrastructure-overview: - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. SPDX-License-Identifier: CC-BY-4.0 -.. (c) Open Platform for NFV Project, Inc. and its contributors - -======================= -Infrastructure Overview -======================= - -OPNFV develops, maintains and operates infrastructure which is used by OPNFV -Community for development, integration, and testing purposes. `OPNFV -Infrastructure Working Group (Infra WG) `_ -oversees the OPNFV Infrastructure, ensures it is kept in a state which serves -the community in best possible way and always up to date. - -The details of what is provided as part of infrastructure can be seen in -following chapters. - -Hardware Infrastructure ------------------------ - -TBD - -Software Infrastructure ------------------------ - -.. toctree:: - :maxdepth: 1 - - ../submodules/releng/docs/sofware-infrastructure-index - -Continuous Integration (CI) ---------------------------- - -.. toctree:: - :maxdepth: 1 - - ../submodules/releng/docs/ci-index - -Cross Community Continuous Integration (XCI) --------------------------------------------- - -.. toctree:: - :maxdepth: 1 - - ../submodules/releng/docs/xci-index diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst new file mode 100644 index 000000000..cbb73a17e --- /dev/null +++ b/docs/infrastructure/overview.rst @@ -0,0 +1,73 @@ +.. _overview: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======================= +Infrastructure Overview +======================= + +OPNFV develops, operates, and maintains infrastructure which is used by the OPNFV +Community for development, integration, and testing purposes. `OPNFV +Infrastructure Working Group (Infra WG) `_ +oversees the OPNFV Infrastructure, ensures it is kept in a state which serves +the community in best possible way and always up to date. + +Infra WG is working towards a model whereby we have a seamless pipeline +for handing resource requests from the OPNFV community for both development and +Continuous Integration perspectives. Automation of requests and integration to +existing automation tools is a primary driver in reaching this model. In the +Infra WG, we imagine a model where the Infrastructure Requirements that are +specified by a Feature, Installer or otherrelevant projects within OPNFV are +requested, provisioned, used, reported on and subsequently torn down with no (or +minimal) user intervention at the physical/infrastructure level. + +Objectives of the Infra WG are + +* Deliver efficiently dimensions resources to OPNFV community needs on request +in a timely manner that ensure maximum usage (capacity) and maximum density +(distribution of workloads) +* Satisfy the needs of the twice-yearly release projects, this includes being +able to handle load (amount of projects and requests) as well as need (topology +and different layouts) +* Support OPNFV community users. As the INFRA group, we are integral to all +aspects of the OPNFV community (since it starts with the Hardware) - this can +mean troubleshooting any element within the stack +* Provide a method to expand and adapt as OPNFV community needs grow and +provide this to Hosting Providers (Lab providers) for input in growth forecast, +so they can better judge how best to contribute with their resources. +* Work with reporting and other groups to ensure we have adequate feedback to +the end-users of the labs on how their systems, code, feature performs. + +The details of what is provided as part of the infrastructure can be seen in +following chapters. + +Hardware Infrastructure +----------------------- + +TBD + +Software Infrastructure +----------------------- + +.. toctree:: + :maxdepth: 1 + + ../submodules/releng/docs/sofware-infrastructure-index + +Continuous Integration (CI) +--------------------------- + +.. toctree:: + :maxdepth: 1 + + ../submodules/releng/docs/ci-index + +Cross Community Continuous Integration (XCI) +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../submodules/releng/docs/xci-index diff --git a/docs/infrastructure/software-infrastructure.rst b/docs/infrastructure/software-infrastructure.rst new file mode 100644 index 000000000..5c7158316 --- /dev/null +++ b/docs/infrastructure/software-infrastructure.rst @@ -0,0 +1,11 @@ +.. _software-infrastructure: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +======================= +Software Infrastructure +======================= + +TBD diff --git a/docs/infrastructure/xci.rst b/docs/infrastructure/xci.rst new file mode 100644 index 000000000..4addde37d --- /dev/null +++ b/docs/infrastructure/xci.rst @@ -0,0 +1,11 @@ +.. _xci: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +====================================== +Cross Community Continuous Integration +====================================== + +TBD -- 2.16.6