diff --git a/README.md b/README.md index b8f32d2..b6aa5b3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@ # Overview -LXD is a hypervisor for managing Linux Containers; it provides a simple RESTful API for creation and management of containers. +LXD is a hypervisor for managing Linux Containers; it provides a simple RESTful API for creation and management of containers. This charm is currently specific to LXD's use with nova-lxd, but that's only by usage, rather than specific design. -# Usage +# Usage with nova-compute and nova-lxd -The lxd charm can be used in-conjunction with any principle charm to setup and enable use of LXD; its primary use case is with the nova-compute charm to enable LXD based OpenStack Clouds: +While the lxd charm can be used with any charm to enable use of LXD, its primary use is +with the nova-compute Openstack charm, for provisioning LXD based OpenStack Nova +instances. - juju deploy cs:~openstack-charmers-next/wily/nova-compute +For example: + + juju deploy nova-compute juju set nova-compute virt-type=lxd - juju deploy cs:~openstack-charmers-next/wily/lxd + juju deploy lxd juju set lxd block-devices=/dev/sdb storage-type=lvm juju add-relation lxd nova-compute -At this point in time, LXD is only supported on Ubuntu 15.10 or above, in-conjunction with OpenStack Liberty (provided as part of Ubuntu 15.10). +The caveat is that nova-compute is part of a greater ecosystem of many OpenStack service +charms. For a full OpenStack Mitaka deployment using LXD, please +refer to the [OpenStack LXD](https://jujucharms.com/u/openstack-charmers-next/openstack-lxd) bundle. -For a full OpenStack Liberty deployment using LXD, please refer to the [OpenStack LXD](https://jujucharms.com/u/openstack-charmers-next/openstack-lxd) bundle. +At this time, nova-lxd is only supported on Ubuntu 16.04 or above, with OpenStack Mitaka +(provided as part of Ubuntu 16.04). # Contact Information