pojntfx/ipxebuilderd

Build daemon and CLI for iPXE.

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 S3
• ipxectl, a CLI for ipxebuilderd

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

ipxebuilderd's Issues

Adopt default CTPF service project structure

The project structure should be refactored so that it is more closely adjusted to the default CTPF project structure and it's conventions.

Add status bar to client CLI

There should be a status bar for the create command.

Add `dibs` configuration

This project should use pojntfx/dibs.

feat: Use `dibs` for client CLI

The client CLI should be build with dibs v2 which supports multiple targets now.

build: Use dibs V2

The new, post-rewrite dibs should be used and the CI/CD configuration of it be adapted for this repo.

feat: Add client CLI

There should be a client CLI that is similar to the other services with full CRUD capabilities, with the create/get all/get one/delete commands calling the gRPC server/the S3 server.

feat: Add list, get and remove capabilities

It should be possible to list, get and remove ipxe builds that are in the S3 server.

Decompose current `main` function into own worker

The current usage of the main function should be decomposed into a reusable worker.

refactor: Use ManageableCommand

With dibs v2 now existing, there is a nice framework for streaming commands. It should be used here as well.

Only show delta in streaming create RPC

It is not necessary to send back the total amount of steps tbd.

feat: Add minimal documentation

There should be the minimal documentation:

• README
• LICENSE
• _config.yml
• CODE_OF_CONDUCT
• description
• website
• tags

Add gRPC service

There should be a gRPC service that returns a stream with status updates and finally a (for now) mocked S3 path.

Add worker for status tracking

In order for the library to be more useful, there should be a worker system that sends data about the progress of each build over a channel.

Queue concurrent build requests

Currently, there is UB for concurrent requests. We should either lock the current build or copy the files somewhere else before every build.

Join us in fighting covid as an iPXE expert

Hey,

Cool project, it ideally looks like you'd be able to help us with fighting COVID with it!

We're planning to use a lot of iPXE related things, and your expertise would be really useful for us.

Join us on: https://devpost.com/software/help-education-sector-to-produce-more-laptops-for-students

Greetings, Karol & the team.

feat: Add GitLab CI/CD

It should be easy enough to set up GitLab CI/CD as dibs already supports it.

feat: Add S3 configuration

There should be a configured Minio chart as a chart dependency as well as an implementation of S3 upload.