docs/lab-description/pod_description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2016 OPNFV.
   4
   5 .. _pharos_pod:
   6
   7 **************************
   8 POD Specification Template
   9 **************************
  10
  11 Introduction
  12 ------------
  13
  14 Add an summary of the POD usage (Project, CI stable, CI latest, dev/test, stand-alone servers, etc.)
  15
  16
  17 Additional Requirements
  18 -----------------------
  19
  20 Describe any addional POD requirements beyond a standard Pharos compliant POD e.g. test equipment,
  21 shared usage, ...
  22
  23
  24 Server Specifications
  25 ---------------------
  26
  27 **Jump Host**
  28
  29 +--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+
  30 |              |         |       |               |              |        | Local     | Lights-out network  | 1GbE: NIC#/IP     | 10GbE: NIC#/IP    |       |
  31 |  Hostname    |  Vendor | Model | Serial Number |  CPUs        | Memory | storage   | (IPMI): IP/MAC, U/P | MAC/VLAN/Network  | MAC/VLAN/Network  | Notes |
  32 +--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+
  33 | 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    |       |
  34 |              |         |       |               |              |        | 1 TB SATA | 00:1E:67:D4:36:9A   | 00:1E:67:4F:B7:B1 | 00:1E:67:4F:B7:B4 |       |
  35 |              |         |       |               |              |        |           | root/root           | VLAN 984          | VLAN 202          |       |
  36 |              |         |       |               |              |        |           |                     | Public            | Private           |       |
  37 |              |         |       |               |              |        |           |                     | IF1: 10.2.1.1     | IF3: 10.2.13.1    |       |
  38 |              |         |       |               |              |        |           |                     | 00:1E:67:4F:B7:B2 | 00:1E:67:4F:B7:B5 |       |
  39 |              |         |       |               |              |        |           |                     | VLAN 201          | VLAN 203          |       |
  40 |              |         |       |               |              |        |           |                     | Admin             | Storage           |       |
  41 +--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+
  42
  43
  44 **Compute Nodes**
  45
  46
  47 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  48 |               |         |       |               |       |        | Local   | Lights-out network  | 1GbE: NIC#/IP    | 10GbE: NIC#/IP   |       |
  49 |  Hostname     |  Vendor | Model | Serial Number |  CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes |
  50 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  51 | pod2-jp-node1 |         |       |               |       |        |         |                     |                  |                  |       |
  52 |               |         |       |               |       |        |         |                     |                  |                  |       |
  53 |               |         |       |               |       |        |         |                     |                  |                  |       |
  54 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  55 | pod2-jp-node2 |         |       |               |       |        |         |                     |                  |                  |       |
  56 |               |         |       |               |       |        |         |                     |                  |                  |       |
  57 |               |         |       |               |       |        |         |                     |                  |                  |       |
  58 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  59 | pod2-jp-node3 |         |       |               |       |        |         |                     |                  |                  |       |
  60 |               |         |       |               |       |        |         |                     |                  |                  |       |
  61 |               |         |       |               |       |        |         |                     |                  |                  |       |
  62 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  63 | pod2-jp-node4 |         |       |               |       |        |         |                     |                  |                  |       |
  64 |               |         |       |               |       |        |         |                     |                  |                  |       |
  65 |               |         |       |               |       |        |         |                     |                  |                  |       |
  66 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  67 | pod2-jp-node5 |         |       |               |       |        |         |                     |                  |                  |       |
  68 |               |         |       |               |       |        |         |                     |                  |                  |       |
  69 |               |         |       |               |       |        |         |                     |                  |                  |       |
  70 +---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+
  71
  72 VPN Users
  73 ---------
  74
  75 +--------------+--------------+--------------+--------------+--------------+
  76 | Name         | Email        | Project      | Role         | Notes        |
  77 +--------------+--------------+--------------+--------------+--------------+
  78 | joe user     | ju@gmail.com | Pharos       | contributer  | CI support   |
  79 +--------------+--------------+--------------+--------------+--------------+
  80
  81
  82 Firewall Rules
  83 --------------
  84
  85 +--------------+--------------+--------------+
  86 | Port(s)      | Service      | Note         |
  87 +--------------+--------------+--------------+
  88 | 22, 43, 80   | Jenkins CI   |              |
  89 +--------------+--------------+--------------+
  90
  91
  92 POD Topology
  93 ------------
  94
  95 Provide a diagram showing the network topology of the POD. Any security sensitive details should not
  96 be exposed publically and can be stored in the secure Pharos repo. The following diagram is an
  97 example only.
  98
  99 .. image:: ./images/pod_topology_example.png
 100    :alt: POD diagram not found