Updates docs and scenarios for Euphrates
[apex.git] / docs / release / installation / requirements.rst
1 Setup Requirements
2 ==================
3
4 Jump Host Requirements
5 ---------------------
6
7 The Jump Host requirements are outlined below:
8
9 1.     CentOS 7 (from ISO or self-installed).
10
11 2.     Root access.
12
13 3.     libvirt virtualization support.
14
15 4.     minimum 1 networks and maximum 5 networks, multiple NIC and/or VLAN
16        combinations are supported.  This is virtualized for a VM deployment.
17
18 5.     The Euphrates Apex RPMs and their dependencies.
19
20 6.     16 GB of RAM for a bare metal deployment, 64 GB of RAM for a Virtual
21        Deployment.
22
23 Network Requirements
24 --------------------
25
26 Network requirements include:
27
28 1.     No DHCP or TFTP server running on networks used by OPNFV.
29
30 2.     1-5 separate networks with connectivity between Jump Host and nodes.
31
32        -  Control Plane (Provisioning)
33
34        -  Private Tenant-Networking Network*
35
36        -  External Network*
37
38        -  Storage Network*
39
40        -  Internal API Network* (required for IPv6 \*\*)
41
42 3.     Lights out OOB network access from Jump Host with IPMI node enabled
43        (bare metal deployment only).
44
45 4.     External network is a routable network from outside the cloud,
46        deployment. The External network is where public internet access would
47        reside if available.
48
49 \*These networks can be combined with each other or all combined on the
50 Control Plane network.
51
52 \*\*Internal API network, by default, is collapsed with provisioning in IPv4
53 deployments, this is not possible with the current lack of PXE boot
54 support and therefore the API network is required to be its own
55 network in an IPv6 deployment.
56
57 Bare Metal Node Requirements
58 ----------------------------
59
60 Bare metal nodes require:
61
62 1.     IPMI enabled on OOB interface for power control.
63
64 2.     BIOS boot priority should be PXE first then local hard disk.
65
66 3.     BIOS PXE interface should include Control Plane network mentioned above.
67
68 Execution Requirements (Bare Metal Only)
69 ----------------------------------------
70
71 In order to execute a deployment, one must gather the following information:
72
73 1.     IPMI IP addresses for the nodes.
74
75 2.     IPMI login information for the nodes (user/pass).
76
77 3.     MAC address of Control Plane / Provisioning interfaces of the overcloud
78        nodes.