Purpose

LXDHub is a management system for linux containers (LXC). With LXDHub you can visualize LXC images of multiple (private & public) remotes. One of the key features of LXDHub is to clone LXC images from one remote to another. Therefor you can mirror public remotes to your private remote.

Packages

Under the hood, LXDHub is split in five packages. The following graph visualizes the dependencies of each package.

The packages @lxdhub/db and @lxdhub/common are solely libraries, which can not be run seperatly. Whereas the packages @lxdhub/web, @lxdhub/api and @lxdhub/dbsync can be run seperatly via Docker or NodeJS.

Installation

Prerequisites

• docker >=18.02.0-ce
• docker-compose >=1.19.0

Generate LXC Certificate

Before you can start the application, you need to add your LXC certificates. More information on generate-lxc-certificates.md

Configure Remotes

You update the lxdhub remotes by editing the lxdhub.yml file. Simply copy the given template and add / alter remotes.

mv lxdhub.yml.template lxdhub.yml
vi lxdhub.yml

Run in Docker

This script builds the project, builds the docker containers and runs them.

docker-compose build
docker-compose up

Tests

Unit / Integration Tests

Run the automated test cases with NodeJS.

# Only need to do once
npm install
# Run tests
./bin/run-tests.sh
# Get coverage report on http://localhost:8000
cd coverage && python -m SimpleHTTPServer 8000

Environment for Manual Testing

LXC

First you need to install lxd. Then run the command ./bin/setup-local-test-remote.sh which uses the port 8443 for your local LXC REST API. The default password for your local remote is unsecret.

LXDHub API

The LXDHub API offers a test environment, which can be tested manually. To run the tests, NodeJS V9 needs to be installed and run npm install. Run

./bin/start-lxdhub-api-test-env.sh

The data will no be loaded from your local SQLite database. The model data inside the test environment, are defined inside the src/api/test/fixtures/*.json files.

Related

• @lxdhub/web: The LXDHub webinterface
• @lxdhub/api: The REST API for the LXDHub webinterface
• @lxdhub/dbsync: The script to synchronize multiple LXD remotes with the LXDHub database
• @lxdhub/db: The package, which provides database functions for the @lxdhub/api and @lxdhub/dbsync packages
• @lxdhub/common: The package, which provides common functions for all LXDHub-packages
• CONTRIBUTING.md: The contributing guidelines
• COPYRIGHT: Copyright informations
• publish.md: Documentation on how LXDHub is being published
• LXC: The underlaying technology behind LXDHub

People

• Livio Brunner - Author
• Eric Keller - Idea