OpenStack in a snap!
Go to file
Ryan Beisner 130ff892b7
Merge pull request #48 from CanonicalLtd/add-launch-to-readme
README now mentions microstack.launch.
2018-12-13 11:12:38 -06:00
patches Major restructure 2018-11-02 10:55:42 +00:00
snap/hooks Perist external bridge over reboots. 2018-12-05 21:25:11 +00:00
snap-overlay Switched to qemu and host-model libvirt settings. 2018-12-12 22:08:59 +00:00
snap-wrappers Drop libvirt wrapper script, no longer needed 2018-11-06 09:07:05 +00:00
src Avoid getting to "(try 4 of 3)" tries to build the instance (#40) 2018-11-28 18:24:43 -05:00
tests Switch region name to microstack 2018-11-08 09:41:49 +00:00
.gitignore Fix horizon (#23) 2018-11-07 16:30:20 -05:00 README now mentions microstack.launch. 2018-12-12 22:32:10 +00:00
snapcraft.yaml Perist external bridge over reboots. 2018-12-05 21:25:11 +00:00


Snap Status

OpenStack in a snap that you can run locally on a single machine!

microstack currently provides Nova, Keystone, Glance, Horizon and Neutron OpenStack services.


microstack is frequently updated to provide the latest stable updates of the most recent OpenStack release. The quickest was to get started is to install directly from the snap store. You can install microstack using:

sudo snap install microstack --classic --candidate


To quickly configure networks and launch a vm, run microstack.launch.

This will launch an instance for you, and make it available to manage via the command line, or via the Horizon Dashboard.

To access the Dashboard, visit http://localhost in a web browser, and login with the following credentials:

username: admin
password: keystone

To ssh into the instance, use the username "cirros" and the ssh key written to ~/.ssh/id_microstack:

ssh -i ~/.ssh/id_microstack cirros@<IP> (Where 'IP' is listed in the output of microstack.launch)

To run openstack commands, run microstack.openstack <some command>

For more detail and control, read the rest of this README. :-)

Accessing OpenStack

microstack provides a pre-configured OpenStack CLI to access the local OpenStack deployment; its namespaced using the microstack prefix:

microstack.openstack server list

You can setup this command as an alias for openstack if you wish (removing the need for the microstack. prefix):

sudo snap alias microstack.openstack openstack

Alternatively you can access the Horizon OpenStack dashboard on with the following credentials:

username: admin
password: keystone

Booting and accessing an instance

microstack comes preconfigured with networking and images so you can get starting using OpenStack as soon as microstack is installed; to boot an instance:

microstack.openstack server create --flavor m1.small --nic net-id=test --image cirros my-microstack-server

To access the instance, you'll need to assign it a floating IP address:

ALLOCATED_FIP=`microstack.openstack floating ip create -f value -c floating_ip_address external`
microstack.openstack server add floating ip my-microstack-server $ALLOCATED_FIP

and as you would expect, microstack is just like a full OpenStack Cloud and does not allow ingress access to the instance by default, so next enable SSH and ping access to the instance:

SECGROUP_ID=`microstack.openstack security group list --project admin -f value -c ID`
microstack.openstack security group rule create $SECGROUP_ID --proto tcp --remote-ip --dst-port 22
microstack.openstack security group rule create $SECGROUP_ID --proto icmp --remote-ip

once this is complete you should be able to SSH to the instance:

ssh cirros@$ALLOCATED_FIP

Happy microstacking!

Stopping and starting microstack

You may wish to temporarily shutdown microstack when not in use without un-installing it.

microstack can be shutdown using:

sudo snap disable microstack

and re-enabled latest using:

sudo snap enable microstack