A10 Harmony Controller Installation

A10 Harmony Controller can be installed on either of the two types of resources:

  1. A10 Hardware Appliances
    Harmony Controller 2000 or Harmony Controller 8000.
  2. Custom Resources
    Generic hardware or Virtual Machines (VMs) provided by the customer.

Overall Installation Steps

Following steps should be carried out for installing the Harmony Controller software on custom resources:

  1. Prepare the environment
    Create VMs with required resources, networking, storage etc. In case of A10 hardware appliances, VM images of appropriate sizes are placed inside the appliances. Networking for the appliances and VMs needs to be set-up as well.
  2. Download the Harmony Controller Installer
    Installer is a tar file of the install scripts that needs to be download on the VM. If Internet access is not available during installation, required packages and Docker images need to be downloaded. In case of A10 hardware appliances, this step is not required as the installer packages of the appropriate version is already placed inside the appliances.
  3. Unpack and run install script
    Installer needs to be unpacked to obtain the install script. This install script needs to be run with appropriate parameters for installing the Harmony Controller software. Installation will take around 30-45 minutes to complete.

Networking Pre-requisites

In order to successfully install the controller and to allow devices (Lightning ADC, Thunder ADC) to connect to the controller, following TCP ports need to be opened for ingress traffic:

_images/network_setup.png
Direction
Port Numbers
Access to A10 Harmony Portal
TCP Secure – 443, 8443, 7443, 9083;
Optional: TCP Plaintext – 80, 9080, 9081
Access to controller
nodes from
Lightning ADC subnet
API server: 8443;
Metrics message broker: 9093;
Registry server: 8080;
Configuration message bus: 5671;
Persistent proxy: 22121
Access to controller
nodes from
Thunder ADC subnet
API server: 8443;
Metrics message broker: 9093;
Registry server: 8080;
SCP: 2222
Between nodes in a
Three Node set-up
TCP – 6443, 6783, 9898, 10250, 22
(for installation and upgrade)

Note: Please make sure all the IP address used to assign to nodes are static IP address and you understand the implications of changing networking configuration as described in maintenance information.

Installation on Custom Resources

Harmony Controller software can be installed on any generic hardware resources or virtual machines. Two configurations are supported in this case.

  • 1-node installation
    Installation on one physical or virtual machine.
  • 3-node installation
    Installation on three physical or virtual machines.

Resources Pre-requisites

Harmony Controller software can be installed on a Linux machine deployed in any environment. However, installation is tested and working well in the environments that are listed below. Additionally there needs to be few items to be set-up from networking and storage point of view.

Environments

Installation of Harmony Controller is certified for the following environments:

  • Hypervisor (in case of Bare Metal Machines) KVM (libvirt version: 3.2.0, package: 14.el7_4.3), VMWare ESXi 6.0
  • Private Cloud: OpenStack Kilo
  • Public Clouds: AWS, Azure, GCP

Hardware

In order to successfully install the controller and to allow devices (Lightning ADC, Thunder ADC ) to connect to the controller, make sure the :ref:`net-pre-req are met and the TCP ports need to be opened for ingress traffic in your firewall. Each set of ports listed below need to be opened for the source IP subnet of the clients accessing the set of ports.

Node Configuration Description
Single node deployment 16 CPU, 64 GB RAM, 1.2TB persistent storage (SSD preferred)
Three node deployment 8 CPU, 32 GB RAM, 500GB persistent storage (SSD preferred) for each node

The actual resource requirement depends on the analytics information flowing to controller. Please consult A10 team for additional information.

Operating System

CentOS 7.4 x86_64 (minimal version) is needed. Downloading latest iso from CentOS Mirror Site and installed with all default installation options works good for smooth installation of Harmony Controller.

In case CentOS is being installed with advance options or it is being upgraded, please make sure that the Linux kernel version is 3.10.0-693.11.6.el7.x86_64 (or higher) and for the partition where Controller is to be installed File System Type is XFS with fstype=1.

Storage Set-Up

It is recommended to use persistent storage with high Input/Output speed. While high Input/Output speed is critical for high performance of Controller, persistent storage is required to keep the data intact in case of machine failure. In the event of machine failure, the storage can be detached from the machine and attached to other other machine for faster recovery of controller with minimal data loss. Disk storage works as persistent storage in case of physical machines. Some example of external persistent storage volumes are Elastic Block Storage, Google Persistent Disk, Azure Disk, Network File Storage etc.

The install script will ask the mount point where persistent storage is attached, and install Harmony Controller on that partition and create required soft links for Controller software to work properly.

Software Installation on Single Node

In this case Harmony Controller is installed only on one physical or virtual machine.

_images/1node.png

Before You Begin

  • Make sure all Networking Pre-requisites and Resources Pre-requisites are met.
  • Keep following information handy as this will be needed during the installation process:
    1. Number of Nodes
      Number of nodes being used for this installation. In this case it is 1.
    2. Mount point of the Storage
      As described in Storage Set-Up, A10 HarmonyTM Controller should be installed on persistent storage. Mount point of the storage where A10 HarmonyTM Controller should be installed is to be provided.
    3. External IP address
      External IP address or domain name (preferred) at which controller will be accessed. Please see more information in networking section of maintenance information.
    4. Email address of root provider administrator
      Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
    5. Password for root provider administrator
      Any password can be kept as per the password policy displayed at the time of installation.
    6. Password for operator
      Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.
    7. Tar File Path
      Path of the directory where Docker images and other package are kept on the Master node. This is asked only when files are not found in the parent directory of the installer.

Download the Installer and Packages

Install script bundle needs to be downloaded from the share file location provided in the email from A10. The share file location contains Release Notes and Getting Started guide for the requested version of software. Please read them carefully as the information (options, requirements, compatibility etc.) specified in Getting Started guide take precedence over the information provided in this documentation.

Required Docker images and other packages also need to be downloaded and placed in the master node before running the installation script. Download location is available in Getting Started Guide that is at the same place where the installer package is.

Install Harmony Controller Software

Run the following commands to unpack install script bundle and extract the script:

$ tar -zxvf Harmony-Controller-4.0.1-install.tar.gz
$ cd a10-harmony-controller-4.0.1/

Run the following command for installing the controller software:

$ sudo ./InstallHC

The script will ask questions about the required information.

Next Steps

Software Installation on Three Nodes

In this case Harmony Controller is installed on three physical or virtual machines.

_images/3node.png

Before You Begin

Keep following information handy as this will be needed during the installation process:

  1. Number of Nodes
    Number of nodes being used for this installation. In this case it is 3.
  2. Mount point of the Storage
    As described in Storage Set-Up, A10 HarmonyTM Controller should be installed on persistent storage. Mount point of the storage where A10 HarmonyTM Controller should be installed is to be provided.
  3. External IP address
    External IP address or domain name (preferred) at which controller will be accessed. Please see more information in networking section of maintenance information.
  4. Email address of root provider administrator
    Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
  5. Password for root provider administrator
    Any password can be kept as per the password policy displayed at the time of installation.
  6. Password for operator
    Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.
  7. Tar File Path
    Path of the directory where Docker images and other package are kept on the Master node. This is asked only when files are not found in the parent directory of the installer.
  8. IP address of NodeOne
    IP address of the first node other than Master node - termed as NodeOne.
  9. IP address of NodeTwo
    IP address of the second node other than Master node - termed as NodeTwo.
  10. NodeOne User
    User name for SSH into NodeOne. This user must have sudo permissions.
  11. NodeTwo User
    User name for SSH into NodeTwo. This user must have sudo permissions.
  12. SSH Key for NodeOne
    Path to SSH private key to login to NodeOne.
  13. SSH Key for NodeTwo
    Path to SSH private key to login to NodeTwo.

SSH Key Set-up

SSH keys needs to be set-up so that nodes can be accessed programmatically without password and user intervention. Following are the steps to generate Key-pair for SSH into nodes. The key-pair is created on Master node and the public keys need to be copied to other nodes. Path of private key file is to be provide to install script.

  1. Generate a key on master machine (First VM/Baremetal) using:

    ssh-keygen -t rsa -N ''
    
  2. Create .ssh directory on remote machine using:

    ssh <user>@<remote_machine> mkdir -p .ssh
    
  3. Upload generated public keys to remote machine using:

    cat ~/.ssh/id_rsa.pub | ssh <user>@<remote_machine> 'cat >> .ssh/authorized_keys'
    
  4. Set permissions on remote machine using:

    ssh <user>@<remote_machine> "chmod 700 .ssh; chmod 640 .ssh/authorized_keys"
    

Download the Installer and Packages

Install script bundle needs to be downloaded from the share file location provided in the email from A10. The share file location contains Release Notes and Getting Started guide for the requested version of the software. Read them carefully as the information (options, requirements, compatibility etc.) specified in Getting Started guide take precedence over the information provided in this documentation.

Required Docker images and other packages need to be downloaded and placed in the master VM before running the deployment. Download location is available in Getting Started Guide that is at the same place where the installer package is.

Install Harmony Controller Software

Run the following commands to unpack install script bundle and extract the script:

$ tar -zxvf Harmony-Controller-4.0.1-install.tar.gz
$ cd a10-harmony-controller-4.0.1/

Run the following command for installing the controller software:

$ sudo ./InstallHC

The script will ask questions for the required information. Script can be started without any parameter. Remaining parameters will be asked in form of questions.Follow the on-screen instructions and provide the value of items asked.

Next Steps

Installation on A10 Hardware Appliances

Harmony Controller software can be installed on the Hardware appliances and Harmony Controller 2000 and Harmony Controller 8000 are the two models available.

KVM hypervisor is installed on these appliances and VMs are created on top of the KVM. Software installation happens on the VMs inside these appliances.

Following four combinations of the appliances are possible:

  1. One Harmony Controller 2000 Appliance
    One VM inside the appliance
  2. Two Harmony Controller 2000 Appliance
    Three total VMs: 2 in one appliance and 1 on other appliance
  3. One Harmony Controller 8000 Appliance
    Three VMs inside the appliance
  4. Two Harmony Controller 8000 Appliance
    Three total VMs: 2 in one appliance and 1 on other appliance

Hardware Pre-Requisites

Before starting to install Harmony Controller software on the appliances, following steps are to be carried out:

  1. Mount the appliances in a rack, connect power supply and other cables as described in the Installation Guide of the appliance.
  2. Set-up IP address for the appliances and change the default admin login password as described in the Quick Start Guide.

Please refer the documents shipped with the appliances for the detailed instructions of the steps above. Alternately, the docs are available at following locations:

Software Installation on one Harmony Controller 2000 Appliance

In case of one Harmony Controller 2000, one VM (node) is placed in the appliance and controller software is installed in that VM.

_images/HC2000.png

Before You Begin

  1. Number of Appliances
    Installation can be done on 1 or 2 appliances as described in various sections in this document. As in this case installation is being done on 1 appliance, the answer should be 1.
  2. IP address and Subnet prefix for Master Node
    This IP address and Subnet mask will be assigned to the master node after it is created and note that the IP address cannot be changed. This IP address may belong to different subnet from Appliance IP address as per your organizational policies. Keeping it in the same Subnet also works well.
  3. Gateway IP address for Master Node
    Gateway address of the Subnet where master node is placed.
  4. DNS IP address for Master Node
    IP address of DNS server that Master node can use.
  5. Email address of root provider administrator
    Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
  6. Password for root provider administrator
    Any password can be kept as per the password policy displayed at the time of installation.
  7. Password for operator
    Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.

Install Harmony Controller Software

Following are the steps for installing Harmony Controller Software on appliance:

  1. Login to Harmony Controller 2000 appliance as user admin with your password.

  2. Go to /a10data folder:

    # cd /a10data
    
  3. Type the following command to start the installation script:

    # sudo ./StartHC
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the value of items asked.

Next Steps

Software Installation of Cluster on two Harmony Controller 2000 Appliances

In case of two Harmony Controller 2000 appliances, three VMs (nodes) are placed in the appliances (two nodes on one appliance and one node on other appliance). The controller software is installed in those VMs.

_images/2HC2000.png

Before You Begin

Before starting the installation process, make sure that the pre-requisites are met.

  1. Number of Appliances
    Installation can be done on 1 or 2 appliances as described in various sections in this document. As in this case installation is being done on 1 appliance, the answer should be 2.
  2. IP address for Second Appliance
    This is the IP address for the second appliance.
  3. IP address and Subnet prefix for Master Node
    This IP address and Subnet mask will be assigned to the master node after it is created and note that the IP address cannot be changed. This IP address may belong to different subnet from Appliance IP address as per your organizational policies. Keeping it in the same subnet also works well.
  4. Gateway IP address for Master Node
    Gateway address of the subnet where master node is placed.
  5. DNS IP address for Master Node
    IP address of DNS server that Master node can use.
  6. IP address and Subnet prefix for NodeOne IP
    This IP address and Subnet mask will be assigned to the NodeOne and note that the IP address cannot be changed.
  7. Gateway IP address for NodeOne
    Gateway address of the Subnet where NodeOne is placed.
  8. DNS IP address for NodeOne
    IP address of DNS server that NodeOne can use.
  9. IP address and Subnet prefix for NodeTwo IP
    This IP address and Subnet mask will be assigned to the NodeTwo and note that the IP address cannot be changed.
  10. Gateway IP address for NodeTwo
    Gateway address of the Subnet where NodeTwo is placed.
  11. DNS IP address for NodeOne
    IP address of DNS server that NodeTwo can use.
  12. Email address of root provider administrator
    Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
  13. Password for root provider administrator
    Any password can be kept as per the password policy displayed at the time of installation.
  14. Password for operator
    Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.

Install Harmony Controller Software

Following are the steps for installing Harmony Controller Software on appliance:

  1. Login to Harmony Controller 2000 appliance as admin with your password.

  2. Go to /a10data folder:

    # cd /a10data
    
  3. Type the following command to start the installation script:

    # sudo ./StartHC
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the value of items asked.

Next Steps

Software Installation of Cluster one Harmony Controller 8000 Appliance

In case of one Harmony Controller 8000, three VMs (nodes) are placed in the appliance and controller software is installed in those VMs.

_images/HC8000.png

Before You Begin

Before starting the installation process, make sure that the pre-requisites are met.

  1. Number of Appliances
    Installation can be done on 1 or 2 appliances as described in various sections in this document. As in this case installation is being done on 1 appliance, the answer should be 1.
  2. IP address and Subnet prefix for Master Node
    This IP address and Subnet mask will be assigned to the master node after it is created and note that the IP address cannot be changed. This IP address may belong to different subnet from Appliance IP address as per your organizational policies. Keeping it in the same subnet also works well.
  3. Gateway IP address for Master Node
    Gateway address of the subnet where master node is placed.
  4. DNS IP address for Master Node
    IP address of DNS server that Master node can use.
  5. IP address and Subnet prefix for NodeOne IP
    This IP address and Subnet mask will be assigned to the NodeOne and note that the IP address cannot be changed.
  6. Gateway IP address for NodeOne
    Gateway address of the Subnet where NodeOne is placed.
  7. DNS IP address for NodeOne
    IP address of DNS server that NodeOne can use.
  8. IP address and Subnet prefix for NodeTwo IP
    This IP address and Subnet mask will be assigned to the NodeTwo and note that the IP address cannot be changed.
  9. Gateway IP address for NodeTwo
    Gateway address of the Subnet where NodeTwo is placed.
  10. DNS IP address for NodeOne
    IP address of DNS server that NodeTwo can use.
  11. Email address of root provider administrator
    Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
  12. Password for root provider administrator
    Any password can be kept as per the password policy displayed at the time of installation.
  13. Password for operator
    Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.

Install Harmony Controller Software

Following are the steps for installing Harmony Controller Software on appliance:

  1. Login to Harmony Controller 8000 appliance as admin with your password.

  2. Go to /a10data folder:

    # cd /a10data
    
  3. Type the following command to start the installation script:

    # sudo ./StartHC
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the value of items asked.

Next Steps

Software Installation of Cluster on two Harmony Controller 8000 Appliances

In case of two Harmony Controller 8000 appliances, three VMs (nodes) are placed in the appliances (two nodes on one appliance and one node on other appliance). The controller software is installed in those VMs.

_images/2HC8000.png

Before You Begin

  1. Number of Appliances
    Installation can be done on 1 or 2 appliances as described in various sections in this document. As in this case installation is being done on 2 appliances, the answer should be 2.
  2. IP address for Second Appliance
    This is the IP address for the second appliance.
  3. IP address and Subnet prefix for Master Node
    This IP address and Subnet mask will be assigned to the master node after it is created and note that the IP address cannot be changed. This IP address may belong to different subnet from Appliance IP address as per your organizational policies. Keeping it in the same subnet also works well.
  4. Gateway IP address for Master Node
    Gateway address of the subnet where master node is placed.
  5. DNS IP address for Master Node
    IP address of DNS server that Master node can use.
  6. IP address and Subnet prefix for NodeOne IP
    This IP address and Subnet mask will be assigned to the NodeOne and note that the IP address cannot be changed.
  7. Gateway IP address for NodeOne
    Gateway address of the Subnet where NodeOne is placed.
  8. DNS IP address for NodeOne
    IP address of DNS server that NodeOne can use.
  9. IP address and Subnet prefix for NodeTwo IP
    This IP address and Subnet mask will be assigned to the NodeTwo and note that the IP address cannot be changed.
  10. Gateway IP address for NodeTwo
    Gateway address of the Subnet where NodeTwo is placed.
  11. DNS IP address for NodeOne
    IP address of DNS server that NodeTwo can use.
  12. Email address of root provider administrator
    Email address will be used as user name for root provider administrator to login to Harmony Portal and administer infrastructure and tenants.
  13. Password for root provider administrator
    Any password can be kept as per the password policy displayed at the time of installation.
  14. Password for operator
    Operator Console is to manage and monitor Harmony Controller installation. User name for operator is ‘admin’. Any password can be kept as per password policy displayed at the time of installation.

Install Harmony Controller Software

Following are the steps for installing Harmony Controller Software on appliance:

  1. Login to HC-8000 appliance as admin and type the password.

  2. Go to /a10data folder:

    # cd /a10data
    
  3. Type the following command to start the installation script:

    # sudo ./StartHC
    

The script is interactive and will prompt for information. Follow the on-screen instructions and provide the value of items asked.

Next Steps