Skip to Content

Deploying

The ways to install a host, and which one fits which machine.

The install methods all run the same Ansible role with the settings of the host's profile. Choose one under How To Install on the Install tab of a host, or use the matching command.

MethodForCommand
USB installerA blank laptop or PC; erases a disk and installs Ubunturookery host iso HOST
Cloud-init seedA fresh cloud machine at a provider that takes cloud-initrookery host seed HOST
Create a machineA container or virtual machine that a plugin creates, such as on Docker or IncusInstall tab, or rookery host create HOST --provisioner PROVISIONER
Existing host over SSHAn Ubuntu 26.04 machine you can log in toInstall tab
This machine or an inventoryThe machine Rookery runs on, or your own Ansible inventoryInstall tab, or ansible-playbook
Container imageTrying the desktop on DockerInstall tab, or docker compose

The target is Ubuntu 26.04 on amd64. The USB installer installs it, and the other methods expect it.

Before you run

The set-up of a host has four tabs. Each tab depends only on the tabs before it.

TabWhat it holds
InstallHow to install, with the target (not for a created machine, which is always cloud), the provisioner and its required arguments, the SSH address, the hostname and Tailscale
FeaturesWhat gets installed, including Cockpit and Docker on the host
SettingsEverything with a default, such as the machine's resources, the accounts, registries and secrets, and the installer's disk and Wi-Fi
RunThe last files for the method, every problem, and the buttons

A setting shows only when the method and features it belongs to are chosen. Each of the first three tabs lists its own problems at the bottom. Run lists all of them under the name of their tab, and does not start while one is listed. Warnings, such as SSH being open to any address, are listed too but do not stop it. Save on Run, or Ctrl+S anywhere, saves the profile.

What Run starts is a job of the server, whose output fills a panel. Esc hides the panel and the job goes on. It stays in the server's list. A password the job needs, such as a sudo password, is asked for in a dialog first. To provision this machine or an inventory, run the role with Ansible directly.

Use dedicated machines

The role installs services, changes the firewall and grants the agent sudo. Applied to localhost, it provisions the machine you are sitting at. Only do that on a dedicated box.

Edit on GitHub

Last updated on

On this page