summaryrefslogtreecommitdiffstats
path: root/docs/lab-description
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-01-19 11:53:14 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-01-22 13:42:03 -0800
commitc4e926c285db44a5ec5ba4a895c8d3889e3358c0 (patch)
treebb37ed035989bcca11e1cbcfe7b3085ad17429cf /docs/lab-description
parent971188744137c6d0dc75cb89740bbb759651d304 (diff)
Organized document directories, added index.rst files ...
./ only file here should be project facts (INFO) ./docs/ no files should be here (jumpserver_install and pharos-spec files will be removed) ./docs/configguide/ overview of community lab expecations, reference to all other files wtih descriptions, get started for a new lab (e.g. how to update pharos start page) ./docs/images/ diagrams for pharos project (Wiki etc. not a particular lab) ./docs/information/ contains pharos project information ... pharos.rst ./docs/lab-description/ templates and config file examples (human readable (rst) and machine readable (yaml) files) ./docs/labs/ all lab specific documentation (filled templates, etc.) ./docs/labs/images/ lab specific diagrams ./docs/specification/ files that are part of the pharos spec Change-Id: I3a7a1434ae4b8f6f0d66d0ce5b6a1b00853378d5 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/lab-description')
-rw-r--r--docs/lab-description/lab_details_template.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/lab-description/lab_details_template.rst b/docs/lab-description/lab_details_template.rst
new file mode 100644
index 0000000..bcc909a
--- /dev/null
+++ b/docs/lab-description/lab_details_template.rst
@@ -0,0 +1,71 @@
+Pharos Lab Details Template
+============================
+
+Hardware details
+-----------------
+
+**General details**
+
++----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+
+| Hostname | Node type | HW model | Storage | CPU model | # Sockets | Memory [GB] | # NIC [MAC / IP / VLAN id] | BW |
++----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+
+| galileo | network | Dell R730 | 3 x 1TB (raid 5) | IntelE5-2690 v2 | 2 | 64 | 1 # 00:ae:ff:cc:dd:12 / 192.168.22.10 / 1003 | 10 Gbps |
+| | | | | | | | 2 # 00:11:22:33:44:55 / 10.7.8.10 / 1 | 1 Gbps |
++----------------+------------------+----------------------+-----------------------+--------------+-----------+-------------+-------------------------------------------+------+---------+
+
+**Lights-out**
+
++----------------+-------------------------------+------------------+---------------------+
+| Hostname | Lights-out address | Username | Password |
+-----------------+-------------------------------+------------------+---------------------+
+| | | | |
++----------------+-------------------------------+------------------+---------------------+
+
+
+Software
+---------
+
+**OS**
+
+
+**Pre-provisioned software**
+
+
+Network
+--------
+
+**Subnet allocations**
+
++--------------+-------------------+-------------------+---------------+---------+
+| Net name | Address | Mask | Gateway | VLAN id |
++--------------+-------------------+-------------------+---------------+---------+
+| | | | | |
++--------------+-------------------+-------------------+---------------+---------+
+
+
+**Firewall rules**
+
+
+**Diagrams**
+
+.. image:: images/<lab-name>_<diagram-name>.png|.jpg
+ :alt: Name of the diagram
+
+Remote access infrastructure
+-----------------------------
+
+**Explanations**
+
+**Diagrams**
+
+.. image:: images/<lab-name>_<diagram-name>.png|.jpg
+ :alt: Name of the diagram
+
+
+Documentation tracking
+-----------------------
+
+Revision: _sha1_
+
+Build date: _date_
+