Juju Charm - Glance
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Facundo Ciccioli 67c85a9688 Merge two configure keys into one in tests.yaml 1 week ago
actions Remove glance-registry in OpenStack Stein deployments 6 months ago
charmhelpers Sync helpers for 20.05 1 week ago
files Sync charm/ceph helpers, tox, and requirements 8 months ago
hooks Stop running register_configs at load time 1 week ago
lib Update tox.ini files from release-tools gold copy 3 years ago
scripts Sync scripts/. 7 years ago
templates Remove policy.json from charm for ussuri 1 month ago
tests Merge two configure keys into one in tests.yaml 1 week ago
unit_tests Remove policy.json from charm for ussuri 1 month ago
.gitignore Request class-read object_prefix rbd_children perm 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.project Add missing files 6 years ago
.pydevproject Add missing files 6 years ago
.stestr.conf Enable Bionic as a gate test 2 years ago
.zuul.yaml Switch to Ussuri jobs 7 months ago
LICENSE Re-license charm as Apache-2.0 3 years ago
Makefile Migrate functional tests from Amulet to Zaza 8 months ago
README.md Streamline README for policy overrides 4 months ago
actions.yaml Add security-checklist action 1 year ago
charm-helpers-hooks.yaml Sync charm/ceph helpers, tox, and requirements 8 months ago
config.yaml Policyd override implementation 7 months ago
copyright Re-license charm as Apache-2.0 3 years ago
hardening.yaml Add hardening support 4 years ago
icon.svg Update charm icon 2 years ago
metadata.yaml Sync c-h for py38 support and add focal to metadata 2 months ago
requirements.txt Sync charm/ceph helpers, tox, and requirements 8 months ago
revision incr revision 6 years ago
setup.cfg Add Python 3 Train unit tests 10 months ago
test-requirements.txt Sync charm/ceph helpers, tox, and requirements 8 months ago
tox.ini Sync helpers for 20.05 1 week ago

README.md

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.