matchbox

module

v0.11.0 Latest Latest Go to latest Published: Mar 24, 2024 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/poseidon/matchbox

Links

Open Source Insights

README ¶

matchbox

Downloads

matchbox is a service that matches bare-metal machines to profiles that PXE boot and provision clusters. Machines are matched by labels like MAC or UUID during PXE and profiles specify a kernel/initrd, iPXE config, and Ignition config.

Features

Chainload via iPXE and match hardware labels
Provision Fedora CoreOS or Flatcar Linux (powered by Ignition)
Authenticated gRPC API for clients (e.g. Terraform)

Documentation

Installation

Matchbox can be installed from a binary or a container image.

Install Matchbox as a binary, as a container image, or on Kubernetes
Setup a PXE-enabled network

Tutorials

Start provisioning machines with Fedora CoreOS or Flatcar Linux.

Terraform Usage
- Fedora CoreOS (PXE install to disk)
- Flatcar Linux (PXE install to disk)
Local QEMU/KVM
- Fedora CoreOS (live PXE or PXE install to disk)
- Flatcar Linux (live PXE or PXE install to disk)

Contrib

dnsmasq - Run DHCP, TFTP, and DNS services as a container
terraform-provider-matchbox - Terraform provider plugin for Matchbox

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
bootcmd
matchbox
matchbox
cli Package cli provides a command line interface client.	Package cli provides a command line interface client.
client Package client provides the matchbox gRPC client.	Package client provides the matchbox gRPC client.
http Package http provides the matchbox HTTP server	Package http provides the matchbox HTTP server
rpc Package rpc provides the matchbox gRPC server	Package rpc provides the matchbox gRPC server
rpc/rpcpb Package rpcpb provides RPC client and server interfaces.	Package rpcpb provides RPC client and server interfaces.
server Package server is a matchbox library package for implementing servers.	Package server is a matchbox library package for implementing servers.
server/serverpb Package serverpb provides matchbox message types.	Package serverpb provides matchbox message types.
sign Package sign adds signatures to matchbox responses.	Package sign adds signatures to matchbox responses.
storage Package storage defines matchbox's storage and object types.	Package storage defines matchbox's storage and object types.
storage/storagepb Package storagepb provides storage protobuf client and server interfaces.	Package storagepb provides storage protobuf client and server interfaces.
storage/testfakes Package testfakes provides shared storage implementations for testing.	Package testfakes provides shared storage implementations for testing.
tlsutil
version Package version provides the matchbox version.	Package version provides the matchbox version.