Removed index files from all doc directories, rearranged headings, fixed broken links...
[pharos.git] / docs / configguide / configguide.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 ***************
6 Lab Setup Guide
7 ***************
8
9 Provides an overview for setting up a Pharos lab. A full set of
10 :ref:`pharos_master` documents are maintained in the *pharos* repo.
11
12 Contributing to the Pharos Community
13 ------------------------------------
14
15 The development, test and production activities rely on Pharos resources and support from the Pharos community. Lab
16 owners and Pharos project committers/contributors will evolve the vision for Pharos as well as expand lab capabilities
17 that are needed to help OPNFV be highly successful.
18
19 * Jira is used to track Pharos activities including lab operations
20 * PODs are connected to Jenkins and generally available 24/7 other than scheduled maintenance and troubleshooting
21 * Lab resources are declared as either for *Development (bare-metal or virtual)*, *Production latest (bare-metal)* or *Production stable (bare-metal)*
22
23 Declaring a Pharos Lab
24 ----------------------
25
26 * Provide the Pharos community with details of the intended setup, including ...
27
28   * Overview of resources are being offered to the community, intended purpose and known limitations
29   * Lab owner name with contacts
30   * Timelines for availablity for development, test, release production, ...
31
32 * Update the Pharos Wiki with lab details
33
34   * Lab map, organization, contacts, status, location, resources, role, etc.
35   * https://wiki.opnfv.org/pharos#community_labs
36   * :ref:`pharos_wiki`
37
38 * Update the Pharos project information file "Current Labs"
39
40   * :ref:`pharos_information`
41
42 * Create new Wiki pages for lab and POD specific information
43
44   * Access procedures
45   * Usage guidelines for developers
46   * Update infomtation as PODs are re-assigned or usage/availability changes
47
48 * Fill Lab and POD templates ... :ref:`pharos_lab` ... :ref:`pharos_pod`
49
50   * Note that security sensitive lab information should be stored in the secure Pharos repo
51
52 * Connect PODs to Jenkins/CI