diff options
author | julien zhang <zhang.jun3g@zte.com.cn> | 2017-09-14 12:26:58 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@opnfv.org> | 2017-09-14 12:26:58 +0000 |
commit | 51095fef7299f4fd05afbb542a0ce5fb0431ea2b (patch) | |
tree | a28c1570a1172874578aa1d76086d86f166a2c9a /docs/release/configguide | |
parent | c795eab899e6a602d7d8009a4b5875019bd25a80 (diff) | |
parent | d8ed4f63a5af8f8836c8951623e6760ddb15710e (diff) |
Merge "Update contents in E release"
Diffstat (limited to 'docs/release/configguide')
-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 |
3 files changed, 54 insertions, 48 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 + |