Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 149 lines (104 sloc) 4.475 kB
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
1 glance
2 =======
f0aa282 @bodepd reformat readme
bodepd authored
3
6affc43 @EmilienM Release 5.1.0 - Juno
EmilienM authored
4 5.1.0 - 2014.2 - Juno
dafc60c 4.0.0 - 2014.1.0 - Icehouse Release
Chris Hoge authored
5
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
6 #### Table of Contents
f0aa282 @bodepd reformat readme
bodepd authored
7
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
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)
f0aa282 @bodepd reformat readme
bodepd authored
15
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
16 Overview
17 --------
e267f68 @bodepd Update README.md
bodepd authored
18
4edba3f @NewpTone Update README.md for project namespace change
NewpTone authored
19 The glance module is a part of [OpenStack](https://github.com/openstack), an effort by the OpenStack infrastructure team to provide continuous integration testing and code review for OpenStack and OpenStack community projects as part of the core software. The module its self is used to flexibly configure and manage the image service for OpenStack.
f0aa282 @bodepd reformat readme
bodepd authored
20
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
21 Module Description
22 ------------------
f0aa282 @bodepd reformat readme
bodepd authored
23
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
24 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.
f0aa282 @bodepd reformat readme
bodepd authored
25
26dac12 @berendt Fix spelling of OpenStack
berendt authored
26 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).
f0aa282 @bodepd reformat readme
bodepd authored
27
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
28 Setup
29 -----
f0aa282 @bodepd reformat readme
bodepd authored
30
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
31 **What the glance module affects**
f0aa282 @bodepd reformat readme
bodepd authored
32
26dac12 @berendt Fix spelling of OpenStack
berendt authored
33 * glance, the image service for OpenStack.
f0aa282 @bodepd reformat readme
bodepd authored
34
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
35 ### Installing glance
f0aa282 @bodepd reformat readme
bodepd authored
36
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
37 example% puppet module install puppetlabs/glance
f0aa282 @bodepd reformat readme
bodepd authored
38
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
39 ### Beginning with glance
f0aa282 @bodepd reformat readme
bodepd authored
40
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
41 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.
f0aa282 @bodepd reformat readme
bodepd authored
42
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
43 **Define a glance node**
f0aa282 @bodepd reformat readme
bodepd authored
44
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
45 ```puppet
46 class { 'glance::api':
e16f86e @mgagne Remove deprecated parameters
mgagne authored
47 verbose => true,
48 keystone_tenant => 'services',
49 keystone_user => 'glance',
50 keystone_password => '12345',
51 database_connection => 'mysql://glance:12345@127.0.0.1/glance',
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
52 }
f0aa282 @bodepd reformat readme
bodepd authored
53
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
54 class { 'glance::registry':
e16f86e @mgagne Remove deprecated parameters
mgagne authored
55 verbose => true,
56 keystone_tenant => 'services',
57 keystone_user => 'glance',
58 keystone_password => '12345',
59 database_connection => 'mysql://glance:12345@127.0.0.1/glance',
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
60 }
f0aa282 @bodepd reformat readme
bodepd authored
61
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
62 class { 'glance::backend::file': }
63 ```
f0aa282 @bodepd reformat readme
bodepd authored
64
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
65 **Setup postgres node glance**
f0aa282 @bodepd reformat readme
bodepd authored
66
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
67 ```puppet
68 class { 'glance::db::postgresql':
69 password => '12345',
70 }
71 ```
f0aa282 @bodepd reformat readme
bodepd authored
72
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
73 **Setup mysql node for glance**
74
75 ```puppet
76 class { 'glance::db::mysql':
77 password => '12345',
78 allowed_hosts => '%',
79 }
80 ```
81
82 **Setup up keystone endpoints for glance on keystone node**
83
84 ```puppet
85 class { 'glance::keystone::auth':
86 password => '12345'
b7960d5 @pabelanger Documentation fix for admin_address
pabelanger authored
87 email => 'glance@example.com',
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
88 public_address => '172.17.0.3',
b7960d5 @pabelanger Documentation fix for admin_address
pabelanger authored
89 admin_address => '172.17.0.3',
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
90 internal_address => '172.17.1.3',
91 region => 'example-west-1',
92 }
93 ```
94
d40f3d8 @bogdando Add multiple rabbit hosts support
bogdando authored
95 **Setup up notifications for multiple RabbitMQ nodes**
96
97 ```puppet
98 class { 'glance::notify::rabbitmq':
99 rabbit_password => 'pass',
100 rabbit_userid => 'guest',
101 rabbit_hosts => [
102 'localhost:5672', 'remotehost:5672'
103 ],
104 rabbit_use_ssl => false,
105 }
106 ```
107
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
108 Implementation
109 --------------
110
111 ### glance
112
113 glance is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
114
115 Limitations
116 ------------
117
bf19533 @mkoderer Add support for rbd in glance
mkoderer authored
118 * Only supports configuring the file, swift and rbd storage backends.
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
119
79d3070 @EmilienM Beaker tests
EmilienM authored
120 Beaker-Rspec
121 ------------
122
123 This module has beaker-rspec tests
124
b8383e4 @cmurphy Add more details on running tests to the readme
cmurphy authored
125 To run the tests on the default vagrant node:
126
79d3070 @EmilienM Beaker tests
EmilienM authored
127 To run:
128
129 ```shell
130 bundle install
131 bundle exec rspec spec/acceptance
132 ```
133
b8383e4 @cmurphy Add more details on running tests to the readme
cmurphy authored
134 For more information on writing and running beaker-rspec tests visit the documentation:
135
136 * https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module
137
202a27b @ody Prepare repository for a Puppet Forge release
ody authored
138 Development
139 -----------
140
141 Developer documentation for the entire puppet-openstack project.
142
143 * https://wiki.openstack.org/wiki/Puppet-openstack#Developer_documentation
144
145 Contributors
146 ------------
147
4edba3f @NewpTone Update README.md for project namespace change
NewpTone authored
148 * https://github.com/openstack/puppet-glance/graphs/contributors
Something went wrong with that request. Please try again.