From c8f8facec439fbc4fced0854845070caf9db38a5 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 23 Feb 2016 23:12:24 -0800 Subject: Removed index files from all doc directories, rearranged headings, fixed broken links and doc formatting issues, created platform overview file, edited content. Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper --- docs/configguide/configguide.rst | 77 ++++---- docs/configguide/jumpserverinstall.rst | 87 +++++++++ docs/configguide/lab_update_guide.rst | 85 +++++---- docs/configguide/pharosconfig.rst | 17 ++ docs/how-to-use-docs/documentation-example.rst | 12 +- docs/how-to-use-docs/index.rst | 4 - docs/index.rst | 13 +- docs/information/index.rst | 13 -- docs/information/pharos.rst | 59 ++---- docs/jumpserver_install.rst | 81 -------- docs/lab-description/index.rst | 18 -- docs/lab-description/inventory.rst | 13 +- docs/lab-description/lab_description.rst | 49 ++--- docs/lab-description/pod_description.rst | 25 +-- docs/lab-description/templates.rst | 26 +++ docs/labs/Dell.rst | 4 +- docs/labs/ZTE.rst | 5 - docs/labs/huawei-us-lab/huawei-us-lab.rst | 9 +- docs/labs/huawei-us-lab/index.rst | 19 -- docs/labs/spirent.rst | 2 +- docs/pharos-spec.rst | 248 ------------------------- docs/platformoverview/labinfrastructure.rst | 20 ++ docs/specification/hardwarespec.rst | 3 +- docs/specification/index.rst | 20 -- docs/specification/jumpserverinstall.rst | 83 --------- docs/specification/networkconfig.rst | 71 +++---- docs/specification/pharosspec.rst | 18 ++ docs/specification/remoteaccess.rst | 78 ++++---- info.rst | 28 --- 29 files changed, 381 insertions(+), 806 deletions(-) create mode 100644 docs/configguide/jumpserverinstall.rst create mode 100644 docs/configguide/pharosconfig.rst delete mode 100644 docs/information/index.rst delete mode 100644 docs/jumpserver_install.rst delete mode 100644 docs/lab-description/index.rst create mode 100644 docs/lab-description/templates.rst delete mode 100644 docs/labs/huawei-us-lab/index.rst delete mode 100644 docs/pharos-spec.rst create mode 100644 docs/platformoverview/labinfrastructure.rst delete mode 100644 docs/specification/index.rst delete mode 100644 docs/specification/jumpserverinstall.rst create mode 100644 docs/specification/pharosspec.rst delete mode 100644 info.rst diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst index d4e4abb4..59715906 100644 --- a/docs/configguide/configguide.rst +++ b/docs/configguide/configguide.rst @@ -2,64 +2,51 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. +*************** +Lab Setup Guide +*************** -============================== -Pharos Lab Configuration Guide -============================== +Provides an overview for setting up a Pharos lab. A full set of +:ref:`pharos_master` documents are maintained in the *pharos* repo. -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. +Contributing to the Pharos Community +------------------------------------ -Overview of Community Lab Expectations --------------------------------------- +The development, test and production activities rely on Pharos resources and support from the Pharos community. Lab +owners and Pharos project committers/contributors will evolve the vision for Pharos as well as expand lab capabilities +that are needed to help OPNFV be highly successful. -* 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: +* Jira is used to track Pharos activities including lab operations +* PODs are connected to Jenkins and generally available 24/7 other than scheduled maintenance and troubleshooting +* Lab resources are declared as either for *Development (bare-metal or virtual)*, *Production latest (bare-metal)* or *Production stable (bare-metal)* - * Development (bare-metal or virtual) - * Production - latest (bare-metal) - * Production - stable (bare-metal) +Declaring a Pharos Lab +---------------------- -On-boarding Steps ------------------ +* Provide the Pharos community with details of the intended setup, including ... -* Provide Pharos community with details of intended setup, including ... + * Overview of resources are being offered to the community, intended purpose and known limitations + * Lab owner name with contacts + * Timelines for availablity for development, test, release production, ... - * Resources being offered - * Lab owner name / contacts - * Timelines for availablity for development and use in upcomming releases +* Update the Pharos Wiki with lab details -* Update Pharos Wiki - * Lab with location, owner + * Lab map, organization, contacts, status, location, resources, role, etc. + * https://wiki.opnfv.org/pharos#community_labs + * :ref:`pharos_wiki` -* Create and fill *New Lab* Wiki pages +* Update the Pharos project information file "Current Labs" - * 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 -------------------- + * :ref:`pharos_information` -* jumpserverinstall.rst - -Lab Documentation ------------------ - -* Pharos Wiki page -* Map Info +* Create new Wiki pages for lab and POD specific information + * Access procedures + * Usage guidelines for developers + * Update infomtation as PODs are re-assigned or usage/availability changes +* Fill Lab and POD templates ... :ref:`pharos_lab` ... :ref:`pharos_pod` -Revision: _sha1_ + * Note that security sensitive lab information should be stored in the secure Pharos repo -Build date: |today| +* Connect PODs to Jenkins/CI diff --git a/docs/configguide/jumpserverinstall.rst b/docs/configguide/jumpserverinstall.rst new file mode 100644 index 00000000..19a659a2 --- /dev/null +++ b/docs/configguide/jumpserverinstall.rst @@ -0,0 +1,87 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +Jump Server Configuration +------------------------- + +Jump server install procedures are maintained by each installer project. Addional Jump server +configuraton BKMs will be maintained here. The below install information was used for Fuel however +may be outdated (please refer to Fuel Installer documents). + +**Procedure** + +1. Obtain CentOS 7 Minimal ISO and install + + ``wget http://mirrors.kernel.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1503-01.iso`` + +2. Set parameters appropriate for your environment during installation + +3. Disable NetworkManager + + ``systemctl disable NetworkManager`` + +4. Configure your /etc/sysconfig/network-scripts/ifcfg-* files for your network + +5. Restart networking + + ``service network restart`` + +6. Edit /etc/resolv.conf and add a nameserver + + ``vi /etc/resolv.conf`` + +7. Install libvirt & kvm + + ``yum -y update`` + ``yum -y install kvm qemu-kvm libvirt`` + ``systemctl enable libvirtd`` + +8. Reboot: + + ``shutdown -r now`` + +9. If you wish to avoid annoying delay when use ssh to log in, disable DNS lookups: + + ``vi /etc/ssh/sshd_config`` + + Uncomment "UseDNS yes", change 'yes' to 'no'. + + Save + +10. Restart sshd + + ``systemctl restart sshd`` + +11. Install virt-install + + ``yum -y install virt-install`` + +12. Visit artifacts.opnfv.org and D/L the OPNFV Fuel ISO + +13. Create a bridge using the interface on the PXE network, for example: br0 + +14. Make a directory owned by qemu: + + ``mkdir /home/qemu; mkdir -p /home/qemu/VMs/fuel-6.0/disk`` + + ``chown -R qemu:qemu /home/qemu`` + +15. Copy the ISO to /home/qemu + + ``cd /home/qemu`` + + ``virt-install -n opnfv-2015-05-22_18-34-07-fuel -r 4096 --vcpus=4 + --cpuset=0-3 -c opnfv-2015-05-22_18-34-07.iso --os-type=linux + --os-variant=rhel6 --boot hd,cdrom --disk + path=/home/qemu/VMs/mirantis-fuel-6.0/disk/fuel-vhd0.qcow2,bus=virtio,size=50,format=qcow2 + -w bridge=br0,model=virtio --graphics vnc,listen=0.0.0.0`` + +16. Temporarily flush the firewall rules to make things easier: + + ``iptables -F`` + +17. Connect to the console of the installing VM with your favorite VNC client. + +18. Change the IP settings to match the pod, use an IP in the PXE/Admin network for the Fuel Master diff --git a/docs/configguide/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst index ba201ec5..3f90d5cc 100644 --- a/docs/configguide/lab_update_guide.rst +++ b/docs/configguide/lab_update_guide.rst @@ -3,49 +3,46 @@ .. (c) 2016 OPNFV. -======================================== -How to update community lab info on wiki -======================================== +.. _pharos_wiki: +************************* +Updating Pharos Documents +************************* -Details about Hosted Community OPNFV Test Labs are located in 3 different places: +Details about each Community Lab is found in 3 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 + - Summary of lab including location, contacts, status, etc. on the `Pharos Project Wiki page `_ + - Lab specific details are provided with dedicated Wiki pages, see this `Example Lab `_ + - Pharos repo docs ... + - docs/information/pharos.rst ... project information file + - docs/labs/ ... Lab documents (includes lab specific capabilities, usages and policies; POD information) + - docs/labs/images/ ... Lab and POD toplogies -How to update the Start Page ------------------------------ +Update Pharos repo +------------------ -* Clone the Pharos Git repository and make the changes:: +Clone the Pharos Git repository - git clone ssh://@gerrit.opnfv.org:29418/pharos + * Make the changes to Pharos project information file (docs/information/pharos.rst) + * After code gets merged http://artifacts.opnfv.org/pharos/docs/information/pharos.html will contain your change - vi docs/pharos.rst - # use the below guide for MAP - git add docs/pharos.rst +Update Pharos Wiki +------------------ - git commit --signoff - # use the proper commit message & include JIRA id +Edit Wiki page - 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 + * https://wiki.opnfv.org/pharos + * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/information/pharos.html}} + * Click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save" (Wiki does not auto update content) - # 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 -* 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 +Update the map info on the Pharos Project Page https://wiki.opnfv.org/pharos?&#community_labs + * You will see a section of code as shown below. Add your lab infomation to the list with a comma separated list as follows: -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 @@ -56,22 +53,24 @@ How to update the map info on the Pharos Project Page * ''\\'' <-- for a new line * external link: <-- optional +.. MAP Code Example (see Wiki page for current version):: + 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 \\ + + 45.52,-122.67,60,.8,marker-red.png,Linux Foundation;Portland, Oregon \\ external link: [[http://www.test.com|test.com]] + 39.7392,-104.9902,60,.8,marker-red.png,Cable Labs;Denver, CA \\ external link: [[http://www.test.com|test.com]] + 37.333685,-121.891272,60,.6,marker-green.png,[[pharos/spirentvctlab|Spirent VCT Lab]] \\ San Jose, California + 39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing, China \\ external link: [[http://www.test.com|test.com]] + 37.413137,-121.977975,-180,.6,marker-red.png,Dell Labs;Santa Clara, California \\ link: [[https://wiki.opnfv.org/dell_hosting]] + 59.41,17.95,60,.8,marker-red.png,Enea Pharos Lab;Kista, Sweden \\ external link: [[http://www.enea.com/pharos-lab|ENEA pharos lab]] + 45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal, Canada \\ external link: [[http://www.test.com|test.com]] + 34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an, China \\ external link: [[http://www.test.com|test.com]] + 37.373424,-121.964913,60,.8,marker-green.png, Huawei Labs;Santa Clara, USA \\ external link: [[http://www.test.com|test.com]] + 45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro, Oregon \\ link: [[https://wiki.opnfv.org/get_started/intel_hosting|intel_hosting]] + 48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion, France \\ external link: [[http://www.test.com|test.com]] + 48.825786,2.274797,-60,.8,marker-gold.png,Orange Labs;Paris, France \\ external link: [[http://www.test.com|test.com]] + 31.97,118.79,60,.8,marker-red.png,ZTE Labs;Nan Jing, China \\ link:[[zte-nj-testlab|ZTE, Nan Jing]] [[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting** - - -**Documentation tracking** - -Revision: _sha1_ - -Build date: _date_ diff --git a/docs/configguide/pharosconfig.rst b/docs/configguide/pharosconfig.rst new file mode 100644 index 00000000..1f8c166d --- /dev/null +++ b/docs/configguide/pharosconfig.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. Top level of Pharos configuration documents. + +******************** +Pharos Configuration +******************** + +Pharos configuration documents provide information on how to setup hardware and networks in a Pharos compliant lab + +.. toctree:: + + ./configguide.rst + ./lab_update_guide.rst + ./jumpserverinstall.rst diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index 1d1ca6d8..54819dc5 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -4,9 +4,12 @@ :width: 200 :alt: OPNFV :align: left + .. these two pipes are to seperate the logo from the first title + | | + How to create documentation for your OPNFV project ================================================== @@ -44,10 +47,6 @@ This index file must refence your other rst files. * :ref:`search` - Revision: _sha1_ - - Build date: |today| - The Sphinx Build ================ @@ -55,6 +54,7 @@ The Sphinx Build When you push documentation changes to gerrit a jenkins job will create html documentation. * Verify Jobs + For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result. * Merge jobs @@ -80,7 +80,3 @@ links are easy to add: Here is a link to sphinx, the tool that we are using to g Leave these at the bottom of each of your documents they are used internally - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst index 36710b32..2fea43e0 100644 --- a/docs/how-to-use-docs/index.rst +++ b/docs/how-to-use-docs/index.rst @@ -24,7 +24,3 @@ Indices and tables ================== * :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/index.rst b/docs/index.rst index e29854be..56a58dc1 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,6 +4,8 @@ .. OPNFV Pharos Documentation master file. +.. _pharos_master: + ====== PHAROS ====== @@ -15,15 +17,12 @@ OPNFV Community Lab Infrastructure :maxdepth: 3 :numbered: 3 - ./information/index.rst - ./specification/index.rst - ./lab-description/index.rst - ./configguide/configguide.rst + ./information/pharos.rst + ./specification/pharosspec.rst + ./lab-description/templates.rst + ./configguide/pharosconfig.rst Indices ======= * :ref:`search` -Revision: _sha1_ - -Build date: |today| diff --git a/docs/information/index.rst b/docs/information/index.rst deleted file mode 100644 index b59211ca..00000000 --- a/docs/information/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) 2016 OPNFV. - -.. toctree:: - :maxdepth: 2 - :numbered: 2 - - ./pharos.rst - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst index be6f9b82..c55dd4ed 100644 --- a/docs/information/pharos.rst +++ b/docs/information/pharos.rst @@ -4,12 +4,14 @@ .. OPNFV Pharos Project Information file. -========================== +.. _pharos_information: + +************************** 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 @@ -34,7 +36,7 @@ Future lab capabilities are currently focussed on 1) Deployment automation 2) Da * `Pharos Planning `_ Project Communication -===================== +--------------------- * `Jira `_ * `Weekly Pharos meeting `_ @@ -43,21 +45,21 @@ Project Communication * Mailing List: use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for filtering Project Release Artifacts -========================= +------------------------- * 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 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 Current Labs -============ +------------ An interactive map of OPNFV lab locations, lab owners and other lab information is maintained on the `Pharos Wiki `_ @@ -105,44 +107,9 @@ An interactive map of OPNFV lab locations, lab owners and other lab information 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 -- Project Category: Integration & Testing -- Lifecycle State: Mature -- Primary Contact: Trevor -- Project Lead: Trevor -- Jira Project Name: Testbed infrastructure Project -- Jira Project Prefix: PHAROS -- Mailing list tag: [pharos] -- IRC: Server:freenode.net Channel:#opnfv-pharos -- Repository: 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 - +------------------------ -Revision: _sha1_ +**Key Project Facts are maintained in the Pharos INFO file in the project repo** -Build date: |today| + * Can be viewed on the project Wiki `INFO `_ + * Project key facts in repo: pharos/INFO diff --git a/docs/jumpserver_install.rst b/docs/jumpserver_install.rst deleted file mode 100644 index 731eb490..00000000 --- a/docs/jumpserver_install.rst +++ /dev/null @@ -1,81 +0,0 @@ -**Jump Server Configuration:** - -(Rough Placeholder, edit me) - -**Fuel** - -1. Obtain CentOS 7 Minimal ISO and install - - ``wget http://mirrors.kernel.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1503-01.iso`` - -2. Set parameters appropriate for your environment during installation - -3. Disable NetworkManager - - ``systemctl disable NetworkManager`` - -4. Configure your /etc/sysconfig/network-scripts/ifcfg-* files for your network - -5. Restart networking - - ``service network restart`` - -6. Edit /etc/resolv.conf and add a nameserver - - ``vi /etc/resolv.conf`` - -7. Install libvirt & kvm - - ``yum -y update`` - ``yum -y install kvm qemu-kvm libvirt`` - ``systemctl enable libvirtd`` - -8. Reboot: - - ``shutdown -r now`` - -9. If you wish to avoid annoying delay when use ssh to log in, disable DNS lookups: - - ``vi /etc/ssh/sshd_config`` - - Uncomment "UseDNS yes", change 'yes' to 'no'. - - Save - -10. Restart sshd - - ``systemctl restart sshd`` - -11. Install virt-install - - ``yum -y install virt-install`` - -12. Visit artifacts.opnfv.org and D/L the OPNFV Fuel ISO - -13. Create a bridge using the interface on the PXE network, for example: br0 - -14. Make a directory owned by qemu: - - ``mkdir /home/qemu; mkdir -p /home/qemu/VMs/fuel-6.0/disk`` - - ``chown -R qemu:qemu /home/qemu`` - -15. Copy the ISO to /home/qemu - - ``cd /home/qemu`` - - ``virt-install -n opnfv-2015-05-22_18-34-07-fuel -r 4096 --vcpus=4 --cpuset=0-3 -c opnfv-2015-05-22_18-34-07.iso - --os-type=linux --os-variant=rhel6 --boot hd,cdrom --disk path=/home/qemu/VMs/mirantis-fuel-6.0/disk/fuel- - vhd0.qcow2,bus=virtio,size=50,format=qcow2 -w bridge=br0,model=virtio --graphics vnc,listen=0.0.0.0`` - -16. Temporarily flush the firewall rules to make things easier: - - ``iptables -F`` - -17. Connect to the console of the installing VM with your favorite VNC client. - -18. Change the IP settings to match the pod, use an IP in the PXE/Admin network for the Fuel Master - -**Foreman** - -TBA diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst deleted file mode 100644 index 0184b026..00000000 --- a/docs/lab-description/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) 2016 OPNFV. - -**************************************** -Pharos Templates and Configuration Files -**************************************** - -.. toctree:: - :maxdepth: 2 - - ./lab_description.rst - ./pod_description.rst - ./inventory.rst - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/lab-description/inventory.rst b/docs/lab-description/inventory.rst index e3f3e05f..db1ea541 100644 --- a/docs/lab-description/inventory.rst +++ b/docs/lab-description/inventory.rst @@ -2,13 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. -========================= -Pharos POD Inventory File -========================= +****************** +POD Inventory File +****************** -Introduction ------------- - -The Common Inventory File provides for a machine reabable format to input into every installer. For convenience the +The Common Inventory File provides a template for machine reabable 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 +https://gerrit.opnfv.org/gerrit/#/c/4079. diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst index 5b52baf0..da84aa11 100644 --- a/docs/lab-description/lab_description.rst +++ b/docs/lab-description/lab_description.rst @@ -2,10 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. +.. _pharos_lab: -=============================== -Pharos Lab Description Template -=============================== +************************** +Lab Specification Template +************************** Introduction ------------ @@ -14,44 +15,48 @@ Add an summary of what your lab hosts, its focus areas and purpose Lab Resources -============= +------------- +----------------+----------------+----------------+----------------+----------------+----------------+----------------+ -| Resource | Project(s) | Project Lead | Email(s) | POD Role* | Status** | Notes | +| POD Name | Project(s) | Project Lead(s)| Email(s) | POD Role | Status | Notes | +----------------+----------------+----------------+----------------+----------------+----------------+----------------+ -| POD1 | example | John Doe | john@intel.com | CI: stable | Active | | +| POD1 | project name | John Doe | john@abc.com | CI: stable | Active | | +----------------+----------------+----------------+----------------+----------------+----------------+----------------+ -* POD Role: CI stable, CI latest, Dev/test, Stand-alone, ... -** Status: Assigned, Configuration in progress, Active, Troubleshooting, Can be re-purposed, ... +* **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description. +* **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ... +* **Status:** Assigned, Configuring, Active, Troubleshooting, Available, ... -Code of Conduct -=============== +Acceptable Usage Policy +----------------------- -Define your lab's policies and expectations here +Define lab user policies and expectations Remote Access Infrastructure -============================ +---------------------------- -Describe your lab remote access setup (type of access (VPN?), link speed, any restrictions, etc.) +Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.) -Remote Access Process -===================== +Remote Access Procedure +----------------------- -Define your lab's process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.) +Define lab process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.) -Documentation -============= +Lab Documentation +----------------- -List your lab specific documents here +List lab specific documents here Lab Topology -============ +------------ + +Provide a diagram showing the network topology of lab including lights-out network. Any security sensitive details should +not be exposed publically. The following diagram is an example only. -.. image:: images/_.png|.jpg - :alt: Name of the diagram +.. image:: ./images/lab_topology_example.jpg + :alt: Lab diagram not found diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst index c44f1162..b63097d6 100644 --- a/docs/lab-description/pod_description.rst +++ b/docs/lab-description/pod_description.rst @@ -2,10 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. +.. _pharos_pod: -=================================== -Pharos Lab POD description Template -=================================== +************************** +POD Specification Template +************************** Introduction ------------ @@ -20,11 +21,10 @@ Describe any addional POD requirements beyond a standard Pharos compliant POD e. shared usage, ... -Systems -------- +Server Specifications +--------------------- -Jump Host -^^^^^^^^^ +**Jump Host** +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ | | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | @@ -41,8 +41,8 @@ Jump Host +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -Nodes -^^^^^ +**Compute Nodes** + +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ | | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | @@ -92,5 +92,8 @@ Firewall Rules POD Topology ------------ -.. image:: images/_.png|.jpg - :alt: Name of the diagram +Provide a diagram showing the network topology of the POD. Any security sensitive details should +not be exposed publically and can be stored in the secure Pharos repo. The following diagram is an example only. + +.. image:: ./images/pod_topology_example.png + :alt: POD diagram not found diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst new file mode 100644 index 00000000..f845457d --- /dev/null +++ b/docs/lab-description/templates.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. Top level of Pharos templates and configuration files + +**************************************** +Pharos Templates and Configuration Files +**************************************** + +Lab and POD templates are provided to help lab owners document capabilities, configurations and network topologies. +Compute, network and storage specifications with network topology details are required to help developers use lab +resources efficiently while minimizing support needs. This also greatly assists with troubleshhoting. It is the +responsibility of the lab owner to keep individual lab documents updated and determine appropriate level of detail +that is exposed publically through the Wiki or maintained in a secure Pharos repo with controlled access. + +While human readable configuration files are needed, the goal is for full automation of deployments. This requires +a common machine readable format for POD configurations as input to every installer. This is the "POD inventory" +common format file. + + +.. toctree:: + + ./lab_description.rst + ./pod_description.rst + ./inventory.rst diff --git a/docs/labs/Dell.rst b/docs/labs/Dell.rst index a427edbd..da934795 100644 --- a/docs/labs/Dell.rst +++ b/docs/labs/Dell.rst @@ -355,9 +355,9 @@ POD2 JumpServer User: opnfv Passwd: d3ll1234 -======= +================== Dell OPNFV Testlab -================================================== +================== Overview ------------------ diff --git a/docs/labs/ZTE.rst b/docs/labs/ZTE.rst index 809baf27..b6b04572 100644 --- a/docs/labs/ZTE.rst +++ b/docs/labs/ZTE.rst @@ -173,11 +173,6 @@ The Jump servers in the Testlab are pre-provisioned with the following software: Networks ---------- -**POD-Fuel Diagram** - -.. image:: images/ZTE_POD.jpg - :alt: ZTE POD Networking - **Subnet allocations** +-------------------+----------------+-------------------+---------------+----------+ diff --git a/docs/labs/huawei-us-lab/huawei-us-lab.rst b/docs/labs/huawei-us-lab/huawei-us-lab.rst index 48b34ba7..13bb8e56 100644 --- a/docs/labs/huawei-us-lab/huawei-us-lab.rst +++ b/docs/labs/huawei-us-lab/huawei-us-lab.rst @@ -1,5 +1,6 @@ -Introduction -============ +=================================================== +Introduction of Huawei's lab located in Santa Clara +=================================================== Huawei's lab located in Santa Clara, CA will provide 1 full POD for baremetal deployment environment, 2 standalone server for virtual deployment, and 1 server with 6 executors for project's building and gate-testing. @@ -53,10 +54,6 @@ Below you'll find a topological view of the hosting set-up: Figure 2: Full Pod network configuration - -How to use our resources? -========================= - Build Resource ^^^^^^^^^^^^^^ diff --git a/docs/labs/huawei-us-lab/index.rst b/docs/labs/huawei-us-lab/index.rst deleted file mode 100644 index 34549b95..00000000 --- a/docs/labs/huawei-us-lab/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -Introduction of Huawei's lab located in Santa Clara -=================================================== - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 8 - - documentation-example.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/labs/spirent.rst b/docs/labs/spirent.rst index d5804ac6..b0ba0ba9 100644 --- a/docs/labs/spirent.rst +++ b/docs/labs/spirent.rst @@ -36,4 +36,4 @@ For example: * SSL and IPSec VPN will typically be leveraged to connect networks across the untrusted Internet or other third party networks. * Stand-alone DUT servers using STCv and AVv traffic generators could easily scale to hundreds of servers as needed. -.. image:: iamges/spirent_vptc-public-drawing.png +.. image:: images/spirent_vptc-public-drawing.png diff --git a/docs/pharos-spec.rst b/docs/pharos-spec.rst deleted file mode 100644 index c4d8d7f7..00000000 --- a/docs/pharos-spec.rst +++ /dev/null @@ -1,248 +0,0 @@ -Pharos Specification -===================== - -.. contents:: Table of Contents - :backlinks: none - -Objectives / Scope -------------------- - -The Pharos specification defines the OPNFV hardware environment upon which the OPNFV Arno -platform release can be deployed on and tested. This specification defines: - -- A secure, scalable, standard and HA environment -- Supports the full Arno deployment lifecycle (this requires a bare metal environment) -- Supports functional and performance testing of the Arno release -- Provides mechanisms and procedures for secure remote access to the test environment - -Deploying Arno in a Virtualized environment is possible and will be useful, however it does not -provide a fully featured deployment and test environment for the Arno release of OPNFV. - -The high level architecture is outlined in the following diagram: - -.. image:: images/pharos-archi1.jpg - -A Pharos compliant OPNFV test-bed environment provides ------------------------------------------------------- - -- One CentOS 7 jump server on which the virtualized Openstack/OPNFV installer runs -- In the Arno release you may select a deployment toolchain to deploy from the jump server from the Foreman and Fuel ISO images. -- 5 compute / controller nodes (`BGS `_ requires 5 nodes) -- A configured network topology allowing for LOM, Admin, Public, Private, and Storage Networks -- Remote access as defined by the Jenkins slave configuration guide http://artifacts.opnfv.org/arno.2015.1.0/docs/opnfv-jenkins-slave-connection.arno.2015.1.0.pdf - -Hardware requirements ---------------------- - -**Servers** - -CPU: - -* Intel Xeon E5-2600v2 Series (Ivy Bridge and newer, or similar) - -Local Storage Configuration: - -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. - -* 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 -* Virtual ISO boot capabilities or a separate PXE boot server (DHCP/tftp or Cobbler) - -Memory: - -* 32G RAM Minimum - -Power Supply Single - -* Single power supply acceptable (redundant power not required/nice to have) - -Provisioning the jump server ----------------------------- - -1. Obtain CentOS 7 Minimal ISO and install - - ``wget http://mirrors.kernel.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1503-01.iso`` - -2. Set parameters appropriate for your environment during installation - -3. Disable NetworkManager - - ``systemctl disable NetworkManager`` - -4. Configure your /etc/sysconfig/network-scripts/ifcfg-* files for your network - -5. Restart networking - - ``service network restart`` - -6. Edit /etc/resolv.conf and add a nameserver - - ``vi /etc/resolv.conf`` - -7. Install libvirt & kvm - - ``yum -y update`` - ``yum -y install kvm qemu-kvm libvirt`` - ``systemctl enable libvirtd`` - -8. Reboot: - - ``shutdown -r now`` - -9. If you wish to avoid annoying delay when use ssh to log in, disable DNS lookups: - - ``vi /etc/ssh/sshd_config`` - Uncomment "UseDNS yes", change 'yes' to 'no'. - Save - -10. Restart sshd - - ``systemctl restart sshd`` - -11. Install virt-install - - ``yum -y install virt-install`` - -12. Begin the installation of the Arno release - - Download your preferred ISO from the `OPNFV dowloads page `_ - and follow the associated installation instructions. - -Remote management ------------------- - -Remote access -^^^^^^^^^^^^^ - -- Remote access is required for … - - 1. Developers to access deploy/test environments (credentials to be issued per POD / user) - 2. Connection of each environment to Jenkins master hosted by Linux Foundation for automated deployment and test - -- OpenVPN is generally used for remote however community hosted labs may vary due to company security rules -- POD access rules / restrictions … - - - Refer to individual test-bed as each company may have different access rules and acceptable usage policies - -- Basic requirement is for SSH sessions to be established (initially on jump server) -- Majority of packages installed on a system (tools or applications) will be pulled from an external repo so this scenario must be accomodated. - -Firewall rules should include - -- SSH sessions -- Jenkins sessions - -Lights-out Management: - -- Out-of-band management for power on/off/reset and bare-metal provisioning -- Access to server is through lights-out-management tool and/or a serial console -- Intel lights-out ⇒ RMM http://www.intel.com/content/www/us/en/server-management/intel-remote-management-module.html -- HP lights-out ⇒ ILO http://www8.hp.com/us/en/products/servers/ilo/index.html -- CISCO lights-out ⇒ UCS https://developer.cisco.com/site/ucs-dev-center/index.gsp -- Dell lights-out ⇒ IDRAC http://en.community.dell.com/techcenter/systems-management/w/wiki/3204.dell-remote-access-controller-drac-idrac - -Linux Foundation - VPN service for accessing Lights-Out Management (LOM) infrastructure for the UCS-M hardware - -- People with admin access to LF infrastructure: - -1. amaged@cisco.com -2. cogibbs@cisco.com -3. daniel.smith@ericsson.com -4. dradez@redhat.com -5. fatih.degirmenci@ericsson.com -6. fbrockne@cisco.com -7. jonas.bjurel@ericsson.com -8. jose.lausuch@ericsson.com -9. joseph.gasparakis@intel.com -10. morgan.richomme@orange.com -11. pbandzi@cisco.com -12. phladky@cisco.com -13. stefan.k.berg@ericsson.com -14. szilard.cserey@ericsson.com -15. trozet@redhat.com - -The people who require VPN access must have a valid PGP key bearing a valid signature from one of -these three people. When issuing OpenVPN credentials, LF will be sending TLS certificates and -2-factor authentication tokens, encrypted to each recipient's PGP key. - -Networking ------------ - -Test-bed network -^^^^^^^^^^^^^^^^ - -* 24 or 48 Port TOR Switch -* NICS - 1GE, 10GE - per server can be on-board or PCI-e -* Connectivity for each data/control network is through a separate NIC. This simplifies Switch Management however requires more NICs on the server and also more switch ports -* Lights-out network can share with Admin/Management - -Network Interfaces -^^^^^^^^^^^^^^^^^^ - -* Option I: 4x1G Control, 2x40G Data, 48 Port Switch - - * 1 x 1G for ILMI (Lights out Management) - * 1 x 1G for Admin/PXE boot - * 1 x 1G for control Plane connectivity - * 1 x 1G for storage - * 2 x 40G (or 10G) for data network (redundancy, NIC bonding, High bandwidth testing) - -* Option II: 1x1G Control, 2x 40G (or 10G) Data, 24 Port Switch - - * Connectivity to networks is through VLANs on the Control NIC. Data NIC used for VNF traffic and storage traffic segmented through VLANs - -* Option III: 2x1G Control, 2x10G Data, 2x40G Storage, 24 Port Switch - - * Data NIC used for VNF traffic, storage NIC used for control plane and Storage segmented through VLANs (separate host traffic from VNF) - * 1 x 1G for IPMI - * 1 x 1G for Admin/PXE boot - * 2 x 10G for control plane connectivity/Storage - * 2 x 40G (or 10G) for data network - -Documented configuration to include: -- Subnet, VLANs (may be constrained by existing lab setups or rules) -- IPs -- Types of NW - lights-out, public, private, admin, storage -- May be special NW requirements for performance related projects -- Default gateways - -Controller node bridge topology overview - -.. image:: images/bridge1.png - -compute node bridge topology overview - -.. image:: images/bridge2.png - - -Architecture -------------- - -Network Diagram -^^^^^^^^^^^^^^^ - -The Pharos architecture may be described as follow: Figure 1: Standard Deployment Environment - -.. image:: images/opnfv-pharos-diagram-v01.jpg - -Figure 1: Standard Deployment Environment - - -Sample Network Drawings ------------------------ - -Files for documenting lab network layout. These were contributed as Visio VSDX format compressed -as a ZIP file. Here is a sample of what the visio looks like. - -Download the visio zip file here: -`opnfv-example-lab-diagram.vsdx.zip `_ - -.. image:: images/opnfv-example-lab-diagram.png - -:Authors: Trevor Cooper (Intel) -:Version: 1.0 diff --git a/docs/platformoverview/labinfrastructure.rst b/docs/platformoverview/labinfrastructure.rst new file mode 100644 index 00000000..d1892408 --- /dev/null +++ b/docs/platformoverview/labinfrastructure.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. Overview of OPNFV lab infrastructure (Pharos). + +************************ +OPNFV Lab Infrastructure +************************ + +The `Pharos Project `_ provides a lab infrastructure that is geographically +and technically diverse. Labs instantiate **bare-metal** and **virtual** environments that are accessed remotely by the +community and used for OPNFV platform and feature development, builds, deploys and testing. This will greatly assist +in developing a highly robust and stable OPNFV platform with well understood performance characteristics. Community +labs are hosted by OPNFV member companies on a voluntary basis. The Linux Foundation also hosts an OPNFV lab that +provides centralised CI and other production resources which are linked to community labs. + +Future lab capabilities will include the ability easily automate deploy and test of any OPNFV install scenario in any +lab environemnt as well as a *Virtual Lab* for developer on-boarding with minimal effort. :ref:`pharos_master` documents +are included with this release. diff --git a/docs/specification/hardwarespec.rst b/docs/specification/hardwarespec.rst index a214be44..a66e68f3 100644 --- a/docs/specification/hardwarespec.rst +++ b/docs/specification/hardwarespec.rst @@ -1,4 +1,4 @@ -. 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. @@ -13,6 +13,7 @@ A pharos compliant OPNFV test-bed provides: - 5 compute / controller nodes (`BGS `_ requires 5 nodes) - A configured network topology allowing for LOM, Admin, Public, Private, and Storage Networks - 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 **Servers** diff --git a/docs/specification/index.rst b/docs/specification/index.rst deleted file mode 100644 index a583087f..00000000 --- a/docs/specification/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) 2016 OPNFV. - -==================== -Pharos Specification -==================== - -.. toctree:: - :maxdepth: 2 - - ./objectives.rst - ./hardwarespec.rst - ./networkconfig.rst - ./jumpserverinstall.rst - ./remoteaccess.rst - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/specification/jumpserverinstall.rst b/docs/specification/jumpserverinstall.rst deleted file mode 100644 index 8400c2ab..00000000 --- a/docs/specification/jumpserverinstall.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) 2016 OPNFV. - - -Jump Server Configuration -------------------------- - -**Fuel** - -1. Obtain CentOS 7 Minimal ISO and install - - ``wget http://mirrors.kernel.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1503-01.iso`` - -2. Set parameters appropriate for your environment during installation - -3. Disable NetworkManager - - ``systemctl disable NetworkManager`` - -4. Configure your /etc/sysconfig/network-scripts/ifcfg-* files for your network - -5. Restart networking - - ``service network restart`` - -6. Edit /etc/resolv.conf and add a nameserver - - ``vi /etc/resolv.conf`` - -7. Install libvirt & kvm - - ``yum -y update`` - ``yum -y install kvm qemu-kvm libvirt`` - ``systemctl enable libvirtd`` - -8. Reboot: - - ``shutdown -r now`` - -9. If you wish to avoid annoying delay when use ssh to log in, disable DNS lookups: - - ``vi /etc/ssh/sshd_config`` - - Uncomment "UseDNS yes", change 'yes' to 'no'. - - Save - -10. Restart sshd - - ``systemctl restart sshd`` - -11. Install virt-install - - ``yum -y install virt-install`` - -12. Visit artifacts.opnfv.org and D/L the OPNFV Fuel ISO - -13. Create a bridge using the interface on the PXE network, for example: br0 - -14. Make a directory owned by qemu: - - ``mkdir /home/qemu; mkdir -p /home/qemu/VMs/fuel-6.0/disk`` - - ``chown -R qemu:qemu /home/qemu`` - -15. Copy the ISO to /home/qemu - - ``cd /home/qemu`` - - ``virt-install -n opnfv-2015-05-22_18-34-07-fuel -r 4096 --vcpus=4 - --cpuset=0-3 -c opnfv-2015-05-22_18-34-07.iso --os-type=linux - --os-variant=rhel6 --boot hd,cdrom --disk - path=/home/qemu/VMs/mirantis-fuel-6.0/disk/fuel-vhd0.qcow2,bus=virtio,size=50,format=qcow2 - -w bridge=br0,model=virtio --graphics vnc,listen=0.0.0.0`` - -16. Temporarily flush the firewall rules to make things easier: - - ``iptables -F`` - -17. Connect to the console of the installing VM with your favorite VNC client. - -18. Change the IP settings to match the pod, use an IP in the PXE/Admin network for the Fuel Master diff --git a/docs/specification/networkconfig.rst b/docs/specification/networkconfig.rst index af09e564..94477fc7 100644 --- a/docs/specification/networkconfig.rst +++ b/docs/specification/networkconfig.rst @@ -6,70 +6,53 @@ Networking ---------- -Test-bed network +**Network Hardware** -* 24 or 48 Port TOR Switch -* NICS - 1GE, 10GE - per server can be on-board or PCI-e -* Connectivity for each data/control network is through a separate NIC. - *This simplifies Switch Management howeverrequires more NICs on the server and also more switch ports -* Lights-out network can share with Admin/Management + * 24 or 48 Port TOR Switch + * NICs - Combination of 1GE and 10GE based on network topology options (per server can be on-board or use PCI-e) + * Connectivity for each data/control network is through a separate NIC. This simplifies Switch Management however requires more NICs on the server and also more switch ports + * BMC (Baseboard Management Controller) for lights-out mangement network using IPMI (Intelligent Platform Management Interface) -Network Interfaces +**Network Options** -* Option I: 4x1G Control, 2x40G Data, 48 Port Switch + * Option I: 4x1G Control, 2x10G Data, 48 Port Switch - * 1 x 1G for ILMI (Lights out Management ) - * 1 x 1G for Admin/PXE boot - * 1 x 1G for control Plane connectivity - * 1 x 1G for storage - * 2 x 40G (or 10G) for data network (redundancy, NIC bonding, High bandwidth testing) + * 1 x 1G for lights-out Management + * 1 x 1G for Admin/PXE boot + * 1 x 1G for control-plane connectivity + * 1 x 1G for storage + * 2 x 10G for data network (redundancy, NIC bonding, High bandwidth testing) -* Option II: 1x1G Control, 2x 40G (or 10G) Data, 24 Port Switch + * Option II: 1x1G Control, 2x 10G Data, 24 Port Switch - * Connectivity to networks is through VLANs on the Control NIC. + * Connectivity to networks is through VLANs on the Control NIC * Data NIC used for VNF traffic and storage traffic segmented through VLANs -* Option III: 2x1G Control, 2x10G Data, 2x40G Storage, 24 Port Switch + * Option III: 2x1G Control, 2x10G Data, 2x10G Storage, 24 Port Switch - * Data NIC used for VNF traffic + * Data NIC used for VNF traffic * Storage NIC used for control plane and Storage segmented through VLANs (separate host traffic from VNF) - * 1 x 1G for IPMI - * 1 x 1G for Admin/PXE boot - * 2 x 10G for control plane connectivity/Storage - * 2 x 40G (or 10G) for data network + * 1 x 1G for lights-out mangement + * 1 x 1G for Admin/PXE boot + * 2 x 10G for control-plane connectivity/storage + * 2 x 10G for data network Documented configuration to include: -- Subnet, VLANs (may be constrained by existing lab setups or rules) -- IPs -- Types of NW - lights-out, public, private, admin, storage -- May be special NW requirements for performance related projects -- Default gateways -Controller node bridge topology overview + - Subnet, VLANs (may be constrained by existing lab setups or rules) + - IPs + - Types of NW - lights-out, public, private, admin, storage + - May be special NW requirements for performance related projects + - Default gateways -.. image:: ../images/bridge1.png - -compute node bridge topology overview +**Sample Network Drawings** .. image:: ../images/bridge2.png -**Network Diagram** - -The Pharos architecture may be described as follow: -Figure 1: Standard Deployment Environment - .. image:: ../images/opnfv-pharos-diagram-v01.jpg -Figure 1: Standard Deployment Environment - -**Sample Network Drawings** - -Files for documenting lab network layout. -These were contributed as Visio VSDX format compressed as a ZIP -file. Here is a sample of what the visio looks like. +.. image:: ../images/opnfv-example-lab-diagram.png Download the visio zip file here: `opnfv-example-lab-diagram.vsdx.zip `_ - -.. image:: ../images/opnfv-example-lab-diagram.png diff --git a/docs/specification/pharosspec.rst b/docs/specification/pharosspec.rst new file mode 100644 index 00000000..c3eb45a7 --- /dev/null +++ b/docs/specification/pharosspec.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. Top level of Pharos specification documents. + +******************** +Pharos Specification +******************** + +The Pharos Specification provides information on Pharos hardware and network requirements + +.. toctree:: + + ./objectives.rst + ./hardwarespec.rst + ./networkconfig.rst + ./remoteaccess.rst diff --git a/docs/specification/remoteaccess.rst b/docs/specification/remoteaccess.rst index cb0ad8e2..51950da4 100644 --- a/docs/specification/remoteaccess.rst +++ b/docs/specification/remoteaccess.rst @@ -3,61 +3,53 @@ .. (c) 2016 OPNFV. -Remote management +Remote Management ------------------ -**Remote access** +Remote access is required for … -- Remote access is required for … + * Developers to access deploy/test environments (credentials to be issued per POD / user) + * Connection of each environment to Jenkins master hosted by Linux Foundation for automated deployment and test - 1. Developers to access deploy/test environments (credentials to be issued per POD / user) - 2. Connection of each environment to Jenkins master hosted by Linux Foundation for automated deployment and test +OpenVPN is generally used for remote however community hosted labs may vary due to company security rules. For POD +access rules / restrictions refer to individual lab documentation as each company may have different access rules +and acceptable usage policies. -- OpenVPN is generally used for remote however community hosted labs may vary due to company security rules -- POD access rules / restrictions … +Basic requirements: - - Refer to individual test-bed as each company may have different access rules and acceptable usage policies + * SSH sessions to be established (initially on the jump server) + * Packages to be installed on a system (tools or applications) by pullig from an external repo. -- Basic requirement is for SSH sessions to be established (initially on jump server) -- Majority of packages installed on a system (tools or applications) will be pulled from an external repo. +Firewall rules accomodate: -Firewall rules should include + * SSH sessions + * Jenkins sessions -- SSH sessions -- Jenkins sessions +Lights-out management network requirements: -Lights-out Management: + * Out-of-band management for power on/off/reset and bare-metal provisioning + * Access to server is through a lights-out-management tool and/or a serial console + * Refer to applicable light-out mangement information from server manufacturer, such as ... -- Out-of-band management for power on/off/reset and bare-metal provisioning -- Access to server is through lights-out-management tool and/or a serial console -- Intel lights-out ⇒ RMM http://www.intel.com/content/www/us/en/server-management/intel-remote-management-module.html -- HP lights-out ⇒ ILO http://www8.hp.com/us/en/products/servers/ilo/index.html -- CISCO lights-out ⇒ UCS https://developer.cisco.com/site/ucs-dev-center/index.gsp + * Intel lights-out `RMM `_ + * HP lights-out `ILO `_ + * CISCO lights-out `UCS `_ -Linux Foundation - VPN service for accessing Lights-Out -Management (LOM) infrastructure for the UCS-M hardware +Linux Foundation Lab is a UCS-M hardware environment with controlled access *as needed* -- People with admin access to LF infrastructure: + * `Access rules and procedure `_ are maintained on the Wiki + * `A list of people `_ with access is maintained on the Wiki + * Send access requests to infra-steering@lists.opnfv.org with the following information ... -1. amaged@cisco.com -2. cogibbs@cisco.com -3. daniel.smith@ericsson.com -4. dradez@redhat.com -5. fatih.degirmenci@ericsson.com -6. fbrockne@cisco.com -7. jonas.bjurel@ericsson.com -8. jose.lausuch@ericsson.com -9. joseph.gasparakis@intel.com -10. morgan.richomme@orange.com -11. pbandzi@cisco.com -12. phladky@cisco.com -13. stefan.k.berg@ericsson.com -14. szilard.cserey@ericsson.com -15. trozet@redhat.com - -- The people who require VPN access must have a valid -PGP key bearing a valid signature from one of these -three people. When issuing OpenVPN credentials, LF -will be sending TLS certificates and 2-factor -authentication tokens, encrypted to each recipient's PGP key. + * Name: + * Company: + * Approved Project: + * Project role: + * Why is access needed: + * How long is access needed (either a specified time period or define "done"): + * What specific POD/machines will be accessed: + * What support is needed from LF admins and LF community support team: + * Once access is approved please follow instructions for setting up VPN access ... https://wiki.opnfv.org/get_started/lflab_hosting + * The people who require VPN access must have a valid PGP key bearing a valid signature from LF + * When issuing OpenVPN credentials, LF will be sending TLS certificates and 2-factor authentication tokens, encrypted to each recipient's PGP key diff --git a/info.rst b/info.rst deleted file mode 100644 index edf1a0fa..00000000 --- a/info.rst +++ /dev/null @@ -1,28 +0,0 @@ -Project: Testbed infrastructure (Pharos) -Project Creation Date: January 8, 2015 -Project Category: Integration & Testing -Lifecycle State: Mature -Primary Contact: Trevor Cooper (trevor.cooper@intel.com) -Project Lead: Trevor Cooper (trevor.cooper@intel.com) -Jira Project Name: Testbed infrastructure project -Jira Project Prefix: PHAROS -Mailing list tag: [pharos] -IRC: Server:freenode.net Channel:#opnfv-pharos -Repository: pharos - -Committers: -trevor.cooper@intel.com -fuqiao@chinamobile.com -sheng-ann.yu@ericsson.com -Wenjing_Chu@DELL.com -C.Donley@cablelabs.com -morgan.richomme@orange.com -erica.johnson@iol.unh.edu -denghui@chinamobile.com -prabu.kuppuswamy@spirent.com -s.chen@huawei.com -saikrishna.kotha@xilinx.com -yuyijun@huawei.com - -Link to TSC approval of the project: http://meetbot.opnfv.org/meetings/opnfv-meeting/ -Link(s) to approval of additional committers: -- cgit 1.2.3-korg