diff options
| author |   10013968 <zhang.jun3g@zte.com.cn> | 2016-07-18 23:51:00 +0800 |
|---|---|---|
| committer | 10013968 <zhang.jun3g@zte.com.cn> | 2016-07-27 23:49:59 +0800 |
| commit | 988cf64e3a7601396e40b08a1aae07a524bf8c74 (patch) | |
| tree | c4faf0b011473671e833df539c04e79de4884608 /docs/lab-description | |
| parent | d9a002cba4741400c8b8d34e5bddb8cf33fb4e3c (diff) | |
Reformat the rst documents
Main changes:
Set the textwidth to 100, exceptions: tables and http links may be
longer than the limits
Cut off the table width as shorten as possible
JIRA: PHAROS-227
Change-Id: I07861e675d76ab5063f388d3be7d0b51c8bad38b
Signed-off-by: 10013968 <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs/lab-description')
| -rw-r--r-- | docs/lab-description/inventory.rst | 6 | ||||
| -rw-r--r-- | docs/lab-description/pod_description.rst | 79 | ||||
| -rw-r--r-- | docs/lab-description/templates.rst | 17 |
3 files changed, 52 insertions, 50 deletions
diff --git a/docs/lab-description/inventory.rst b/docs/lab-description/inventory.rst index db1ea541..81c0dd57 100644 --- a/docs/lab-description/inventory.rst +++ b/docs/lab-description/inventory.rst @@ -6,6 +6,6 @@ POD Inventory File ****************** -The Common Inventory File provides a template for machine reabable input into every installer. For convenience the -YAML file template currently resides in the Genesis Project repo. Refer to the following patch for further infomation -https://gerrit.opnfv.org/gerrit/#/c/4079. +The Common Inventory File provides a template for machine reabable input into every installer. For +convenience the YAML file template currently resides in the Genesis Project repo. Refer to the +following patch for further infomation https://gerrit.opnfv.org/gerrit/#/c/4079. diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst index b63097d6..2d4047a8 100644 --- a/docs/lab-description/pod_description.rst +++ b/docs/lab-description/pod_description.rst @@ -26,48 +26,48 @@ Server Specifications **Jump Host** -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | -| Hostname | Vendor | Model | Serial Number| CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-jump | Dell | R730 | ABCDEF007 | 2 x E5-2699 | 64 GB | 240GB SSD | 10.10.10.10 | IF0: 10.2.117.36 | IF2: 10.2.12.1 | | -| | | | | | | 1 TB SATA | 00:1E:67:D4:36:9A | 00:1E:67:4F:B7:B1 | 00:1E:67:4F:B7:B4 | | -| | | | | | | | root/root | VLAN 984 | VLAN 202 | | -| | | | | | | | | Public | Private | | -| | | | | | | | | IF1: 10.2.1.1 | IF3: 10.2.13.1 | | -| | | | | | | | | 00:1E:67:4F:B7:B2 | 00:1E:67:4F:B7:B5 | | -| | | | | | | | | VLAN 201 | VLAN 203 | | -| | | | | | | | | Admin | Storage | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ ++--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+ +| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | +| Hostname | Vendor | Model | Serial Number | CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes | ++--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+ +| pod2-jp-jump | Dell | R730 | ABCDEF007 | 2 x E5-2699 | 64 GB | 240GB SSD | 10.10.10.10 | IF0: 10.2.117.36 | IF2: 10.2.12.1 | | +| | | | | | | 1 TB SATA | 00:1E:67:D4:36:9A | 00:1E:67:4F:B7:B1 | 00:1E:67:4F:B7:B4 | | +| | | | | | | | root/root | VLAN 984 | VLAN 202 | | +| | | | | | | | | Public | Private | | +| | | | | | | | | IF1: 10.2.1.1 | IF3: 10.2.13.1 | | +| | | | | | | | | 00:1E:67:4F:B7:B2 | 00:1E:67:4F:B7:B5 | | +| | | | | | | | | VLAN 201 | VLAN 203 | | +| | | | | | | | | Admin | Storage | | ++--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+ **Compute Nodes** -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | -| Hostname | Vendor | Model | Serial Number| CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-node1| | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-node2| | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-node3| | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-node4| | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ -| pod2-jp-node5| | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+ ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | | +| Hostname | Vendor | Model | Serial Number | CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| pod2-jp-node1 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| pod2-jp-node2 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| pod2-jp-node3 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| pod2-jp-node4 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ +| pod2-jp-node5 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ VPN Users --------- @@ -92,8 +92,9 @@ Firewall Rules POD Topology ------------ -Provide a diagram showing the network topology of the POD. Any security sensitive details should -not be exposed publically and can be stored in the secure Pharos repo. The following diagram is an example only. +Provide a diagram showing the network topology of the POD. Any security sensitive details should not +be exposed publically and can be stored in the secure Pharos repo. The following diagram is an +example only. .. image:: ./images/pod_topology_example.png :alt: POD diagram not found diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst index f845457d..c207cfa7 100644 --- a/docs/lab-description/templates.rst +++ b/docs/lab-description/templates.rst @@ -8,15 +8,16 @@ 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 the Wiki or maintained in a secure Pharos repo with controlled access. +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 +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. +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. .. toctree:: |