summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJulien <zhang.jun3g@zte.com.cn>2016-08-22 10:22:16 +0800
committerJulien <zhang.jun3g@zte.com.cn>2016-08-22 21:35:15 +0800
commit1b8752a2d1ab6dbb3992435c762c12066f6033f0 (patch)
tree2a45eb68f3d75716f0da8a9802afc5ab258f208a /docs
parentdc98986c0cacfdf10e8f22ad9c3fb804cc2c37d3 (diff)
Description updates
Minor udpates and suggestions in review https://gerrit.opnfv.org/gerrit/#/c/18847/ Change-Id: I70c71dc36d6653fc0d09159a35e78253aa8cb81b Signed-off-by: Julien-zte <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/index.rst15
-rw-r--r--docs/information/pharos.rst35
-rw-r--r--docs/lab-description/index.rst9
3 files changed, 34 insertions, 25 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 6b48100..c51f029 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -12,13 +12,18 @@ OPNFV development, test and production activities rely on Pharos resources and s
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.
-Pharos configuration documents provide information on how to setup hardware and networks in a Pharos
-compliant lab. 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)*
+Pharos configuration documents provide information on how to setup hardware and networks in a
+Pharos compliant lab. Jira is used to track Pharos activities including lab operations. Lab
+resources can be used for and declared as either *Development (bare-metal or virtual)* or
+*Production/CI (bare-metal or virtual)*. If a resource is used for and declared as *Development*
+resource, it can not be used for and declared as *Production/CI* resource at the same time and vice
+versa. Changing the resource declation must be brought in to Infra WG. Production/CI PODs are
+required to be connected to OPNFV Jenkins and available on a 24/7 basis other than scheduled
+maintenance and troubleshooting. Jenkins slave status can be seen on `Jenkins dashboard
+https://build.opnfv.org/ci/computer/`.
.. toctree::
+ :maxdepth: 2
./configguide.rst
./lab_update_guide.rst
diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst
index 3a250c5..1679e38 100644
--- a/docs/information/pharos.rst
+++ b/docs/information/pharos.rst
@@ -23,28 +23,31 @@ federated lab infrastructure continues to be an objective. Virtual environments
provided by some labs. Jira is currently used for tracking lab operational issues as well as for
Pharos project activities.
-Future lab capabilities are currently focussed on 1) Deployment automation 2) Dashboards (for
-capability and usage) 3) *Virtual Labs* for developer on-boarding.
+Future lab capabilities are currently focused on:
-* `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>`_
+1) Automatic resource provisioning
+2) Dashboards (for capability and usage)
+3) *Virtual Labs* for developer on-boarding
Project Communication
---------------------
-* `Jira <https://jira.opnfv.org/projects/PHAROS/summary>`_
-* `Weekly Pharos meeting <https://wiki.opnfv.org/display/INF/Infra+Working+Group>`_
+* `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 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
+* `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
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/
+* `Project Repository <https://gerrit.opnfv.org/gerrit/gitweb?p=pharos.git>`_
+* `Continuous Integration <https://build.opnfv.org/ci/view/pharos/>`_
+* `Documentation <http://artifacts.opnfv.org/pharos/docs/>`_
Pharos Lab Process
------------------
@@ -96,7 +99,7 @@ An interactive map of OPNFV lab locations, lab owners and other lab information
| 11 | Orange | https://wiki.opnfv.org/display/pharos/Opnfv-orange | Paris, France |
| | | | |
+----+---------------+----------------------------------------------------------------------------+-------------------+
-| 12 | ZTE | https://wiki.opnfv.org/display/pharos/ZTE+NJ+Testlab | Nan Jing, China |
+| 12 | ZTE | https://wiki.opnfv.org/display/pharos/ZTE+SH+Testlab | Shanghai, China |
| | | | |
+----+---------------+----------------------------------------------------------------------------+-------------------+
| 13 | Okinawa | https://wiki.opnfv.org/display/pharos/OOL+TestLab | Okinawa |
@@ -110,6 +113,8 @@ Pharos project Key Facts
**Key Project Facts are maintained in the Pharos INFO file in the project repo**
- * Can be viewed on the project Wiki
- `INFO <https://wiki.opnfv.org/pharos?&#pharos_project_-_key_facts>`_
- * Project key facts in repo: pharos/INFO
+ * Can be viewed on the project
+ `wiki INFO <https://wiki.opnfv.org/pharos?&#pharos_project_-_key_facts>`_
+ * Project key facts in
+ `repo INFO <https://gerrit.opnfv.org/gerrit/gitweb?p=pharos.git;f=INFO;hb=refs/heads/master>`_
+
diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst
index 1dfacc8..23b675a 100644
--- a/docs/lab-description/index.rst
+++ b/docs/lab-description/index.rst
@@ -11,13 +11,12 @@ 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
+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.
-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.
+The goal of the Pharos Project is automation of resource provisioning. This requires machine
+readable inventory and network configuration files that follow common format.
.. toctree::