docs/lab-description/pod_description.rst

   1 Pharos Lab POD description Template
   2 ===================================
   3
   4 Introduction
   5 ------------
   6
   7 Add an summary of the POD usage (Project, CI stable, CI latest, dev/test, stand-alone servers, etc.)
   8
   9
  10 Additional Requirements
  11 -----------------------
  12
  13 Describe any addional POD requirements beyond a standard Pharos compliant POD e.g. test equipment,
  14 shared usage, ...
  15
  16
  17 Systems
  18 -------
  19
  20 Jump Host
  21 ^^^^^^^^^
  22
  23 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  24 |              |              |              |              |              |              | Local        | Lights-out network     | 1GbE: NIC#/IP          | 10GbE: NIC#/IP         |              |
  25 |  Hostname    |  Vendor      | Model        | Serial Number|  CPUs        | Memory       | storage      | (IPMI): IP/MAC, U/P    | MAC/VLAN/Network       | MAC/VLAN/Network       | Notes        |
  26 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  27 | 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         |              |
  28 |              |              |              |              |              |              | 1 TB SATA    | 00:1E:67:D4:36:9A      | 00:1E:67:4F:B7:B1      | 00:1E:67:4F:B7:B4      |              |
  29 |              |              |              |              |              |              |              | root/root              | VLAN 984               | VLAN 202               |              |
  30 |              |              |              |              |              |              |              |                        | Public                 | Private                |              |
  31 |              |              |              |              |              |              |              |                        | IF1: 10.2.1.1          | IF3: 10.2.13.1         |              |
  32 |              |              |              |              |              |              |              |                        | 00:1E:67:4F:B7:B2      | 00:1E:67:4F:B7:B5      |              |
  33 |              |              |              |              |              |              |              |                        | VLAN 201               | VLAN 203               |              |
  34 |              |              |              |              |              |              |              |                        | Admin                  | Storage                |              |
  35 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  36
  37
  38 Nodes
  39 ^^^^^
  40
  41 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  42 |              |              |              |              |              |              | Local        | Lights-out network     | 1GbE: NIC#/IP          | 10GbE: NIC#/IP         |              |
  43 |  Hostname    |  Vendor      | Model        | Serial Number|  CPUs        | Memory       | storage      | (IPMI): IP/MAC, U/P    | MAC/VLAN/Network       | MAC/VLAN/Network       | Notes        |
  44 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  45 | pod2-jp-node1|              |              |              |              |              |              |                        |                        |                        |              |
  46 |              |              |              |              |              |              |              |                        |                        |                        |              |
  47 |              |              |              |              |              |              |              |                        |                        |                        |              |
  48 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  49 | pod2-jp-node2|              |              |              |              |              |              |                        |                        |                        |              |
  50 |              |              |              |              |              |              |              |                        |                        |                        |              |
  51 |              |              |              |              |              |              |              |                        |                        |                        |              |
  52 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  53 | pod2-jp-node3|              |              |              |              |              |              |                        |                        |                        |              |
  54 |              |              |              |              |              |              |              |                        |                        |                        |              |
  55 |              |              |              |              |              |              |              |                        |                        |                        |              |
  56 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  57 | pod2-jp-node4|              |              |              |              |              |              |                        |                        |                        |              |
  58 |              |              |              |              |              |              |              |                        |                        |                        |              |
  59 |              |              |              |              |              |              |              |                        |                        |                        |              |
  60 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  61 | pod2-jp-node5|              |              |              |              |              |              |                        |                        |                        |              |
  62 |              |              |              |              |              |              |              |                        |                        |                        |              |
  63 |              |              |              |              |              |              |              |                        |                        |                        |              |
  64 +--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
  65
  66 VPN Users
  67 ---------
  68
  69 +--------------+--------------+--------------+--------------+--------------+
  70 | Name         | Email        | Project      | Role         | Notes        |
  71 +--------------+--------------+--------------+--------------+--------------+
  72 | joe user     | ju@gmail.com | Pharos       | contributer  | CI support   |
  73 +--------------+--------------+--------------+--------------+--------------+
  74
  75
  76 Firewall Rules
  77 --------------
  78
  79 +--------------+--------------+--------------+
  80 | Port(s)      | Service      | Note         |
  81 +--------------+--------------+--------------+
  82 | 22, 43, 80   | Jenkins CI   |              |
  83 +--------------+--------------+--------------+
  84
  85
  86 POD Topology
  87 ------------
  88
  89 .. image:: images/<lab-name>_<diagram-name>.png|.jpg
  90    :alt: Name of the diagram