From c4e926c285db44a5ec5ba4a895c8d3889e3358c0 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 19 Jan 2016 11:53:14 -0800 Subject: Organized document directories, added index.rst files ... ./ only file here should be project facts (INFO) ./docs/ no files should be here (jumpserver_install and pharos-spec files will be removed) ./docs/configguide/ overview of community lab expecations, reference to all other files wtih descriptions, get started for a new lab (e.g. how to update pharos start page) ./docs/images/ diagrams for pharos project (Wiki etc. not a particular lab) ./docs/information/ contains pharos project information ... pharos.rst ./docs/lab-description/ templates and config file examples (human readable (rst) and machine readable (yaml) files) ./docs/labs/ all lab specific documentation (filled templates, etc.) ./docs/labs/images/ lab specific diagrams ./docs/specification/ files that are part of the pharos spec Change-Id: I3a7a1434ae4b8f6f0d66d0ce5b6a1b00853378d5 Signed-off-by: Trevor Cooper --- .INFO.swp | Bin 0 -> 12288 bytes docs/configguide/index.rst | 15 ++++ docs/configguide/lab_update_guide.rst | 72 +++++++++++++++++ docs/information/index.rst | 15 ++++ docs/information/pharos.rst | 107 ++++++++++++++++++++++++++ docs/lab-description/lab_details_template.rst | 71 +++++++++++++++++ docs/lab_update_guide.rst | 72 ----------------- docs/labs/templates/lab_details_template.rst | 71 ----------------- docs/pharos.rst | 107 -------------------------- 9 files changed, 280 insertions(+), 250 deletions(-) create mode 100644 .INFO.swp create mode 100644 docs/configguide/index.rst create mode 100644 docs/configguide/lab_update_guide.rst create mode 100644 docs/information/index.rst create mode 100644 docs/information/pharos.rst create mode 100644 docs/lab-description/lab_details_template.rst delete mode 100644 docs/lab_update_guide.rst delete mode 100644 docs/labs/templates/lab_details_template.rst delete mode 100644 docs/pharos.rst diff --git a/.INFO.swp b/.INFO.swp new file mode 100644 index 00000000..a187b76f Binary files /dev/null and b/.INFO.swp differ diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 00000000..4af40a59 --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,15 @@ +Pharos Project Information +==================== + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst + +:Authors: Trevor Cooper (Intel) +:Version: 1.0 + +Indices and tables +================== + +* :ref:`search` diff --git a/docs/configguide/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst new file mode 100644 index 00000000..fb41f4bc --- /dev/null +++ b/docs/configguide/lab_update_guide.rst @@ -0,0 +1,72 @@ +How to update the lab info on this wiki +======================================== + +Details about Hosted Community OPNFV Test Labs are located in 3 different places: + + - Summarized on the OPNFV wiki [[start#opnfv_community_labs|Start Page]] + - Overview with additional details on the [[pharos#opnfv_test_labs|Pharos Test Bed Governance Project Page]] + - With Project specific information on each project page + +---- + +How to update the Start Page +----------------------------- + +* Clone the Pharos Git repository and make the changes:: + + git clone ssh://@gerrit.opnfv.org:29418/pharos + + vi docs/pharos.rst + # use the below guide for MAP + + git add docs/pharos.rst + + git commit --signoff + # use the proper commit message & include JIRA id + + git review -v + # go to gerrit web and add reviewers, wait to have it merged + # after code gets merged http://artifacts.opnfv.org/pharos/docs/pharos.html will contain your change + + # edit Wiki page https://wiki.opnfv.org/pharos and look for {{scrape>http://artifacts.opnfv.org/pharos/docs/pharos.html}} + # click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save" + # This must be done as Wiki does not auto update content for now + +* You will see a section of code as shown below. Add your page to the bullet list with wiki link, nice name, and location summary + + +How to update the map info on the Pharos Project Page +------------------------------------------------------ + + * Login and edit the OPNFV wiki [[pharos#opnfv_test_labs|Pharos Project Page]] + * You will see a section of code as shown below. Add your page to the list with a comma separated list as follows: + * longitude + * latitude + * .8 <- for size + * marker color png ([[marker-green.png|marker-green.png]], [[marker-blue.png|marker-blue.png]], [[marker-red.png|marker-red.png]], [[marker-gold.png|marker-gold.png]]) + * Nice Format Lab Name + * '';'' + * Location Summary + * ''\\'' <-- for a new line + * external link: <-- optional + +MAP:: + + + 50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\ external link: + 39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing \\ external link: + 45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal \\ + 34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an \\ + 45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro \\ + 48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion \\ + 48.82,2.27,60,.8,marker-gold.png,Orange Labs;Paris \\ + [[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting** + + + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + diff --git a/docs/information/index.rst b/docs/information/index.rst new file mode 100644 index 00000000..4af40a59 --- /dev/null +++ b/docs/information/index.rst @@ -0,0 +1,15 @@ +Pharos Project Information +==================== + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst + +:Authors: Trevor Cooper (Intel) +:Version: 1.0 + +Indices and tables +================== + +* :ref:`search` diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst new file mode 100644 index 00000000..dc0bcc6a --- /dev/null +++ b/docs/information/pharos.rst @@ -0,0 +1,107 @@ +Project: Testbed infrastructure (Pharos) +######################################### + + +The Pharos project deals with the creation of a distributed and federated NFV test capability that will be hosted by a number of companies in the OPNFV community. The goals consist in managing the list of community platforms, describing the different community platforms, offering timeslots and tools to perform tests, sharing the results and the best practices, supporting any test campaigns of the projects of the community (e.g. [[opnfv_functional_testing | functional testing project]], [[platform_performance_benchmarking|Qtip]], [[get_started|BGS]], [[oscar/project_proposal|oscar]],...). Pharos shall provide the infrastructure and the tooling needed by the different projects. + + +.. image:: images/opnfv-test.jpg + +Community Test Labs +-------------------- + +A summary of all Community Hosted OPNFV test labs (existing and planned) is also kept on the `wiki home page `. This section here contains additional details and project relationship mappings. //NOTE: Please follow `these instructions ` when updating this list.// + ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| Map | Hosting | Home page | Contact person | Comments | Location | +| Position | Organization | | | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 1 | Spirent | https://wiki.opnfv.org/pharos/spirentvctlab | Iben Rodriguez | OpenDaylight, NFV, SDN, & | Nephoscale | +| | | | iben.rodriguez@spirent.com | OpenStack testing in progress | San Jose, CA | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 2 | China Mobile | | Fu Qiao | PODs dedicated for BGS and | Beijing, China | +| | | | fuqiao@chinamobile.com | Functest | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 3 | Ericsson | https://wiki.opnfv.org/get_started/ericsson_hosting | Jonas Bjurel | | Montreal, Canada | +| | | | jonas.bjurel@ericsson.com | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 4 | Huawei | | Radoaca Vasile | TBD | Xi an, China | +| | | | radoaca.vasile@huawei.com | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 5 | Intel | https://wiki.opnfv.org/get_started/intel_hosting | Trevor Cooper | Operational with PODs dedicated to | Intel Labs; Hillsboro| +| | | | trevor.cooper@intel.com | BGS and vSwitch projects | Oregon | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 6 | Orange | | Morgan Richomme | Available Q1 2015 | Orange Labs; | +| | | | morgan.richomme@orange.com | | Lannion, France | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 7 | Cable Labs | | | TBD | | +| | | | | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 8 | Dell | https://wiki.opnfv.org/dell_hosting | Wenjing Chu | Operational with PODs based on Arno | Santa Clara, CA | +| | | | Wenjing_Chu@DELL.com | outputs | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 9 | Huawei | | Sean Chen | TBD | Santa Clara, CA | +| | | | | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ +| 10 | ZTE | | Zhihui Wu | BGS Parser Yardstick | Nanjing, China | +| | | | wu.zhihui1@zte.com.cn | | | ++-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ + + + +Pharos management +------------------ + +- `Project proposal `_ +- A "Pharos compliant" environment is the `standard configuration of a deployed system `_ for test purposes +- `Testing `_ on "Pharos compliant" environment +- `Project draft release `_ +- `Task follow-up `_ +- `FAQ `_ +- `meeting & minutes page] `_ <- this page needs to be moved and renamed + +Pharos project - Key facts +--------------------------- + +- Project Creation Date: January 8, 2015 +- Project Category: Integration & Testing +- Lifecycle State: Incubation +- Primary Contact: Trevor +- Project Lead: Trevor +- Jira Project Name: Testbed infrastructure Project +- Jira Project Prefix: PHAROS +- Committers: + + - Trevor Cooper + - Fu Qiao + - Sheng-ann Yu + - Wenjing Chu + - Chris Donley + - Morgan Richomme + - Erica Johnson + - Hui Deng + - Prabu Kuppuswamy + - Sean Chen + - Saikrishna M Kotha + - Eugene Yu + +- Contributors: + + - Iben Rodriguez + + +- IRC : freenode.net #opnfv-pharos `http://webchat.freenode.net/?channels=opnfv-pharos `_ +- Mailing List : no dedicated mailing list - use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for easier filtering +- Meetings : + + - `meetings `_ + +- Repository: pharos + +**Documentation tracking** + +Revision: _sha1_ + +Build date: _date_ + + diff --git a/docs/lab-description/lab_details_template.rst b/docs/lab-description/lab_details_template.rst new file mode 100644 index 00000000..bcc909ad --- /dev/null +++ b/docs/lab-description/lab_details_template.rst @@ -0,0 +1,71 @@ +Pharos Lab Details Template +============================ + +Hardware details +----------------- + +**General details** + ++----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+ +| Hostname | Node type | HW model | Storage | CPU model | # Sockets | Memory [GB] | # NIC [MAC / IP / VLAN id] | BW | ++----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+ +| galileo | network | Dell R730 | 3 x 1TB (raid 5) | IntelE5-2690 v2 | 2 | 64 | 1 # 00:ae:ff:cc:dd:12 / 192.168.22.10 / 1003 | 10 Gbps | +| | | | | | | | 2 # 00:11:22:33:44:55 / 10.7.8.10 / 1 | 1 Gbps | ++----------------+------------------+----------------------+-----------------------+--------------+-----------+-------------+-------------------------------------------+------+---------+ + +**Lights-out** + ++----------------+-------------------------------+------------------+---------------------+ +| Hostname | Lights-out address | Username | Password | +-----------------+-------------------------------+------------------+---------------------+ +| | | | | ++----------------+-------------------------------+------------------+---------------------+ + + +Software +--------- + +**OS** + + +**Pre-provisioned software** + + +Network +-------- + +**Subnet allocations** + ++--------------+-------------------+-------------------+---------------+---------+ +| Net name | Address | Mask | Gateway | VLAN id | ++--------------+-------------------+-------------------+---------------+---------+ +| | | | | | ++--------------+-------------------+-------------------+---------------+---------+ + + +**Firewall rules** + + +**Diagrams** + +.. image:: images/_.png|.jpg + :alt: Name of the diagram + +Remote access infrastructure +----------------------------- + +**Explanations** + +**Diagrams** + +.. image:: images/_.png|.jpg + :alt: Name of the diagram + + +Documentation tracking +----------------------- + +Revision: _sha1_ + +Build date: _date_ + diff --git a/docs/lab_update_guide.rst b/docs/lab_update_guide.rst deleted file mode 100644 index fb41f4bc..00000000 --- a/docs/lab_update_guide.rst +++ /dev/null @@ -1,72 +0,0 @@ -How to update the lab info on this wiki -======================================== - -Details about Hosted Community OPNFV Test Labs are located in 3 different places: - - - Summarized on the OPNFV wiki [[start#opnfv_community_labs|Start Page]] - - Overview with additional details on the [[pharos#opnfv_test_labs|Pharos Test Bed Governance Project Page]] - - With Project specific information on each project page - ----- - -How to update the Start Page ------------------------------ - -* Clone the Pharos Git repository and make the changes:: - - git clone ssh://@gerrit.opnfv.org:29418/pharos - - vi docs/pharos.rst - # use the below guide for MAP - - git add docs/pharos.rst - - git commit --signoff - # use the proper commit message & include JIRA id - - git review -v - # go to gerrit web and add reviewers, wait to have it merged - # after code gets merged http://artifacts.opnfv.org/pharos/docs/pharos.html will contain your change - - # edit Wiki page https://wiki.opnfv.org/pharos and look for {{scrape>http://artifacts.opnfv.org/pharos/docs/pharos.html}} - # click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save" - # This must be done as Wiki does not auto update content for now - -* You will see a section of code as shown below. Add your page to the bullet list with wiki link, nice name, and location summary - - -How to update the map info on the Pharos Project Page ------------------------------------------------------- - - * Login and edit the OPNFV wiki [[pharos#opnfv_test_labs|Pharos Project Page]] - * You will see a section of code as shown below. Add your page to the list with a comma separated list as follows: - * longitude - * latitude - * .8 <- for size - * marker color png ([[marker-green.png|marker-green.png]], [[marker-blue.png|marker-blue.png]], [[marker-red.png|marker-red.png]], [[marker-gold.png|marker-gold.png]]) - * Nice Format Lab Name - * '';'' - * Location Summary - * ''\\'' <-- for a new line - * external link: <-- optional - -MAP:: - - - 50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\ external link: - 39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing \\ external link: - 45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal \\ - 34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an \\ - 45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro \\ - 48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion \\ - 48.82,2.27,60,.8,marker-gold.png,Orange Labs;Paris \\ - [[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting** - - - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ - diff --git a/docs/labs/templates/lab_details_template.rst b/docs/labs/templates/lab_details_template.rst deleted file mode 100644 index bcc909ad..00000000 --- a/docs/labs/templates/lab_details_template.rst +++ /dev/null @@ -1,71 +0,0 @@ -Pharos Lab Details Template -============================ - -Hardware details ------------------ - -**General details** - -+----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+ -| Hostname | Node type | HW model | Storage | CPU model | # Sockets | Memory [GB] | # NIC [MAC / IP / VLAN id] | BW | -+----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+ -| galileo | network | Dell R730 | 3 x 1TB (raid 5) | IntelE5-2690 v2 | 2 | 64 | 1 # 00:ae:ff:cc:dd:12 / 192.168.22.10 / 1003 | 10 Gbps | -| | | | | | | | 2 # 00:11:22:33:44:55 / 10.7.8.10 / 1 | 1 Gbps | -+----------------+------------------+----------------------+-----------------------+--------------+-----------+-------------+-------------------------------------------+------+---------+ - -**Lights-out** - -+----------------+-------------------------------+------------------+---------------------+ -| Hostname | Lights-out address | Username | Password | ------------------+-------------------------------+------------------+---------------------+ -| | | | | -+----------------+-------------------------------+------------------+---------------------+ - - -Software ---------- - -**OS** - - -**Pre-provisioned software** - - -Network --------- - -**Subnet allocations** - -+--------------+-------------------+-------------------+---------------+---------+ -| Net name | Address | Mask | Gateway | VLAN id | -+--------------+-------------------+-------------------+---------------+---------+ -| | | | | | -+--------------+-------------------+-------------------+---------------+---------+ - - -**Firewall rules** - - -**Diagrams** - -.. image:: images/_.png|.jpg - :alt: Name of the diagram - -Remote access infrastructure ------------------------------ - -**Explanations** - -**Diagrams** - -.. image:: images/_.png|.jpg - :alt: Name of the diagram - - -Documentation tracking ------------------------ - -Revision: _sha1_ - -Build date: _date_ - diff --git a/docs/pharos.rst b/docs/pharos.rst deleted file mode 100644 index dc0bcc6a..00000000 --- a/docs/pharos.rst +++ /dev/null @@ -1,107 +0,0 @@ -Project: Testbed infrastructure (Pharos) -######################################### - - -The Pharos project deals with the creation of a distributed and federated NFV test capability that will be hosted by a number of companies in the OPNFV community. The goals consist in managing the list of community platforms, describing the different community platforms, offering timeslots and tools to perform tests, sharing the results and the best practices, supporting any test campaigns of the projects of the community (e.g. [[opnfv_functional_testing | functional testing project]], [[platform_performance_benchmarking|Qtip]], [[get_started|BGS]], [[oscar/project_proposal|oscar]],...). Pharos shall provide the infrastructure and the tooling needed by the different projects. - - -.. image:: images/opnfv-test.jpg - -Community Test Labs --------------------- - -A summary of all Community Hosted OPNFV test labs (existing and planned) is also kept on the `wiki home page `. This section here contains additional details and project relationship mappings. //NOTE: Please follow `these instructions ` when updating this list.// - -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| Map | Hosting | Home page | Contact person | Comments | Location | -| Position | Organization | | | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 1 | Spirent | https://wiki.opnfv.org/pharos/spirentvctlab | Iben Rodriguez | OpenDaylight, NFV, SDN, & | Nephoscale | -| | | | iben.rodriguez@spirent.com | OpenStack testing in progress | San Jose, CA | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 2 | China Mobile | | Fu Qiao | PODs dedicated for BGS and | Beijing, China | -| | | | fuqiao@chinamobile.com | Functest | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 3 | Ericsson | https://wiki.opnfv.org/get_started/ericsson_hosting | Jonas Bjurel | | Montreal, Canada | -| | | | jonas.bjurel@ericsson.com | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 4 | Huawei | | Radoaca Vasile | TBD | Xi an, China | -| | | | radoaca.vasile@huawei.com | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 5 | Intel | https://wiki.opnfv.org/get_started/intel_hosting | Trevor Cooper | Operational with PODs dedicated to | Intel Labs; Hillsboro| -| | | | trevor.cooper@intel.com | BGS and vSwitch projects | Oregon | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 6 | Orange | | Morgan Richomme | Available Q1 2015 | Orange Labs; | -| | | | morgan.richomme@orange.com | | Lannion, France | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 7 | Cable Labs | | | TBD | | -| | | | | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 8 | Dell | https://wiki.opnfv.org/dell_hosting | Wenjing Chu | Operational with PODs based on Arno | Santa Clara, CA | -| | | | Wenjing_Chu@DELL.com | outputs | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 9 | Huawei | | Sean Chen | TBD | Santa Clara, CA | -| | | | | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ -| 10 | ZTE | | Zhihui Wu | BGS Parser Yardstick | Nanjing, China | -| | | | wu.zhihui1@zte.com.cn | | | -+-----------+---------------+------------------------------------------------------+---------------------------------------------+-------------------------------------+----------------------+ - - - -Pharos management ------------------- - -- `Project proposal `_ -- A "Pharos compliant" environment is the `standard configuration of a deployed system `_ for test purposes -- `Testing `_ on "Pharos compliant" environment -- `Project draft release `_ -- `Task follow-up `_ -- `FAQ `_ -- `meeting & minutes page] `_ <- this page needs to be moved and renamed - -Pharos project - Key facts ---------------------------- - -- Project Creation Date: January 8, 2015 -- Project Category: Integration & Testing -- Lifecycle State: Incubation -- Primary Contact: Trevor -- Project Lead: Trevor -- Jira Project Name: Testbed infrastructure Project -- Jira Project Prefix: PHAROS -- Committers: - - - Trevor Cooper - - Fu Qiao - - Sheng-ann Yu - - Wenjing Chu - - Chris Donley - - Morgan Richomme - - Erica Johnson - - Hui Deng - - Prabu Kuppuswamy - - Sean Chen - - Saikrishna M Kotha - - Eugene Yu - -- Contributors: - - - Iben Rodriguez - - -- IRC : freenode.net #opnfv-pharos `http://webchat.freenode.net/?channels=opnfv-pharos `_ -- Mailing List : no dedicated mailing list - use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for easier filtering -- Meetings : - - - `meetings `_ - -- Repository: pharos - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ - - -- cgit 1.2.3-korg