Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ungtb10d/matchbox

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/ungtb10d/matchbox
Owner: ungtb10d
License: apache-2.0
Created: 2022-10-02T23:38:00.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-03-06T12:07:39.000Z (almost 2 years ago)
Last Synced: 2024-11-12T03:19:32.305Z (2 months ago)
Language: Go
Size: 16.6 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # matchbox

[![GoDoc](https://pkg.go.dev/badge/github.com/poseidon/matchbox.svg)](https://pkg.go.dev/github.com/poseidon/matchbox) [![Quay](https://img.shields.io/badge/container-quay-green)](https://quay.io/repository/poseidon/matchbox) [![Workflow](https://github.com/poseidon/matchbox/actions/workflows/test.yaml/badge.svg)](https://github.com/poseidon/matchbox/actions/workflows/test.yaml?query=branch%3Amain) ![Downloads](https://img.shields.io/github/downloads/poseidon/matchbox/total) [![Sponsors](https://img.shields.io/github/sponsors/poseidon?logo=github)](https://github.com/sponsors/poseidon) [![Twitter](https://img.shields.io/badge/follow-news-1da1f2?logo=twitter)](https://twitter.com/poseidonlabs)

`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](https://github.com/coreos/ignition))

* Authenticated gRPC API for clients (e.g. Terraform)

## Documentation

* [Docs](https://matchbox.psdn.io/)

* [Configuration](docs/config.md)

* [HTTP API](docs/api-http.md) / [gRPC API](docs/api-grpc.md)

## Installation

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

* Install Matchbox as a [binary](docs/deployment.md#matchbox-binary), as a [container image](docs/deployment.md#container-image), or on [Kubernetes](docs/deployment.md#kubernetes)

* Setup a PXE-enabled [network](docs/network-setup.md)

## Tutorials

Start provisioning machines with Fedora CoreOS or Flatcar Linux.

* [Terraform Usage](docs/getting-started.md)

  * Fedora CoreOS (PXE install to disk)

  * Flatcar Linux (PXE install to disk)

* [Local QEMU/KVM](docs/getting-started-docker.md)

    * Fedora CoreOS (live PXE or PXE install to disk)

    * Flatcar Linux (live PXE or PXE install to disk)

## Contrib

* [dnsmasq](contrib/dnsmasq/README.md) - Run DHCP, TFTP, and DNS services as a container

* [terraform-provider-matchbox](https://github.com/poseidon/terraform-provider-matchbox) - Terraform provider plugin for Matchbox