39b58df7a8
This patch changes the glance_image provider to use puppet-openstacklib's authentication methods, which use python-openstackclient as an interface, instead of the glance command line client. The benefits of this is: - Code reduction. This patch reduces the amount of code in the glance parent provider and glance_image provider by reusing code from Puppet::Provider::Openstack instead of implementing authentication, retries, and response parsing in the provider. - Presumed reduction in sudden API changes that require quick fixes in this module, such as f377c0229c006b02f43a14be4979553e983cb98e. - Ability to set project-based access control for images Additional reasoning for this change is in the blueprint. Important note: this change does not work on Ubuntu under Juno due to a major bug in the version of python-openstackclient shipped in UCA [1]. This change targets the Kilo releases. Note about performance: the self.instances and instances methods make API requests for each image found in the list of instances. This is not a change from how this was implemented before. The --long formatted list, either from the glance client or openstackclient, does not provide all information needed to query an instance and populate setters. Future patches could possibly improve on this. Other details of this change: - Removes auth_glance method, replaced by the request and glance_request methods - Removes auth_glance_stdin method which was not being used - Removes parse_table which is now unnecessary because openstackclient formats its responses as CSV and Puppet::Provider::Openstack#request returns the results a hash - Removes remove_warnings methods which are handled by Puppet::Provider::Openstack#request - Removes list_glance_images and get_glance_image_attr which are sufficiently replaced by using the 'list' and 'show' commands with Puppet::Provider::Openstack's request method. - Removed self.prefetch since we can't populate auth parameters during a prefetch. Instead we prepopulate the list via the instances method. - Added a flush method to do updates more efficiently - Changed is_public property to accept true/false in addition to yes/no and to munge to a symbol instead of a capitalized string, for consistency with keystone_tenant's enabled property - Move the reset method into the spec tests since it is only necessary for testing - Added tests for glance_image, which did not exist before - Removed connection retry test since this is taken care of in openstacklib [1] https://bugs.launchpad.net/python-openstackclient/+bug/1269821 blueprint use-openstackclient-in-module-resources Change-Id: Iceab5e1c6138e7aba0f883ed4acb8f7ecbcd2830
glance
5.1.0 - 2014.2 - Juno
Table of Contents
- Overview - What is the glance module?
- Module Description - What does the module do?
- Setup - The basics of getting started with glance
- Implementation - An under-the-hood peek at what the module is doing
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Notes on the most recent updates to the module
Overview
The glance module is a part of Stackforge, an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects not part of the core software. The module its self is used to flexibly configure and manage the image service for OpenStack.
Module Description
The glance module is a thorough attempt to make Puppet capable of managing the entirety of glance. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to glance, and database connections. Types are shipped as part of the glance module to assist in manipulation of configuration files.
This module is tested in combination with other modules needed to build and leverage an entire OpenStack software stack. These modules can be found, all pulled together in the openstack module.
Setup
What the glance module affects
- glance, the image service for OpenStack.
Installing glance
example% puppet module install puppetlabs/glance
Beginning with glance
To utilize the glance module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. This is not an exhaustive list of all the components needed, we recommend you consult and understand the openstack module and the core openstack documentation.
Define a glance node
class { 'glance::api':
verbose => true,
keystone_tenant => 'services',
keystone_user => 'glance',
keystone_password => '12345',
database_connection => 'mysql://glance:12345@127.0.0.1/glance',
}
class { 'glance::registry':
verbose => true,
keystone_tenant => 'services',
keystone_user => 'glance',
keystone_password => '12345',
database_connection => 'mysql://glance:12345@127.0.0.1/glance',
}
class { 'glance::backend::file': }
Setup postgres node glance
class { 'glance::db::postgresql':
password => '12345',
}
Setup mysql node for glance
class { 'glance::db::mysql':
password => '12345',
allowed_hosts => '%',
}
Setup up keystone endpoints for glance on keystone node
class { 'glance::keystone::auth':
password => '12345'
email => 'glance@example.com',
public_address => '172.17.0.3',
admin_address => '172.17.0.3',
internal_address => '172.17.1.3',
region => 'example-west-1',
}
Setup up notifications for multiple RabbitMQ nodes
class { 'glance::notify::rabbitmq':
rabbit_password => 'pass',
rabbit_userid => 'guest',
rabbit_hosts => [
'localhost:5672', 'remotehost:5672'
],
rabbit_use_ssl => false,
}
Implementation
glance
glance is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
Limitations
- Only supports configuring the file, swift and rbd storage backends.
Beaker-Rspec
This module has beaker-rspec tests
To run the tests on the default vagrant node:
To run:
bundle install
bundle exec rspec spec/acceptance
For more information on writing and running beaker-rspec tests visit the documentation:
Development
Developer documentation for the entire puppet-openstack project.
Contributors
Release Notes
5.1.0
- Service Validation for Glance-API
- Switch to TLSv1
- spec: pin rspec-puppet to 1.0.1
- Makes kombu_ssl_* parameters optional when rabbit_use_ssl => true
- Allow overriding package ensure for glance-registry
- Move rbd related options into glance_store section
- Pin puppetlabs-concat to 1.2.1 in fixtures
- change default MySQL collate to utf8_general_ci
- Add openstack tag to glance packages
- Correctly munge glance_image is_public property
- Create a sync_db boolean for Glance
- Command parameter to sync the correct Database
- Fix catalog compilation when not configuring endpoint
- Add $notification_driver parameter to notify::rabbitmq
- Fix is_public munge
- Update .gitreview file for project rename
5.0.0
- Stable Juno release
- Added ceilometer::policy to control policy.json
- Fixed bug in glance_image type
- Added parameter os_region_name to glance::api
- Added support for vSphere datastore backend
- Updated the calls to the glance command-line utility
- Added parameter swift_store_large_object_size to glance::backend::swift
- Bumped stdlib dependency to >=4.0.0
- Added parameter command_options to glance::cache::cleaner and glance::cache::pruner
- Added parameter package_ensure to glance::backend::rbd
- Added parameter manage_service to various classes
- Added parameters to control whether to configure users
- Migrated the glance::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
- Added parameter registery_client_protocol to glance::api
- Fixed ssl parameter requirements for kombu and rabbit
4.2.0
- Added ability to hide secret type parameters from logs
4.1.0
- Added multiple rabbit hosts support.
- Added image_cache_dir parameter.
- Deprecated old SQL parameters.
- Fixed the Glance add_image parser for new client.
- Fixed values in get_glance_image_attrs.
- Fixed 'could not find user glance' bug.
- Pinned major gems.
4.0.0
- Stable Icehouse release.
- Added glance::config to handle additional custom options.
- Added known_stores option for glance::api.
- Added copy-on-write cloning of images to volumes.
- Added support for puppetlabs-mysql 2.2 and greater.
- Added support for python-glanceclient v2 API update.
- Removed deprecated notifier_stratgy parameter.
- Deprecated show_image_direct_url in glance::rbd.
3.1.0
- Added availability to configure show_image_direct_url.
- Removed Keystone client warnings.
- Added support for https authentication endpoints.
- Enabled ssl configuration for glance-registry.
- Explicitly sets default notifier strategy.
3.0.0
- Major release for OpenStack Havana.
- Fixed bug to ensure keystone endpoint is set before service starts.
- Added Cinder backend to image storage.
- Fixed qpid_hostname bug.
2.2.0
- Added syslog support.
- Added support for iso disk format.
- Fixed bug to allow support for rdb options in glance-api.conf.
- Fixed bug for rabbitmq options in notify::rabbitmq.
- Removed non-implemented glance::scrubber class.
- Various lint and bug fixes.
2.1.0
- Added glance-cache-cleaner and glance-cache-pruner.
- Added ceph/rdb support.
- Added retry for glance provider to account for service startup time.
- Added support for both file and swift backends.
- Fixed allowed_hosts/database access bug.
- Fixed glance_image type example.
- Removed unnecessary mysql::server dependency.
- Removed --silent-upload option.
- Removed glance-manage version_control.
- Pinned rabbit and mysql module versions.
- Various lint and bug fixes.
2.0.0
- Upstream is now part of stackfoge.
- Added postgresql support.
- Various cleanups and bug fixes.