From 2184b0391f56ebe8220273c35e71a7ecc685b895 Mon Sep 17 00:00:00 2001 From: Paul Hummer Date: Thu, 21 Apr 2016 12:04:02 -0600 Subject: [PATCH] Update readme for better detail for using with devstack --- README.md | 30 +++++++++++++++++++++++++++--- devstack/README.rst | 15 --------------- 2 files changed, 27 insertions(+), 18 deletions(-) delete mode 100644 devstack/README.rst diff --git a/README.md b/README.md index 57b0998a..12fa90f4 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,32 @@ An OpenStack Compute driver for managing containers using LXD. -## Bug reports +## nova-lxd on Devstack -Bug reports can be filed at https://github.com/lxc/nova-lxd/issues/new +For development purposes, nova-lxd provides a devstack plugin. To use it, just include the +following in your devstack `local.conf` -## Support and discussions + [[local|localrc]] + enable_plugin nova-lxd https://github.com/lxc/nova-lxd + +Change git repositories as needed (it's probably not very useful to point to the main +nova-lxd repo). If you have a local tree you'd like to use, you can symlink your tree to +`/opt/stack/nova-lxd` and do your development from there. + +The devstack default images won't work with lxd, as lxd doesn't support them. Once your +stack is up and you've configured authentication against your devstack, do the following: + + wget http://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-root.tar.gz + glance image-create --name xenial --disk-format raw --container-format bare --file xenial-server-cloudimg-amd64-root.tar.gz + +You can test your configuration using the exercise scripts in devstack. For instance, + + DEFAULT_IMAGE_NAME=xenial ./exercises/volumes.sh + +Please note: the exercise scripts in devstack likely won't work, as they have requirements +for using the cirros images. + +# Support and discussions We use the LXC mailing-lists for developer and user discussions, you can find and subscribe to those at: https://lists.linuxcontainers.org @@ -14,3 +35,6 @@ find and subscribe to those at: https://lists.linuxcontainers.org If you prefer live discussions, some of us also hang out in [#lxcontainers](http://webchat.freenode.net/?channels=#lxcontainers) on irc.freenode.net. +## Bug reports + +Bug reports can be filed at https://github.com/lxc/nova-lxd/issues/new diff --git a/devstack/README.rst b/devstack/README.rst deleted file mode 100644 index 5622963f..00000000 --- a/devstack/README.rst +++ /dev/null @@ -1,15 +0,0 @@ -==================== -Enabling in Devstack -=================== - -1. Download DevStack: - - $ git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack - -2. Modify DevStack's local.conf to pull in this project by adding: - - [[local|localrc]] - enable_plugin nova-lxd https://github.com/lxc/nova-lxd - -3. run stack.sh -