summaryrefslogtreecommitdiff
path: root/README.md
blob: 12c3cfd543bb132c5b8f66ac6476399d51e383db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-glance.svg)](https://governance.openstack.org/tc/reference/tags/index.html)

<!-- Change things from this point on -->

glance
=======

#### Table of Contents

1. [Overview - What is the glance module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - The basics of getting started with glance](#setup)
4. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Release Notes - Release notes for the project](#release-notes)
8. [Contributors - Those with commits](#contributors)
9. [Repository - The project source code repository](#repository)

Overview
--------

The glance module is a part of [OpenStack](https://git.openstack.org), 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.

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.

Setup
-----

**What the glance module affects**

* [Glance](https://docs.openstack.org/glance/latest/), the image service for OpenStack.

### Installing glance

    puppet module install openstack/glance

### Beginning with glance

To utilize the glance module's functionality you will need to declare multiple resources. This is not an exhaustive list of all the components needed, we recommend you consult and understand the [core openstack](https://docs.openstack.org) documentation.

**Define a glance node**

```puppet
class { 'glance::api::authtoken':
  password => '12345',
  auth_url => 'http://172.17.0.3:5000',
  auth_uri => 'http://172.17.0.3:5000',
}

class { 'glance::registry::authtoken':
  password => '12345',
  auth_url => 'http://172.17.0.3:5000',
  auth_uri => 'http://172.17.0.3:5000',
}

class { 'glance::api':
  database_connection => 'mysql+pymysql://glance:12345@127.0.0.1/glance',
  stores              => ['file', 'http'],
  default_store       => 'file',
}

class { 'glance::registry':
  database_connection => 'mysql+pymysql://glance:12345@127.0.0.1/glance',
}

class { 'glance::backend::file': }
```

**Setup postgres node glance**

```puppet
class { 'glance::db::postgresql':
  password => '12345',
}
```

**Setup mysql node for glance**

```puppet
class { 'glance::db::mysql':
  password      => '12345',
  allowed_hosts => '%',
}
```

**Setup up keystone endpoints for glance on keystone node**

```puppet
class { 'glance::keystone::auth':
  password     => '12345'
  email        => 'glance@example.com',
  public_url   => 'http://172.17.0.3:9292',
  admin_url    => 'http://172.17.0.3:9292',
  internal_url => 'http://172.17.1.3:9292',
  region       => 'example-west-1',
}
```

**Setup up notifications for multiple RabbitMQ nodes**

```puppet
class { 'glance::notify::rabbitmq':
  default_transport_url      => os_transport_url({
    'transport'    => 'rabbit',
    'hosts'        => ['host1', 'host2'],
    'username'     => 'glance',
    'password'     => 'secret',
    'virtual_host' => 'glance',
  )},
  notification_transport_url => os_transport_url({
    'transport'    => 'rabbit',
    'hosts'        => ['host1', 'host2'],
    'username'     => 'notify',
    'password'     => 'secret',
    'virtual_host' => 'notify',
  )},
}
```

### Types

#### glance_api_config

The `glance_api_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/glance/glance-api.conf` file.

```puppet
glance_api_config { 'DEFAULT/image_cache_dir' :
  value => /var/lib/glance/image-cache,
}
```

This will write `image_cache_dir=/var/lib/glance/image-cache` in the `[DEFAULT]` section.

##### name

Section/setting name to manage from `glance-api.conf`

##### value

The value of the setting to be defined.

##### secret

Whether to hide the value from Puppet logs. Defaults to `false`.

##### ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`

#### glance_registry_config

The `glance_registry_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/glance/glance-registry.conf` file.

```puppet
glance_registry_config { 'DEFAULT/workers' :
  value => 1,
}
```

This will write `workers=1` in the `[DEFAULT]` section.

##### name

Section/setting name to manage from `glance-registry.conf`

##### value

The value of the setting to be defined.

##### secret

Whether to hide the value from Puppet logs. Defaults to `false`.

##### ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`

#### glance_cache_config

The `glance_cache_config` provider is a children of the ini_setting provider. It allows one to write an entry in the `/etc/glance/glance-cache.conf` file.

```puppet
glance_cache_config { 'DEFAULT/image_cache_stall_time' :
  value => 86400,
}
```

This will write `image_cache_stall_time=86400` in the `[DEFAULT]` section.

##### name

Section/setting name to manage from `glance-cache.conf`

##### value

The value of the setting to be defined.

##### secret

Whether to hide the value from Puppet logs. Defaults to `false`.

##### ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if `ensure => absent` was specified. Defaults to `<SERVICE DEFAULT>`

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:

```shell
bundle install
bundle exec rspec spec/acceptance
```

For more information on writing and running beaker-rspec tests visit the documentation:

* https://github.com/puppetlabs/beaker-rspec/blob/master/README.md

Development
-----------

Developer documentation for the entire puppet-openstack project.

* https://docs.openstack.org/puppet-openstack-guide/latest/

Release Notes
-------------

* https://docs.openstack.org/releasenotes/puppet-glance

Contributors
------------

* https://github.com/openstack/puppet-glance/graphs/contributors

Repository
----------

* https://git.openstack.org/cgit/openstack/puppet-glance