diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/configguide/configguide.rst | 15 | ||||
| -rw-r--r-- | docs/release/configguide/jumpserverinstall.rst | 4 | ||||
| -rw-r--r-- | docs/release/configguide/lab_update_guide.rst | 83 | ||||
| -rw-r--r-- | docs/release/information/pharos.rst | 49 | ||||
| -rw-r--r-- | docs/release/release-notes/lab-description/index.rst | 11 | ||||
| -rw-r--r-- | docs/release/release-notes/lab-description/pdf.rst | 18 | ||||
| -rw-r--r-- | docs/release/release-notes/specification/hardwarespec.rst | 15 | ||||
| -rw-r--r-- | docs/release/release-notes/specification/objectives.rst | 17 |
8 files changed, 116 insertions, 96 deletions
diff --git a/docs/release/configguide/configguide.rst b/docs/release/configguide/configguide.rst index 29466776..c71036b4 100644 --- a/docs/release/configguide/configguide.rst +++ b/docs/release/configguide/configguide.rst @@ -13,7 +13,8 @@ When setting up an OPNFV community lab ... * Provide the Pharos community with details of the intended setup, including ... - * Overview of resources are being offered to the community, intended purpose and known limitations + * 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, ... @@ -27,14 +28,18 @@ When setting up an OPNFV community lab ... * :ref:`pharos_information` -* Create new Wiki pages for lab and POD specific information +* Submit a patch using Pharos template for lab( :ref:`pharos_lab`) and POD( :ref:`pharos_pod`) + specific information in gerrit * 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` - - * Note that security sensitive lab information should be stored in the secure Pharos repo +* Create new Wiki pages and include the lab and POD content in the + `pharos git <https://git.opnfv.org/pharos/>`_ * Connect PODs to Jenkins/CI + +* Note: if the POD will be used for dynamical deployment with community installers, some security + sensitive lab information should be stored in the secure Pharos repo :ref:`securedlab` + diff --git a/docs/release/configguide/jumpserverinstall.rst b/docs/release/configguide/jumpserverinstall.rst index e51e9469..eb0fc7c8 100644 --- a/docs/release/configguide/jumpserverinstall.rst +++ b/docs/release/configguide/jumpserverinstall.rst @@ -7,8 +7,8 @@ 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). +configuraton BKMs will be maintained here. Let's take CentOS7 for example. The below install +information was used for Fuel(up to Danube, and it is replaced by MCP since Euphrates). **Procedure** diff --git a/docs/release/configguide/lab_update_guide.rst b/docs/release/configguide/lab_update_guide.rst index c939164c..fc34dbe2 100644 --- a/docs/release/configguide/lab_update_guide.rst +++ b/docs/release/configguide/lab_update_guide.rst @@ -17,19 +17,47 @@ Details about each Community Lab is found in 3 places: see this `Example Lab <https://wiki.opnfv.org/display/pharos/Intel+Hosting>`_ - 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 +.. code: bash + + ├── development ... for pharos developer + │ ├── design + │ ├── overview + │ └── requirement + ├── index.rst + └── release ... release documents + ├── configguide + │ ├── configguide.rst + │ ├── jumpserverinstall.rst + │ └── lab_update_guide.rst + ├── images + ├── information + │ └── pharos.rst ... project information file + ├── release-notes + │ ├── lab-description + │ │ ├── inventory.rst + │ │ ├── lab_description.rst + │ │ └── pod_description.rst + │ ├── labs ... lab specific documents + │ ├── platformoverview + │ │ └── labinfrastructure.rst + │ └── specification + │ ├── hardwarespec.rst + │ ├── networkconfig.rst + │ ├── objectives.rst + │ └── remoteaccess.rst + └── userguide + ├── documentation-example.rst Update Pharos repo ------------------ Clone the Pharos Git repository - * 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 + * git clone https://gerrit.opnfv.org/gerrit/pharos + * Make the changes to Pharos project information file (docs/release/information/pharos.rst) + * Submit changes for review + * After code gets merged http://artifacts.opnfv.org/pharos/docs/release/information/pharos.html + will contain your change Update Pharos Wiki @@ -38,47 +66,20 @@ Update Pharos Wiki Edit Wiki page * https://wiki.opnfv.org/pharos - * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/information/pharos.html}} + * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/release/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) 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 +Update the map info on the Pharos Project Page https://wiki.opnfv.org/display/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: - * 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 Code Example (see Wiki page for current version):: - -MAP:: - - <olmap id="olMapOne" width="877px" height="200px" lat="45.0" lon="0.0" zoom="3" statusbar="1" toolbar="1" controls="1" - poihoverstyle="0" baselyr="OpenStreetMap" gpxfile="" kmlfile=""> - 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** - </olmap> + * Location + * Contact + * POD/vPOD + * Role + diff --git a/docs/release/information/pharos.rst b/docs/release/information/pharos.rst index 1679e380..19cfa581 100644 --- a/docs/release/information/pharos.rst +++ b/docs/release/information/pharos.rst @@ -6,7 +6,7 @@ Introduction ------------ -The `Pharos Project <https://www.opnfv.org/developers/pharos>`_ deals with developing an OPNFV lab +The `Pharos <https://www.opnfv.org/developers/pharos>`_ Project deals with developing an OPNFV lab infrastructure that is geographically and technically diverse. This will greatly assist in developing a highly robust and stable OPNFV platform. Community labs are hosted by individual companies and there is also an OPNFV lab hosted by the Linux Foundation that has controlled access @@ -16,7 +16,7 @@ management/usage policies and process; and a support plan for reliable access to resources. Community labs are provided as a service by companies and are not controlled by Pharos however our goal is to provide easy visibility of all lab capabilities and their usage at all-times. -A requirement of Pharos labs is to provide *bare-metal* for development, deployment and testing. +A requirement of Pharos labs is to provide **bare-metal** for development, deployment and testing. This is resource intensive from a hardware and support perspective while providing remote access can also be very challenging due to corporate IT policies. Achieving a consistent *look and feel* of a federated lab infrastructure continues to be an objective. Virtual environments are also useful and @@ -34,13 +34,13 @@ Project Communication * `Pharos page <https://www.opnfv.org/developers/pharos>`_ * `Pharos project Wiki <https://wiki.opnfv.org/display/pharos>`_ -* `Pharos Planning <https://wiki.opnfv.org/display/pharos/Pharos+Colorado+Plan>`_ +* `Pharos Planning <https://wiki.opnfv.org/display/pharos/Pharos+Euphrates+Plan>`_ * `Pharos Jira <https://jira.opnfv.org/projects/PHAROS/summary>`_ -* `Bi-weekly Pharos meeting <https://wiki.opnfv.org/display/pharos/Pharos+Meetings>`_ * `Weekly INFRA WG meeting <https://wiki.opnfv.org/display/INF/Infra+Working+Group>`_ * `Weekly coordination meeting for Test related projects <https://wiki.opnfv.org/meetings/test>`_ * `IRC: freenode.net #opnfv-pharos <http://webchat.freenode.net/?channels=opnfv-pharos>`_ -* Mailing List: use opnfv-tech-discuss and tag your emails with [Pharos] in the subject for filtering +* Mailing List: use opnfv-tech-discuss@lists.opnfv.org and tag your emails with [Pharos] in the + subject for filtering Project Release Artifacts ------------------------- @@ -52,9 +52,9 @@ Project Release Artifacts Pharos Lab Process ------------------ -* Process for requesting lab access and support https://wiki.opnfv.org/display/pharos/Pharos+Rls+B+Support +* Process for requesting lab access and support https://wiki.opnfv.org/display/INF/Infra+Lab+Support * Pharos Lab Governance and Policies https://wiki.opnfv.org/display/pharos/Pharos+Policies -* Status of Community labs https://wiki.opnfv.org/display/pharos/#PharosHome-Overview +* Status of Community labs https://wiki.opnfv.org/display/pharos/Community+Labs Current Labs ------------ @@ -69,43 +69,34 @@ An interactive map of OPNFV lab locations, lab owners and other lab information | 1 | Linux | https://wiki.opnfv.org/display/pharos/Lflab+Hosting | Portland, Oregon | | | Foundation | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 2 | Spirent | https://wiki.opnfv.org/display/pharos/Spirentvctlab | Nephoscale, CA | +| 2 | China Mobile | https://wiki.opnfv.org/display/pharos/Lab2+Chinamobile+Hosting | Beijing, China | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 3 | China Mobile | https://wiki.opnfv.org/display/pharos/Lab2+Chinamobile+Hosting | Beijing, China | +| 3 | Enea | https://wiki.opnfv.org/display/pharos/Enea-pharos-lab | Kista, Sweden | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 4 | Dell | https://wiki.opnfv.org/display/pharos/Dell+Hosting | Santa Clara, CA | +| 4 | Ericsson | https://wiki.opnfv.org/display/pharos/Ericsson+Hosting+and+Request+Process | Montreal, Canada | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 5 | Enea | https://wiki.opnfv.org/display/pharos/Enea-pharos-lab | Kista, Sweden | -| | | | | -+----+---------------+----------------------------------------------------------------------------+-------------------+ -| 6 | Ericsson | https://wiki.opnfv.org/display/pharos/Ericsson+Hosting+and+Request+Process | Montreal, Canada | -| | | | | +| 5 | Huawei | https://wiki.opnfv.org/display/pharos/Huawei+Hosting | Langfang, China | +| | | | Shanghai, China | +| | | | Munich, Germany | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 7 | Huawei | https://wiki.opnfv.org/display/pharos/Lab4+Huawei | Xi an, China | +| 6 | Intel | https://wiki.opnfv.org/display/pharos/Intel+Hosting | Hillsboro, Oregon | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 8 | Huawei | https://wiki.opnfv.org/display/pharos/Huawei+Sc+Hosting | Santa Clara, CA | +| 7 | Nokia | https://wiki.opnfv.org/display/pharos/Nokia+Hosting | Espoo, Finland | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 9 | Intel | https://wiki.opnfv.org/display/pharos/Intel+Hosting | Hillsboro, Oregon | -| | | | | -+----+---------------+----------------------------------------------------------------------------+-------------------+ -| 10 | Orange | https://wiki.opnfv.org/display/pharos/Opnfv-orange | Lannion, France | -| | | | | +| 8 | Okinawa | https://wiki.opnfv.org/display/pharos/OOL+TestLab | Okinawa, Japan | +| | Open Lab | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 11 | Orange | https://wiki.opnfv.org/display/pharos/Opnfv-orange | Paris, France | -| | | | | +| 9 | Orange | https://wiki.opnfv.org/display/pharos/Opnfv-orange | Lannion, France | +| | | | Paris, France | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 12 | ZTE | https://wiki.opnfv.org/display/pharos/ZTE+SH+Testlab | Shanghai, China | +| 10 | ZTE | https://wiki.opnfv.org/display/pharos/ZTE+SH+Testlab | Shanghai, China | | | | | | +----+---------------+----------------------------------------------------------------------------+-------------------+ -| 13 | Okinawa | https://wiki.opnfv.org/display/pharos/OOL+TestLab | Okinawa | -| | Open Lab | | | -+----+---------------+----------------------------------------------------------------------------+-------------------+ - Pharos project Key Facts diff --git a/docs/release/release-notes/lab-description/index.rst b/docs/release/release-notes/lab-description/index.rst index 23b675ae..aed596e2 100644 --- a/docs/release/release-notes/lab-description/index.rst +++ b/docs/release/release-notes/lab-description/index.rst @@ -13,7 +13,14 @@ network topologies. Compute, network and storage specifications with network top required to help developers use lab resources efficiently while minimizing support needs. This also greatly assists with troubleshoting. It is the responsibility of the lab owner to keep individual lab documents updated and determine appropriate level of detail that is exposed publicly through -the Wiki or maintained in a secure Pharos repo with controlled access. +the Wiki or maintained in a secure Pharos repo +`securedlab <https://gerrit.opnfv.org/gerrit/#/admin/projects/securedlab>`_ with controlled access. +To avoid deplicated content, it is suggested to directly include the rst docs in the wiki. + +Before Danube release, securedlab is only opened for Infra WG committers and installer projects's +contributors. Since Euphrates release, it is opened for all the contributors of Pharos project, if +you are the owner of a community lab, please ask helpdesk to become a Pharos contributor in order +to submit your PDF to the securedlab repo. The goal of the Pharos Project is automation of resource provisioning. This requires machine readable inventory and network configuration files that follow common format. @@ -24,4 +31,4 @@ readable inventory and network configuration files that follow common format. ./lab_description.rst ./pod_description.rst - ./inventory.rst + ./pdf.rst diff --git a/docs/release/release-notes/lab-description/pdf.rst b/docs/release/release-notes/lab-description/pdf.rst new file mode 100644 index 00000000..4f53edb3 --- /dev/null +++ b/docs/release/release-notes/lab-description/pdf.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. + +******************** +Pod Description File +******************** + +The PDF(Pod Descrition File) provides template for POD's hardware information for all the +installers in yaml. The target is to use the same PDF file to deploy a POD by any installer with +any scenario it supports. It is the base of the dynamic CI , LaaS(Lab as a Service) and +SDF(Scenario Description File). + +Currently Jinja template is used to transfer the PDF to the specific installer's +template. PDF, Jinja template and the transfering tools are all stored in :ref:`securedlab`. +You can find the latest PDF template in +https://gerrit.opnfv.org/gerrit/#/c/38283/8/labs/lf/pod4.yaml. + diff --git a/docs/release/release-notes/specification/hardwarespec.rst b/docs/release/release-notes/specification/hardwarespec.rst index 8086aa91..1eb883e7 100644 --- a/docs/release/release-notes/specification/hardwarespec.rst +++ b/docs/release/release-notes/specification/hardwarespec.rst @@ -8,15 +8,16 @@ Hardware A pharos compliant OPNFV test-bed provides: -- One CentOS 7 jump server on which the virtualized Openstack/OPNFV installer runs -- In the Brahmaputra release you may select a variety of deployment toolchains to deploy from the - jump server. -- 5 compute / controller nodes (`BGS - <https://wiki.opnfv.org/get_started/get_started_work_environment>`_ requires 5 nodes) +- One CentOS/Ubuntu jump server on which the virtualized Openstack/OPNFV installer runs. For an ARM + POD, the jump server should also be an ARM server +- 3 controller nodes +- 2 compute 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/octopus/brahmaputra/docs/octopus_docs/opnfv-jenkins-slave-connection.html#jenkins-slaves -http://artifacts.opnfv.org/brahmaputra.1.0/docs/opnfv-jenkins-slave-connection.brahmaputra.1.0.html +In the Euphrates release you may select a variety of deployment toolchains to deploy from the +jump server. **Servers** @@ -38,7 +39,7 @@ a better result. * Disks: 2 x 1TB HDD + 1 x 100GB SSD (or greater capacity) * The first HDD should be used for OS & additional software/tool installation -* The second HDD is configured for CEPH object storage +* The second HDD is configured for CEPH OSD * The SSD should be used as the CEPH journal * Performance testing requires a mix of compute nodes with CEPH (Swift+Cinder) and without CEPH storage * Virtual ISO boot capabilities or a separate PXE boot server (DHCP/tftp or Cobbler) diff --git a/docs/release/release-notes/specification/objectives.rst b/docs/release/release-notes/specification/objectives.rst index 0a0ad6aa..dac50bfb 100644 --- a/docs/release/release-notes/specification/objectives.rst +++ b/docs/release/release-notes/specification/objectives.rst @@ -7,23 +7,20 @@ Pharos Compliance ----------------- The **Pharos Specification** defines a hardware environment for deployment and testing of the -**Brahmaputra** platform release. The **Pharos Project** is also responsible for defining lab -capabilities, developing management/usage policies and process; and a support plan for reliable -access to project and release resources. Community labs are provided as a service by companies and -are not controlled by Pharos however our objective is to provide easy visibility of all lab -capabilities and their usage at all-times. +OPNFV platform release. Pharos lab infrastructure has the following objectives: + - Provides secure, scalable, standard and HA environments for feature development -- Supports the full Brahmaputra deployment lifecycle (this requires a **bare-metal** environment) -- Supports functional and performance testing of the Brahmaputra release +- Supports the full Euphrates deployment lifecycle (this requires a **bare-metal** environment) +- Supports functional and performance testing of the Euphrates release - Provides mechanisms and procedures for secure remote access to Pharos compliant environments for OPNFV community -Deploying Brahmaputra in a Virtualized environment is possible and will be useful, however it does -not provide a fully featured deployment and realistic test environment for the Brahmaputra release +Deploying Euphrates in a Virtualized environment is possible and will be useful, however it does +not provide a fully featured deployment and realistic test environment for the Euphrates release of OPNFV. The high level architecture is outlined in the following diagram: -.. image:: ../images/pharos-archi1.jpg +.. image:: ../../images/pharos-archi1.jpg |