Juju Charm - Glance Simplestreams Sync
Go to file
melissaml f42904ee89 fix typos in the docstring
Change-Id: I17f78630aab6d08003de514e4da3d0f3afb25edd
2018-12-22 03:52:53 +08:00
actions Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
charmhelpers fix typos in the docstring 2018-12-22 03:52:53 +08:00
hooks Series Upgrade 2018-10-23 22:24:27 +00:00
lib Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
scripts Trivial restoration of endpoint URI updates 2018-05-17 08:23:08 +01:00
templates Keystone v3 updates 2017-09-12 22:16:54 +00:00
tests Update requirements 2018-10-03 11:41:11 -05:00
unit_tests Fix lint in unit test 2018-11-02 19:28:53 +08:00
.gitignore Update series metadata, test combos and readme 2018-04-10 14:33:49 +00:00
.gitreview Add gitreview file in prep for gerrit 2018-05-08 12:03:26 -05:00
.testr.conf Initial baseline from bzr 2017-04-10 09:00:27 +01:00
.zuul.yaml import zuul job settings from project-config 2018-09-11 13:09:31 -04:00
LICENSE Relicense to Apache2 2018-05-08 12:30:29 -05:00
Makefile Tests dir no longer need copy of charmhelpers 2018-10-10 12:40:13 +00:00
README.md Merge pull request #7 from openstack-charmers/update-readme-1508 2018-05-08 10:43:28 -07:00
charm-helpers-hooks.yaml Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
config.yaml Add bionic to list of images to sync by default 2018-05-17 09:09:51 +01:00
copyright Update copyright date 2018-05-08 12:37:36 -05:00
metadata.yaml Change openstack-dev to openstack-discuss 2018-11-18 03:08:50 -05:00
requirements.txt Update requirements 2018-10-03 11:41:11 -05:00
setup.cfg Initial baseline from bzr 2017-04-10 09:00:27 +01:00
test-requirements.txt Update requirements 2018-10-03 11:41:11 -05:00
tox.ini fix tox python3 overrides 2018-09-26 18:38:10 -04:00

README.md

Known Issues

https://bugs.launchpad.net/charm-glance-simplestreams-sync

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 relation to keystone. It also requires a running glance instance, but not a direct relation to glance. It connects to 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.