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 +++++++ 4 files changed, 178 insertions(+), 88 deletions(-) create mode 100644 docs/configguide/jumpserverinstall.rst create mode 100644 docs/configguide/pharosconfig.rst (limited to 'docs/configguide') 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 -- cgit 1.2.3-korg