Skip to content

Compose-like wrapper for LXD and deployment automatization

License

Notifications You must be signed in to change notification settings

OSSHelp/lxhelper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LXHelper

Build Status

About

This script is used with the lxd-functions library for LXD container deployment.

Requirements

  • Ubuntu Xenial/Bionic/Focal
  • LXD client and accessible LXD server (2.15+, 3.x, 4.x)

There is also limited support for the following distributions:

  • CentOS 7.x or newer
  • Debian 8.x or newer

Mostly it should work but without any guarantees ;)

How to use it

Installtion

LXHelper is just a wrapper around lxd-functions.sh library. For deployment you need:

  1. Place lxd-function.sh library in the /usr/local/include/osshelp/ path
  2. Place lxhelper script in the /usr/local/sbin/ path
  3. Place the container YAML config in the /usr/local/etc/lxc/ path (see examples dir)

There’re install/update scripts in the repository. Command for installation (lxd-function.sh, lxhelper, yq and minio-client):

curl -s https://oss.help/scripts/lxc/lxhelper/install.sh | bash

Options

LXHelper usage is described in the table below:

Action Description Usage
deploy-container deploy one container from specified YAML config `lxhelper deploy-container [-y=(URL
deploy-containers deploy all containers from specified YAML config `lxhelper deploy-containers [-y=(URL
download-image download container image with specified source URL in the YAML config `lxhelper download-image [-y=(URL
create-image create image from the container with the same name or with specified name lxhelper create-image container_name [image_name]
export-image export specified image to archive lxhelper export-image image_name
update-image create and export container image from the container lxhelper update-image image_name
update-configs update all YAML configs in specified path (default path /usr/local/etc/lxc/) lxhelper update-configs [/path/to/dir]

Useful

LXHelper is tightly coupled with deploy-functions library, but it's still possible to use LXHelper without it.

Author

OSSHelp Team, see https://oss.help

About

Compose-like wrapper for LXD and deployment automatization

Topics

Resources

License

Stars

Watchers

Forks

Languages