From b2231a970fb73f4f5df72b59ed9d58a039644ac3 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Mon, 22 Feb 2016 15:12:18 -0800 Subject: Various Document edits to fix formatting issues and add contents Change-Id: I522bf15377fb00cb22e46050ee966884896afeac Signed-off-by: Trevor Cooper --- docs/information/index.rst | 20 +------- docs/information/pharos.rst | 114 ++++++++++++++++++++++++++------------------ 2 files changed, 68 insertions(+), 66 deletions(-) (limited to 'docs/information') diff --git a/docs/information/index.rst b/docs/information/index.rst index 4c248c56..b59211ca 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 624fd556..be6f9b82 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 `_ 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 `_ -- Jira -- Weekly Pharos meeting logistics -- Weekly Test Coordination meeting logistics -- IRC: freenode.net #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** +* `Jira `_ +* `Weekly Pharos meeting `_ +* `Weekly coordination meeting for Test related projects `_ +* 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** +Project Release Artifacts +========================= -**Status of Community 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** +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** - +An interactive map of OPNFV lab locations, lab owners and other lab information is maintained on the `Pharos Wiki +`_ +----+---------------+----------------------------------------------------------+----------------------+ -| | 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 - Fu Qiao - Sheng-ann Yu @@ -123,6 +142,7 @@ Pharos project - Key Facts - Saikrishna M Kotha - Eugene Yu + Revision: _sha1_ Build date: |today| -- cgit 1.2.3-korg