OpenStack in a snap!
Go to file
Corey Bryant c853b3e8c8 Enable rw snap mount for test debugging
Add support for using unsquashfs to uncompress the microstack snap
followed by 'snap try ./squashfs-root/'. This enables installation
of the snap as an rw mount, and local files can be modified in
./squashfs-root/ and will go live instantly. See 'snap try --help'
for more details.

New tox targets are added for snap-try, snap-try-basic, and
snap-try-cluster.

Change-Id: I54fb8dc864fd4f346f20ae986155ad36bb7c1fac
2021-03-17 17:04:45 -04:00
checks Added Filebeat, NRPE and Telegraf to Microstack 2020-02-11 14:33:26 +00:00
patches Use focal/core20/Ussuri/OVN & enable confinement 2020-09-25 13:20:12 +00:00
snap/hooks Fix service enablement during init 2020-11-12 15:01:32 +03:00
snap-overlay Only include loop devices in LVM global_filter 2021-03-17 17:01:29 -04:00
snap-wrappers Skip hostname checks and drop IP-based ACLs 2020-11-09 13:30:41 +03:00
tests Enable rw snap mount for test debugging 2021-03-17 17:04:45 -04:00
tools Add missing dependencies to requirements.txt 2021-01-21 18:49:08 +00:00
.gitignore Strict confinement (devmode) 2020-03-05 09:31:15 +00:00
.gitreview Added automated testing via tox and zuul. 2019-07-24 08:04:38 +01:00
.zuul.yaml Migrate functional testing to third-parth CI 2021-01-15 14:08:02 +03:00
CONTRIBUTING.md Updated "Building MicroStack" section of CONTRIBUTING.md 2019-11-14 17:36:25 +00:00
DEMO.md Add Secure Clustering 2020-10-15 01:37:33 +03:00
README.md Add command to README for retrieving admin password 2020-12-03 16:44:31 +00:00
filebeat.pgp.key Added Filebeat, NRPE and Telegraf to Microstack 2020-02-11 14:33:26 +00:00
osci.yaml Fail fast when one of the gate jobs fails 2021-03-11 16:17:48 +01:00
snapcraft.yaml Only include loop devices in LVM global_filter 2021-03-17 17:01:29 -04:00
telegraf.pgp.key Added Filebeat, NRPE and Telegraf to Microstack 2020-02-11 14:33:26 +00:00
test-requirements.txt Rework the test framework & the clustering test 2021-01-15 15:58:03 +03:00
tox.ini Enable rw snap mount for test debugging 2021-03-17 17:04:45 -04: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

The edge channel is moving toward a strictly confined snap. At this time, it must be installed in devmode:

sudo snap install microstack --devmode --edge

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. The username is 'admin' and the password can be obtained in this way:

sudo snap get microstack config.credentials.keystone-password

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

LMA stack

Filebeat, Telegraf and NRPE are bundled as the snap systemd services.

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.