Version information
released Oct 2nd 2015
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'stackforge-glance', '5.2.0'Learn more about managing modules with a PuppetfileDocumentation
stackforge/glance — version 5.2.0 Oct 2nd 2015
glance
5.2.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',
sql_connection => 'mysql://glance:12345@127.0.0.1/glance',
}
class { 'glance::registry':
verbose => true,
keystone_tenant => 'services',
keystone_user => 'glance',
keystone_password => '12345',
sql_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.
Development
Developer documentation for the entire puppet-openstack project.
Contributors
Release Notes
5.2.0
- Add an ability to manage use_stderr parameter
5.1.0
- Service Validation for Glance-API
- Switch to TLSv1
- spec: pin rspec-puppet to 1.0.1
- Makes kombussl* 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.
Types in this module release
Dependencies
- puppetlabs/inifile (>=1.0.0 <2.0.0)
- stackforge/keystone (>=5.0.0 <6.0.0)
- puppetlabs/stdlib (>=4.0.0 <5.0.0)
- stackforge/openstacklib (>=5.0.0 <6.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.