maruos / blueprints

Container builder for Maru OS.
Apache License 2.0
15 stars 12 forks source link
containers debian lxc maru

Maru OS Container Blueprints

CI workflow

Container image builder for Maru OS.

Blueprints

Image building logic is separated into standalone plugins called blueprints.

To create your own blueprint, all you need to do is:

  1. Add a directory under blueprint/. Use this directory to store anything you need during the build process.

  2. Add a script called plugin.sh to the top-level of your new blueprint directory. This will be the entrypoint to your blueprint.

  3. Define the function blueprint_build in plugin.sh that will run your build logic.

  4. Define the function blueprint_cleanup in plugin.sh that will clean up any intermediate build artifacts.

See blueprint/debian as the canonical example for Debian.

Examples

Build the default container:

$ ./build.sh

Build a minimal Debian arm64 buster container called "buster-container":

$ ./build.sh -b debian -n buster-container -- -r buster -a arm64 --minimal

Tip: You will need root privileges to mount binfmt_misc for bootstrapping foreign architecture containers.

Building with Docker

If you have Docker set up on your machine, just substitute ./build.sh with ./build-with-docker.sh to run a build within a Docker container with all the necessary dependencies pre-installed. All args will be passed to build.sh just like usual.

Build a Debian arm64 buster container called "buster-container" with Docker (args will be passed to build.sh):

$ ./build-with-docker.sh -b debian -n buster-container -- -r buster -a arm64 --minimal

To stop the build early you can run:

$ docker stop $CONTAINER_ID

where $CONTAINER_ID is determined from docker ps.

Contributing

See the main Maru OS repository for more info.

Licensing

Apache 2.0