summaryrefslogtreecommitdiffstats
path: root/docs/specification
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-02-22 15:12:18 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-02-22 15:12:18 -0800
commitb2231a970fb73f4f5df72b59ed9d58a039644ac3 (patch)
treea2ccaac92fa78927e0390b135e63640d2fb98dde /docs/specification
parent2fe5f8f73ed6db8c281f251b9fb3a9aad4838fc5 (diff)
Various Document edits to fix formatting issues and add contents
Change-Id: I522bf15377fb00cb22e46050ee966884896afeac Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/specification')
-rw-r--r--docs/specification/hardwarespec.rst38
-rw-r--r--docs/specification/index.rst13
-rw-r--r--docs/specification/networkconfig.rst10
-rw-r--r--docs/specification/objectives.rst4
4 files changed, 23 insertions, 42 deletions
diff --git a/docs/specification/hardwarespec.rst b/docs/specification/hardwarespec.rst
index 80987ce7..a214be44 100644
--- a/docs/specification/hardwarespec.rst
+++ b/docs/specification/hardwarespec.rst
@@ -1,10 +1,10 @@
-.. 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.
-Pharos compliant environment
-----------------------------
+Hardware
+--------
A pharos compliant OPNFV test-bed provides:
@@ -15,35 +15,29 @@ A pharos compliant OPNFV test-bed provides:
- 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
-Hardware requirements
----------------------
-
**Servers**
-CPU:
+**CPU:**
-* Intel Xeon E5-2600v2 Series
-(Ivy Bridge and newer, or similar)
+* Intel Xeon E5-2600v2 Series or newer
-Local Storage Configuration:
+**Local Storage:**
-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.
+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 mayproduce
+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
+* 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 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)
-Memory:
+**Memory:**
* 32G RAM Minimum
-Power Supply Single
+**Power Supply**
* Single power supply acceptable (redundant power not required/nice to have)
diff --git a/docs/specification/index.rst b/docs/specification/index.rst
index b3f06e65..a583087f 100644
--- a/docs/specification/index.rst
+++ b/docs/specification/index.rst
@@ -2,10 +2,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-
-********************
+====================
Pharos Specification
-********************
+====================
.. toctree::
:maxdepth: 2
@@ -16,14 +15,6 @@ Pharos Specification
./jumpserverinstall.rst
./remoteaccess.rst
-:Authors: Trevor Cooper (Intel)
-:Version: 1.0
-
-Indices and tables
-==================
-
-* :ref:`search`
-
Revision: _sha1_
Build date: |today|
diff --git a/docs/specification/networkconfig.rst b/docs/specification/networkconfig.rst
index 7eb0615c..af09e564 100644
--- a/docs/specification/networkconfig.rst
+++ b/docs/specification/networkconfig.rst
@@ -45,7 +45,7 @@ Documented configuration to include:
- May be special NW requirements for performance related projects
- Default gateways
-ontroller node bridge topology overview
+Controller node bridge topology overview
.. image:: ../images/bridge1.png
@@ -53,10 +53,7 @@ compute node bridge topology overview
.. image:: ../images/bridge2.png
-Architecture
--------------
-
-** Network Diagram **
+**Network Diagram**
The Pharos architecture may be described as follow:
Figure 1: Standard Deployment Environment
@@ -65,8 +62,7 @@ Figure 1: Standard Deployment Environment
Figure 1: Standard Deployment Environment
-Sample Network Drawings
------------------------
+**Sample Network Drawings**
Files for documenting lab network layout.
These were contributed as Visio VSDX format compressed as a ZIP
diff --git a/docs/specification/objectives.rst b/docs/specification/objectives.rst
index 310959f4..f6cfabed 100644
--- a/docs/specification/objectives.rst
+++ b/docs/specification/objectives.rst
@@ -3,8 +3,8 @@
.. (c) 2016 OPNFV.
-Objectives / Scope
--------------------
+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