blob: 2a2693f9e1de1b2c8037bc09c7172500c15669c7 [file] [log] [blame]
Aleš Komáreke5b388f2017-02-06 15:48:57 +01001==============
2Glance formula
3==============
Filip Pytlound681ae22015-10-06 16:28:31 +02004
Jakub Pavlik9e85d172016-05-20 11:13:14 +02005The Glance project provides services for discovering, registering, and
6retrieving virtual machine images. Glance has a RESTful API that allows
7querying of VM image metadata as well as retrieval of the actual image.
Filip Pytlound681ae22015-10-06 16:28:31 +02008
Filip Pytlound681ae22015-10-06 16:28:31 +02009
Aleš Komáreke5b388f2017-02-06 15:48:57 +010010Sample pillars
11==============
Filip Pytlound681ae22015-10-06 16:28:31 +020012
13.. code-block:: yaml
14
15 glance:
16 server:
17 enabled: true
18 version: juno
Alena Holanovac1e51312016-03-22 14:08:44 +010019 workers: 8
Filip Pytlound681ae22015-10-06 16:28:31 +020020 policy:
21 publicize_image:
22 - "role:admin"
23 - "role:image_manager"
24 database:
25 engine: mysql
26 host: 127.0.0.1
27 port: 3306
28 name: glance
29 user: glance
30 password: pwd
31 identity:
32 engine: keystone
33 host: 127.0.0.1
34 port: 35357
35 tenant: service
36 user: glance
37 password: pwd
38 message_queue:
39 engine: rabbitmq
40 host: 127.0.0.1
41 port: 5672
42 user: openstack
43 password: pwd
44 virtual_host: '/openstack'
45 storage:
46 engine: file
47 images:
48 - name: "CirrOS 0.3.1"
49 format: qcow2
50 file: cirros-0.3.1-x86_64-disk.img
51 source: http://cdn.download.cirros-cloud.net/0.3.1/cirros-0.3.1-x86_64-disk.img
52 public: true
Petr Michalec86ec0142016-11-29 16:34:15 +010053 audit:
54 enabled: false
Simon Pasquier2acbef52017-02-03 15:09:39 +010055 api_limit_max: 100
56 limit_param_default: 50
57
58The pagination is controlled by the *api_limit_max* and *limit_param_default*
59parameters as shown above:
60
61* *api_limit_max* defines the maximum number of records that the server will
62 return.
63
64* *limit_param_default* is the default *limit* parameter that
65 applies if the request didn't defined it explicitly.
Filip Pytlound681ae22015-10-06 16:28:31 +020066
Aleš Komáreke5b388f2017-02-06 15:48:57 +010067Keystone and cinder region
68
69.. code-block:: yaml
70
71 glance:
72 server:
73 enabled: true
74 version: kilo
75 ...
76 identity:
77 engine: keystone
78 host: 127.0.0.1
79 region: RegionTwo
80 ...
81
82Ceph integration glance
83
84.. code-block:: yaml
85
86 glance:
87 server:
88 enabled: true
89 version: juno
90 storage:
91 engine: rbd,http
92 user: glance
93 pool: images
94 chunk_size: 8
95 client_glance_key: AQDOavlU6BsSJhAAnpFR906mvdgdfRqLHwu0Uw==
96
97RabbitMQ HA setup
98
99.. code-block:: yaml
100
101 glance:
102 server:
103 ....
104 message_queue:
105 engine: rabbitmq
106 members:
107 - host: 10.0.16.1
108 - host: 10.0.16.2
109 - host: 10.0.16.3
110 user: openstack
111 password: pwd
112 virtual_host: '/openstack'
113 ....
114
mnederlofad6d6242017-03-30 15:31:15 +0200115Enable Glance Image Cache:
116
117.. code-block:: yaml
118
119 glance:
120 server:
121 image_cache:
122 enabled: true
123 enable_management: true
124 directory: /var/lib/glance/image-cache/
125 max_size: 21474836480
126 ....
127
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100128Enable auditing filter (CADF):
129
130.. code-block:: yaml
131
132 glance:
133 server:
134 audit:
135 enabled: true
136 ....
137 filter_factory: 'keystonemiddleware.audit:filter_factory'
138 map_file: '/etc/pycadf/glance_api_audit_map.conf'
139 ....
140
RobertJansen168e84f92017-03-30 15:45:12 +0200141Swift integration glance
142
143.. code-block:: yaml
144
145 glance:
146 server:
147 enabled: true
148 version: mitaka
149 storage:
150 engine: swift,http
151 swift:
152 store:
153 auth:
154 address: http://keystone.example.com:5000/v2.0
155 version: 2
156 endpoint_type: publicURL
157 container: glance
158 create_container_on_put: true
159 retry_get_count: 5
160 user: 2ec7966596504f59acc3a76b3b9d9291:glance-user
161 key: someRandomPassword
162
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100163
Richard Felkl4143a0e2017-02-01 23:24:13 +0100164Client role
165-----------
166
167Glance images
168
169.. code-block:: yaml
170
171 glance:
172 client:
173 enabled: true
174 server:
175 profile_admin:
176 image:
177 cirros-test:
178 visibility: public
179 protected: false
180 location: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-i386-disk.img
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200181
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100182
183Usage
184=====
185
186Import new public image
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200187
188.. code-block:: yaml
189
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100190 glance image-create --name 'Windows 7 x86_64' --is-public true --container-format bare --disk-format qcow2 < ./win7.qcow2
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200191
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100192Change new image's disk properties
Petr Michalec86ec0142016-11-29 16:34:15 +0100193
194.. code-block:: yaml
195
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100196 glance image-update "Windows 7 x86_64" --property hw_disk_bus=ide
Petr Michalec86ec0142016-11-29 16:34:15 +0100197
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100198Change new image's NIC properties
Jakub Pavlik80a41ea2016-03-06 14:33:42 +0100199
200.. code-block:: yaml
201
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100202 glance image-update "Windows 7 x86_64" --property hw_vif_model=rtl8139
Jakub Pavlik80a41ea2016-03-06 14:33:42 +0100203
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200204
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100205External links
206==============
Filip Pytlound681ae22015-10-06 16:28:31 +0200207
208* http://ceph.com/docs/master/rbd/rbd-openstack/
209
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100210
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200211Documentation and Bugs
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100212======================
Filip Pytlound681ae22015-10-06 16:28:31 +0200213
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200214To learn how to deploy OpenStack Salt, consult the documentation available
215online at:
216
217 https://wiki.openstack.org/wiki/OpenStackSalt
218
219In the unfortunate event that bugs are discovered, they should be reported to
220the appropriate bug tracker. If you obtained the software from a 3rd party
221operating system vendor, it is often wise to use their own bug tracker for
222reporting problems. In all other cases use the master OpenStack bug tracker,
223available at:
224
225 http://bugs.launchpad.net/openstack-salt
226
227Developers wishing to work on the OpenStack Salt project should always base
228their work on the latest formulas code, available from the master GIT
229repository at:
230
231 https://git.openstack.org/cgit/openstack/salt-formula-glance
232
233Developers should also join the discussion on the IRC list, at:
234
235 https://wiki.openstack.org/wiki/Meetings/openstack-salt
Filip Pytloune94a0a72017-02-02 13:02:03 +0100236
237Documentation and Bugs
238======================
239
240To learn how to install and update salt-formulas, consult the documentation
241available online at:
242
243 http://salt-formulas.readthedocs.io/
244
245In the unfortunate event that bugs are discovered, they should be reported to
246the appropriate issue tracker. Use Github issue tracker for specific salt
247formula:
248
249 https://github.com/salt-formulas/salt-formula-glance/issues
250
251For feature requests, bug reports or blueprints affecting entire ecosystem,
252use Launchpad salt-formulas project:
253
254 https://launchpad.net/salt-formulas
255
256You can also join salt-formulas-users team and subscribe to mailing list:
257
258 https://launchpad.net/~salt-formulas-users
259
260Developers wishing to work on the salt-formulas projects should always base
261their work on master branch and submit pull request against specific formula.
262
263 https://github.com/salt-formulas/salt-formula-glance
264
265Any questions or feedback is always welcome so feel free to join our IRC
266channel:
267
268 #salt-formulas @ irc.freenode.net