Merge "Let kubespray install the correct docker versions"
[icn.git] / README.md
1 # Introduction
2 ICN strives to automate the process of installing the local cluster
3 controller to the greatest degree possible – "zero touch
4 installation". Most of the work is done simply by booting up the jump
5 server (Local Controller). Once booted, the controller is fully
6 provisioned and begins to inspect and provision the bare metal
7 servers, until the cluster is entirely configured. This document shows
8 step-by-step how to configure the network and deployment architecture
9 for the ICN blueprint.
10
11 # License
12 Apache license v2.0
13
14 # Deployment Architecture
15 The Local Controller is provisioned with the Metal3 Baremetal Operator
16 and Ironic, which enable provisioning of bare metal servers. The
17 controller has three network connections to the bare metal servers:
18 network A connects bare metal servers, network B is a private network
19 used for provisioning the bare metal servers and network C is the IPMI
20 network, used for control during provisioning. In addition, the
21 bare metal servers connect to the network D, the SRIOV network.
22
23 ![Figure 1](figure-1.png)*Figure 1: Deployment Architecture*
24
25 - Net A -- Bare metal network, lab networking for ssh. It is used as
26   the control plane for k8s, used by OVN and Flannel for the overlay
27   networking.
28 - Net B (internal network) -- Provisioning network used by Ironic to
29   do inspection.
30 - Net C (internal network) -- IPMI LAN to do IPMI protocol for the OS
31   provisioning. The NICs support IPMI. The IP address should be
32   statically assigned via the IPMI tool or other means.
33 - Net D (internal network) -- Data plane network for the Akraino
34   application. Using the SR-IOV networking and fiber cables.  Intel
35   25GB and 40GB FLV NICs.
36
37 In some deployment models, you can combine Net C and Net A to be the
38 same networks, but the developer should take care of IP address
39 management between Net A and IPMI address of the server.
40
41 Also note that the IPMI NIC may share the same RJ-45 jack with another
42 one of the NICs.
43
44 # Pre-installation Requirements
45 There are two main components in ICN Infra Local Controller - Local
46 Controller and k8s compute cluster.
47
48 ### Local Controller
49 The Local Controller will reside in the jump server to run the Metal3
50 operator, Binary Provisioning Agent (BPA) operator and BPA REST API
51 controller.
52
53 ### k8s Compute Cluster
54 The k8s compute cluster will actually run the workloads and is
55 installed on bare metal servers.
56
57 ## Hardware Requirements
58
59 ### Minimum Hardware Requirement
60 All-in-one VM based deployment requires servers with at least 32 GB
61 RAM and 32 CPUs.
62
63 ### Recommended Hardware Requirements
64 Recommended hardware requirements are servers with 64GB Memory, 32
65 CPUs and SRIOV network cards.
66
67 ## Software Prerequisites
68 The jump server is required to be pre-installed with Ubuntu 18.04.
69
70 ## Database Prerequisites
71 No prerequisites for ICN blueprint.
72
73 ## Other Installation Requirements
74
75 ### Jump Server Requirements
76
77 #### Jump Server Hardware Requirements
78 - Local Controller: at least three network interfaces.
79 - Bare metal servers: four network interfaces, including one IPMI interface.
80 - Four or more hubs, with cabling, to connect four networks.
81
82 (Tested as below)
83 Hostname | CPU Model | Memory | Storage | 1GbE: NIC#, VLAN, (Connected extreme 480 switch) | 10GbE: NIC# VLAN, Network (Connected with IZ1 switch)
84 ---------|-----------|--------|---------|--------------------------------------------------|------------------------------------------------------
85 jump0 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 |
86
87 #### Jump Server Software Requirements
88 ICN supports Ubuntu 18.04. The ICN blueprint installs all required
89 software during `make install`.
90
91 ### Network Requirements
92 Please refer to figure 1 for all the network requirements of the ICN
93 blueprint.
94
95 Please make sure you have 3 distinguished networks - Net A, Net B and
96 Net C as mentioned in figure 1. Local Controller uses the Net B and
97 Net C to provision the bare metal servers to do the OS provisioning.
98
99 ### Bare Metal Server Requirements
100
101 ### k8s Compute Cluster
102
103 #### Compute Server Hardware Requirements
104 (Tested as below)
105 Hostname | CPU Model | Memory | Storage | 1GbE: NIC#, VLAN, (Connected extreme 480 switch) | 10GbE: NIC# VLAN, Network (Connected with IZ1 switch)
106 ---------|-----------|--------|---------|--------------------------------------------------|------------------------------------------------------
107 node1 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
108 node2 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
109 node3 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
110
111 #### Compute Server Software Requirements
112 The Local Controller will install all the software in compute servers
113 from the OS to the software required to bring up the k8s cluster.
114
115 ### Execution Requirements (Bare Metal Only)
116 The ICN blueprint checks all the precondition and execution
117 requirements for bare metal.
118
119 # Installation High-Level Overview
120 Installation is two-step process and everything starts with one
121 command `make install`.
122 - Installation of the Local Controller.
123 - Installation of compute cluster.
124
125 ## Bare Metal Deployment Guide
126
127 ### Install Bare Metal Jump Server
128
129 #### Creating a Node Inventory File
130
131 ##### Preconfiguration for the Local Controller in Jump Server
132 The user is required to provide the IPMI information of the servers
133 they connect to the Local Controller by editing node JSON sample file
134 in the directory icn/deploy/metal3/scripts/nodes.json.sample as
135 below. This example only shows 2 servers, statically configured on the
136 baremetal network. If you want to increase servers, just add another
137 array.  If the baremetal network provides a DHCP server with gateway
138 and DNS server information, just change the baremetal type to "ipv4".
139 ICN provides DHCP servers for the provisioning network.
140
141 `node.json.sample`
142 ``` json
143 {
144   "nodes": [{
145     "name": "node1",
146     "ipmi_driver_info": {
147       "username": "admin",
148       "password": "admin",
149       "address": "10.10.10.11"
150     },
151     "os": {
152       "image_name": "bionic-server-cloudimg-amd64.img",
153       "username": "ubuntu",
154       "password": "mypasswd"
155     },
156     "net": {
157       "links": [
158         {
159           "id": "baremetal_nic",
160           "ethernet_mac_address": "00:1e:67:fe:f4:19",
161           "type": "phy"
162         },
163         {
164           "id": "provisioning_nic",
165           "ethernet_mac_address": "00:1e:67:fe:f4:1a",
166           "type": "phy"
167         },
168         {
169           "id": "sriov_nic",
170           "ethernet_mac_address": "00:1e:67:f8:6a:41",
171           "type": "phy"
172         }
173       ],
174       "networks": [
175         {
176           "id": "baremetal",
177           "link": "baremetal_nic",
178           "type": "ipv4",
179           "ip_address": "10.10.110.21/24",
180           "gateway": "10.10.110.1",
181           "dns_nameservers": ["8.8.8.8"]
182         },
183         {
184           "id": "provisioning",
185           "link": "provisioning_nic",
186           "type": "ipv4_dhcp"
187         },
188         {
189           "id": "sriov",
190           "link": "sriov_nic",
191           "type": "ipv4",
192           "ip_address": "10.10.113.2/24"
193         }
194       ],
195       "services": []
196     }
197   },
198   {
199     "name": "node2",
200     "ipmi_driver_info": {
201       "username": "admin",
202       "password": "admin",
203       "address": "10.10.10.12"
204     },
205     "os": {
206       "image_name": "bionic-server-cloudimg-amd64.img",
207       "username": "ubuntu",
208       "password": "mypasswd"
209     },
210     "net": {
211       "links": [
212         {
213           "id": "baremetal_nic",
214           "ethernet_mac_address": "00:1e:67:f1:5b:90",
215           "type": "phy"
216         },
217         {
218           "id": "provisioning_nic",
219           "ethernet_mac_address": "00:1e:67:f1:5b:91",
220           "type": "phy"
221         },
222         {
223           "id": "sriov_nic",
224           "ethernet_mac_address": "00:1e:67:f8:69:81",
225           "type": "phy"
226         }
227       ],
228       "networks": [
229         {
230           "id": "baremetal",
231           "link": "baremetal_nic",
232           "type": "ipv4",
233           "ip_address": "10.10.110.22/24",
234           "gateway": "10.10.110.1",
235           "dns_nameservers": ["8.8.8.8"]
236         },
237         {
238           "id": "provisioning",
239           "link": "provisioning_nic",
240           "type": "ipv4_dhcp"
241         },
242         {
243           "id": "sriov",
244           "link": "sriov_nic",
245           "type": "ipv4",
246           "ip_address": "10.10.113.3/24"
247         }
248       ],
249       "services": []
250     }
251   }]
252 }
253 ```
254
255 ##### Local Controller Metal3 Configuration Reference
256 - *node*: The array of nodes required to add to Local Controller.
257 - *name*: This will be the hostname for the machine, once it is
258   provisioned by Metal3.
259 - *ipmi_driver_info*: IPMI driver info is a json field. It currently
260   holds the IPMI information required for Ironic to send the IPMI tool
261   command.
262   - *username*: BMC username required to be provided for Ironic.
263   - *password*: BMC password required to be provided for Ironic.
264   - *address*: BMC server IPMI LAN IP address.
265 - *os*: Bare metal machine OS information is a json field. It
266   currently holds the image name to be provisioned, username and
267   password for the login.
268   - *image_name*: Images name should be in qcow2 format.
269   - *username*: Login username for the OS provisioned.
270   - *password*: Login password for the OS provisioned.
271 - *net*: Bare metal network information is a json field.  It describes
272   the interfaces and networks used by ICN.  For more information,
273   refer to the *networkData* field of the BareMetalHost resource
274   definition.
275   - *links*: An array of interfaces.
276         - *id*: The ID of the interface.  This is used in the network
277       definitions to associate the interface with its network
278       configuration.
279     - *ethernet_mac_address*: The MAC address of the interface.
280         - *type*: The type of interface.  Valid values are "phy".
281   - *networks*: An array of networks.
282     - *id*: The ID of the network.
283     - *link*: The ID of the link this network definition applies to.
284     - *type*: The type of network, either dynamic ("ipv4_dhcp") or
285       static ("ipv4").
286     - *ip_address*: Only valid for type "ipv4"; the IP address of the
287       interface.
288     - *gateway*: Only valid for type "ipv4"; the gateway of this
289       network.
290     - *dns_nameservers*: Only valid for type "ipv4"; an array of DNS
291       servers.
292
293 #### Creating the Settings Files
294
295 ##### Local Controller Network Configuration Reference
296 The user will find the network configuration file named as
297 "user_config.sh" in the ICN parent directory.
298
299 `user_config.sh`
300 ``` shell
301 #!/bin/bash
302
303 #Edge Location Provider Network configuration
304 #Net A - Provider Network
305 #If provider having specific Gateway and DNS server details in the edge location,
306 #supply those values in nodes.json.
307
308 #Ironic Metal3 settings for provisioning network
309 #Interface to which Ironic provision network to be connected
310 #Net B - Provisioning Network
311 export IRONIC_INTERFACE="eno2"
312
313 #Ironic Metal3 setting for IPMI LAN Network
314 #Interface to which Ironic IPMI LAN should bind
315 #Net C - IPMI LAN Network
316 export IRONIC_IPMI_INTERFACE="eno1"
317
318 #Interface IP for the IPMI LAN, ICN verfiy the LAN Connection is active or not
319 #Net C - IPMI LAN Network
320 export IRONIC_IPMI_INTERFACE_IP="10.10.10.10"
321 ```
322
323 #### Running
324 After configuring the node inventory file and network configuration
325 files, please run `make install` from the ICN parent directory as
326 shown below:
327
328 ``` shell
329 root@pod11-jump:# git clone "https://gerrit.akraino.org/r/icn"
330 Cloning into 'icn'...
331 remote: Counting objects: 69, done
332 remote: Finding sources: 100% (69/69)
333 remote: Total 4248 (delta 13), reused 4221 (delta 13)
334 Receiving objects: 100% (4248/4248), 7.74 MiB | 21.84 MiB/s, done.
335 Resolving deltas: 100% (1078/1078), done.
336 root@pod11-jump:# cd icn/
337 root@pod11-jump:# vim Makefile
338 root@pod11-jump:# make install
339 ```
340
341 The following steps occurs once the `make install` command is given.
342 1. All the software required to run the bootstrap cluster is
343    downloaded and installed.
344 2. k8s cluster to maintain the bootstrap cluster and all the servers
345    in the edge location is installed.
346 3. Metal3 specific network configuration such as local DHCP server
347    networking for each edge location, Ironic networking for both
348    provisioning network and IPMI LAN network are identified and
349    created.
350 4. Metal3 is launched with IPMI configuration as configured in
351    "user_config.sh" and provisions the bare metal servers using IPMI
352    LAN network. For more information refer to the [Debugging
353    Failures](#debugging-failures) section.
354 5. Metal3 launch verification runs with a timeout of 60 mins by
355    checking the status of all the servers being provisioned or not.
356    1. All servers are provisioned in parallel. For example, if your
357       deployment is having 10 servers in the edge location, all the 10
358       servers are provisioned at the same time.
359    2. Metal3 launch verification takes care of checking all the
360       servers are provisioned, the network interfaces are up and
361       provisioned with a provider network gateway and DNS server.
362    3. Metal3 launch verification checks the status of all servers
363       given in user_config.sh to make sure all the servers are
364       provisioned. For example, if 8 servers are provisioned and 2
365       servers are not provisioned, launch verification makes sure all
366       servers are provisioned before launch k8s clusters on those
367       servers.
368 6. BPA bare metal components are invoked with the MAC address of the
369    servers provisioned by Metal3, BPA bare metal components decide the
370    cluster size and also the number of clusters required in the edge
371    location.
372 7. BPA bare metal runs the containerized Kuberenetes Reference
373    Deployment (KUD) as a job for each cluster. KUD installs the k8s
374    cluster on the slice of servers and install ONAP4K8S and all other
375    default plugins such as Multus, OVN, OVN4NFV, NFD, Virtlet and
376    SRIOV.
377 8. BPA REST API agent installed in the bootstrap cluster or jump
378    server, and this install rest-api, rook/ceph, MinIO as the cloud
379    storage. This provides a way for user to upload their own software,
380    container images or OS image to jump server.
381
382 ## Virtual Deployment Guide
383
384 ### Standard Deployment Overview
385 ![Figure 2](figure-2.png)*Figure 2: Virtual Deployment Architecture*
386
387 Virtual deployment is used for the development environment using
388 Metal3 virtual deployment to create VM with PXE boot. VM Ansible
389 scripts the node inventory file in /opt/ironic. No setting is required
390 from the user to deploy the virtual deployment.
391
392 ### Snapshot Deployment Overview
393 No snapshot is implemented in ICN R2.
394
395 ### Special Requirements for Virtual Deployment
396
397 #### Install Jump Server
398 Jump server is required to be installed with Ubuntu 18.04. This will
399 install all the VMs and install the k8s clusters.
400
401 #### Verifying the Setup - VMs
402 `make verify_all` installs two VMs with name master-0 and worker-0
403 with 8GB RAM and 8 vCPUs and installs k8s cluster on the VMs using the
404 ICN BPA operator and install the ICN BPA REST API verifier. BPA
405 operator installs the multi-cluster KUD to bring up k8s with all
406 addons and plugins.
407
408 # Verifying the Setup
409 ICN blueprint checks all the setup in both bare metal and VM
410 deployment. Verify script will check that Metal3 provisioned the OS in
411 each bare metal servers by checking with a timeout period of 60 sec
412 and interval of 30. BPA operator verifier will check whether the KUD
413 installation is complete by doing plain curl command to the k8s
414 cluster installed in bare metal and VM setup.
415
416 **Bare Metal Verifier**: Run the `make bm_verifer`, it will verify the
417 bare-metal deployment.
418
419 **Verifier**: Run the `make vm_verifier`, it will verify the virtual
420 deployment.
421
422 # Developer Guide and Troubleshooting
423 For development uses the virtual deployment, it take up to 10 mins to
424 bring up the virtual BMC VMs with PXE boot.  Virtual deployment works
425 well for the BPA operator development for Metal3 installation scripts.
426
427 ## Utilization of Images
428 No images provided in this ICN release.
429
430 ## Post-deployment Configuration
431 No post-deployment configuration required in this ICN release.
432
433 ## Debugging Failures
434 * For first time installation enable KVM console in the trial or lab
435   servers using Raritan console or use Intel web BMC console.
436
437   ![Figure 3](figure-3.png)
438 * Deprovision state will result in Ironic agent sleeping before next
439   heartbeat - it is not an error. It results in bare metal server
440   without OS and installed with ramdisk.
441 * Deprovision in Metal3 is not straight forward - Metal3 follows
442   various stages from provisioned, deprovisioning and ready. ICN
443   blueprint take care navigating the deprovisioning states and
444   removing the BareMetalHost (BMH) custom resouce in case of cleaning.
445 * Manual BMH cleaning of BMH or force cleaning of BMH resource result
446   in hang state - use `make bmh_clean` to remove the BMH state.
447 * Logs of Ironic, openstack baremetal command to see the state of the
448   server.
449 * Logs of baremetal operator gives failure related to images or images
450   md5sum errors.
451 * It is not possible to change the state from provision to deprovision
452   or deprovision to provision without completing that state. All the
453   issues are handled in ICN scripts.
454 * k8s cluster failure can be debugged by KUD Pod logs.
455
456 ## Reporting a Bug
457 Required Linux Foundation ID to launch bug in ICN:
458 https://jira.akraino.org/projects/ICN/issues
459
460 # Uninstall Guide
461
462 ## Bare Metal deployment
463 The command `make clean_all` uninstalls all the components installed by
464 `make install`
465 * It de-provision all the servers provisioned and removes them from
466   Ironic database.
467 * Baremetal operator is deleted followed by Ironic database and
468   container.
469 * Network configuration such internal DHCP server, provisioning
470   interfaces and IPMI LAN interfaces are deleted.
471 * docker images built during the `make install` are deleted, such as
472   all Ironic, baremetal operator, BPA operator and KUD images.
473 * KUD will reset the bootstrap cluster - k8s cluster is torn down in
474   the jump server and all the associated docker images are removed.
475 * All software packages installed by `make install_all` are removed,
476   such as Ironic, openstack utility tool, docker packages and basic
477   prerequisite packages.
478
479 ## Virtual deployment
480 The command `make vm_clean_all` uninstalls all the components for the
481 virtual deployments.
482
483 # Troubleshooting
484
485 ## Error Message Guide
486 The error message is explicit, all messages are captured in log
487 directory.
488
489 # Maintenance
490
491 ## Blueprint Package Maintenance
492 No packages are maintained in ICN.
493
494 ## Software maintenance
495 Not applicable.
496
497 ## Hardware maintenance
498 Not applicable.
499
500 ## BluePrint Deployment Maintenance
501 Not applicable.
502
503 # Frequently Asked Questions
504 **How to setup IPMI?**
505
506 First, make sure the IPMI tool is installed in your servers, if not
507 install them using `apt install ipmitool`. Then, check for the
508 ipmitool information of each servers using the command `ipmitool lan
509 print 1`. If the above command doesn't show the IPMI information, then
510 setup the IPMI static IP address using the following instructions:
511 - Mostl easy way to set up IPMI topology in your lab setup is by
512   using IPMI tool.
513 - Using IPMI tool -
514   https://www.thomas-krenn.com/en/wiki/Configuring_IPMI_under_Linux_using_ipmitool
515 - IPMI information can be considered during the BIOS setting as well.
516
517 **BMC web console URL is not working?**
518
519 It is hard to find issues or reason. Check the ipmitool bmc info to
520 find the issues, if the URL is not available.
521
522 **No change in BMH state - provisioning state is for more than 40min?**
523
524 Generally, Metal3 provision for bare metal takes 20 - 30 mins. Look at
525 the Ironic logs and baremetal operator to look at the state of
526 servers. Openstack baremetal node shows all state of the server right
527 from power, storage.
528
529 **Why provider network (baremetal network configuration) is required?**
530
531 Generally, provider network DHCP servers in a lab provide the router
532 and DNS server details. In some labs, there is no DHCP server or the
533 DHCP server does not provide this information.
534
535 # License
536
537 ```
538 /*
539 * Copyright 2019 Intel Corporation, Inc
540 *
541 * Licensed under the Apache License, Version 2.0 (the "License");
542 * you may not use this file except in compliance with the License.
543 * You may obtain a copy of the License at
544 *
545 * http://www.apache.org/licenses/LICENSE-2.0
546 *
547 * Unless required by applicable law or agreed to in writing, software
548 * distributed under the License is distributed on an "AS IS" BASIS,
549 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
550 * See the License for the specific language governing permissions and
551 * limitations under the License.
552 */
553 ```
554
555 # References
556
557 # Definitions, acronyms and abbreviations