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". Once the jump server (Local Controller) is booted and
   5 the compute cluster-specific values are provided, the controller
   6 begins to inspect and provision the bare metal servers until the
   7 cluster is entirely configured. This document shows step-by-step how
   8 to configure the network and deployment architecture for the ICN
   9 blueprint.
  10
  11 # License
  12 Apache license v2.0
  13
  14 # Deployment Architecture
  15 The Local Controller is provisioned with the Cluster API controllers
  16 and the Metal3 infrastructure provider, which enable provisioning of
  17 bare metal servers. The controller has three network connections to
  18 the bare metal servers: network A connects bare metal servers, network
  19 B is a private network used for provisioning the bare metal servers
  20 and network C is the IPMI network, used for control during
  21 provisioning. In addition, the bare metal servers connect to the
  22 network D, the SRIOV network.
  23
  24 ![Figure 1](figure-1.png)*Figure 1: Deployment Architecture*
  25
  26 - Net A -- Bare metal network, lab networking for ssh. It is used as
  27   the control plane for K8s, used by OVN and Flannel for the overlay
  28   networking.
  29 - Net B (internal network) -- Provisioning network used by Ironic to
  30   do inspection.
  31 - Net C (internal network) -- IPMI LAN to do IPMI protocol for the OS
  32   provisioning. The NICs support IPMI. The IP address should be
  33   statically assigned via the IPMI tool or other means.
  34 - Net D (internal network) -- Data plane network for the Akraino
  35   application. Using the SR-IOV networking and fiber cables.  Intel
  36   25GB and 40GB FLV NICs.
  37
  38 In some deployment models, you can combine Net C and Net A to be the
  39 same networks, but the developer should take care of IP address
  40 management between Net A and IPMI address of the server.
  41
  42 Also note that the IPMI NIC may share the same RJ-45 jack with another
  43 one of the NICs.
  44
  45 # Pre-installation Requirements
  46 There are two main components in ICN Infra Local Controller - Local
  47 Controller and K8s compute cluster.
  48
  49 ### Local Controller
  50 The Local Controller will reside in the jump server to run the Cluster
  51 API controllers with the Kubeadm bootstrap provider and Metal3
  52 infrastructure provider.
  53
  54 ### K8s Compute Cluster
  55 The K8s compute cluster will actually run the workloads and is
  56 installed on bare metal servers.
  57
  58 ## Hardware Requirements
  59
  60 ### Minimum Hardware Requirement
  61 All-in-one VM based deployment requires servers with at least 32 GB
  62 RAM and 32 CPUs.
  63
  64 ### Recommended Hardware Requirements
  65 Recommended hardware requirements are servers with 64GB Memory, 32
  66 CPUs and SRIOV network cards.
  67
  68 ## Software Prerequisites
  69 The jump server is required to be pre-installed with Ubuntu 18.04.
  70
  71 ## Database Prerequisites
  72 No prerequisites for ICN blueprint.
  73
  74 ## Other Installation Requirements
  75
  76 ### Jump Server Requirements
  77
  78 #### Jump Server Hardware Requirements
  79 - Local Controller: at least three network interfaces.
  80 - Bare metal servers: four network interfaces, including one IPMI interface.
  81 - Four or more hubs, with cabling, to connect four networks.
  82
  83 (Tested as below)
  84 Hostname | CPU Model | Memory | Storage | 1GbE: NIC#, VLAN, (Connected extreme 480 switch) | 10GbE: NIC# VLAN, Network (Connected with IZ1 switch)
  85 ---------|-----------|--------|---------|--------------------------------------------------|------------------------------------------------------
  86 jump0 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 |
  87
  88 #### Jump Server Software Requirements
  89 ICN supports Ubuntu 18.04. The ICN blueprint installs all required
  90 software during `make jump_server`.
  91
  92 ### Network Requirements
  93 Please refer to figure 1 for all the network requirements of the ICN
  94 blueprint.
  95
  96 Please make sure you have 3 distinguished networks - Net A, Net B and
  97 Net C as mentioned in figure 1. Local Controller uses the Net B and
  98 Net C to provision the bare metal servers to do the OS provisioning.
  99
 100 ### Bare Metal Server Requirements
 101
 102 ### K8s Compute Cluster
 103
 104 #### Compute Server Hardware Requirements
 105 (Tested as below)
 106 Hostname | CPU Model | Memory | Storage | 1GbE: NIC#, VLAN, (Connected extreme 480 switch) | 10GbE: NIC# VLAN, Network (Connected with IZ1 switch)
 107 ---------|-----------|--------|---------|--------------------------------------------------|------------------------------------------------------
 108 node1 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
 109 node2 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
 110 node3 | Intel 2xE5-2699 | 64GB | 3TB (Sata)<br/>180 (SSD) | eth0: VLAN 110<br/>eno1: VLAN 110<br/>eno2: VLAN 111 | eno3: VLAN 113
 111
 112 #### Compute Server Software Requirements
 113 The Local Controller will install all the software in compute servers
 114 from the OS to the software required to bring up the K8s cluster.
 115
 116 ### Execution Requirements (Bare Metal Only)
 117 The ICN blueprint checks all the precondition and execution
 118 requirements for bare metal.
 119
 120 # Installation High-Level Overview
 121 Installation is two-step process:
 122 - Installation of the Local Controller.
 123 - Installation of a compute cluster.
 124
 125 ## Bare Metal Deployment Guide
 126
 127 ### Install Bare Metal Jump Server
 128
 129 #### Creating the Settings Files
 130
 131 ##### Local Controller Network Configuration Reference
 132 The user will find the network configuration file named as
 133 "user_config.sh" in the ICN parent directory.
 134
 135 `user_config.sh`
 136 ``` shell
 137 #!/bin/bash
 138
 139 #Ironic Metal3 settings for provisioning network (Net B)
 140 export IRONIC_INTERFACE="eno2"
 141
 142 #Ironic Metal3 setting for IPMI LAN Network (Net C)
 143 export IRONIC_IPMI_INTERFACE="eno1"
 144 ```
 145
 146 #### Running
 147 After configuring the network configuration file, please run `make
 148 jump_server` from the ICN parent directory as shown below:
 149
 150 ``` shell
 151 root@jump0:# git clone "https://gerrit.akraino.org/r/icn"
 152 Cloning into 'icn'...
 153 remote: Counting objects: 69, done
 154 remote: Finding sources: 100% (69/69)
 155 remote: Total 4248 (delta 13), reused 4221 (delta 13)
 156 Receiving objects: 100% (4248/4248), 7.74 MiB | 21.84 MiB/s, done.
 157 Resolving deltas: 100% (1078/1078), done.
 158 root@jump0:# cd icn/
 159 root@jump0:# make jump_server
 160 ```
 161
 162 The following steps occurs once the `make jump_server` command is
 163 given.
 164 1. All the software required to run the bootstrap cluster is
 165    downloaded and installed.
 166 2. K8s cluster to maintain the bootstrap cluster and all the servers
 167    in the edge location is installed.
 168 3. Metal3 specific network configuration such as local DHCP server
 169    networking for each edge location, Ironic networking for both
 170    provisioning network and IPMI LAN network are identified and
 171    created.
 172 4. The Cluster API controllers, bootstrap, and infrastructure
 173    providers and configured and installed.
 174 5. The Flux controllers are installed.
 175
 176 #### Creating a compute cluster
 177 A compute cluster is composed of installations of two types of Helm
 178 charts: machine and cluster. The specific installations of these Helm
 179 charts are defined in HelmRelease resources consumed by the Flux
 180 controllers in the jump server. The user is required to provide the
 181 machine and cluster specific values in the HelmRelease resources.
 182
 183 ##### Preconfiguration for the compute cluster in Jump Server
 184 The user is required to provide the IPMI information of the servers
 185 and the values of the compute cluster they connect to the Local
 186 Controller.
 187
 188 If the baremetal network provides a DHCP server with gateway and DNS
 189 server information, and each server has identical hardware then a
 190 cluster template can be used. Otherwise these values must also be
 191 provided with the values for each server. Refer to the machine chart
 192 in icn/deploy/machine for more details. In the example below, no DHCP
 193 server is present in the baremetal network.
 194
 195 `site.yaml`
 196 ``` yaml
 197 apiVersion: v1
 198 kind: Namespace
 199 metadata:
 200     name: metal3
 201 ---
 202 apiVersion: source.toolkit.fluxcd.io/v1beta1
 203 kind: GitRepository
 204 metadata:
 205     name: icn
 206     namespace: metal3
 207 spec:
 208     gitImplementation: go-git
 209     interval: 1m0s
 210     ref:
 211         branch: master
 212     timeout: 20s
 213     url: https://gerrit.akraino.org/r/icn
 214 ---
 215 apiVersion: helm.toolkit.fluxcd.io/v2beta1
 216 kind: HelmRelease
 217 metadata:
 218     name: machine-node1
 219     namespace: metal3
 220 spec:
 221     interval: 5m
 222     chart:
 223         spec:
 224             chart: deploy/machine
 225             sourceRef:
 226                 kind: GitRepository
 227                 name: icn
 228             interval: 1m
 229     values:
 230         machineName: node1
 231         machineLabels:
 232             machine: node1
 233         bmcAddress: ipmi://10.10.110.11
 234         bmcUsername: admin
 235         bmcPassword: password
 236         networks:
 237             baremetal:
 238                 macAddress: 00:1e:67:fe:f4:19
 239                 type: ipv4
 240                 ipAddress: 10.10.110.21/24
 241                 gateway: 10.10.110.1
 242                 nameservers: ["8.8.8.8"]
 243             provisioning:
 244                 macAddress: 00:1e:67:fe:f4:1a
 245                 type: ipv4_dhcp
 246             sriov:
 247                 macAddress: 00:1e:67:f8:6a:41
 248                 type: ipv4
 249                 ipAddress: 10.10.113.3/24
 250 ---
 251 apiVersion: helm.toolkit.fluxcd.io/v2beta1
 252 kind: HelmRelease
 253 metadata:
 254     name: machine-node2
 255     namespace: metal3
 256 spec:
 257     interval: 5m
 258     chart:
 259         spec:
 260             chart: deploy/machine
 261             sourceRef:
 262                 kind: GitRepository
 263                 name: icn
 264             interval: 1m
 265     values:
 266         machineName: node2
 267         machineLabels:
 268             machine: node2
 269         bmcAddress: ipmi://10.10.110.12
 270         bmcUsername: admin
 271         bmcPassword: password
 272         networks:
 273             baremetal:
 274                 macAddress: 00:1e:67:f1:5b:90
 275                 type: ipv4
 276                 ipAddress: 10.10.110.22/24
 277                 gateway: 10.10.110.1
 278                 nameservers: ["8.8.8.8"]
 279             provisioning:
 280                 macAddress: 00:1e:67:f1:5b:91
 281                 type: ipv4_dhcp
 282             sriov:
 283                 macAddress: 00:1e:67:f8:69:81
 284                 type: ipv4
 285                 ipAddress: 10.10.113.4/24
 286 ---
 287 apiVersion: helm.toolkit.fluxcd.io/v2beta1
 288 kind: HelmRelease
 289 metadata:
 290     name: cluster-compute
 291     namespace: metal3
 292 spec:
 293     interval: 5m
 294     chart:
 295         spec:
 296             chart: deploy/cluster
 297             sourceRef:
 298                 kind: GitRepository
 299                 name: icn
 300             interval: 1m
 301     values:
 302         clusterName: compute
 303         controlPlaneEndpoint: 10.10.110.21
 304         controlPlaneHostSelector:
 305             matchLabels:
 306                 machine: node1
 307         workersHostSelector:
 308             matchLabels:
 309                 machine: node2
 310         userData:
 311             hashedPassword: $6$rounds=10000$PJLOBdyTv23pNp$9RpaAOcibbXUMvgJScKK2JRQioXW4XAVFMRKqgCB5jC4QmtAdbA70DU2jTcpAd6pRdEZIaWFjLCNQMBmiiL40.
 312             sshAuthorizedKey: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCrxu+fSrU51vgAO5zP5xWcTU8uLv4MkUZptE2m1BJE88JdQ80kz9DmUmq2AniMkVTy4pNeUW5PsmGJa+anN3MPM99CR9I37zRqy5i6rUDQgKjz8W12RauyeRMIBrbdy7AX1xasoTRnd6Ta47bP0egiFb+vUGnlTFhgfrbYfjbkJhVfVLCTgRw8Yj0NSK16YEyhYLbLXpix5udRpXSiFYIyAEWRCCsWJWljACr99P7EF82vCGI0UDGCCd/1upbUwZeTouD/FJBw9qppe6/1eaqRp7D36UYe3KzLpfHQNgm9AzwgYYZrD4tNN6QBMq/VUIuam0G1aLgG8IYRLs41HYkJ root@jump0
 313         flux:
 314             url: https://gerrit.akraino.org/r/icn
 315             branch: master
 316             path: ./deploy/site/cluster-e2etest
 317 ```
 318
 319 A brief overview of the values is below. Refer to the machine and
 320 cluster charts in deploy/machine and deploy/cluster respectively for
 321 more details.
 322
 323 - *machineName*: This will be the hostname for the machine, once it is
 324   provisioned by Metal3.
 325 - *bmcUsername*: BMC username required to be provided for Ironic.
 326 - *bmcPassword*: BMC password required to be provided for Ironic.
 327 - *bmcAddress*: BMC server IPMI LAN IP address.
 328 - *networks*: A dictionary of the networks used by ICN.  For more
 329   information, refer to the *networkData* field of the BareMetalHost
 330   resource definition.
 331   - *macAddress*: The MAC address of the interface.
 332   - *type*: The type of network, either dynamic ("ipv4_dhcp") or
 333     static ("ipv4").
 334   - *ipAddress*: Only valid for type "ipv4"; the IP address of the
 335     interface.
 336   - *gateway*: Only valid for type "ipv4"; the gateway of this
 337     network.
 338   - *nameservers*: Only valid for type "ipv4"; an array of DNS
 339      servers.
 340 - *clusterName*: The name of the cluster.
 341 - *controlPlaneEndpoint*: The K8s control plane endpoint. This works
 342   in cooperation with the *controlPlaneHostSelector* to ensure that it
 343   addresses the control plane node.
 344 - *controlPlaneHostSelector*: A K8s match expression against labels on
 345   the *BareMetalHost* machine resource (from the *machineLabels* value
 346   of the machine Helm chart).  This will be used by Cluster API to
 347   select machines for the control plane.
 348 - *workersHostSelector*: A K8s match expression selecting worker
 349   machines.
 350 - *userData*: User data values to be provisioned into each machine in
 351   the cluster.
 352   - *hashedPassword*: The hashed password of the default user on each
 353     machine.
 354   - *sshAuthorizedKey*: An authorized public key of the *root* user on
 355     each machine.
 356 - *flux*: An optional repository to continuously reconcile the created
 357   K8s cluster against.
 358
 359 #### Running
 360 After configuring the machine and cluster site values, the next steps
 361 are to encrypt the secrets contained in the file, commit the file to
 362 source control, and create the Flux resources on the jump server
 363 pointing to the committed files.
 364
 365 1. Create a key protect the secrets in the values if one does not
 366    already exist. The key created below will be named "site-secrets".
 367
 368 ``` shell
 369 root@jump0:# ./deploy/site/site.sh create-gpg-key site-secrets
 370 ```
 371
 372 2. Encrypt the secrets in the site values.
 373
 374 ``` shell
 375 root@jump0:# ./deploy/site/site.sh sops-encrypt-site site.yaml site-secrets
 376 ```
 377
 378 3. Commit the site.yaml and additional files (sops.pub.asc,
 379    .sops.yaml) created by sops-encrypt-site to a Git repository. For
 380    the purposes of the next step, site.yaml will be committed to a Git
 381    repository hosted at URL, on the specified BRANCH, and at location
 382    PATH inside the source tree.
 383
 384 4. Create the Flux resources to deploy the resources described by the
 385    repository in step 3. This creates a GitRepository resource
 386    containing the URL and BRANCH to synchronize, a Secret resource
 387    containing the private key used to decrypt the secrets in the site
 388    values, and a Kustomization resource with the PATH to the site.yaml
 389    file at the GitRepository.
 390
 391 ```shell
 392 root@jump0:# ./deploy/site/site.sh flux-create-site URL BRANCH PATH site-secrets
 393 ```
 394
 395 The progress of the deployment may be monitored in a number of ways:
 396
 397 ``` shell
 398 root@jump0:# kubectl -n metal3 get baremetalhost
 399 root@jump0:# kubectl -n metal3 get cluster compute
 400 root@jump0:# clusterctl -n metal3 describe cluster compute
 401 ```
 402
 403 When the control plane is ready, the kubeconfig can be obtained with
 404 clusterctl and used to access the compute cluster:
 405
 406 ``` shell
 407 root@jump0:# clusterctl -n metal3 get kubeconfig compute >compute-admin.conf
 408 root@jump0:# kubectl --kubeconfig=compute-admin.conf cluster-info
 409 ```
 410
 411 ## Virtual Deployment Guide
 412
 413 ### Standard Deployment Overview
 414 ![Figure 2](figure-2.png)*Figure 2: Virtual Deployment Architecture*
 415
 416 Virtual deployment is used for the development environment using
 417 Vagrant to create VMs with PXE boot. No setting is required from the
 418 user to deploy the virtual deployment.
 419
 420 ### Snapshot Deployment Overview
 421 No snapshot is implemented in ICN R6.
 422
 423 ### Special Requirements for Virtual Deployment
 424
 425 #### Install Jump Server
 426 Jump server is required to be installed with Ubuntu 18.04. This will
 427 install all the VMs and install the K8s clusters.
 428
 429 #### Verifying the Setup - VMs
 430 To verify the virtual deployment, execute the following commands:
 431 ``` shell
 432 $ vagrant up --no-parallel
 433 $ vagrant ssh jump
 434 vagrant@jump:~$ sudo su
 435 root@jump:/home/vagrant# cd /icn
 436 root@jump:/icn# make jump_server
 437 root@jump:/icn# make vm_cluster
 438 ```
 439 `vagrant up --no-parallel` creates three VMs: vm-jump, vm-machine-1,
 440 and vm-machine-2, each with 16GB RAM and 8 vCPUs. `make jump_server`
 441 installs the jump server components into vm-jump, and `make
 442 vm_cluster` installs a K8s cluster on the vm-machine VMs using Cluster
 443 API. The cluster is configured to use Flux to bring up the cluster
 444 with all addons and plugins.
 445
 446 # Verifying the Setup
 447 ICN blueprint checks all the setup in both bare metal and VM
 448 deployment. Verify script will first confirm that the cluster control
 449 plane is ready then run self tests of all addons and plugins.
 450
 451 **Bare Metal Verifier**: Run the `make bm_verifer`, it will verify the
 452 bare-metal deployment.
 453
 454 **Verifier**: Run the `make vm_verifier`, it will verify the virtual
 455 deployment.
 456
 457 # Developer Guide and Troubleshooting
 458 For development uses the virtual deployment, it take up to 10 mins to
 459 bring up the virtual BMC VMs with PXE boot.
 460
 461 ## Utilization of Images
 462 No images provided in this ICN release.
 463
 464 ## Post-deployment Configuration
 465 No post-deployment configuration required in this ICN release.
 466
 467 ## Debugging Failures
 468 * For first time installation enable KVM console in the trial or lab
 469   servers using Raritan console or use Intel web BMC console.
 470
 471   ![Figure 3](figure-3.png)
 472 * Deprovision state will result in Ironic agent sleeping before next
 473   heartbeat - it is not an error. It results in bare metal server
 474   without OS and installed with ramdisk.
 475 * Deprovision in Metal3 is not straight forward - Metal3 follows
 476   various stages from provisioned, deprovisioning and ready. ICN
 477   blueprint take care navigating the deprovisioning states and
 478   removing the BareMetalHost (BMH) custom resouce in case of cleaning.
 479 * Manual BMH cleaning of BMH or force cleaning of BMH resource result
 480   in hang state - use `make bmh_clean` to remove the BMH state.
 481 * Logs of Ironic, openstack baremetal command to see the state of the
 482   server.
 483 * Logs of baremetal operator gives failure related to images or images
 484   md5sum errors.
 485 * It is not possible to change the state from provision to deprovision
 486   or deprovision to provision without completing that state. All the
 487   issues are handled in ICN scripts.
 488
 489 ## Reporting a Bug
 490 Required Linux Foundation ID to launch bug in ICN:
 491 https://jira.akraino.org/projects/ICN/issues
 492
 493 # Uninstall Guide
 494
 495 ## Bare Metal deployment
 496 The command `make clean_all` uninstalls all the components installed by
 497 `make install`
 498 * It de-provision all the servers provisioned and removes them from
 499   Ironic database.
 500 * Baremetal operator is deleted followed by Ironic database and
 501   container.
 502 * Network configuration such internal DHCP server, provisioning
 503   interfaces and IPMI LAN interfaces are deleted.
 504 * It will reset the bootstrap cluster - K8s cluster is torn down in
 505   the jump server and all the associated docker images are removed.
 506 * All software packages installed by `make jump_server` are removed,
 507   such as Ironic, openstack utility tool, docker packages and basic
 508   prerequisite packages.
 509
 510 ## Virtual deployment
 511 The command `vagrant destroy -f` uninstalls all the components for the
 512 virtual deployments.
 513
 514 # Troubleshooting
 515
 516 ## Error Message Guide
 517 The error message is explicit, all messages are captured in log
 518 directory.
 519
 520 # Maintenance
 521
 522 ## Blueprint Package Maintenance
 523 No packages are maintained in ICN.
 524
 525 ## Software maintenance
 526 Not applicable.
 527
 528 ## Hardware maintenance
 529 Not applicable.
 530
 531 ## BluePrint Deployment Maintenance
 532 Not applicable.
 533
 534 # Frequently Asked Questions
 535 **How to setup IPMI?**
 536
 537 First, make sure the IPMI tool is installed in your servers, if not
 538 install them using `apt install ipmitool`. Then, check for the
 539 ipmitool information of each servers using the command `ipmitool lan
 540 print 1`. If the above command doesn't show the IPMI information, then
 541 setup the IPMI static IP address using the following instructions:
 542 - Mostl easy way to set up IPMI topology in your lab setup is by
 543   using IPMI tool.
 544 - Using IPMI tool -
 545   https://www.thomas-krenn.com/en/wiki/Configuring_IPMI_under_Linux_using_ipmitool
 546 - IPMI information can be considered during the BIOS setting as well.
 547
 548 **BMC web console URL is not working?**
 549
 550 It is hard to find issues or reason. Check the ipmitool bmc info to
 551 find the issues, if the URL is not available.
 552
 553 **No change in BMH state - provisioning state is for more than 40min?**
 554
 555 Generally, Metal3 provision for bare metal takes 20 - 30 mins. Look at
 556 the Ironic logs and baremetal operator to look at the state of
 557 servers. Openstack baremetal node shows all state of the server right
 558 from power, storage.
 559
 560 **Why provider network (baremetal network configuration) is required?**
 561
 562 Generally, provider network DHCP servers in a lab provide the router
 563 and DNS server details. In some labs, there is no DHCP server or the
 564 DHCP server does not provide this information.
 565
 566 # License
 567
 568 ```
 569 /*
 570 * Copyright 2019 Intel Corporation, Inc
 571 *
 572 * Licensed under the Apache License, Version 2.0 (the "License");
 573 * you may not use this file except in compliance with the License.
 574 * You may obtain a copy of the License at
 575 *
 576 * http://www.apache.org/licenses/LICENSE-2.0
 577 *
 578 * Unless required by applicable law or agreed to in writing, software
 579 * distributed under the License is distributed on an "AS IS" BASIS,
 580 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 581 * See the License for the specific language governing permissions and
 582 * limitations under the License.
 583 */
 584 ```
 585
 586 # References
 587
 588 # Definitions, acronyms and abbreviations