This guide walks through a bare metal installation of Tectonic utilizing PXE-based tools. This document will cover:
|1. Node and networking requirements||Review types of machines in the cluster
Review networking requirements
|2. Provision Infrastructure||Download and install matchbox
Generate TLS assets
|3. Configure Networking||Set up DHCP, TFTP, and DNS services
Configure DNS for the cluster
|4. Tectonic Installer||Install Kubernetes and Tectonic|
|5. Tectonic Console||You're done! Your cluster is ready!|
For a more complete list of hardware and networking requirements, please see the bare metal requirements document.
This overview video helps understand the big picture before beginning the deployment steps:
A minimum of 3 machines are required to run Tectonic.
etcdand the control plane of the Tectonic cluster.
For more information, see bare metal installation requirements.
This guide requires familiarity with PXE booting, the ability to configure network services, and to add DNS names. Networking requirements include:
Installation and setup of these three items is detailed below.
Matchbox is an open source service for on-premise environments that matches bare metal machines to profiles in order to PXE boot Container Linux clusters and automate cluster provisioning. Matchbox provides an authenticated API for clients like Tectonic Installer and Terraform. Profiles will define the kernel, initrd, iPXE config, and Container Linux config each node should use.
Download a Matchbox v0.6+ release.
$ wget https://github.com/coreos/matchbox/releases/download/v0.6.1/matchbox-v0.6.1-linux-amd64.tar.gz $ wget https://github.com/coreos/matchbox/releases/download/v0.6.1/matchbox-v0.6.1-linux-amd64.tar.gz.asc
Untar the release.
$ tar xzvf matchbox-v0.6.1-linux-amd64.tar.gz $ cd matchbox-v0.6.1-linux-amd64
Install Matchbox on a server or Kubernetes cluster that your bare metal machines can reach using the guides:
Be sure to enable the gRPC API and use the TLS generation script to create server and client certificates. This can be done following the "Customization" and "Generate TLS" sections. Save the
client.key on your local machine (e.g.
Verify the Matchbox service is running.
Matchbox can serve CoreOS Container Linux images to reduce bandwidth usage and increase the speed of CoreOS Container Linux PXE boots and installs to disk. Tectonic Installer detects the highest version number available in the Matchbox cache.
Download a recent CoreOS Container Linux stable release with signatures.
$ ./scripts/get-coreos stable 1465.8.0 . # note the "." 3rd argument
Move the images to
$ sudo cp -r coreos /var/lib/matchbox/assets
$ tree /var/lib/matchbox/assets /var/lib/matchbox/assets/ ├── coreos │ └── 1465.8.0 │ ├── CoreOS_Image_Signing_Key.asc │ ├── coreos_production_image.bin.bz2 │ ├── coreos_production_image.bin.bz2.sig │ ├── coreos_production_pxe_image.cpio.gz │ ├── coreos_production_pxe_image.cpio.gz.sig │ ├── coreos_production_pxe.vmlinuz │ └── coreos_production_pxe.vmlinuz.sig
and verify the images are accessible.
$ curl http://matchbox.example.com:8080/assets/coreos/1465.8.0/ <pre>...
A bare metal Tectonic cluster requires PXE infrastructure.
Tectonic works with many on-premise network setups. Matchbox does not seek to be the DHCP server, TFTP server, or DNS server for the network. Instead, it serves iPXE scripts as the entrypoint for provisioning network booted machines. At a high level, the goals are to:
In the simplest case, an iPXE-enabled network can chain to Matchbox,
# /var/www/html/ipxe/default.ipxe chain http://matchbox.foo:8080/boot.ipxe
Read network-setup for the complete range of options. Network admins have a great amount of flexibility. They may choose to:
Tectonic Installer will prompt for Controller and Tectonic DNS names.
For the controller DNS name, add a record which resolves to the node you plan to use as a controller.
By default, Tectonic Ingress runs as a Kubernetes Daemon Set across all worker nodes. For the Tectonic DNS name, add a record resolving to any nodes you plan to use as workers. Tectonic Console will be accessible at this DNS name. Choosing a Tectonic DNS type depends on the available infrastructure. Provide either a single DNS entry, round-robin DNS records, or the name of a load balancer fronting the workers on ports 80 and 443.
matchbox.example.comresolves to your
controllers.example.comresolves to any controller node
tectonic.example.comresolves to any worker nodes
Providing a single entry for Tectonic DNS implies the Console will be inaccessible if that node fails. For higher availability, use a load balancer over several worker nodes. Changes to the Tectonic and Controller DNS configuration are not supported after installation.
Make sure a current version of either the Google Chrome or Mozilla Firefox web browser is set as the default browser on the workstation where Installer will run.
Download Tectonic Installer.
wget https://releases.tectonic.com/releases/tectonic_1.8.4-tectonic.3.zip unzip tectonic_1.8.4-tectonic.3.zip cd tectonic_1.8.4-tectonic.3/tectonic-installer
Run the Tectonic Installer for your platform:
For macOS users:
For Linux users:
For Windows users, see this guide.
A browser window will open to begin the GUI installation process, which will require the following information:
ca.crtgenerated when installing Matchbox.
Click Submit to launch Terraform apply, then power on your machines via IPMI or by pressing the power button. Matchbox will configure your machine, load Container Linux, and allow cluster creation to begin.
After the installer is complete, you'll have a Tectonic cluster and be able to access Tectonic Console. You are ready to deploy your first application on to the cluster!