ipxebuilderd
Build daemon and CLI for iPXE.
Overview
ipxebuilderd
is a build daemon with a CLI for iPXE, the leading open source network boot firmware. It is built of two components:
ipxebuilderd
, a build daemon with a gRPC interface which uploads built artifacts to S3ipxectl
, a CLI foripxebuilderd
ipxebuilderd
bundles the iPXE source code, but does not the toolchain in it’s binary. Please use to the Docker images or Helm chart, which bundle it; the latter also bundles a S3 (Minio) server.
Installation
Prebuilt Binaries
Prebuilt binaries are available on the releases page.
Go Package
A Go package is available.
Docker Image
A Docker image is available on Docker Hub.
Helm Chart
A Helm chart is available in @pojntfx’s Helm chart repository.
Usage
Daemon
You may also set the flags by setting env variables in the format IPXEBUILDERD_[FLAG]
(i.e. IPXEBUILDERD_IPXEBUILDERD_CONFIGFILE=examples/ipxebuilderd.yaml
) or by using a configuration file.
% ipxebuilderd --help
ipxebuilderd is the iPXE build daemon.
Find more information at:
https://pojntfx.github.io/ipxebuilderd/
Usage:
ipxebuilderd [flags]
Flags:
-h, --help help for ipxebuilderd
-f, --ipxebuilderd.configFile string Configuration file to use.
-l, --ipxebuilderd.listenHostPort string TCP listen host:port. (default "0.0.0.0:1010")
-u, --ipxebuilderd.s3AccessKey string Access key of the S3 server to connect to. (default "ipxebuilderUser")
-b, --ipxebuilderd.s3Bucket string S3 bucket to use. (default "ipxebuilderd")
-s, --ipxebuilderd.s3HostPort string Host:port of the S3 server to connect to. (default "minio.ipxebuilderd.example.com")
-o, --ipxebuilderd.s3HostPortPublic string Public host:port of the S3 server (will be used in shared links). (default "minio.ipxebuilderd.example.com")
-p, --ipxebuilderd.s3SecretKey string Secret key of the S3 server to connect to. (default "ipxebuilderdPass")
-z, --ipxebuilderd.secure Whether to use a secure connection to S3.
Client CLI
You may also set the flags by setting env variables in the format IPXE_[FLAG]
(i.e. IPXE_IPXE_CONFIGFILE=examples/ipxe.yaml
) or by using a configuration file.
% ipxectl --help
ipxectl manages ipxebuilderd, the iPXE build daemon.
Find more information at:
https://pojntfx.github.io/ipxe/
Usage:
ipxectl [command]
Available Commands:
apply Apply a ipxe
delete Delete one or more iPXE(s)
get Get one or all iPXE(s)
help Help about any command
Flags:
-h, --help help for ipxectl
Use "ipxectl [command] --help" for more information about a command.
License
ipxebuilderd (c) 2020 Felicitas Pojtinger
SPDX-License-Identifier: AGPL-3.0