summaryrefslogtreecommitdiffstats
path: root/docs/lab-description/lab_description.rst
blob: d36e8c6fc3a08ca3c4aec321253cc1b2598735d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.

.. _pharos_lab:

**************************
Lab Specification Template
**************************

Introduction
------------

Add an summary of what your lab hosts, its focus areas and purpose


Lab Resources
-------------

+----------+--------------+-----------------+--------------+-------------+---------+-------+
| POD Name | Project(s)   | Project Lead(s) | Email(s)     |  POD Role   |  Status | Notes |
+----------+--------------+-----------------+--------------+-------------+---------+-------+
| POD1     | Project Name | John Doe        | john@abc.com |  CI: stable |  Active |       |
+----------+--------------+-----------------+--------------+-------------+---------+-------+

* **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description.
* **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ...
* **Status:** Assigned, Configuring, Active, Troubleshooting, Available, ...


Acceptable Usage Policy
-----------------------

Define lab user policies and expectations


Remote Access Infrastructure
----------------------------

Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.)


Remote Access Procedure
-----------------------

Define lab process for requesting access to the lab (e.g. VPN guide,
how to modify BIOS settings, etc.)


Lab Documentation
-----------------

List lab specific documents here


Lab Topology
------------

Provide a diagram showing the network topology of lab including lights-out network. Any security
sensitive details should not be exposed publically. The following diagram is an example only.

.. image:: ./images/lab_topology_example.jpg
   :alt: Lab diagram not found