OpenStack in a snap!
Go to file
Zuul be4e35ab29 Merge "Initial DPDK support" 2020-02-11 01:43:32 +00:00
patches Align ovs version with Stein UCA 2019-10-18 15:40:41 +00:00
snap/hooks Initial DPDK support 2019-12-09 16:45:11 +01:00
snap-overlay Merge "Initial DPDK support" 2020-02-11 01:43:32 +00:00
snap-wrappers Initial DPDK support 2019-12-09 16:45:11 +01:00
tests Fixes for snapcraft 3.9.x 2020-01-29 14:49:03 +00:00
tools Merge "Initial DPDK support" 2020-02-11 01:43:32 +00:00
.gitignore Added testing for control nodes 2019-10-16 15:44:38 +00:00
.gitreview Added automated testing via tox and zuul. 2019-07-24 08:04:38 +01:00
.zuul.yaml Ported and updated launch script 2019-10-23 01:09:42 +00:00
CONTRIBUTING.md Updated "Building MicroStack" section of CONTRIBUTING.md 2019-11-14 17:36:25 +00:00
DEMO.md Ported and updated launch script 2019-10-23 01:09:42 +00:00
README.md Added microstack.remove command 2019-12-17 17:11:32 +00:00
snapcraft.yaml Merge "Initial DPDK support" 2020-02-11 01:43:32 +00:00
test-requirements.txt Added testing for control nodes 2019-10-16 15:44:38 +00:00
tox.ini Fixes for snapcraft 3.9.x 2020-01-29 14:49:03 +00:00

README.md

MicroStack

Snap Status

MicroStack is a single-machine, snap-deployed OpenStack cloud.

Common purposes include:

  • Development and testing of OpenStack workloads
  • Continuous integration (CI)
  • IoT and appliances
  • Edge clouds (experimental)
  • Introducing new users to OpenStack

Currently provided OpenStack services are: Nova, Keystone, Glance, Horizon, and Neutron.

MicroStack is frequently updated to provide the latest stable updates of the most recent OpenStack release.

Requirements: You will need at least 2 CPUs, 8 GiB of memory, and 100 GiB of disk space.

See the full MicroStack documentation.

Installation

At this time you can install from the --beta or --edge snap channels:

sudo snap install microstack --classic --beta

Initialisation

Initialisation will set up databases, networks, flavors, an SSH keypair, a CirrOS image, and open ICMP/SSH security groups:

sudo microstack.init --auto

OpenStack client

The OpenStack client is bundled as microstack.openstack. For example:

microstack.openstack network list
microstack.openstack flavor list
microstack.openstack keypair list
microstack.openstack image list
microstack.openstack security group rule list

Creating an instance

To create an instance (called "awesome") based on the CirrOS image:

microstack.launch cirros --name awesome

SSH to an instance

The launch output will show you how to connect to the instance. For the CirrOS image, the user account is 'cirros'.

ssh -i ~/.ssh/id_microstack cirros@<ip-address>

Horizon

The launch output will also provide information for the Horizon dashboard. Its credentials are:

username: admin
password: keystone

Removing MicroStack

To remove MicroStack, run:

sudo microstack.remove --auto

This will clean up the Open vSwitch bridge device and uninstall MicroStack. If you remove MicroStack with the snap remove command instead, don't worry -- the Open vSwitch bridge will disappear the next time that you reboot your system.

Note that you can pass any arguments that you'd pass to the snap remove command to microstack.remove. To purge the snap, for example, run:

sudo microstack.remove --auto --purge

Customising and contributing

To customise services and settings, look in the .d directories under /var/snap/microstack/common/etc. You can add services with your package manager, or take a look at CONTRIBUTING.md and make a code based argument for adding a service to the default list.

Reporting a bug

Please report bugs to the MicroStack project on Launchpad.