matchbox

module

v0.5.0 Latest Latest Go to latest Published: Jan 23, 2017 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

Network boot and provision CoreOS clusters on virtual or physical hardware.

Announcement: coreos-baremetal and bootcfg have been renamed to CoreOS matchbox, which will be reflected in v0.5.0. Please see CHANGES or #400. If you're looking for older docs, be sure to use the branch/tag switcher.

Guides

Network Setup
Machine Lifecycle
Background: PXE Booting
Tutorials (QEMU/KVM/libvirt)
- matchbox with rkt
- matchbox with Docker

matchbox

matchbox is an HTTP and gRPC service that renders signed Ignition configs, cloud-configs, network boot configs, and metadata to machines to create CoreOS clusters. Groups match machines based on labels (e.g. MAC, UUID, stage, region) and use named Profiles for provisioning. Network boot endpoints provide PXE, iPXE, and GRUB. matchbox can be deployed as a binary, as an appc container with rkt, or as a Docker container.

matchbox Service
Profiles
Groups
Config Templates
- Ignition
- Cloud-Config
Configuration
HTTP API
gRPC API
Installation

Examples

The examples network boot and provision CoreOS clusters. Network boot QEMU/KVM VMs to try the examples on your Linux laptop.

Multi-node Kubernetes cluster
Multi-node rktnetes cluster (i.e. Kubernetes with rkt as the container runtime)
Multi-node self-hosted Kubernetes cluster
Upgrading self-hosted Kubernetes clusters
Multi-node etcd2 or etcd3 cluster
Multi-node Torus distributed storage cluster
Network boot and/or install to disk (multi-stage installs)

Enterprise

Tectonic is the enterprise-ready Kubernetes offering from CoreOS (free for 10 nodes!). The Tectonic Installer app integrates directly with matchbox through its gRPC API to provide a rich graphical client for populating matchbox with machine configs.

Learn more from our docs or blog.

Tectonic Installer

Tectonic Console

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.