This repository contains tools for working with XRd containers.
Accompanying documentation is coming soon.
See CHANGELOG.md for a record of changes that have been made.
See docs/version-compatibility.md for the compatibility statement across versions.
Download an archive from the releases page.
XRd is only able to run on Linux, therefore the scripts provided here are also targeting Linux.
The scripts are implemented in bash and python3, which must therefore be found on PATH.
All active versions of python3 are supported.
The xr-compose script also requires docker-compose (v1) to be on PATH and for the PyYAML python package be installed (e.g. in an active virtual environment).
Accompanying documentation is coming soon.
Check the usage of the scripts by passing --help.
host-check- Check the host is set up correctly for running XRd containers.launch-xrd- Launch a single XRd container, or use--dry-runto see the args required.xr-compose- Launch a topology of XRd containers (wrapsdocker-compose).apply-bugfixes- Create a new XRd image with bugfixes installed on top of a base image.
Sample files, e.g. xr-compose topology samples.
Template files, whether illustrative scripts or template config/topology files.
Tests for the scripts.
Dockerfile for producing a host-check container image.
This project loosely follows semantic versioning.
Version numbers consist of major, minor and patch, e.g. v1.0.2.
Cosmetic changes will involve a patch bump, moderate (possibly breaking) changes will be a minor bump, while significant backwards-incompatible changes require a major version bump.
Major version bumps are avoided as much as possible since we want to maintain backwards compatibility! An example of a breaking change requiring a major version bump would be dropping support for an old XR release version, however this should not be a common occurrence (we aim to maintain compatibility of at least 3 release versions at a time).
Minor version bumps may introduce incompatibilities with previous invocations as long as these are documented in version-compatibility.md, and as long as there's still a way to tweak the invocation to work with the same range of XR releases.
Thanks for considering contributing to the project!
Check out the repo's open issues or see CONTRIBUTING.md for more contributing guidelines.