Juju Charm - Glance
Go to file
Alex Kavanagh 848eb535a4 Remove policy.json from charm for ussuri
Glance (in ussuri) uses policy-in-code, and so that policy.json file
doesn't ship with the package.  This means that the charm can't rely on
the file existing ussuri onwards.  This patchset changes the way the
charm uses policy.json by switching it to a charm determined policy.yaml
file (preferred format) with the only 3 options that the charm
determines to enforce.

Also add yaml vars to focal-ussuri bundle

This brings it into line with the other charms that are part of the the
enable-focal topic.  This makes it easier to add a new bundle just by
changing a couple of variables.

Closes-Bug: #1872996
Change-Id: I47f19272a4e0af3781843608b76304ce8ba1e2b8
2020-04-23 16:17:35 +01:00
actions Remove glance-registry in OpenStack Stein deployments 2019-11-30 19:49:11 +02:00
charmhelpers Sync c-h for py38 support and add focal to metadata 2020-03-06 14:08:30 +01:00
files Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:03 -05:00
hooks Remove policy.json from charm for ussuri 2020-04-23 16:17:35 +01:00
lib Update tox.ini files from release-tools gold copy 2016-09-09 19:43:11 +00:00
scripts Sync scripts/. 2013-04-09 11:30:47 -07:00
templates Remove policy.json from charm for ussuri 2020-04-23 16:17:35 +01:00
tests Remove policy.json from charm for ussuri 2020-04-23 16:17:35 +01:00
unit_tests Remove policy.json from charm for ussuri 2020-04-23 16:17:35 +01:00
.gitignore Request class-read object_prefix rbd_children perm 2017-12-15 11:05:31 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:31:05 +00:00
.project Add missing files 2013-10-22 16:15:28 -07:00
.pydevproject Add missing files 2013-10-22 16:15:28 -07:00
.stestr.conf Enable Bionic as a gate test 2018-05-11 14:29:27 -07:00
.zuul.yaml Switch to Ussuri jobs 2019-10-22 11:37:20 +08:00
actions.yaml Add security-checklist action 2019-03-14 16:49:11 +01:00
charm-helpers-hooks.yaml Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:03 -05:00
config.yaml Policyd override implementation 2019-10-07 22:04:00 +01:00
copyright Re-license charm as Apache-2.0 2016-07-01 17:23:19 +01:00
hardening.yaml Add hardening support 2016-03-29 14:26:51 +01:00
icon.svg Update charm icon 2017-08-02 18:16:04 +01:00
LICENSE Re-license charm as Apache-2.0 2016-07-01 17:23:19 +01:00
Makefile Migrate functional tests from Amulet to Zaza 2019-09-10 14:48:18 +12:00
metadata.yaml Sync c-h for py38 support and add focal to metadata 2020-03-06 14:08:30 +01:00
README.md Streamline README for policy overrides 2020-01-09 12:46:10 -05:00
requirements.txt Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:03 -05:00
revision incr revision 2014-03-07 09:29:37 -05:00
setup.cfg Add Python 3 Train unit tests 2019-07-30 10:19:50 -04:00
test-requirements.txt Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:03 -05:00
tox.ini Sync charm/ceph helpers, tox, and requirements 2019-09-30 22:10:03 -05:00

Overview

This charm provides the Glance image service for OpenStack. It is intended to be used alongside the other OpenStack components.

Usage

Glance may be deployed in a number of ways. This charm focuses on 3 main configurations. All require the existence of the other core OpenStack services deployed via Juju charms, specifically: mysql, keystone and nova-cloud-controller. The following assumes these services have already been deployed.

Local Storage

In this configuration, Glance uses the local storage available on the server to store image data:

juju deploy glance
juju add-relation glance keystone
juju add-relation glance mysql
juju add-relation glance nova-cloud-controller

Swift backed storage

Glance can also use Swift Object storage for image storage. Swift is often deployed as part of an OpenStack cloud and provides increased resilience and scale when compared to using local disk storage. This configuration assumes that you have already deployed Swift using the swift-proxy and swift-storage charms:

juju deploy glance
juju add-relation glance keystone
juju add-relation glance mysql
juju add-relation glance nova-cloud-controller
juju add-relation glance swift-proxy

This configuration can be used to support Glance in HA/Scale-out deployments.

Ceph backed storage

In this configuration, Glance uses Ceph based object storage to provide scalable, resilient storage of images. This configuration assumes that you have already deployed Ceph using the ceph charm:

juju deploy glance
juju add-relation glance keystone
juju add-relation glance mysql
juju add-relation glance nova-cloud-controller
juju add-relation glance ceph

This configuration can also be used to support Glance in HA/Scale-out deployments.

NOTE: Glance acts as a Ceph client in this case which requires IP (L3) connectivity to ceph monitors and OSDs. For MAAS-based deployments this can be addressed with network spaces (see the relevant section below).

HA/Clustering

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true and at least one of 'os-public-hostname', 'os-internal-hostname' or 'os-internal-hostname' must be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances: If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster If both 'vip' and 'dns-ha' are set as they are mutually exclusive If 'dns-ha' is set and none of the os-{admin,internal,public}-hostname(s) are set

Note that Glance in HA configuration must be used with either Ceph or Swift providing backing image storage.

Glance metering

In order to do Glance metering with Ceilometer, an AMQP relation is required e.g.

juju deploy glance
juju deploy rabbitmq-server
juju deploy ceilometer-agent
...
juju add-relation glance rabbitmq-server
juju add-relation glance ceilometer-agent
...

Spaces

This charm supports the use of Juju Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal and admin endpoints.

Glance acts as a Ceph client and needs IP connectivity to Ceph monitors and OSDs. Binding the ceph endpoint to a space can solve this problem in case monitors and OSDs are located on a single L2 broadcast domain (if they are not, static or dynamic routes need to be used in addition to spaces).

Access to the underlying MySQL instance can also be bound to a specific space using the shared-db relation.

To use this feature, use the --bind option when deploying the charm:

juju deploy glance --bind \
   "public=public-space \
    internal=internal-space \
    admin=admin-space \
    shared-db=internal-space \
    ceph=ceph-access-space"

Alternatively, these can also be provided as part of a juju native bundle configuration:

    glance:
      charm: cs:xenial/glance
      num_units: 1
      bindings:
        public: public-space
        admin: admin-space
        internal: internal-space
        shared-db: internal-space
        ceph: ceph-access-space

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using os-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set.

Policy Overrides

Policy overrides is an advanced feature that allows an operator to override the default policy of an OpenStack service. The policies that the service supports, the defaults it implements in its code, and the defaults that a charm may include should all be clearly understood before proceeding.

Caution

: It is possible to break the system (for tenants and other services) if policies are incorrectly applied to the service.

Policy statements are placed in a YAML file. This file (or files) is then (ZIP) compressed into a single file and used as an application resource. The override is then enabled via a Boolean charm option.

Here are the essential commands (filenames are arbitrary):

zip overrides.zip override-file.yaml
juju attach-resource glance policyd-override=overrides.zip
juju config glance use-policyd-override=true

See appendix Policy Overrides in the OpenStack Charms Deployment Guide for a thorough treatment of this feature.

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.