lxdepot

module
v0.0.0-...-7f8d8f8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2023 License: BSD-3-Clause

README

LXDepot

LXDepot is a simple UI to interface with one to many LXD servers, allowing you to start, stop, create, and delete containers.

Additionally, it can talk to third party DNS providers to automatically register and remove records, and bootstrap containers so once a user hits create, they can sit back for a moment and then be ready to SSH in and begin work.

Usage

LXDepot has only a few command line flags to keep things simple

    -port       (default:8080) which port to bind to
    -config     (default:configs/config.yaml) instance config file
    -webroot    (default:web/) where our templates + static files live
    -cache_templates (default:true) more for dev work, setting to false make the service read the web templates off disk each request

Ex.

./lxdepot -port=8888 -config=/opt/lxdepot/configs/config.yaml -webroot=/opt/lxdepot/web/

Config

The config file controls PKI, the hosts we talk to, DNS configuration, and bootstrapping commands. A fully documented sample config can be found in configs/sample.yaml

PKI

To use this you need to create a client cert and key using openssl or similar. An example openssl command is:

openssl req -x509 -nodes -newkey rsa:4096 -keyout client.key -out client.crt -days 365 -subj '/CN=lxdepot'

This cert will then need added to all the LXD hosts you want to talk to. Put the client.crt on the host and then do:

lxc config trust add client.crt

Alter the commands as you see fit, these are only examples.

The server certificate can then be found (on the LXD host) at: /var/lib/lxd/server.crt

Disabling remote management for certain containers

Sometimes you don't want people messing with your stuff. To that end, if you do not want LXDepot to manage a container, that is to say start, stop, delete (it will still be listed and you can view info on it), add this user flag to the container. It will tell LXDepot the container is off limits

During creation add this to the config, the container will start and bootstrap and then be unmanageable by LXDepot

user.lxdepot_lock=true

Or from the command line:

lxc config set CONTAINERNAME user.lxdepot_lock true
Limitations

First, this was an experiment in learning Go, so I'm sure there are a few things that make you go ... wat

Secondly, everthing was initially developed for use at Circonus so perhaps some assumptions were made (like limiting to IPv4).

Last, tests are light / not really exsistent for anything as this depends on a lot of external services to really do anything, and I haven't decided how to handle that in test yet

Directories

Path Synopsis
cmd
internal
config
Package config provides all the structure and functions for parsing and dealing with the yaml config file
Package config provides all the structure and functions for parsing and dealing with the yaml config file
dns
Package dns is for our 3rd party DNS integrations
Package dns is for our 3rd party DNS integrations
handlers
Package handlers is where all the "normal" web handlers are defined
Package handlers is where all the "normal" web handlers are defined
handlers/ws
Package ws is for our websocket handlers All the websocket handlers send 2 messages to the UI.
Package ws is for our websocket handlers All the websocket handlers send 2 messages to the UI.
lxd
Package lxd is our wrapper to the official lxd client
Package lxd is our wrapper to the official lxd client
utils
Package utils is meant to be a collection of functions that could be useful elsewhere
Package utils is meant to be a collection of functions that could be useful elsewhere

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL