summaryrefslogtreecommitdiffstats
path: root/docs/ci
diff options
context:
space:
mode:
authorTrevor Bramwell <tbramwell@linuxfoundation.org>2017-10-13 10:41:00 -0700
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2017-11-03 13:22:02 -0700
commit346e4bbd88886a7749ec4ca19bb32be6bb1668d8 (patch)
tree39ccc5dadc5f8805ed8e7aefa5fb95b705624211 /docs/ci
parent364119099b845175ffc8f386cafcd14c348e19ce (diff)
Updated Docs Structure
Provides a new organizational structure for release engineering documentation: /ci | Job/Gate structures and CI requirements /infra | Software Infrastructure documentation /component | Documentation specific to a component (Gerrit, etc.) /release | Release documentation (ex. stable branch policy) Change-Id: I8d24435d4d2f5ab797ad90309ee2246fb9b74c8e Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Diffstat (limited to 'docs/ci')
-rw-r--r--docs/ci/index.rst18
-rw-r--r--docs/ci/resources.rst61
-rw-r--r--docs/ci/user-guide.rst11
3 files changed, 90 insertions, 0 deletions
diff --git a/docs/ci/index.rst b/docs/ci/index.rst
new file mode 100644
index 000000000..da6fc7de1
--- /dev/null
+++ b/docs/ci/index.rst
@@ -0,0 +1,18 @@
+.. 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
+
+.. _ci-overview:
+
+========
+OPNFV CI
+========
+
+TBD
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ user-guide
+ resources
diff --git a/docs/ci/resources.rst b/docs/ci/resources.rst
new file mode 100644
index 000000000..572852c48
--- /dev/null
+++ b/docs/ci/resources.rst
@@ -0,0 +1,61 @@
+.. 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
+
+.. _ci-resources:
+
+============
+CI Resources
+============
+
+CI for OPNFV requires a range of resources in order to meet testing and
+verification needs. Each resource must meet a set of criteria in order
+to be part of CI for an OPNFV release. There are three types of
+resources:
+
+ - Baremetal PODs (PODs)
+ - Virtual PODs (vPODs)
+ - Build Servers
+
+--------------
+Baremetal PODs
+--------------
+
+TBD
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Baremetal PODs Requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order of a POD to be considered CI-Ready the following requirements
+must be met:
+
+ #. Pharos Compliant and has a PDF
+ #. Connected to Jenkins
+ #. 24/7 Uptime
+ #. No Development
+ #. No manual intervention
+
+------------
+Virtual PODS
+------------
+
+TBD
+
+~~~~~~~~~~~~
+Requirements
+~~~~~~~~~~~~
+
+TBD
+
+-------------
+Build Servers
+-------------
+
+TBD
+
+~~~~~~~~~~~~
+Requirements
+~~~~~~~~~~~~
+
+TBD
diff --git a/docs/ci/user-guide.rst b/docs/ci/user-guide.rst
new file mode 100644
index 000000000..9c9b74a41
--- /dev/null
+++ b/docs/ci/user-guide.rst
@@ -0,0 +1,11 @@
+.. 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
+
+.. _ci-user-guide:
+
+=============
+CI User Guide
+=============
+
+TBD