Installing an Embedded Cluster

This article refers to installing the Admin Console on an embedded cluster. When running the Admin Console on an existing cluster, refer to the Installing the Admin Console documentation.

Refer to the reference documentation for a full list of options that may be passed to the install script.

Online Installations

To install the Admin Console with an embedded cluster, simply run the installation script provided by the application developer.

curl -sSL | sudo bash

Airgapped Installations

To install an airgapped embedded cluster, download the airgap bundle, untar it, and run the script.

curl -SL -o supergoodtool.tar.gz
tar xzvf supergoodtool.tar.gz
cat | sudo bash -s airgap

Note that the airgapped installer is not the same as an airgapped application package. A KOTS application may be installed in airgap mode on clusters installed online and vice versa.

HA Installations

Both online and airgapped installations can be configured in high-availability mode. When installing a highly available cluster, the script will prompt for a load balancer address. The load balancer can be preconfigured by passing in the load-balancer-address=host:port flag. This load balancer should be configured to distribute traffic to all healthy control plane nodes in its target list. This should be a TCP forwarding load balancer. The health check for an apiserver is a TCP check on the port the kube-apiserver listens on (default value :6443). For more information on the kube-apiserver load balancer see In the absence of a load balancer, all traffic will be routed to the first master.

curl -sSL | sudo bash -s ha


cat | sudo bash -s airgap ha

Operating Systems

  • Ubuntu 18.04
  • Ubuntu 16.04
  • Red Hat Enterprise Linux 7.4 - 7.6
  • CentOS 7.4 - 7.6

Minimum System Requirements

  • 2 CPUs per machine for master nodes, 1 CPU for worker nodes
  • 4 GB or more of RAM per machine
  • TCP ports 6443, 6783, and 8800 open
  • UDP ports 6783 and 6784 open

Joining Nodes

Visit the /cluster/manage page in the Kotsadm web console to generate scripts for joining additional worker and master nodes.

For airgapped installations, the airgap bundle must also be downloaded and extracted on the remote node prior to running the join script.