3rdparty/modules/glance/README.md

   1 glance
   2 =======
   3
   4 5.1.0 - 2014.2 - Juno
   5
   6 #### Table of Contents
   7
   8 1. [Overview - What is the glance module?](#overview)
   9 2. [Module Description - What does the module do?](#module-description)
  10 3. [Setup - The basics of getting started with glance](#setup)
  11 4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
  12 5. [Limitations - OS compatibility, etc.](#limitations)
  13 6. [Development - Guide for contributing to the module](#development)
  14 7. [Contributors - Those with commits](#contributors)
  15 8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
  16
  17 Overview
  18 --------
  19
  20 The glance module is a part of [Stackforge](https://github.com/stackfoge), 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.
  21
  22 Module Description
  23 ------------------
  24
  25 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.
  26
  27 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](https://github.com/stackfoge/puppet-openstack).
  28
  29 Setup
  30 -----
  31
  32 **What the glance module affects**
  33
  34 * glance, the image service for Openstack.
  35
  36 ### Installing glance
  37
  38     example% puppet module install puppetlabs/glance
  39
  40 ### Beginning with glance
  41
  42 To utilize the glance module's functionality you will need to declare multiple resources.  The following is a modified excerpt from the [openstack module](https://github.com/stackfoge/puppet-openstack).  This is not an exhaustive list of all the components needed, we recommend you consult and understand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core openstack](http://docs.openstack.org) documentation.
  43
  44 **Define a glance node**
  45
  46 ```puppet
  47 class { 'glance::api':
  48   verbose           => true,
  49   keystone_tenant   => 'services',
  50   keystone_user     => 'glance',
  51   keystone_password => '12345',
  52   sql_connection    => 'mysql://glance:12345@127.0.0.1/glance',
  53 }
  54
  55 class { 'glance::registry':
  56   verbose           => true,
  57   keystone_tenant   => 'services',
  58   keystone_user     => 'glance',
  59   keystone_password => '12345',
  60   sql_connection    => 'mysql://glance:12345@127.0.0.1/glance',
  61 }
  62
  63 class { 'glance::backend::file': }
  64 ```
  65
  66 **Setup postgres node glance**
  67
  68 ```puppet
  69 class { 'glance::db::postgresql':
  70   password => '12345',
  71 }
  72 ```
  73
  74 **Setup mysql node for glance**
  75
  76 ```puppet
  77 class { 'glance::db::mysql':
  78   password      => '12345',
  79   allowed_hosts => '%',
  80 }
  81 ```
  82
  83 **Setup up keystone endpoints for glance on keystone node**
  84
  85 ```puppet
  86 class { 'glance::keystone::auth':
  87   password         => '12345'
  88   email            => 'glance@example.com',
  89   public_address   => '172.17.0.3',
  90   admin_address    => '172.17.0.3',
  91   internal_address => '172.17.1.3',
  92   region           => 'example-west-1',
  93 }
  94 ```
  95
  96 **Setup up notifications for multiple RabbitMQ nodes**
  97
  98 ```puppet
  99 class { 'glance::notify::rabbitmq':
 100   rabbit_password               => 'pass',
 101   rabbit_userid                 => 'guest',
 102   rabbit_hosts                  => [
 103     'localhost:5672', 'remotehost:5672'
 104   ],
 105   rabbit_use_ssl                => false,
 106 }
 107 ```
 108
 109 Implementation
 110 --------------
 111
 112 ### glance
 113
 114 glance is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
 115
 116 Limitations
 117 ------------
 118
 119 * Only supports configuring the file, swift and rbd storage backends.
 120
 121 Development
 122 -----------
 123
 124 Developer documentation for the entire puppet-openstack project.
 125
 126 * https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
 127
 128 Contributors
 129 ------------
 130
 131 * https://github.com/stackforge/puppet-glance/graphs/contributors
 132
 133 Release Notes
 134 -------------
 135
 136 **5.1.0**
 137
 138 * Service Validation for Glance-API
 139 * Switch to TLSv1
 140 * spec: pin rspec-puppet to 1.0.1
 141 * Makes kombu_ssl_* parameters optional when rabbit_use_ssl => true
 142 * Allow overriding package ensure for glance-registry
 143 * Move rbd related options into glance_store section
 144 * Pin puppetlabs-concat to 1.2.1 in fixtures
 145 * change default MySQL collate to utf8_general_ci
 146 * Add openstack tag to glance packages
 147 * Correctly munge glance_image is_public property
 148 * Create a sync_db boolean for Glance
 149 * Command parameter to sync the correct Database
 150 * Fix catalog compilation when not configuring endpoint
 151 * Add $notification_driver parameter to notify::rabbitmq
 152 * Fix is_public munge
 153 * Update .gitreview file for project rename
 154
 155 **5.0.0**
 156
 157 * Stable Juno release
 158 * Added ceilometer::policy to control policy.json
 159 * Fixed bug in glance_image type
 160 * Added parameter os_region_name to glance::api
 161 * Added support for vSphere datastore backend
 162 * Updated the calls to the glance command-line utility
 163 * Added parameter swift_store_large_object_size to glance::backend::swift
 164 * Bumped stdlib dependency to >=4.0.0
 165 * Added parameter command_options to glance::cache::cleaner and glance::cache::pruner
 166 * Added parameter package_ensure to glance::backend::rbd
 167 * Added parameter manage_service to various classes
 168 * Added parameters to control whether to configure users
 169 * Migrated the glance::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
 170 * Added parameter registery_client_protocol to glance::api
 171 * Fixed ssl parameter requirements for kombu and rabbit
 172
 173 **4.2.0**
 174
 175 * Added ability to hide secret type parameters from logs
 176
 177 **4.1.0**
 178
 179 * Added multiple rabbit hosts support.
 180 * Added image_cache_dir parameter.
 181 * Deprecated old SQL parameters.
 182 * Fixed the Glance add_image parser for new client.
 183 * Fixed values in get_glance_image_attrs.
 184 * Fixed 'could not find user glance' bug.
 185 * Pinned major gems.
 186
 187 **4.0.0**
 188
 189 * Stable Icehouse release.
 190 * Added glance::config to handle additional custom options.
 191 * Added known_stores option for glance::api.
 192 * Added copy-on-write cloning of images to volumes.
 193 * Added support for puppetlabs-mysql 2.2 and greater.
 194 * Added support for python-glanceclient v2 API update.
 195 * Removed deprecated notifier_stratgy parameter.
 196 * Deprecated show_image_direct_url in glance::rbd.
 197
 198 **3.1.0**
 199
 200 * Added availability to configure show_image_direct_url.
 201 * Removed Keystone client warnings.
 202 * Added support for https authentication endpoints.
 203 * Enabled ssl configuration for glance-registry.
 204 * Explicitly sets default notifier strategy.
 205
 206 **3.0.0**
 207
 208 * Major release for OpenStack Havana.
 209 * Fixed bug to ensure keystone endpoint is set before service starts.
 210 * Added Cinder backend to image storage.
 211 * Fixed qpid_hostname bug.
 212
 213 **2.2.0**
 214
 215 * Added syslog support.
 216 * Added support for iso disk format.
 217 * Fixed bug to allow support for rdb options in glance-api.conf.
 218 * Fixed bug for rabbitmq options in notify::rabbitmq.
 219 * Removed non-implemented glance::scrubber class.
 220 * Various lint and bug fixes.
 221
 222 **2.1.0**
 223
 224 * Added glance-cache-cleaner and glance-cache-pruner.
 225 * Added ceph/rdb support.
 226 * Added retry for glance provider to account for service startup time.
 227 * Added support for both file and swift backends.
 228 * Fixed allowed_hosts/database access bug.
 229 * Fixed glance_image type example.
 230 * Removed unnecessary mysql::server dependency.
 231 * Removed --silent-upload option.
 232 * Removed glance-manage version_control.
 233 * Pinned rabbit and mysql module versions.
 234 * Various lint and bug fixes.
 235
 236 **2.0.0**
 237
 238 * Upstream is now part of stackfoge.
 239 * Added postgresql support.
 240 * Various cleanups and bug fixes.