openstack
/
charm-glance-simplestreams-sync
Code Issues Proposed changes
Juju Charm - Glance Simplestreams Sync
29 Commits 28 Branches 0 Tags 2.5 MiB
Python 99.5%
Shell 0.5%
Go to file
Ryan Beisner 7ac139fb75 Update copyright file 2018-05-08 12:35:22 -05:00
actions Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
charmhelpers Sync charmhelpers to pull in Queens, KSv3 and other updates 2018-04-06 22:11:21 +00:00
hooks Relicense to Apache2 2018-05-08 12:30:29 -05:00
lib Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
scripts Clarify lint cleanup with comment on user_agent 2018-04-12 20:21:25 +00:00
templates Keystone v3 updates 2017-09-12 22:16:54 +00:00
tests Merge pull request #4 from openstack-charmers/test-updates 2018-04-13 09:51:00 -05:00
unit_tests Resync charmhelpers for fixes to add_source 2017-04-10 09:25:48 +01:00
.bzrignore Initial baseline from bzr 2017-04-10 09:00:27 +01:00
.gitignore Update series metadata, test combos and readme 2018-04-10 14:33:49 +00:00
.project Initial baseline from bzr 2017-04-10 09:00:27 +01:00
.testr.conf Initial baseline from bzr 2017-04-10 09:00:27 +01:00
LICENSE Relicense to Apache2 2018-05-08 12:30:29 -05:00
Makefile Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
README.md Relicense to Apache2 2018-05-08 12:30:29 -05:00
charm-helpers-hooks.yaml Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
charm-helpers-tests.yaml Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
config.yaml Initial baseline from bzr 2017-04-10 09:00:27 +01:00
copyright Update copyright file 2018-05-08 12:35:22 -05:00
metadata.yaml Update series metadata, test combos and readme 2018-04-10 14:33:49 +00:00
requirements.txt Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
setup.cfg Initial baseline from bzr 2017-04-10 09:00:27 +01:00
test-requirements.txt Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
tox.ini Update tox to add lint coverage of scripts dir 2018-04-12 19:11:29 +00:00

README.md

Notice

This charm has been tested with Trusty and Xenial series. Bionic series is enabled, but is still under testing and in development.

Overview

This charm provides a service that syncs your OpenStack cloud's available OS images in OpenStack Glance with the available images from a set of simplestreams mirrors, by default using cloud-images.ubuntu.com.

It will create a user named 'image-stream' in the 'services' tenant. If swift is enabled, glance will store its images in swift using the image-stream username.

It can optionally also store simplestreams metadata into Swift for future use by juju. If enabled, it publishes the URL for that metadata as the endpoints of a new OpenStack service called 'product-streams'. If using Swift is not enabled, the product-streams service will still exist, but nothing will respond to requests to its endpoints.

The charm installs a cron job that repeatedly checks the status of related services and begins syncing image data from your configured mirrors as soon as all services are in place.

It can be deployed at any time, and upon deploy (or changing the 'run' config setting), it will attempt to contact keystone and glance and start a sync every minute until a successful sync occurs.

Requirements

This charm requires a juju relation to Keystone. It also requires a running Glance instance, but not a relation - it connects with glance via its endpoint as published in Keystone.

Usage

juju deploy glance-simplestreams-sync [--config optional-config.yaml]
juju add-relation keystone glance-simplestreams-sync

Configuration

The charm has the following configuration variables:

run

run is a boolean that enables or disables the sync cron script. It is True by default, and changing it from False to True will schedule an immediate attempt to sync images.

use_swift

use_swift is a boolean that determines whether or not to store data in swift and publish the path to product metadata via the 'product-streams' endpoint.

NOTE Changing the value will only affect the next sync, and does not currently remove an existing product-streams service or delete potentially stale product data.

frequency

frequency is a string, and must be one of 'hourly', 'daily', 'weekly'. It controls how often the sync cron job is run - it is used to link the script into /etc/cron.$frequency.

region

region is the OpenStack region in which the product-streams endpoint will be created.

mirror_list

mirror_list is a yaml-formatted list of options to be passed to Simplestreams. It defaults to settings for downloading images from cloud-images.ubuntu.com, and is not yet tested with other mirror locations. If you have set up your own Simplestreams mirror, you should be able to set the necessary configuration values.