blob: 22ab068ac285b2bc331351a40dacf3a1351e973f [file] [log] [blame]
Filip Pytlound681ae22015-10-06 16:28:31 +02001==================
2Glance Image Store
3==================
4
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
9Usage
10=====
11
12Import new public image
13
14.. code-block:: yaml
15
16 glance image-create --name 'Windows 7 x86_64' --is-public true --container-format bare --disk-format qcow2 < ./win7.qcow2
17
18Change new image's disk properties
19
20.. code-block:: yaml
21
22 glance image-update "Windows 7 x86_64" --property hw_disk_bus=ide
23
24Change new image's NIC properties
25
26.. code-block:: yaml
27
28 glance image-update "Windows 7 x86_64" --property hw_vif_model=rtl8139
29
30Sample pillar
31=============
32
33.. code-block:: yaml
34
35 glance:
36 server:
37 enabled: true
38 version: juno
Alena Holanovac1e51312016-03-22 14:08:44 +010039 workers: 8
Filip Pytlound681ae22015-10-06 16:28:31 +020040 policy:
41 publicize_image:
42 - "role:admin"
43 - "role:image_manager"
44 database:
45 engine: mysql
46 host: 127.0.0.1
47 port: 3306
48 name: glance
49 user: glance
50 password: pwd
51 identity:
52 engine: keystone
53 host: 127.0.0.1
54 port: 35357
55 tenant: service
56 user: glance
57 password: pwd
58 message_queue:
59 engine: rabbitmq
60 host: 127.0.0.1
61 port: 5672
62 user: openstack
63 password: pwd
64 virtual_host: '/openstack'
65 storage:
66 engine: file
67 images:
68 - name: "CirrOS 0.3.1"
69 format: qcow2
70 file: cirros-0.3.1-x86_64-disk.img
71 source: http://cdn.download.cirros-cloud.net/0.3.1/cirros-0.3.1-x86_64-disk.img
72 public: true
Petr Michalec86ec0142016-11-29 16:34:15 +010073 audit:
74 enabled: false
Simon Pasquier2acbef52017-02-03 15:09:39 +010075 api_limit_max: 100
76 limit_param_default: 50
77
78The pagination is controlled by the *api_limit_max* and *limit_param_default*
79parameters as shown above:
80
81* *api_limit_max* defines the maximum number of records that the server will
82 return.
83
84* *limit_param_default* is the default *limit* parameter that
85 applies if the request didn't defined it explicitly.
Filip Pytlound681ae22015-10-06 16:28:31 +020086
Richard Felkl4143a0e2017-02-01 23:24:13 +010087Client role
88-----------
89
90Glance images
91
92.. code-block:: yaml
93
94 glance:
95 client:
96 enabled: true
97 server:
98 profile_admin:
99 image:
100 cirros-test:
101 visibility: public
102 protected: false
103 location: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-i386-disk.img
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200104
105Client-side RabbitMQ HA setup
106
107.. code-block:: yaml
108
109 glance:
110 server:
111 ....
112 message_queue:
113 engine: rabbitmq
114 members:
115 - host: 10.0.16.1
116 - host: 10.0.16.2
117 - host: 10.0.16.3
118 user: openstack
119 password: pwd
120 virtual_host: '/openstack'
121 ....
122
123
Petr Michalec86ec0142016-11-29 16:34:15 +0100124Enable auditing filter, ie: CADF
125
126.. code-block:: yaml
127
128 glance:
129 server:
130 audit:
131 enabled: true
132 ....
133 filter_factory: 'keystonemiddleware.audit:filter_factory'
134 map_file: '/etc/pycadf/glance_api_audit_map.conf'
135 ....
136
137
Jakub Pavlik80a41ea2016-03-06 14:33:42 +0100138Keystone and cinder region
139============================
140
141.. code-block:: yaml
142
143 glance:
144 server:
145 enabled: true
146 version: kilo
147 ...
148 identity:
149 engine: keystone
150 host: 127.0.0.1
151 region: RegionTwo
152 ...
153
Jiri Konecny0456cfa2016-04-20 16:47:25 +0200154
Filip Pytlound681ae22015-10-06 16:28:31 +0200155Ceph integration glance
156=======================
157
158.. code-block:: yaml
159
160 glance:
161 server:
162 enabled: true
163 version: juno
164 storage:
Petr Michalec72b35382016-12-04 10:27:27 +0100165 engine: rbd,http
Filip Pytlound681ae22015-10-06 16:28:31 +0200166 user: glance
167 pool: images
168 chunk_size: 8
169 client_glance_key: AQDOavlU6BsSJhAAnpFR906mvdgdfRqLHwu0Uw==
170
171* http://ceph.com/docs/master/rbd/rbd-openstack/
172
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200173Documentation and Bugs
174============================
Filip Pytlound681ae22015-10-06 16:28:31 +0200175
Jakub Pavlik9e85d172016-05-20 11:13:14 +0200176To learn how to deploy OpenStack Salt, consult the documentation available
177online at:
178
179 https://wiki.openstack.org/wiki/OpenStackSalt
180
181In the unfortunate event that bugs are discovered, they should be reported to
182the appropriate bug tracker. If you obtained the software from a 3rd party
183operating system vendor, it is often wise to use their own bug tracker for
184reporting problems. In all other cases use the master OpenStack bug tracker,
185available at:
186
187 http://bugs.launchpad.net/openstack-salt
188
189Developers wishing to work on the OpenStack Salt project should always base
190their work on the latest formulas code, available from the master GIT
191repository at:
192
193 https://git.openstack.org/cgit/openstack/salt-formula-glance
194
195Developers should also join the discussion on the IRC list, at:
196
197 https://wiki.openstack.org/wiki/Meetings/openstack-salt
Filip Pytloune94a0a72017-02-02 13:02:03 +0100198
199Documentation and Bugs
200======================
201
202To learn how to install and update salt-formulas, consult the documentation
203available online at:
204
205 http://salt-formulas.readthedocs.io/
206
207In the unfortunate event that bugs are discovered, they should be reported to
208the appropriate issue tracker. Use Github issue tracker for specific salt
209formula:
210
211 https://github.com/salt-formulas/salt-formula-glance/issues
212
213For feature requests, bug reports or blueprints affecting entire ecosystem,
214use Launchpad salt-formulas project:
215
216 https://launchpad.net/salt-formulas
217
218You can also join salt-formulas-users team and subscribe to mailing list:
219
220 https://launchpad.net/~salt-formulas-users
221
222Developers wishing to work on the salt-formulas projects should always base
223their work on master branch and submit pull request against specific formula.
224
225 https://github.com/salt-formulas/salt-formula-glance
226
227Any questions or feedback is always welcome so feel free to join our IRC
228channel:
229
230 #salt-formulas @ irc.freenode.net