docs/pharos-spec.rst

   1 Pharos Specification
   2 =====================
   3
   4 Objectives / Scope
   5 -------------------
   6
   7 Pharos spec defines the OPNFV test environment (in which OPNFV platform can be deployed and tested).
   8
   9 - Provides a secure, scalable, standard and HA environment
  10 - Supports full deployment lifecycle (this requires a bare metal environment)
  11 - Supports functional and performance testing
  12 - Provides common tooling and test scenarios (including test cases and workloads) available to the community
  13 - Provides mechanisms and procedures for secure remote access to the test environment
  14
  15 Virtualized environments will be useful but do not provide a fully featured deployment/test capability.
  16
  17 The high level architecture may be summarized as follows:
  18
  19 .. image:: images/pharos-archi1.jpg
  20
  21 Constraints of a Pharos compliant OPNFV test-bed environment
  22 -------------------------------------------------------------
  23
  24 - One CentOS 7 Jump Server on which the virtualized Openstack/OPNFV installer runs
  25 - Desired installer - may be Fuel, Foreman, Juju, etc
  26 - 2 - 5 compute / controller nodes (`BGS <https://wiki.opnfv.org/get_started/get_started_work_environment>`_ requires 5 nodes)
  27 - Network topology allowing for LOM, Admin, Public, Private, and Storage Networks
  28 - Remote access
  29 - Test Tools
  30
  31 Target Systems State
  32 ---------------------
  33
  34 - Target system state includes default software components, network configuration, storage requirements `https://wiki.opnfv.org/get_started/get_started_system_state <https://wiki.opnfv.org/get_started/get_started_system_state>`
  35
  36
  37 Rls 1 specification is modeled from Arno
  38
  39 * First draft of environment for BGS https://wiki.opnfv.org/get_started/get_started_work_environment
  40 * Fuel environment https://wiki.opnfv.org/get_started/networkingblueprint
  41 * Foreman environment https://wiki.opnfv.org/get_started_experiment1#topology
  42
  43 Hardware
  44 ---------
  45
  46 **Servers**
  47
  48 CPU:
  49
  50 * Intel Xeon E5-2600v2 Series (Ivy Bridge and newer, or similar)
  51
  52 Local Storage Configuration:
  53
  54 Below describes the minimum for the Pharos spec, which is designed to provide enough capacity for a reasonably functional environment. Additional and/or faster disks are nice to have and may produce a better result.
  55
  56 * Disks: 2 x 1TB + 1 x 100GB SSD
  57 * The first 1TB HDD should be used for OS & additional software/tool installation
  58 * The second 1TB HDD configured for CEPH object storage
  59 * Finally, the 100GB SSD should be used as the CEPH journal
  60 * Performance testing requires a mix of compute nodes that have CEPH(swift+Cinder) and without CEPH storage
  61 * Virtual ISO boot capabilities or a separate PXE boot server (DHCP/tftp or Cobbler)
  62
  63 Memory:
  64
  65 * 32G RAM Minimum
  66
  67 Power Supply Single
  68
  69 * Single power supply acceptable (redundant power not required/nice to have)
  70
  71 **Provisioning**
  72
  73 Jump Server Installation
  74
  75 * OS: CentOS 7
  76 * KVM / Qemu
  77 * Installer (Foreman, Fuel, ...) in a VM
  78 * Tools
  79
  80 See `Jump Server Installation <https://wiki.opnfv.org/jump_server_installation_guide>`_ for detailed Jump Server installation details.
  81
  82 Test Tools
  83
  84 Jump Server - `functest <http://artifacts.opnfv.org/functest/docs/functest.html>`_
  85
  86 Controller nodes - bare metal
  87
  88 Compute nodes - bare metal
  89
  90 **Security**
  91
  92 - Servers
  93
  94   - Default permissions
  95   - Server Logins
  96   - **Pharos team needs to provide consistent usernames for infrastructure**
  97
  98 Remote management
  99 ------------------
 100
 101 **Remote access**
 102
 103 - Remote access is required for …
 104
 105   1. Developers to access deploy/test environments (credentials to be issued per POD / user)
 106   2. Connection of each environment to Jenkins master hosted by Linux Foundation for automated deployment and test
 107
 108 - VPN is optional and dependent on company security rules (out of Pharos scope)
 109 - POD access rules / restrictions …
 110
 111   - Refer to individual test-bed as each company may have different access rules and procedures
 112
 113 - Basic requirement is for SSH sessions to be established (initially on jump server)
 114 - Majority of packages installed on a system (tools or applications) will be pulled from an external storage solution so this type of things should be solved in a very general sense for the projects
 115
 116 Firewall rules
 117
 118 - SSH sessions
 119 - Jenkins sessions
 120
 121 Lights-out Management:
 122
 123 - Out-of-band management for power on/off/reset and bare-metal provisioning
 124 - Access to server is through lights-out-management tool and/or a serial console
 125 - Intel lights-out ⇒ RMM http://www.intel.com/content/www/us/en/server-management/intel-remote-management-module.html
 126 - HP lights-out ⇒ ILO http://www8.hp.com/us/en/products/servers/ilo/index.html
 127 - CISCO lights-out ⇒ UCS https://developer.cisco.com/site/ucs-dev-center/index.gsp
 128
 129 Linux Foundation - VPN service for accessing Lights-Out Management (LOM) infrastructure for the UCS-M hardware
 130
 131 - People with admin access to LF infrastructure:
 132
 133 1. amaged@cisco.com
 134 2. cogibbs@cisco.com
 135 3. daniel.smith@ericsson.com
 136 4. dradez@redhat.com
 137 5. fatih.degirmenci@ericsson.com
 138 6. fbrockne@cisco.com
 139 7. jonas.bjurel@ericsson.com
 140 8. jose.lausuch@ericsson.com
 141 9. joseph.gasparakis@intel.com
 142 10. morgan.richomme@orange.com
 143 11. pbandzi@cisco.com
 144 12. phladky@cisco.com
 145 13. stefan.k.berg@ericsson.com
 146 14. szilard.cserey@ericsson.com
 147 15. trozet@redhat.com
 148
 149 - The people who require VPN access must have a valid PGP key bearing a valid signature from one of these three people. When issuing OpenVPN credentials, LF will be sending TLS certificates and 2-factor authentication tokens, encrypted to each recipient's PGP key.
 150
 151 Networking
 152 -----------
 153
 154 Test-bed network
 155
 156 * 24 or 48 Port TOR Switch
 157 * NICS - 1GE, 10GE - per server can be on-board or PCI-e
 158 * Connectivity for each data/control network is through a separate NIC. This simplifies Switch Management however requires more NICs on the server and also more switch ports
 159 * Lights-out network can share with Admin/Management
 160
 161 Network Interfaces
 162
 163 * Option 1: 4x1G Control, 2x40G Data, 48 Port Switch
 164
 165   * 1 x 1G for ILMI (Lights out Management )
 166   * 1 x 1G for Admin/PXE boot
 167   * 1 x 1G for control Plane connectivity
 168   * 1 x 1G for storage
 169   * 2 x 40G (or 10G) for data network (redundancy, NIC bonding, High bandwidth testing)
 170
 171 * Option II: 1x1G Control, 2x 40G (or 10G) Data, 24 Port Switch
 172
 173   * Connectivity to networks is through VLANs on the Control NIC. Data NIC used for VNF traffic and storage traffic segmented through VLANs
 174
 175 * Option III: 2x1G Control, 2x10G Data, 2x40G Storage, 24 Port Switch
 176
 177   * Data NIC used for VNF traffic, storage NIC used for control plane and Storage segmented through VLANs (separate host traffic from VNF)
 178   * 1 x 1G for IPMI
 179   * 1 x 1G for Admin/PXE boot
 180   * 2 x 10G for control plane connectivity/Storage
 181   * 2 x 40G (or 10G) for data network
 182
 183 Storage Network
 184 ----------------
 185
 186 - Needs specification
 187
 188 ** Topology **
 189
 190 - Subnet, VLANs (want to standardize but may be constrained by existing lab setups or rules)
 191 - IPs
 192 - Types of NW - lights-out, public, private, admin, storage
 193 - May be special NW requirements for performance related projects
 194 - Default gateways
 195
 196 .. image:: images/bridge1.png
 197
 198 controller node bridge topology overview
 199
 200
 201 .. image:: images/bridge2.png
 202
 203 compute node bridge topology overview
 204
 205 Architecture
 206 -------------
 207
 208 ** Network Diagram **
 209
 210 The Pharos architecture may be described as follow: Figure 1: Standard Deployment Environment
 211
 212 .. image:: images/opnfv-pharos-diagram-v01.jpg
 213
 214 Figure 1: Standard Deployment Environment
 215
 216
 217 Tools
 218 ------
 219
 220 - Jenkins
 221 - Tempest / Rally
 222 - Robot
 223 - Git repository
 224 - Jira
 225 - FAQ channel
 226
 227 Sample Network Drawings
 228 -----------------------
 229
 230 Files for documenting lab network layout. These were contributed as Visio VSDX format compressed as a ZIP file. Here is a sample of what the visio looks like.
 231
 232 Download the visio zip file here: `opnfv-example-lab-diagram.vsdx.zip <https://wiki.opnfv.org/_media/opnfv-example-lab-diagram.vsdx.zip>`
 233
 234 .. image:: images/opnfv-example-lab-diagram.png
 235
 236 FYI: `Here <http://www.opendaylight.org/community/community-labs>` is what the OpenDaylight lab wiki pages look like.