Skip to content

docs: hosting provider #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Iheanacho-ai wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: hosting provider #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions ...i-cluster-setup/registering-machines/register-a-bare-metal-machine-pxe-ipxe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ title: Register a Bare Metal Machine (PXE/iPXE)

This guide shows you how to register a bare metal machine with Omni by PXE/iPXE booting.

### Copy the Required Kernel Parameters <a href="#copy-the-required-kernel-parameters" id="copy-the-required-kernel-parameters"></a>
### Copy the Required Kernel Parameters

Upon logging in you will be presented with the Omni dashboard. Click the “Copy Kernel Parameters” button on the right hand side, and save the value for later.

### Download the PXE/iPXE Assets <a href="#download-the-pxeipxe-assets" id="download-the-pxeipxe-assets"></a>
### Download the PXE/iPXE Assets

The following example assumes the use of Matchbox server.

Download `vmlinuz` and `initramfs.xz` from the [release](https://github.com/siderolabs/talos/releases) of your choice (Talos Linux 1.4 or greater is required), and place them in `/var/lib/matchbox/assets`.

#### Create the Profile <a href="#create-the-profile" id="create-the-profile"></a>
#### Create the Profile

Place the following in `/var/lib/matchbox/profiles/default.json`:

Expand Down Expand Up @@ -58,8 +58,27 @@ Place the following in `/var/lib/matchbox/groups/default.json`:

Once your machine is configured to PXE boot using your tool of choice, power the machine on.

### Conclusion <a href="#conclusion" id="conclusion"></a>

Navigate to the “Machines” menu in the sidebar of Omni. You should now see a machine listed.

You now have a bare metal machine registered with Omni and ready to provision.

## Alternative option: Use a hosting provider that supports iPXE with DHCP

Some bare metal hosting providers (for example, managed dedicated server providers) already provide DHCP and an iPXE boot environment.

In these environments, you do not need to run your own Matchbox server or bare metal infrastructure provider. Instead, you can chainload Talos directly from the Talos Image Factory.

Use the following minimal iPXE script:

```ipxe
#!ipxe
dhcp
chain --replace --autofree https://pxe.factory.talos.dev/pxe/<YOUR_SCHEMATIC_ID>/<TALOS_VERSION>/metal-amd64
```

Replace:

- `<YOUR_SCHEMATIC_ID>` with the schematic ID generated in Image Factory
- `<TALOS_VERSION>` with the Talos version you want to boot (for example, `v1.12.0`)

After the machine boots, it will register with Omni using the kernel parameters configured in Image Factory.
Loading