edlerd / lxd-ui

LXD-UI

LXD-UI is a browser frontend for LXD. It enables easy and accessible container and virtual machine management. Targets small and large scale private clouds.

Setting up for development

Setup LXD - Linux (with snap)

snap install lxd
lxd init # can accept all defaults
lxc config set core.https_address "[::]:8443"

Setup LXD - Mac

⚠️ VM instances cannot be created with LXC + Multipass on a Mac. Nested virtualization is unsupported.

First, if you have not already, you need to install Homebrew.

Then install LXC client with brew:

brew install lxc

LXD cannot run natively on a Mac, so you need to connect LXC to a remote LXD server. You can set up one inside a Multipass instance. How to install Multipass on macOS - Using brew

Once you have LXC and Multipass installed, we can create a Multipass instance where we will run the LXD daemon:

# launch a new instance called "lxd" with 2 CPUs, 4G memory, and 50G of disk space - gauge these values as you prefer
multipass launch -n lxd -c 2 -m 4G -d 50G

If you get the Launched: lxd output, it means that the command succeeded. We can now launch a shell into the newly created instance:

multipass shell lxd

You should be greeted with the Ubuntu shell login message Welcome to Ubuntu .... Make sure the latest version of LXD is installed:

sudo snap refresh lxd --channel=latest/stable

This command will either output snap "lxd" has no updates available or update lxd to the latest stable version.

Initialise LXD - replace your-password with a password of your choice - and then close the multipass shell:

sudo lxd init --auto --trust-password your-password --network-address '[::]'
exit

Connect the LXD server in Multipass to the local LXC. In a terminal on your Mac, run:

lxc remote add default $(multipass info lxd | grep IPv4 | awk '{print $2}') --password your-password --accept-certificate

(replace your-password with the password you selected before)

You should get a message saying: Client certificate now trusted by server: default

Switch the remote to the default server that we have just added:

lxc remote switch default

Launch an instance with the lxc command on your Mac:

lxc launch ubuntu:jammy test-jammy

If this succeeds, the setup of LXC and LXD is complete. Finally, expose the API on port 8443:

lxc config set core.https_address "[::]:8443"

Now, proceed with the steps to run the LXD-UI.

Install dotrun as described in https://github.com/canonical/dotrun#installation Launch it from the head of this repo

dotrun

You should enable a firewall as dotrun exposes an api to start or interact with unprivileged containers on your public ip via port 8407. Ensure that the lxd API on port 8443 is open, so dotrun can access it.

First time running dotrun will generate certificates for you. You can find them in the keys folder on the top of this repo. Trust them from your local lxd with

sudo lxc config trust add keys/lxd-ui.crt

If you are on a Mac and running LXD inside Multipass, set the LXD_UI_BACKEND_IP in the .env.local file:

echo "LXD_UI_BACKEND_IP=$(multipass info lxd | grep IPv4 | awk '{print $2}')" > .env.local

Now you can browse through https://localhost:8407/ to reach lxd-ui.

To enable pre commit checks, after the 1st successful run of dotrun, execute yarn hooks-add. You can remove the hooks with yarn hooks-remove later.

End-to-end tests

Install playwright and its browsers

npx playwright install

The tests expect the environment on localhost to be accessible. Execute dotrun and start tests with

npx playwright test

Generate new tests with helper

npx playwright codegen --ignore-https-errors https://localhost:8407/

Examples

Image Selection	Instances	Instances - Detail

Snapshots	Terminal	Profiles - Detail