summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-02-22 15:12:18 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-02-22 15:12:18 -0800
commitb2231a970fb73f4f5df72b59ed9d58a039644ac3 (patch)
treea2ccaac92fa78927e0390b135e63640d2fb98dde /docs
parent2fe5f8f73ed6db8c281f251b9fb3a9aad4838fc5 (diff)
Various Document edits to fix formatting issues and add contents
Change-Id: I522bf15377fb00cb22e46050ee966884896afeac Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/configguide.rst61
-rwxr-xr-xdocs/index.rst26
-rw-r--r--docs/information/index.rst20
-rw-r--r--docs/information/pharos.rst114
-rw-r--r--docs/lab-description/index.rst16
-rw-r--r--docs/lab-description/inventory.rst14
-rw-r--r--docs/specification/hardwarespec.rst38
-rw-r--r--docs/specification/index.rst13
-rw-r--r--docs/specification/networkconfig.rst10
-rw-r--r--docs/specification/objectives.rst4
10 files changed, 164 insertions, 152 deletions
diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
index f239c11..d4e4abb 100644
--- a/docs/configguide/configguide.rst
+++ b/docs/configguide/configguide.rst
@@ -3,13 +3,62 @@
.. (c) 2016 OPNFV.
-=====================================
-Pharos Lab Configuration requirements
-=====================================
+==============================
+Pharos Lab Configuration Guide
+==============================
+
+This section provides an overview for Pharos lab setup and operation. The tasks and expectations for configuring a
+Pharos compliant lab are explained along with reference to relavant Pharos documents.
+
+Overview of Community Lab Expectations
+--------------------------------------
+
+* Designated lab owners and project committers participate in the Pharos community (discussions, meetings, ...)
+* Jira is used to track activities including lab operations (requests and support)
+* Production resources are connected to Jenkins and available 24/7 (other than scheduled maintenance and troubleshooting)
+* Lab resources are declared as either:
+
+ * Development (bare-metal or virtual)
+ * Production - latest (bare-metal)
+ * Production - stable (bare-metal)
+
+On-boarding Steps
+-----------------
+
+* Provide Pharos community with details of intended setup, including ...
+
+ * Resources being offered
+ * Lab owner name / contacts
+ * Timelines for availablity for development and use in upcomming releases
+
+* Update Pharos Wiki
+ * Lab with location, owner
+
+* Create and fill *New Lab* Wiki pages
+
+ * Access policies
+ * Usage guidelines for developers
+ * Fill Lab and POD templates
+ * POD allocations (updated as PODs are assigned or revoked)
+ * Lab documentation with security sensitive infomation can be stored in the Pharos secure repo (will be available soon)
+
+* Network Information
+* Update Pharos infomation file i.e. pharos.rst
+* labupdateguide.rst ... how to update Pharos Wiki start page; how to update map info
+* Connect to CI
+
+Jump Server Install
+-------------------
+
+* jumpserverinstall.rst
+
+Lab Documentation
+-----------------
+
+* Pharos Wiki page
+* Map Info
+
-.. Add an overview for the Pharos configuration guide here. This should be informative regarding the tasks
-.. and expectations when configuring a lab to be pharos compliant and refer to the relevant pharos docs published
-from the project.
Revision: _sha1_
diff --git a/docs/index.rst b/docs/index.rst
index 848343d..e29854b 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,33 +4,12 @@
.. OPNFV Pharos Documentation master file.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
======
PHAROS
======
-Pharos is the OPNFV Lab Infrastructure project.
-
-The **Pharos Project** deals with developing an OPNFV lab infrastructure that is geographically and technically diverse.
-This will greatly assist in developing a highly robust and stable OPNFV platform. Community labs are hosted by
-individual companies and there is also an OPNFV lab hosted by the Linux Foundation that has controlled access for key
-development and production activities. The **Pharos Specification** defines a "compliant" deployment and test
-environment. Pharos is responsible for defining lab capabilities, developing management/usage policies and process;
-and a support plan for reliable access to project and release resources. Community labs are provided as a service by
-companies and are not controlled by Pharos however our goal is to provide easy visibility of all lab capabilities
-and their usage at all-times.
-
-* Pharos introduction https://www.opnfv.org/developers/pharos
-* Project Wiki: https://wiki.opnfv.org/pharos
-* Project Repository: https://gerrit.opnfv.org/gerrit/#/q/pharos
-* Continuous Integration https://build.opnfv.org/ci/view/pharos/
-* Documentation: http://artifacts.opnfv.org/pharos/docs/
+OPNFV Community Lab Infrastructure
+==================================
.. toctree::
:maxdepth: 3
@@ -39,6 +18,7 @@ and their usage at all-times.
./information/index.rst
./specification/index.rst
./lab-description/index.rst
+ ./configguide/configguide.rst
Indices
=======
diff --git a/docs/information/index.rst b/docs/information/index.rst
index 4c248c5..b59211c 100644
--- a/docs/information/index.rst
+++ b/docs/information/index.rst
@@ -2,30 +2,12 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
-**************************
-Pharos Project Information
-**************************
-
.. toctree::
:maxdepth: 2
+ :numbered: 2
./pharos.rst
-:Authors: Trevor Cooper (Intel)
-:Version: 1.0
-
-Indices and tables
-==================
-
-* :ref:`search`
-
Revision: _sha1_
Build date: |today|
diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst
index 624fd55..be6f9b8 100644
--- a/docs/information/pharos.rst
+++ b/docs/information/pharos.rst
@@ -4,98 +4,116 @@
.. OPNFV Pharos Project Information file.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
-========================================
-Pharos Project: OPNFV Lab Infrastructure
-========================================
-
-The **Pharos Project** deals with developing an OPNFV lab infrastructure that is geographically and technically diverse.
+==========================
+Pharos Project Information
+==========================
+
+Introduction
+============
+
+The `Pharos Project <https://www.opnfv.org/developers/pharos>`_ deals with developing an OPNFV lab infrastructure that is geographically and technically diverse.
This will greatly assist in developing a highly robust and stable OPNFV platform. Community labs are hosted by
individual companies and there is also an OPNFV lab hosted by the Linux Foundation that has controlled access for key
development and production activities. The **Pharos Specification** defines a "compliant" deployment and test
environment. Pharos is responsible for defining lab capabilities, developing management/usage policies and process;
-and a support plan for reliable access to project and release resources. Community labs are provided as a service
-by companies and are not controlled by Pharos however our goal is to provide easy visibility of all lab capabilities
+and a support plan for reliable access to project and release resources. Community labs are provided as a service by
+companies and are not controlled by Pharos however our goal is to provide easy visibility of all lab capabilities
and their usage at all-times.
+A requirement of Pharos labs is to provide *bare-metal* for development, deployment and testing. This is resource
+intensive from a hardware and support perspective while providing remote access can also be very challenging due to
+corporate IT policies. Achieving a consistent *look and feel* of a federated lab infrastructure continues to be an
+objective. Virtual environments are also useful and provided by some labs. Jira is currently used for tracking lab
+operational issues as well as for Pharos project activities.
+
+Future lab capabilities are currently focussed on 1) Deployment automation 2) Dashboards (for capability and usage)
+3) *Virtual Labs* for developer on-boarding.
-Communication
--------------
+* Pharos page: https://www.opnfv.org/developers/pharos
+* Pharos project Wiki: https://wiki.opnfv.org/pharos
+* `Pharos Planning <https://wiki.opnfv.org/pharos_rls_b_plan>`_
-- Jira <https://jira.opnfv.org/projects/PHAROS/summary>
-- Weekly Pharos meeting logistics <https://wiki.opnfv.org/meetings#pharos_meetings>
-- Weekly Test Coordination meeting logistics <https://wiki.opnfv.org/meetings/test>
-- IRC: freenode.net #opnfv-pharos <http://webchat.freenode.net/?channels=opnfv-pharos>
-- Mailing List: use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for filtering
+Project Communication
+=====================
-**Process for requesting lab access and support** <https://wiki.opnfv.org/pharos_rls_b_support>
+* `Jira <https://jira.opnfv.org/projects/PHAROS/summary>`_
+* `Weekly Pharos meeting <https://wiki.opnfv.org/meetings#pharos_meetings>`_
+* `Weekly coordination meeting for Test related projects <https://wiki.opnfv.org/meetings/test>`_
+* IRC: freenode.net #opnfv-pharos http://webchat.freenode.net/?channels=opnfv-pharos
+* Mailing List: use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for filtering
-**Pharos Lab Governance and Policies** <https://wiki.opnfv.org/pharos_policies>
+Project Release Artifacts
+=========================
-**Status of Community labs** <https://wiki.opnfv.org/pharos_rls_b_labs>
+* Project Repository: https://gerrit.opnfv.org/gerrit/#/q/pharos
+* Continuous Integration https://build.opnfv.org/ci/view/pharos/
+* Documentation: http://artifacts.opnfv.org/pharos/docs/
-**Pharos Milesone Planning** <https://wiki.opnfv.org/pharos_rls_b_plan>
+Pharos Lab Process
+==================
+* Process for requesting lab access and support https://wiki.opnfv.org/pharos_rls_b_support
+* Pharos Lab Governance and Policies https://wiki.opnfv.org/pharos_policies
+* Status of Community labs https://wiki.opnfv.org/pharos_rls_b_labs
-Community Test Labs
---------------------
+Current Labs
+============
-An interactive map of OPNFV lab locations, lab owners and other lab information is maintained on the Pharos **Wiki**
-<https://wiki.opnfv.org/pharos#community_labs>
+An interactive map of OPNFV lab locations, lab owners and other lab information is maintained on the `Pharos Wiki
+<https://wiki.opnfv.org/pharos#community_labs>`_
+----+---------------+----------------------------------------------------------+----------------------+
-| | Hosting | Home page | Location |
-| # | Organization | | |
+| | **Hosted by** | **Home page** | **Location** |
+| # | | | |
+----+---------------+----------------------------------------------------------+----------------------+
| 1 | Linux | https://wiki.opnfv.org/get_started/lflab_hosting | Portland, Oregon |
| | Foundation | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 2 | Cable Labs | Internal use only at present | Denver, Colorado |
+| 2 | Spirent | https://wiki.opnfv.org/pharos/spirentvctlab | Nephoscale, CA |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 3 | Spirent | https://wiki.opnfv.org/pharos/spirentvctlab | Nephoscale |
-| | | | San Jose, CA |
-+----+---------------+----------------------------------------------------------+----------------------+
-| 4 | China Mobile | https://wiki.opnfv.org/lab2_chinamobile_hosting | Beijing, China |
+| 3 | China Mobile | https://wiki.opnfv.org/lab2_chinamobile_hosting | Beijing, China |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 5 | Dell | https://wiki.opnfv.org/dell_hosting | Santa Clara, CA |
+| 4 | Dell | https://wiki.opnfv.org/dell_hosting | Santa Clara, CA |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 6 | Enea | https://wiki.opnfv.org/enea-pharos-lab | Kista, Sweden |
+| 5 | Enea | https://wiki.opnfv.org/enea-pharos-lab | Kista, Sweden |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 7 | Ericsson | https://wiki.opnfv.org/get_started/ericsson_hosting | Montreal, Canada |
+| 6 | Ericsson | https://wiki.opnfv.org/get_started/ericsson_hosting | Montreal, Canada |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 8 | Huawei | https://wiki.opnfv.org/lab4_huawei | Xi an, China |
+| 7 | Huawei | https://wiki.opnfv.org/lab4_huawei | Xi an, China |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 9 | Huawei | https://wiki.opnfv.org/get_started/huawei_sc_hosting | Santa Clara, CA |
+| 8 | Huawei | https://wiki.opnfv.org/get_started/huawei_sc_hosting | Santa Clara, CA |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 10 | Intel | https://wiki.opnfv.org/get_started/intel_hosting | Hillsboro, Oregon |
+| 9 | Intel | https://wiki.opnfv.org/get_started/intel_hosting | Hillsboro, Oregon |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 11 | Orange | https://wiki.opnfv.org/opnfv-orange | Lannion, France |
+| 10 | Orange | https://wiki.opnfv.org/opnfv-orange | Lannion, France |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 12 | Orange | https://wiki.opnfv.org/opnfv-orange | Paris, France |
+| 11 | Orange | https://wiki.opnfv.org/opnfv-orange | Paris, France |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-| 13 | ZTE | https://wiki.opnfv.org/zte-nj-testlab | Nan Jing, China |
+| 12 | ZTE | https://wiki.opnfv.org/zte-nj-testlab | Nan Jing, China |
| | | | |
+----+---------------+----------------------------------------------------------+----------------------+
-Pharos project - Key Facts
---------------------------
+Pharos project Key Facts
+========================
+
+**Key Project Facts are mainatined in the Pharos INFO file**
+
+.. Reference Project Fact File ... does not work???
+
+.. include:: ../../INFO
+
+.. Remove below text once include directive above works
- Project: Testbed infrastructure (Pharos)
- Project Creation Date: January 8, 2015
@@ -110,6 +128,7 @@ Pharos project - Key Facts
- Repository: pharos
- Committers:
+
- Trevor Cooper<trevor.cooper@intel.com>
- Fu Qiao <fuqiao@chinamobile.com>
- Sheng-ann Yu <sheng-ann.yu@ericsson.com>
@@ -123,6 +142,7 @@ Pharos project - Key Facts
- Saikrishna M Kotha <saikrishna.kotha@xilinx.com>
- Eugene Yu <yuyijun@huawei.com>
+
Revision: _sha1_
Build date: |today|
diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst
index f864c97..0184b02 100644
--- a/docs/lab-description/index.rst
+++ b/docs/lab-description/index.rst
@@ -2,13 +2,6 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
****************************************
Pharos Templates and Configuration Files
****************************************
@@ -18,14 +11,7 @@ Pharos Templates and Configuration Files
./lab_description.rst
./pod_description.rst
-
-:Authors: Trevor Cooper (Intel)
-:Version: 1.0
-
-Indices and tables
-==================
-
-* :ref:`search`
+ ./inventory.rst
Revision: _sha1_
diff --git a/docs/lab-description/inventory.rst b/docs/lab-description/inventory.rst
new file mode 100644
index 0000000..e3f3e05
--- /dev/null
+++ b/docs/lab-description/inventory.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 OPNFV.
+
+=========================
+Pharos POD Inventory File
+=========================
+
+Introduction
+------------
+
+The Common Inventory File provides for a machine reabable format to input into every installer. For convenience the
+YAML file template currently resides in the Genesis Project repo. Refer to the following patch for further infomation
+https://gerrit.opnfv.org/gerrit/#/c/4079
diff --git a/docs/specification/hardwarespec.rst b/docs/specification/hardwarespec.rst
index 80987ce..a214be4 100644
--- a/docs/specification/hardwarespec.rst
+++ b/docs/specification/hardwarespec.rst
@@ -1,10 +1,10 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-Pharos compliant environment
-----------------------------
+Hardware
+--------
A pharos compliant OPNFV test-bed provides:
@@ -15,35 +15,29 @@ A pharos compliant OPNFV test-bed provides:
- Remote access as defined by the Jenkins slave configuration guide
http://artifacts.opnfv.org/brahmaputra.1.0/docs/opnfv-jenkins-slave-connection.brahmaputra.1.0.html
-Hardware requirements
----------------------
-
**Servers**
-CPU:
+**CPU:**
-* Intel Xeon E5-2600v2 Series
-(Ivy Bridge and newer, or similar)
+* Intel Xeon E5-2600v2 Series or newer
-Local Storage Configuration:
+**Local Storage:**
-Below describes the minimum for the Pharos spec,
-which is designed to provide enough capacity for
-a reasonably functional environment. Additional
-and/or faster disks are nice to have and may
-produce a better result.
+Below describes the minimum for the Pharos spec, which is designed to provide enough capacity for
+a reasonably functional environment. Additional and/or faster disks are nice to have and mayproduce
+a better result.
-* Disks: 2 x 1TB + 1 x 100GB SSD
-* The first 1TB HDD should be used for OS & additional software/tool installation
-* The second 1TB HDD configured for CEPH object storage
-* Finally, the 100GB SSD should be used as the CEPH journal
-* Performance testing requires a mix of compute nodes that have CEPH(swift+Cinder) and without CEPH storage
+* Disks: 2 x 1TB HDD + 1 x 100GB SSD (or greater capacity)
+* The first HDD should be used for OS & additional software/tool installation
+* The second HDD is configured for CEPH object storage
+* The SSD should be used as the CEPH journal
+* Performance testing requires a mix of compute nodes with CEPH (Swift+Cinder) and without CEPH storage
* Virtual ISO boot capabilities or a separate PXE boot server (DHCP/tftp or Cobbler)
-Memory:
+**Memory:**
* 32G RAM Minimum
-Power Supply Single
+**Power Supply**
* Single power supply acceptable (redundant power not required/nice to have)
diff --git a/docs/specification/index.rst b/docs/specification/index.rst
index b3f06e6..a583087 100644
--- a/docs/specification/index.rst
+++ b/docs/specification/index.rst
@@ -2,10 +2,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-
-********************
+====================
Pharos Specification
-********************
+====================
.. toctree::
:maxdepth: 2
@@ -16,14 +15,6 @@ Pharos Specification
./jumpserverinstall.rst
./remoteaccess.rst
-:Authors: Trevor Cooper (Intel)
-:Version: 1.0
-
-Indices and tables
-==================
-
-* :ref:`search`
-
Revision: _sha1_
Build date: |today|
diff --git a/docs/specification/networkconfig.rst b/docs/specification/networkconfig.rst
index 7eb0615..af09e56 100644
--- a/docs/specification/networkconfig.rst
+++ b/docs/specification/networkconfig.rst
@@ -45,7 +45,7 @@ Documented configuration to include:
- May be special NW requirements for performance related projects
- Default gateways
-ontroller node bridge topology overview
+Controller node bridge topology overview
.. image:: ../images/bridge1.png
@@ -53,10 +53,7 @@ compute node bridge topology overview
.. image:: ../images/bridge2.png
-Architecture
--------------
-
-** Network Diagram **
+**Network Diagram**
The Pharos architecture may be described as follow:
Figure 1: Standard Deployment Environment
@@ -65,8 +62,7 @@ Figure 1: Standard Deployment Environment
Figure 1: Standard Deployment Environment
-Sample Network Drawings
------------------------
+**Sample Network Drawings**
Files for documenting lab network layout.
These were contributed as Visio VSDX format compressed as a ZIP
diff --git a/docs/specification/objectives.rst b/docs/specification/objectives.rst
index 310959f..f6cfabe 100644
--- a/docs/specification/objectives.rst
+++ b/docs/specification/objectives.rst
@@ -3,8 +3,8 @@
.. (c) 2016 OPNFV.
-Objectives / Scope
--------------------
+Pharos Compliance
+-----------------
The **Pharos Specification** defines a hardware environment for deployment and testing of the **Brahmaputra**
platform release. The **Pharos Project** is also responsible for defining lab capabilities, developing