blob: d372d2b263a836a44e51202ba189a5e506988323 [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
115Enable auditing filter (CADF):
116
117.. code-block:: yaml
118
119 glance:
120 server:
121 audit:
122 enabled: true
123 ....
124 filter_factory: 'keystonemiddleware.audit:filter_factory'
125 map_file: '/etc/pycadf/glance_api_audit_map.conf'
126 ....
127
128
Richard Felkl4143a0e2017-02-01 23:24:13 +0100129Client role
130-----------
131
132Glance images
133
134.. code-block:: yaml
135
136 glance:
137 client:
138 enabled: true
139 server:
140 profile_admin:
141 image:
142 cirros-test:
143 visibility: public
144 protected: false
145 location: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-i386-disk.img
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200146
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100147
148Usage
149=====
150
151Import new public image
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200152
153.. code-block:: yaml
154
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100155 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 +0200156
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100157Change new image's disk properties
Petr Michalec86ec0142016-11-29 16:34:15 +0100158
159.. code-block:: yaml
160
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100161 glance image-update "Windows 7 x86_64" --property hw_disk_bus=ide
Petr Michalec86ec0142016-11-29 16:34:15 +0100162
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100163Change new image's NIC properties
Jakub Pavlik80a41ea2016-03-06 14:33:42 +0100164
165.. code-block:: yaml
166
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100167 glance image-update "Windows 7 x86_64" --property hw_vif_model=rtl8139
Jakub Pavlik80a41ea2016-03-06 14:33:42 +0100168
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200169
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100170External links
171==============
Filip Pytlound681ae22015-10-06 16:28:31 +0200172
173* http://ceph.com/docs/master/rbd/rbd-openstack/
174
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100175
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200176Documentation and Bugs
Aleš Komáreke5b388f2017-02-06 15:48:57 +0100177======================
Filip Pytlound681ae22015-10-06 16:28:31 +0200178
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200179To learn how to deploy OpenStack Salt, consult the documentation available
180online at:
181
182 https://wiki.openstack.org/wiki/OpenStackSalt
183
184In the unfortunate event that bugs are discovered, they should be reported to
185the appropriate bug tracker. If you obtained the software from a 3rd party
186operating system vendor, it is often wise to use their own bug tracker for
187reporting problems. In all other cases use the master OpenStack bug tracker,
188available at:
189
190 http://bugs.launchpad.net/openstack-salt
191
192Developers wishing to work on the OpenStack Salt project should always base
193their work on the latest formulas code, available from the master GIT
194repository at:
195
196 https://git.openstack.org/cgit/openstack/salt-formula-glance
197
198Developers should also join the discussion on the IRC list, at:
199
200 https://wiki.openstack.org/wiki/Meetings/openstack-salt
Filip Pytloune94a0a72017-02-02 13:02:03 +0100201
202Documentation and Bugs
203======================
204
205To learn how to install and update salt-formulas, consult the documentation
206available online at:
207
208 http://salt-formulas.readthedocs.io/
209
210In the unfortunate event that bugs are discovered, they should be reported to
211the appropriate issue tracker. Use Github issue tracker for specific salt
212formula:
213
214 https://github.com/salt-formulas/salt-formula-glance/issues
215
216For feature requests, bug reports or blueprints affecting entire ecosystem,
217use Launchpad salt-formulas project:
218
219 https://launchpad.net/salt-formulas
220
221You can also join salt-formulas-users team and subscribe to mailing list:
222
223 https://launchpad.net/~salt-formulas-users
224
225Developers wishing to work on the salt-formulas projects should always base
226their work on master branch and submit pull request against specific formula.
227
228 https://github.com/salt-formulas/salt-formula-glance
229
230Any questions or feedback is always welcome so feel free to join our IRC
231channel:
232
233 #salt-formulas @ irc.freenode.net