Table of Contents
outline true

Introduction

...

Recommended Hardware requirements 64GB Memory and 32 CPU servers, QAT card and SRIOV network cards

Software Prerequisites

...

Other Installation Requirements

Jump Host

...

Requirements  <--- SM comment "Is jump host same as jump server? if yes, better to use same nomenclature thru out the doc" >>>

Jump server required to be installed with Ubuntu 18.04 server, and have 3 distinguished networks as shown in figure 11  <--- SM comment "This is redundant, is captured under HW and SW requirements" >>>

Jump server Hardware Requirements

...

Jump server Software Requirements:

    ICN R2 release support Ubuntu 18.04 - ICN BP install all required software during "make install"

...

<--- SM comment "DMZ may not mean anything to customer. Lets be consistent. Can we replace IF0, IF1 etc with Net A, Net BThis is redundant, is captured under HW and SW requirements" >>>

Jump server Software Requirements:

    ICN R2 release support Ubuntu 18.04 - ICN BP install all required software during "make install"

Network Requirements

Please refer the figure 1, for all the network requirement in ICN BP

Please make sure you have 3 distinguished networks net - Net A, Net B and Net C as mentioned in figure 1. Local controller uses the Net B and Net C to provision the Baremetal servers to do the OS provisioning.

...

Compute server Software Requirements:

The local controller will install all the software in compute servers right from OS, the software required to bring up the Kubernetes cluster

...

cluster <--- SM comment "local controller installs OS on compute servers?" >>>

Execution Requirements (Bare Metal Only)

ICN BP check all the precondition and execution requirements for both Baremetal and VM deploymentVM deployment <--- SM comment "Heading indicates only Baremetal but the text here mentions both types of deployments including VM" >>>

Installation High-Level Overview

...

• Installation of the local controller in the edge location.
• Installation of Compute cluster to run the workload invoked by the local controller in the edge location.

Baremetal Deployment Guide

Install Bare Metal

...

Jump Host <--- SM comment "Is Jump Host same as local Controller? The high level installation overview never mentions installing jump host" >>>

Creating a Node Inventory File

Preconfiguration for the local controller. <--- SM comment "local Controller or jump host? Please use one nomenclature. changing names is confusing" >>>

User required to provide the IPMI information of the edge server they required to connect to the local controller by editing node JSON sample file in the directory icn/deploy/metal3/scripts/nodes.json.sample as below. If you want to increase nodes, just add another array

{
  "nodes": [
    {
      "name": "edge01-node01",
      "ipmi_driver_info": {
        "username": "admin",
        "password": "admin",
        "address": "10.10.10.11"
      },
      "os": {
        "image_name": "bionic-server-cloudimg-amd64.img",
        "username": "ubuntu",
        "password": "mypasswd"
      }
    },
     {
      "name": "edge01-node02",
      "ipmi_driver_info": {
        "username": "admin",
        "password": "admin",
        "address": "10.10.10.12"
      },
      "os": {
        "image_name": "bionic-server-cloudimg-amd64.img",
        "username": "ubuntu",
        "password": "mypasswd"
      }
    }
  ]
}

Local controller Metal3 configuration Reference:

...

       <--- SM comment "Since we are doing a 3 compute node installation; it will be better to include 3 nodes in the json sample file above." >>>

• node: The array of nodes required to add to local controller
• name: Name of the Baremetal to be provisioned by Metal3, and this name will be the hostname for the machine, once it is provisioned
• ipmi_driver_info: IPMI driver info is a json field, currently holds the IPMI information required for Ironic to send the IPMI tool command
  • username: BMC username required to be provided for Ironic
  • password: BMC password required to be provided for Ironic
  • address: BMC server IPMI LAN IP address
• os: Baremetal machine OS information is a json field, currently holds the image name to be provisioned, username name and password for the login.
  • image_name: images name should be in qcow2 format
  • username: login username for the OS provisioned
  • password: login password for the OS provisioned

...

1. All the software required to run the bootstrap cluster is being downloaded and installed
2. Kubernetes cluster to maintain the Bootstrap cluster and all the servers in the edge location is installed
3. Metal3 specific network configuration such as local DHCP server networking for each edge location, Ironic networking for both provisioning network and IPMI LAN network are identified and created
4. Metal3 is launched with IPMI configuration as configured in "user_config.sh" and provision the Baremetal servers using IPMI LAN network. For more information refer the Debugging Failure section
5. Metal3 launch verification run without a timeout of 60 mins, by checking the status of all the servers being provisioned or not,
   1. All servers are provisioned parallelly. For example, if your deployment is having 10 servers in the edge location. All the 10 servers are provisioned at the same time
   2. Metal3 launch verification take care of checking all the servers are provisioned, the network interfaces are up and provisioned with a provider network gateway and DNS server
   3. Metal3 launch verification checks the status of all servers given in user_config.sh to make sure all the servers are provisioned. For example, if 8 servers are provisioned and 2 servers are not provisioned, Launch verification make sure all servers are provisioned before launch Kubernetes clusters on those servers
6. BPA Baremetal components are invoked with the mac address of the servers provisioned by metal3, BPA Baremetal components decide the cluster size and also the number of clusters required in the edge location
7. BPA Baremetal runs the containerized KUD as a job for each cluster. KUD install the kubernetes cluster on the slice of servers and install ONAP4k8s and all other default plugins such as Multus, OVN, OVN4NFV, NFD, Virtlet, SRIOV, QAT
8.   BPA rest agent installed in the bootstrap cluster or jump server, and this install rest-api, rook/ceph, Mimio as the cloud storage. This provides a way for user to upload their own software, container images or os image to jump server

...

Host server or Jump host required to install with ubuntu 18.04. This install all the VMs and install the k8s clusters. Same as Baremetal deployment use "make vm_install" to install Virtual deployment

Verifying the Setup - VMs

...

• For first time installation enable KVM console in the trial or lab servers using Raritan console or use Intel web bmc console
• Deprovision state will result ironic agent to sleeping before next heartbeat - It is not a error message. It Baremetal without OS and installed with ramdisk
• Deprovision in metal3 is not straight forward - Metal3 follow various stages from provisioned → deprovisioning → ready. ICN BP take care navigating the deprovisioning and removing the BMH CR in case of clean
• Manual BMH cleaning of bmh or force cleaning of bmh resource result in hang state - Use make bmh_clean to remove the bmh state.
• Logs of ironic, openstack baremetal command to see the state of the node.
• Logs of Baremetal operator gives failure related to images or images md5sum errors
• It is not possible to change the state from provision to deprovision or deprovision to provision without completing that state. All the issues are handled in ICN scripts
• Kubernetes cluster failure can be debugged by KUD pod logs

Reporting a Bug

Required Linux Foundation ID to launch bug in ICN: https://jira.akraino.org/projects/ICN/issues

...

• The command make clean_all unistall uninstall all the components installed by "make install" 
  • It
  deprovision
  • de-provision all the servers provisioned and remove them from Ironic database
  • Baremetal operator is deleted followed by Ironic database and container
  • Network configuration such internal dhcp server, provisioning
  interfces

Troubleshooting

Error Message Guide

Maintenance

Blue Print Package Maintenance

Software maintenance

Hardware maintenance

Blue Print Deployment Maintenance

Frequently Asked Questions

...

• • interfaces and IPMI LAN interfaces are deleted
  • docker images build during the "make install" are deleted , such all Ironic images, baremetal operator images, bpa operator images and KUD images 
  • KUD will reset the bootstrap cluster - Kubernetes cluster is teardown in the jump server and all the associated docker images are removed
  • All software packages installed by "make install_all" are removed, such Ironic , openstack utility tool, docker packages and basic prerequisite packages

Virtual deployment

The command "make vm_clean_all" uninstall all the components for the virtual deployments

Troubleshooting

Error Message Guide

The error message is explicit, all messages are captured in logs folder

Maintenance

Blue Print Package Maintenance

no packages is maintained in ICN R2

Software maintenance

not applicable

Hardware maintenance

not applicable

BluePrint Deployment Maintenance

not applicable

Frequently Asked Questions

How to setup IPMI?

First, make sure the IPMI tool is installed in your servers, if not install them using apt install ipmitool

Then, check for the ipmitool information of each servers using the command "ipmitool lan print 1"

If the above command doesn't show the IPMI information, then setup the IPMI static IP address using following instruction

• Mostly easy way to set up IPMI topology in your lab setup is by using IPMI tool. 
• Using IPMI tool - https://www.thomas-krenn.com/en/wiki/Configuring_IPMI_under_Linux_using_ipmitool
• IPMI information can be considered during the BIOS setting as well.

BMC web console url is not working?

It is hard to find issues or reason. Check the ipmitool bmc info to find the issues, if the url is not available

No change in bmh state - provisioning state is for more than 40min?

Generally metal3 provision for bare metal takes 20 - 30 mins. Look at the ironic logs and bare-metal operator to look at the state of nodes. Openstack baremetal node shows all state of the node right from power, storage.

Why provide network is required?

Generally, provider network DHCP servers in lab provide the router and dns server details. In some lab setup DHCP server don't provide this information.

License

/*
* Copyright 2019 Intel Corporation, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

References

Definitions, acronyms and abbreviations