Juju Charm - Glance Simplestreams Sync
Go to file
Corey Bryant e752d8de26 Pin tox to < 4.0.0
Tox 4.0.0 was recently released and it has several breaking changes.
We pin to < 4.0.0 here. We are planning to move forward only on the
master charm branches.

Tox is also pinned to < 4.0.0 for stable branches in upstream
openstack-zuul-jobs as well as in zosci-config. However, the
requires= section in the charm's tox.ini file ends up installing
tox>4, wiping out the zuul-pinned tox<4 that was already installed
installed. This patch fixes that.

Related-Bug: #2002788
Change-Id: I8d9ca1ae1698597a4368093a35b5dc846918d355
2023-01-13 15:14:41 -05:00
actions Switch to using snap for simplestreams tools 2020-06-18 08:50:02 +01:00
charmhelpers Add xena bundles 2021-09-23 10:50:27 +01:00
files Support --visibility option for simplestreams 2022-07-21 19:22:04 +00:00
hooks Support --visibility option for simplestreams 2022-07-21 19:22:04 +00:00
lib Update tox, requirements, add initial func tests framework 2018-04-06 22:06:49 +00:00
templates Support --visibility option for simplestreams 2022-07-21 19:22:04 +00:00
tests Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
unit_tests Add use-internal-endpoints as a new config option 2021-09-02 11:03:32 -07:00
.gitignore Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
.gitreview Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
.stestr.conf Replace ostestr with stestr in testing framework. 2019-03-07 17:11:21 -05:00
.zuul.yaml Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
HACKING.md Add doc pointing contributors to charm-guide 2019-07-16 09:42:57 +02:00
LICENSE Relicense to Apache2 2018-05-08 12:30:29 -05:00
Makefile Migrate from Amulet to Zaza 2019-09-12 22:41:32 +12:00
README.md Update README 2020-08-11 16:03:23 -04:00
actions.yaml Switch to using snap for simplestreams tools 2020-06-18 08:50:02 +01:00
build-requirements.txt Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
charm-helpers-hooks.yaml Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
charmcraft.yaml Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
config.yaml Support --visibility option for simplestreams 2022-07-21 19:22:04 +00:00
copyright Update copyright date 2018-05-08 12:37:36 -05:00
metadata.yaml Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
osci.yaml Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
pip.sh Add xena bundles 2021-09-23 10:50:27 +01:00
rename.sh Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
requirements.txt Dynamically generate proxy settings for image syncs 2021-07-22 21:14:03 +03:00
setup.cfg Initial baseline from bzr 2017-04-10 09:00:27 +01:00
test-requirements.txt Migrate charm charmhub for stable/victoria 2022-07-11 11:32:35 +01:00
tox.ini Pin tox to < 4.0.0 2023-01-13 15:14:41 -05:00

README.md

Overview

The glance-simplestreams-sync charm keeps OpenStack cloud images (in Glance) synchronised with the latest available images from a Simplestreams mirror(s). It uses Cron to do this.

The charm places simplestreams metadata in Object storage for future use by Juju. It then publishes the URL for that metadata as the endpoints of a new OpenStack service called 'product-streams'.

The charm installs Simplestreams from a snap.

Usage

Configuration

This section covers common and/or important configuration options. See file config.yaml for the full list of options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.

run

The run option enables the synchronisation cron script. This option accepts Boolean values ('true' or 'false') with the default value being 'false'. Changing the value from 'false' to 'true' will immediately schedule an image sync.

Note: Enabling this option at cloud deploy time may cause a race condition with the set up of a possible storage backend for Glance.

frequency

The frequency option controls how often the sync cron job is run. It is used to link the cron script into /etc/cron.<frequency>. Valid string values are: 'hourly', 'daily', and 'weekly'. The default is 'daily'.

region

The region option states the OpenStack region to operate in. The default value is 'RegionOne'.

mirror_list

The mirror_list option is a YAML-formatted list of Simplestreams mirrors and their configuration properties. The default behaviour is to download images from https://cloud-images.ubuntu.com.

ssl_ca

The ssl_ca option verifies (optionally) the certificates when in SSL mode for Keystone and Glance. This should be provided as a base64 encoded PEM certificate.

Deployment

To deploy to an existing OpenStack cloud (that already includes Glance, Object storage, and Keystone):

juju deploy glance-simplestreams-sync
juju add-relation glance-simplestreams-sync:identity-service keystone:identity-service

Note: Charmed OpenStack commonly employs Ceph-backed Object storage (see the ceph-radosgw charm). Otherwise, a vanilla Swift-based solution can be used (see the swift-proxy charm).

Actions

Juju actions allow specific operations to be performed on a per-unit basis. This charm supports the single action sync-images, which allows for a one-time image sync from the currently configured mirror list.

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.