macro187 / hotbox

Workstation and container automation

hotbox

Workstation and container automation

Features are shell scripts that set up particular aspects of machines (physical, virtual, or container). They can do any kind of system-wide or user-specific setup. The hotbox-apply-feature command applies individual features to the running system, by basically just running the feature script.

Some features currently implement personal preferences of mine. I am in the process of extracting those out of hotbox to make it suitable for general-purpose use by anyone.

Specs are lists of features. An include mechanism allows specs to derive from one another. The hotbox-apply-spec command applies specs to the running system by applying features in the order listed.

While some features may depend on the effects of others, there is no dependency resolution magic in hotbox. What you see listed in a spec is what you get.

Hotboxes are containers built from specs. The hotbox-build command builds container images from specs by starting from a base image and applying features in the order listed. The hotbox command runs hotbox containers by allowing their features to perform pre-startup tasks on the host and then starting the container, usually connected interactively to the terminal. Hotboxes are just plain old containers that can be used in the usual batch/background ways with the usual Docker tools, but the hotbox tools and features also enable a more lightweight, interactive usage style where users can quickly jump in and out of different hotboxes depending on the task at hand, sometimes from multiple terminal sessions, sharing assets and resources from the host.

Requirements

The Hotbox tools are POSIX shell scripts (https://shellhaters.org/) which is (basically) the common subset of Bourne shells (Bash, Dash, Ash, etc.) that works on any of them.

Some features need to be implemented in os-specific ways. Where this is the case, the features included with Hotbox currently support:

• Alpine Linux

• Ubuntu Linux

• Void Linux

Container functionality requires Docker.

To run X applications in containers, they must be allowed access to the host X server. This can be done manually each session or prepended to .xinitrc (or similar):

xhost +

Features

Features consist of one or more related scripts in the features/ subdirectory, each of which performs actions at different times:

• <feature>.user.feature.sh

  Performs one-time setup action(s) as the unprivileged user.

  Can perform privileged operations using doas (if available).

  Features should be designed to do as much setup as possible at this time.

• <feature>.system.feature.sh

  Performs one-time setup actions as root, usually early in the machine setup process, usually before unprivileged users or doas have been set up.

  Features should only perform setup at this time if necessary.

• <feature>.run.feature.sh

  (containers only)

  Performs actions on the host as the unprivileged host user just before starting a container, with any stdout output being included in the docker run command line.

A number of features are included with hotbox itself. User-defined features can be used in addition to or instead of the included ones.

Specs

Specs are named sets of features tailored to different workstation use cases. They are defined in shell scripts in the specs/ subdirectory.

Containers

Hotbox can build and run containers configured with features according to specs.

Hotbox includes a number of features that can be used to support interactive container use. These include:

• Unprivileged container user matching the unprivileged host user so file ownership and permissions work

• Host $TERM and $COLORTERM environment variables so 256-color and truecolor terminals work

• Host user's ~/.git-credentials so Git works

• Host Docker socket so Docker works

• Host X11 socket and $DISPLAY environment variable so X11 applications work

• Shared, persistent caches for various package managers (Alpine APK, Ubuntu APT, Nuget, NPM, etc.) so packages only get downloaded once

Hotbox containers are identified primarily by the name of the spec they are built from. A spec named foo and its related image and containers can all be loosely referred to as the foo hotbox or a foo hotbox.

In addition, hotbox attaches names to individual containers to identify them and to distinguish amongst multiple containers from the same spec.

Commands

hotbox-apply-feature

Apply a feature to the running system

Synopsis

hotbox-apply-feature [--system] <name>
hotbox-apply-feature <path>

Options

--system
    Apply system aspects of the feature.  Must be run as root.

<name>
    Name of feature to apply.

<path>
    Path to *.user.feature.sh or *.system.feature.sh script to apply.

hotbox-apply-spec

Apply all features in a spec to the running system

Synopsis

hotbox-apply-spec [--system] <spec>

Options

--system
    Apply system aspects of features.  Must be run as root.

<spec>
    The spec whose features are to be applied.

hotbox

Enter or join a hotbox container, building it if necessary

Synopsis

hotbox [--volume <volume>] [--workdir <workdir>] <spec> [<name>] [-- <command> [<arg>...]]

Options

--volume <hostpath>:<containerpath>
    Mount the specified <hostpath> into the container at <containerpath>.  Can
    be specified more than once.

--workdir <workdir>
    Enter the container in the specified <workdir>

<spec>
    The spec of the container to enter.

<name>
    The name of the container to enter.  Default same as <spec>.

<command>
    The command to run in the container instead of a login shell.

<arg>
    Argument to <command>

Description

If an image for <spec> doesn't exist, build it.

If a container with <name> is not running, start one in a new login shell.

If a container with <name> is already running, join it in a new login shell.

hotbox-build

Build a hotbox container image from a spec

Synopsis

hotbox-build [--refresh] [--source <source>] <spec>

Options

--refresh
    Refresh cached assets from their upstream sources

--source <source>
    Include features and specs from <source> location

<spec>
    The spec to build.

Environment

HOTBOX_PATH
    Additional locations to include features and specs from, colon-separated,
    in decreasing order of priority

hotbox-run

Enter or join a hotbox container

Synopsis

hotbox-run [--volume <volume>] [--workdir <workdir>] <spec> <name> [<command> [<arg>...]]

Options

--volume <hostpath>:<containerpath>
    Mount the specified <hostpath> into the container at <containerpath>.  Can
    be specified more than once.

--workdir <workdir>
    Enter the container in the specified <workdir>

<spec>
    The hotbox spec to run.

<name>
    The name to assign to the container, or the name of the existing container
    to join.

<command>
    The command to run in the container.  Default the shell specified in the
    <spec>.

<arg>
    Argument(s) to <command>.  Default the shell argument specified in the
    <spec>.

Description

If a container with the specified <name> is not running, start it.

If a container with the specified <name> is already running, join it.

hotbox-clean

Delete all hotbox container images and associated feature/spec snapshots.

License

MIT License (https://github.com/macro187/cook/blob/master/license.txt)

Copyright

Copyright (c) 2023
Ron MacNeil (https://github.com/macro187)