Pharos Templates and Configuration Files

Lab and POD templates are provided to help lab owners document capabilities, configurations and network topologies. Compute, network and storage specifications with network topology details are required to help developers use lab resources efficiently while minimizing support needs. This also greatly assists with troubleshoting. It is the responsibility of the lab owner to keep individual lab documents updated and determine appropriate level of detail that is exposed publicly through the Wiki or maintained in a secure Pharos repo securedlab with controlled access. To avoid deplicated content, it is suggested to directly include the rst docs in the wiki.

Before Danube release, securedlab is only opened for Infra WG committers and installer projects’s contributors. Since Euphrates release, it is opened for all the contributors of Pharos project, if you are the owner of a community lab, please ask helpdesk to become a Pharos contributor in order to submit your PDF to the securedlab repo.

The goal of the Pharos Project is automation of resource provisioning. This requires machine readable inventory and network configuration files that follow common format.

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.

POD Specification Template

Introduction

Add an summary of the POD usage (Project, CI stable, CI latest, dev/test, stand-alone servers, etc.)

Additional Requirements

Describe any addional POD requirements beyond a standard Pharos compliant POD e.g. test equipment, shared usage, ...

Server Specifications

Jump Host

Hostname	Vendor	Model	Serial Number	CPUs	Memory	Local Storage	Lights-out network (IPMI): IP/MAC, U/P	1GbE: NIC#/IP MAC/VLAN/Network	10GbE: NIC#/IP MAC/VLAN/Network	Notes
jump	Dell	R730	ABCDEF007	E5-2699x2	64 GB	240GB SSD 1 TB SATA	10.10.10.10 00:1E:67:D4:36:9A root/root	IF0: 10.2.117.36 00:1E:67:4F:B7:B1 VLAN 984 Public IF1: 10.2.1.1 00:1E:67:4F:B7:B2 VLAN 201 Admin	IF2: 10.2.12.1 00:1E:67:4F:B7:B4 VLAN 202 Private IF3: 10.2.13.1 00:1E:67:4F:B7:B5 VLAN 203 Storage

Compute Nodes

Hostname	Vendor	Model	Serial Number	CPUs	Memory	Local Storage	Lights-out network (IPMI): IP/MAC, U/P	1GbE: NIC#/IP MAC/VLAN/Network	10GbE: NIC#/IP MAC/VLAN/Network	Notes
node1
node2
node3
node4
node5

VPN Users

Name	Email	Project	Role	Notes
joe user	ju@gmail.com	Pharos	contributer	CI support

Firewall Rules

Port(s)	Service	Notes
22, 43, 80	Jenkins CI

POD Topology

Provide a diagram showing the network topology of the POD. Any security sensitive details should not be exposed publically and can be stored in the secure Pharos repo. The following diagram is an example only.

Pod Description File

The PDF(Pod Descrition File) provides template for POD’s hardware information for all the installers in yaml. The target is to use the same PDF file to deploy a POD by any installer with any scenario it supports. It is the base of the dynamic CI , LaaS(Lab as a Service) and SDF(Scenario Description File).

Currently Jinja template is used to transfer the PDF to the specific installer’s template. PDF, Jinja template and the transfering tools are all stored in securedlab. You can find the latest PDF template in https://gerrit.opnfv.org/gerrit/#/c/38283/8/labs/lf/pod4.yaml.