blob: 0184a831079d6cdc73dff417f49d1acf73c93b5c [file] [log] [blame]
Filip Pytloun4a72d792015-10-06 16:28:32 +02001
Aleš Komárek72152852017-04-11 13:48:48 +02002============
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03003Usage
Aleš Komárek72152852017-04-11 13:48:48 +02004============
Filip Pytloun4a72d792015-10-06 16:28:32 +02005
Jakub Pavlikfcf34f82016-05-20 09:35:51 +02006OpenStack Nova provides a cloud computing fabric controller, supporting a wide
7variety of virtualization technologies, including KVM, Xen, LXC, VMware, and
8more. In addition to its native API, it includes compatibility with the
9commonly encountered Amazon EC2 and S3 APIs.
Filip Pytloun4a72d792015-10-06 16:28:32 +020010
Aleš Komárek72152852017-04-11 13:48:48 +020011Sample Pillars
Filip Pytloun4a72d792015-10-06 16:28:32 +020012==============
13
14Controller nodes
15----------------
16
OlgaGusarenko9dd01c92018-07-31 00:49:30 +030017Nova services on the controller node:
Filip Pytloun4a72d792015-10-06 16:28:32 +020018
19.. code-block:: yaml
20
21 nova:
22 controller:
23 version: juno
24 enabled: true
25 security_group: true
Lachlan Evensonb72de502016-01-20 15:34:04 -080026 cpu_allocation_ratio: 8.0
27 ram_allocation_ratio: 1.0
Jiri Konecny9344a372016-03-21 19:25:48 +010028 disk_allocation_ratio: 1.0
Dmitry Stremkovskiy2bcba8d2017-07-30 21:43:59 +030029 cross_az_attach: false
Jiri Konecnyb5a80e42016-03-22 11:51:01 +010030 workers: 8
Jakub Pavlik617a8962016-09-04 18:50:06 +020031 report_interval: 60
Michel Nederlof8ff99332017-10-23 14:29:15 +020032 dhcp_domain: novalocal
Vasyl Saienko09b6ac32019-01-17 15:23:58 +020033 vif_plugging_timeout: 300
34 vif_plugging_is_fatal: false
Vasyl Saienko2adac3f2019-02-18 12:32:52 +020035 instance_build_timeout: 600
sgarbuzcc02c7f2018-10-25 14:29:30 +030036 consoleauth:
37 token_ttl: 600
Filip Pytloun4a72d792015-10-06 16:28:32 +020038 bind:
39 public_address: 10.0.0.122
40 public_name: openstack.domain.com
41 novncproxy_port: 6080
42 database:
43 engine: mysql
44 host: 127.0.0.1
45 port: 3306
46 name: nova
47 user: nova
48 password: pwd
49 identity:
50 engine: keystone
51 host: 127.0.0.1
52 port: 35357
53 user: nova
54 password: pwd
55 tenant: service
56 message_queue:
57 engine: rabbitmq
58 host: 127.0.0.1
59 port: 5672
60 user: openstack
61 password: pwd
62 virtual_host: '/openstack'
Oleh Hryhorovf5093b82018-10-17 11:16:08 +000063 pci:
64 alias:
65 alias1:
66 device_type: "type-PF"
67 name: "a1"
68 product_id: "154d"
69 vendor_id: "8086"
Filip Pytloun4a72d792015-10-06 16:28:32 +020070 network:
71 engine: neutron
72 host: 127.0.0.1
73 port: 9696
Jakub Pavlik617a8962016-09-04 18:50:06 +020074 extension_sync_interval: 600
Filip Pytloun4a72d792015-10-06 16:28:32 +020075 identity:
76 engine: keystone
77 host: 127.0.0.1
78 port: 35357
79 user: neutron
80 password: pwd
81 tenant: service
82 metadata:
83 password: password
Petr Michalecaa23dc02016-11-29 16:30:25 +010084 audit:
85 enabled: false
Simon Pasquier8683b7a2017-02-03 16:00:16 +010086 osapi_max_limit: 500
Oleg Iurchenko370c10d2017-10-19 14:03:37 +030087 barbican:
88 enabled: true
Filip Pytloun4a72d792015-10-06 16:28:32 +020089
OlgaGusarenko9dd01c92018-07-31 00:49:30 +030090Nova services from custom package repository:
Filip Pytloun4a72d792015-10-06 16:28:32 +020091
92.. code-block:: yaml
93
94 nova:
95 controller:
96 version: juno
97 source:
98 engine: pkg
99 address: http://...
100 ....
101
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300102Client-side RabbitMQ HA setup:
Jiri Konecnye31f2c52016-04-14 17:16:02 +0200103
104.. code-block:: yaml
105
106 nova:
107 controller:
108 ....
109 message_queue:
110 engine: rabbitmq
111 members:
112 - host: 10.0.16.1
113 - host: 10.0.16.2
114 - host: 10.0.16.3
115 user: openstack
116 password: pwd
117 virtual_host: '/openstack'
118 ....
119
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300120Enable auditing filter, i.e: CADF:
Petr Michalecaa23dc02016-11-29 16:30:25 +0100121
122.. code-block:: yaml
123
124 nova:
125 controller:
Simon Pasquier6a3c8f72016-12-19 15:37:24 +0100126 audit:
Petr Michalecaa23dc02016-11-29 16:30:25 +0100127 enabled: true
128 ....
129 filter_factory: 'keystonemiddleware.audit:filter_factory'
130 map_file: '/etc/pycadf/nova_api_audit_map.conf'
131 ....
132
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300133Enable CORS parameters:
Ondrej Smola25b53cb2017-04-28 10:56:19 +0200134
135.. code-block:: yaml
136
137 nova:
138 controller:
139 cors:
140 allowed_origin: https:localhost.local,http:localhost.local
141 expose_headers: X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token
142 allow_methods: GET,PUT,POST,DELETE,PATCH
143 allow_headers: X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token
144 allow_credentials: True
145 max_age: 86400
146
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300147Configuration of the ``policy.json`` file:
Dmitry Ukov3562a082017-05-04 00:00:48 +0400148
149.. code-block:: yaml
150
151 nova:
152 controller:
153 ....
154 policy:
155 context_is_admin: 'role:admin or role:administrator'
156 'compute:create': 'rule:admin_or_owner'
157 # Add key without value to remove line from policy.json
158 'compute:create:attach_network':
Ondrej Smola25b53cb2017-04-28 10:56:19 +0200159
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300160Enable Barbican integration:
Oleg Iurchenko370c10d2017-10-19 14:03:37 +0300161
162.. code-block:: yaml
163
164 nova:
165 controller:
166 ....
167 barbican:
168 enabled: true
169
Oleh Hryhorovf5093b82018-10-17 11:16:08 +0000170Define aliases for PCI devices:
171.. code-block:: yaml
172
173 nova:
174 controller:
175 ...
176 pci:
177 alias:
178 alias1:
179 device_type: "type-PF"
180 name: "a1"
181 product_id: "154d"
182 vendor_id: "8086"
183
Jiri Broulik789179a2018-02-13 16:16:46 +0100184Enable cells update:
185
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300186.. note:: Useful when upgrading Openstack. To update cells to test
187 sync db agains duplicated production database.
Jiri Broulik789179a2018-02-13 16:16:46 +0100188
189.. code-block:: yaml
190
191 nova:
192 controller:
193 update_cells: true
194
Kirill Bespalov64617172017-07-11 14:43:14 +0300195
Kirill Bespalova0eaca72017-11-20 13:40:42 +0300196Configuring TLS communications
197------------------------------
Kirill Bespalov64617172017-07-11 14:43:14 +0300198
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300199.. note:: By default system wide installed CA certs are used,
200 so ``cacert_file`` param is optional, as well as ``cacert``.
Kirill Bespalova0eaca72017-11-20 13:40:42 +0300201
202- **RabbitMQ TLS**
Kirill Bespalov64617172017-07-11 14:43:14 +0300203
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300204 .. code-block:: yaml
Kirill Bespalov64617172017-07-11 14:43:14 +0300205
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300206 nova:
207 compute:
208 message_queue:
209 port: 5671
210 ssl:
211 enabled: True
212 (optional) cacert: cert body if the cacert_file does not exists
213 (optional) cacert_file: /etc/openstack/rabbitmq-ca.pem
214 (optional) version: TLSv1_2
Kirill Bespalov64617172017-07-11 14:43:14 +0300215
Kirill Bespalova0eaca72017-11-20 13:40:42 +0300216- **MySQL TLS**
Kirill Bespalov64617172017-07-11 14:43:14 +0300217
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300218 .. code-block:: yaml
Kirill Bespalov64617172017-07-11 14:43:14 +0300219
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300220 nova:
221 controller:
222 database:
223 ssl:
224 enabled: True
225 (optional) cacert: cert body if the cacert_file does not exists
226 (optional) cacert_file: /etc/openstack/mysql-ca.pem
Kirill Bespalov64617172017-07-11 14:43:14 +0300227
Kirill Bespalova0eaca72017-11-20 13:40:42 +0300228- **Openstack HTTPS API**
229
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300230 Set the ``https`` as protocol at ``nova:compute`` and
231 ``nova:controller`` sections :
Kirill Bespalova0eaca72017-11-20 13:40:42 +0300232
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300233 .. code-block:: yaml
Kirill Bespalov64617172017-07-11 14:43:14 +0300234
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300235 nova:
236 controller :
237 identity:
238 protocol: https
239 (optional) cacert_file: /etc/openstack/proxy.pem
240 network:
241 protocol: https
242 (optional) cacert_file: /etc/openstack/proxy.pem
243 glance:
244 protocol: https
245 (optional) cacert_file: /etc/openstack/proxy.pem
Kirill Bespalov64617172017-07-11 14:43:14 +0300246
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300247 .. code-block:: yaml
Kirill Bespalov64617172017-07-11 14:43:14 +0300248
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300249 nova:
250 compute:
251 identity:
252 protocol: https
253 (optional) cacert_file: /etc/openstack/proxy.pem
254 network:
255 protocol: https
256 (optional) cacert_file: /etc/openstack/proxy.pem
257 image:
258 protocol: https
259 (optional) cacert_file: /etc/openstack/proxy.pem
260 ironic:
261 protocol: https
262 (optional) cacert_file: /etc/openstack/proxy.pem
Kirill Bespalov64617172017-07-11 14:43:14 +0300263
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300264.. note:: Barbican, Cinder, and placement url endpoints are discovering
265 using service catalog.
Kirill Bespalov64617172017-07-11 14:43:14 +0300266
Filip Pytloun4a72d792015-10-06 16:28:32 +0200267Compute nodes
268-------------
269
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300270Nova controller services on compute node:
Filip Pytloun4a72d792015-10-06 16:28:32 +0200271
272.. code-block:: yaml
273
274 nova:
275 compute:
276 version: juno
277 enabled: true
Mykyta Karpin5ef9f982019-02-07 18:40:00 +0200278 timeout_nbd: 10
279 heal_instance_info_cache_interval: 60
Dmitry Stremkovskiy2bcba8d2017-07-30 21:43:59 +0300280 cross_az_attach: false
Dmitry Stremkovskiy35e53b72017-07-29 12:50:39 +0300281 disk_cachemodes: network=writeback,block=none
Jiri Broulik70d9e3f2017-02-15 18:37:13 +0100282 availability_zone: availability_zone_01
Damian Szelugae1922412017-04-18 16:36:46 +0200283 aggregates:
284 - hosts_with_fc
285 - hosts_with_ssd
Filip Pytloun4a72d792015-10-06 16:28:32 +0200286 security_group: true
Petr Michalecf03e4882017-04-10 10:26:18 +0200287 resume_guests_state_on_host_boot: False
Michael Polenchuk159c2542018-06-09 15:31:51 +0400288 preallocate_images: space # Default is 'none'
Dmitry Stremkovskiy8a0ff512017-07-25 20:54:13 +0300289 my_ip: 10.1.0.16
Vasyl Saienko09b6ac32019-01-17 15:23:58 +0200290 vif_plugging_timeout: 300
291 vif_plugging_is_fatal: false
Filip Pytloun4a72d792015-10-06 16:28:32 +0200292 bind:
293 vnc_address: 172.20.0.100
294 vnc_port: 6080
295 vnc_name: openstack.domain.com
296 vnc_protocol: http
297 database:
298 engine: mysql
299 host: 127.0.0.1
300 port: 3306
301 name: nova
302 user: nova
303 password: pwd
304 identity:
305 engine: keystone
306 host: 127.0.0.1
307 port: 35357
308 user: nova
309 password: pwd
310 tenant: service
311 message_queue:
312 engine: rabbitmq
313 host: 127.0.0.1
314 port: 5672
315 user: openstack
316 password: pwd
317 virtual_host: '/openstack'
318 image:
319 engine: glance
320 host: 127.0.0.1
321 port: 9292
Oleh Hryhorovf5093b82018-10-17 11:16:08 +0000322 pci:
323 alias:
324 alias1:
325 device_type: "type-PF"
326 name: "a1"
327 product_id: "154d"
328 vendor_id: "8086"
Oleksandr Pidrepnyi14f08272019-02-20 12:48:17 +0200329 passthrough_whitelist:
330 - vendor_id: "10de"
331 product_id: "1db4"
Filip Pytloun4a72d792015-10-06 16:28:32 +0200332 network:
333 engine: neutron
334 host: 127.0.0.1
335 port: 9696
336 identity:
337 engine: keystone
338 host: 127.0.0.1
339 port: 35357
340 user: neutron
341 password: pwd
342 tenant: service
343 qemu:
344 max_files: 4096
345 max_processes: 4096
Dmitry Stremkovskiy96281f52017-07-26 00:39:22 +0300346 host: node-12.domain.tld
Filip Pytloun4a72d792015-10-06 16:28:32 +0200347
Vasyl Saienkocab3a902018-07-12 13:17:17 +0300348Compute with vmware driver. Each vmware cluster requires a separate process of nova-compute.
349Each process should have uniq host identifier. However multiple computes might be running on
350single host. It is not recommended to have multiple computes running on different hosts that
351manage the same vmware cluster. To achive this pacemaker/corosync or keepalived might be used.
352
353.. code-block:: yaml
354
355 nova:
356 compute:
357 compute_driver: vmwareapi.VMwareVCDriver
358 vmware:
359 host_username: vmware
360 host_password: vmware
361 cluster_name: vmware_cluster01
362 host_ip: 1.2.3.4
363
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300364Group and user to be used for QEMU processes run by the system instance:
kkalynovskyif50f0c02017-12-12 17:52:57 +0200365
366.. code-block:: yaml
367
368 nova:
369 compute:
370 enabled: true
371 ...
372 qemu:
373 user: nova
374 group: cinder
375 dynamic_ownership: 1
376
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300377Group membership for user nova (upgrade related):
Dmitry Stremkovskiy3cd6ba82017-07-25 17:15:36 +0300378
379.. code-block:: yaml
380
381 nova:
382 compute:
383 enabled: true
384 ...
385 user:
386 groups:
387 - libvirt
Filip Pytloun4a72d792015-10-06 16:28:32 +0200388
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300389Nova services on compute node with OpenContrail:
Filip Pytloun4a72d792015-10-06 16:28:32 +0200390
391.. code-block:: yaml
392
393 nova:
394 compute:
395 enabled: true
396 ...
397 networking: contrail
398
Oleksandr Bryndziibb8abfe2018-09-28 22:21:43 +0000399Nova services on compute node with memcached caching and security strategy:
Filip Pytloun4a72d792015-10-06 16:28:32 +0200400
401.. code-block:: yaml
402
403 nova:
404 compute:
405 enabled: true
406 ...
407 cache:
408 engine: memcached
409 members:
410 - host: 127.0.0.1
411 port: 11211
412 - host: 127.0.0.1
413 port: 11211
Oleksandr Bryndziibb8abfe2018-09-28 22:21:43 +0000414 security:
415 enabled: true
416 strategy: ENCRYPT
417 secret_key: secret
Filip Pytloun4a72d792015-10-06 16:28:32 +0200418
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300419Client-side RabbitMQ HA setup:
Jiri Konecnye31f2c52016-04-14 17:16:02 +0200420
421.. code-block:: yaml
422
423 nova:
Kirill Bespalov64617172017-07-11 14:43:14 +0300424 compute:
Jiri Konecnye31f2c52016-04-14 17:16:02 +0200425 ....
426 message_queue:
427 engine: rabbitmq
428 members:
429 - host: 10.0.16.1
430 - host: 10.0.16.2
431 - host: 10.0.16.3
432 user: openstack
433 password: pwd
434 virtual_host: '/openstack'
435 ....
436
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300437Nova with ephemeral configured with Ceph:
maxstack39e6aca2016-05-04 13:50:13 +0000438
439.. code-block:: yaml
440
441 nova:
442 compute:
443 enabled: true
444 ...
445 ceph:
446 ephemeral: yes
447 rbd_pool: nova
448 rbd_user: nova
449 secret_uuid: 03006edd-d957-40a3-ac4c-26cd254b3731
Kalynovskyi0bc79692017-07-21 16:22:09 +0300450 ....
maxstack39e6aca2016-05-04 13:50:13 +0000451
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300452Nova with ephemeral configured with LVM:
Kalynovskyi0bc79692017-07-21 16:22:09 +0300453
454.. code-block:: yaml
455
456 nova:
457 compute:
458 enabled: true
459 ...
460 lvm:
461 ephemeral: yes
462 images_volume_group: nova_vg
463
464 linux:
465 storage:
466 lvm:
467 nova_vg:
468 name: nova_vg
469 devices:
470 - /dev/sdf
471 - /dev/sdd
472 - /dev/sdg
473 - /dev/sde
474 - /dev/sdc
475 - /dev/sdj
476 - /dev/sdh
maxstack39e6aca2016-05-04 13:50:13 +0000477
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300478Enable Barbican integration:
Oleg Iurchenko370c10d2017-10-19 14:03:37 +0300479
480.. code-block:: yaml
481
482 nova:
483 compute:
484 ....
485 barbican:
486 enabled: true
487
Oleksandr Pidrepnyi14f08272019-02-20 12:48:17 +0200488Define aliases for a PCI passthrough devices:
Oleh Hryhorovf5093b82018-10-17 11:16:08 +0000489.. code-block:: yaml
490
491 nova:
492 compute:
493 ...
494 pci:
495 alias:
496 alias1:
497 device_type: "type-PF"
498 name: "a1"
499 product_id: "154d"
500 vendor_id: "8086"
501
Oleksandr Pidrepnyi14f08272019-02-20 12:48:17 +0200502Define white list of PCI devices available to VMs:
503.. code-block:: yaml
504
505 nova:
506 compute:
507 ...
508 pci:
509 passthrough_whitelist:
510 - vendor_id: "10de"
511 product_id: "1db4"
512
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300513Nova metadata custom bindings:
Vasyl Saienko2d591282018-02-05 14:19:02 +0200514
515.. code-block:: yaml
516
517 nova:
518 controller:
519 enabled: true
520 ...
521 metadata:
522 bind:
523 address: 1.2.3.4
524 port: 8776
525
Oleh Hryhorov08482aa2018-11-19 14:07:47 +0200526Define multipath for nova compute:
527
528.. code-block:: yaml
529
530 nova:
531 compute:
532 ....
533 libvirt:
534 volume_use_multipath: True
535
Jiri Broulik0ce9fc92017-02-01 23:10:40 +0100536Client role
537-----------
538
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300539Nova configured with NFS:
Dmitry Stremkovskiy665c7282017-07-05 17:36:27 +0300540
541.. code-block:: yaml
542
543 nova:
544 compute:
545 instances_path: /mnt/nova/instances
546
547 linux:
548 storage:
549 enabled: true
550 mount:
551 nfs_nova:
552 enabled: true
553 path: ${nova:compute:instances_path}
554 device: 172.31.35.145:/data
555 file_system: nfs
556 opts: rw,vers=3
557
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300558Nova flavors:
Jiri Broulik0ce9fc92017-02-01 23:10:40 +0100559
560.. code-block:: yaml
561
562 nova:
563 client:
564 enabled: true
565 server:
566 identity:
567 flavor:
Jiri Broulik70d9e3f2017-02-15 18:37:13 +0100568 flavor1:
Jiri Broulik0ce9fc92017-02-01 23:10:40 +0100569 flavor_id: 10
570 ram: 4096
571 disk: 10
572 vcpus: 1
Jiri Broulik70d9e3f2017-02-15 18:37:13 +0100573 flavor2:
574 flavor_id: auto
575 ram: 4096
576 disk: 20
577 vcpus: 2
Jiri Broulik0ce9fc92017-02-01 23:10:40 +0100578 identity1:
579 flavor:
580 ...
581
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300582Availability zones:
Jiri Broulik70d9e3f2017-02-15 18:37:13 +0100583
584.. code-block:: yaml
585
586 nova:
587 client:
588 enabled: true
589 server:
590 identity:
591 availability_zones:
592 - availability_zone_01
593 - availability_zone_02
594
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300595Aggregates:
Damian Szeluga5dca0f02017-04-13 17:27:15 +0200596
597.. code-block:: yaml
598
599 nova:
600 client:
601 enabled: true
602 server:
603 identity:
604 aggregates:
605 - aggregate1
606 - aggregate2
607
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300608Upgrade levels:
Dmitry Stremkovskiy91f45852017-07-18 16:22:31 +0300609
610.. code-block:: yaml
611
612 nova:
613 controller:
614 upgrade_levels:
615 compute: juno
616
617 nova:
618 compute:
619 upgrade_levels:
620 compute: juno
621
Petr Jedinýd855ef22017-03-06 22:24:33 +0100622SR-IOV
Jakub Pavlik39a05942017-02-13 23:03:08 +0100623------
624
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300625Add ``PciPassthroughFilter`` into scheduler filters and NICs on
626specific compute nodes:
Jakub Pavlik39a05942017-02-13 23:03:08 +0100627
628.. code-block:: yaml
629
630 nova:
631 controller:
632 sriov: true
sandriichenko4fe321d2018-01-22 17:34:06 +0000633 scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,PciPassthroughFilter"
Jakub Pavlik39a05942017-02-13 23:03:08 +0100634
635 nova:
636 compute:
637 sriov:
638 nic_one:
639 devname: eth1
640 physical_network: physnet1
641
Oleh Hryhorovf5093b82018-10-17 11:16:08 +0000642.. note:: Parameters located under nova:compute:sriov:<nic_name> are copied to passthrough_whitelist parameter into
643 nova.conf file in appropriate format.
644
Jakub Pavlik26fb85c2017-02-16 22:29:22 +0100645CPU pinning & Hugepages
646-----------------------
647
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300648CPU pinning of virtual machine instances to dedicated physical
649CPU cores. Hugepages mount point for libvirt.
Jakub Pavlik26fb85c2017-02-16 22:29:22 +0100650
651.. code-block:: yaml
652
653 nova:
654 controller:
sandriichenko4fe321d2018-01-22 17:34:06 +0000655 scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,NUMATopologyFilter,AggregateInstanceExtraSpecsFilter"
Jakub Pavlik26fb85c2017-02-16 22:29:22 +0100656
657 nova:
658 compute:
659 vcpu_pin_set: 2,3,4,5
660 hugepages:
661 mount_points:
662 - path: /mnt/hugepages_1GB
663 - path: /mnt/hugepages_2MB
Jiri Broulik0ce9fc92017-02-01 23:10:40 +0100664
Michel Nederlof171c7ac2017-04-13 12:54:14 +0200665Custom Scheduler filters
666------------------------
667
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300668If you have a custom filter, that needs to be included in the
669scheduler, then you can include it like so:
Michel Nederlof171c7ac2017-04-13 12:54:14 +0200670
671.. code-block:: yaml
672
673 nova:
674 controller:
675 scheduler_custom_filters:
676 - my_custom_driver.nova.scheduler.filters.my_custom_filter.MyCustomFilter
677
678 # Then add your custom filter on the end (make sure to include all other ones that you need as well)
sandriichenko4fe321d2018-01-22 17:34:06 +0000679 scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,PciPassthroughFilter,MyCustomFilter"
Michel Nederlof171c7ac2017-04-13 12:54:14 +0200680
Michael Polenchuk2bce2cb2018-09-17 16:05:43 +0400681 # Since Queens version a sequence could be used as well:
682 ~scheduler_default_filters:
683 - DifferentHostFilter
684 - SameHostFilter
685 ...
686 - MyCustomFilter
687
688
Michel Nederlofeb566f62017-04-21 15:37:47 +0200689Hardware Trip/Unmap Support
690---------------------------
691
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300692To enable TRIM support for ephemeral images (thru nova managed
693images), libvirt has this option:
Michel Nederlofeb566f62017-04-21 15:37:47 +0200694
695.. code-block:: yaml
696
697 nova:
698 compute:
699 libvirt:
700 hw_disk_discard: unmap
701
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300702To actually utilize this feature, the following metadata must be
703set on the image as well, so the SCSI unmap is supported:
Michel Nederlofeb566f62017-04-21 15:37:47 +0200704
705.. code-block:: bash
706
707 glance image-update --property hw_scsi_model=virtio-scsi <image>
708 glance image-update --property hw_disk_bus=scsi <image>
Filip Pytloun5bc9e9f2017-02-02 13:05:40 +0100709
Thom Gerdesf582f1e2017-05-02 18:05:50 +0000710Scheduler Host Manager
711----------------------
712
713Specify a custom host manager.
714
Thom Gerdesec00afd2017-04-07 18:06:59 +0000715libvirt CPU mode
716----------------
717
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300718Allow setting the model of CPU that is exposed to a VM. This
719allows for better support live migration between hypervisors with
720different hardware, among other things. Defaults to host-passthrough.
Jakub Pavlik7046b9c2017-09-19 12:04:19 +0200721
Thom Gerdesf582f1e2017-05-02 18:05:50 +0000722.. code-block:: yaml
723
724 nova:
725 controller:
726 scheduler_host_manager: ironic_host_manager
727
Thom Gerdesec00afd2017-04-07 18:06:59 +0000728 compute:
729 cpu_mode: host-model
730
Dzmitry Stremkouski7da9bf12018-04-25 22:30:37 +0200731Nova compute cpu model
732----------------------
733
734.. code-block:: yaml
735
736 nova:
737 compute:
738 cpu_mode: custom
739 libvirt:
740 cpu_model: IvyBridge
741
742
Michel Nederloff7eefb22017-07-10 11:14:33 +0200743Nova compute workarounds
744------------------------
745
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300746Live snapshotting is disabled by default in nova. To enable
747this, it needs a manual switch.
Michel Nederloff7eefb22017-07-10 11:14:33 +0200748
749From manual:
750
751.. code-block:: yaml
752
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300753 When using libvirt 1.2.2 live snapshots fail intermittently under load
754 (likely related to concurrent libvirt/qemu operations). This config
755 option provides a mechanism to disable live snapshot, in favor of cold
756 snapshot, while this is resolved. Cold snapshot causes an instance
757 outage while the guest is going through the snapshotting process.
758
759 For more information, refer to the bug report:
760
761 https://bugs.launchpad.net/nova/+bug/1334398
Michel Nederloff7eefb22017-07-10 11:14:33 +0200762
763Configurable pillar data:
764
765.. code-block:: yaml
766
767 nova:
768 compute:
Michel Nederlofe322ebb2017-07-10 12:29:21 +0200769 workaround:
Michel Nederloff7eefb22017-07-10 11:14:33 +0200770 disable_libvirt_livesnapshot: False
771
Michel Nederlofb51a5142017-06-27 08:31:35 +0200772Config drive options
773--------------------
774
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300775See example below on how to configure the options for the
776config drive:
Michel Nederlofb51a5142017-06-27 08:31:35 +0200777
778.. code-block:: yaml
779
780 nova:
781 compute:
782 config_drive:
783 forced: True # Default: True
784 cdrom: True # Default: False
785 format: iso9660 # Default: vfat
786 inject_password: False # Default: False
787
Michel Nederloff81919b2017-11-20 09:37:07 +0100788Number of concurrent live migrates
789----------------------------------
790
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300791Default is to have no concurrent live migrations (so 1
792live-migration at a time).
Michel Nederloff81919b2017-11-20 09:37:07 +0100793
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300794Excerpt from config options page
795https://docs.openstack.org/ocata/config-reference/compute/config-options.html:
Michel Nederloff81919b2017-11-20 09:37:07 +0100796
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300797Maximum number of live migrations to run concurrently. This limit is
798enforced to avoid outbound live migrations overwhelming the host/network
799and causing failures. It is not recommended that you change this unless
800you are very sure that doing so is safe and stable in your environment.
Michel Nederloff81919b2017-11-20 09:37:07 +0100801
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300802Possible values:
Michel Nederloff81919b2017-11-20 09:37:07 +0100803
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300804- 0 : treated as unlimited.
805- Negative value defaults to 0.
806- Any positive integer representing maximum number of live migrations
807 to run concurrently.
Michel Nederloff81919b2017-11-20 09:37:07 +0100808
809To configure this option:
810
811.. code-block:: yaml
812
813 nova:
814 compute:
815 max_concurrent_live_migrations: 1 # (1 is the default)
816
Sergio Lystopad9d31cba2018-05-15 11:29:11 +0300817Live migration with auto converge
818----------------------------------
819
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300820Auto converge throttles down CPU if a progress of on-going live
821migration is slow
822https://docs.openstack.org/ocata/config-reference/compute/config-options.html:
Sergio Lystopad9d31cba2018-05-15 11:29:11 +0300823
824.. code-block:: yaml
825
826 nova:
827 compute:
828 libvirt:
829 live_migration_permit_auto_converge: False # (False is the default)
830
831.. code-block:: yaml
832
833 nova:
834 controller:
835 libvirt:
836 live_migration_permit_auto_converge: False # (False is the default)
837
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400838Enhanced logging with logging.conf
839----------------------------------
840
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300841By default ``logging.conf`` is disabled.
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400842
843That is possible to enable per-binary logging.conf with new variables:
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400844
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300845* ``openstack_log_appender``
846 Set to true to enable log_config_append for all OpenStack services
847
848* ``openstack_fluentd_handler_enabled``
849 Set to true to enable FluentHandler for all Openstack services
850
851* ``openstack_ossyslog_handler_enabled``
852 Set to true to enable OSSysLogHandler for all Openstack services
853
854Only ``WatchedFileHandler``, ``OSSysLogHandler``, and ``FluentHandler``
855are available.
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400856
Dmitry Kalashnik8da249c2018-01-16 17:58:00 +0400857Also it is possible to configure this with pillar:
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400858
859.. code-block:: yaml
860
861 nova:
862 controller:
863 logging:
864 log_appender: true
865 log_handlers:
866 watchedfile:
867 enabled: true
868 fluentd:
869 enabled: true
Oleksii Chupryn99e35032018-02-06 01:59:40 +0200870 ossyslog:
871 enabled: true
Dmitry Kalashnike58fe082017-12-01 16:31:14 +0400872
873 compute:
874 logging:
875 log_appender: true
876 log_handlers:
877 watchedfile:
878 enabled: true
879 fluentd:
880 enabled: true
Oleksii Chupryn99e35032018-02-06 01:59:40 +0200881 ossyslog:
882 enabled: true
Thom Gerdesf582f1e2017-05-02 18:05:50 +0000883
Vasyl Saienko7243a952018-05-11 21:26:54 +0300884The log level might be configured per logger by using the
885following pillar structure:
886
887.. code-block:: yaml
888
889 nova:
890 compute:
891 logging:
892 loggers:
893 <logger_name>:
894 level: WARNING
895
896 nova:
897 compute:
898 logging:
899 loggers:
900 <logger_name>:
901 level: WARNING
902
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000903Configure syslog parameters for libvirtd
904----------------------------------------
905
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300906To configure syslog parameters for libvirtd the below pillar
907structure should be used with values which are supported
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000908by libvirtd. These values might be known from the documentation.
909
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300910.. code-block:: yaml
911
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000912 nova:
913 compute:
914 libvirt:
915 logging:
916 level: 3
917 filters: '3:remote 4:event'
918 outputs: '3:syslog:libvirtd'
919 buffer_size: 64
920
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300921Logging controls:
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000922
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300923Logging level: 4 errors, 3 warnings, 2 information, 1 debug
924basically 1 will log everything possible ``log_level = 3``
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000925
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300926Logging filters:
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000927
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300928A filter allows to select a different logging level for a given category
929of logs.
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000930
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300931The format for a filter is one of:
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000932
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300933* ``x:name``
934* ``x:+name``
935 where name is a string which is matched against source file name,
936 e.g., ``remote``, ``qemu``, or ``util/json``, the optional ``+`` prefix
937 tells libvirt to log stack trace for each message matching name,
938 and x is the minimal level where matching messages should be logged:
Oleh Hryhorove38525d2018-05-15 08:58:59 +0000939
OlgaGusarenko9dd01c92018-07-31 00:49:30 +0300940* ``1: DEBUG``
941* ``2: INFO``
942* ``3: WARNING``
943* ``4: ERROR``
944
945Multiple filter can be defined in a single @filters, they just
946need to be separated by spaces.
947
948For example, to only get warning or errors from the remote layer
949and only errors from the event layer: ``log_filters="3:remote 4:event``
950
951Logging outputs:
952
953An output is one of the places to save logging information
954The format for an output can be:
955
956* ``x:stderr``
957 Output goes to stderr
958
959* ``x:syslog:name``
960 Use syslog for the output and use the given name as the ident
961
962* ``x:file:file_path``
963 output to a file, with the given filepath
964
965 In all case the x prefix is the minimal level, acting as a filter
966
967* ``1: DEBUG``
968* ``2: INFO``
969* ``3: WARNING``
970* ``4: ERROR``
971
972Multiple output can be defined, they just need to be separated by spaces.
973For example, to log all warnings and errors to syslog under the libvirt
974dident: ``log_outputs="3:syslog:libvirtd``
975
976Log debug buffer size: default 64
977The daemon keeps an internal debug log buffer which will be dumped
978in case of crash or upon receiving a ``SIGUSR2`` signal. This setting
979allows to override the default buffer size in kilobytes.
980If value is ``0`` or less the debug log buffer is deactivated
981``log_buffer_size = 64``
982
983To configure the logging parameters for QEMU, the below pillar
984structure and logging parameters should be used:
985
986.. code-block:: yaml
987
988 nova:
989 compute:
990 qemu:
991 logging:
992 handler: logd
993 virtlog:
994 enabled: true
995 level: 4
996 filters: '3:remote 3:event'
997 outputs: '4:syslog:virtlogd'
998 max_clients: 512
999 max_size: 2097100
1000 max_backups: 2
Oleh Hryhorove38525d2018-05-15 08:58:59 +00001001
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001002Inject password to VM
1003---------------------
1004
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001005By default nova blocks up any inject to VM because
1006``inject_partition`` param is equal to ``-2``.
1007If you want to inject password to VM, you will need to
1008define ``inject_partition`` greater or equal to ``-1`` and
1009define ``inject_password`` to ``True``
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001010
1011For example:
1012
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001013.. code-block:: yaml
1014
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001015 nova:
1016 compute:
1017 inject_partition: '-1'
1018 inject_password: True
1019
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001020Allow the injection of an admin password for instance only at
1021``create`` and ``rebuild`` process.
1022
1023There is no agent needed within the image to do this. If *libguestfs* is
1024available on the host, it will be used. Otherwise *nbd* is used. The file
1025system of the image will be mounted and the admin password, which is provided
1026in the REST API call will be injected as password for the root user. If no
1027root user is available, the instance won't be launched and an error is thrown.
1028Be aware that the injection is *not* possible when the instance gets launched
1029from a volume.
1030
1031Possible values:
1032
1033* ``True``
1034 Allows the injection
1035
1036* ``False`` (default)
1037 Disallows the injection. Any via the REST API provided
1038 admin password will be silently ignored.
1039
1040Related options:
1041
1042* ``inject_partition``
1043 Decides about the discovery and usage of the file system.
1044 It also can disable the injection at all.
1045 (boolean value)
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001046
1047You can read more about injecting the administrator password here:
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001048https://docs.openstack.org/nova/queens/admin/admin-password-injection.html
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001049
Oleksandr Shyshko1c020d12018-05-24 12:47:08 +03001050Enable libvirt control channel over TLS
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001051---------------------------------------
Oleksandr Shyshko1c020d12018-05-24 12:47:08 +03001052
1053By default TLS is disabled.
1054
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001055Enable TLS transport:
1056
1057.. code-block:: yaml
Oleksandr Shyshko1c020d12018-05-24 12:47:08 +03001058
1059 compute:
1060 libvirt:
1061 tls:
1062 enabled: True
1063
1064You able to set custom certificates in pillar:
1065
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001066.. code-block:: yaml
1067
Oleksandr Shyshko1c020d12018-05-24 12:47:08 +03001068 nova:
1069 compute:
1070 libvirt:
1071 tls:
1072 key: (certificate content)
1073 cert: (certificate content)
1074 cacert: (certificate content)
1075 client:
1076 key: (certificate content)
1077 cert: (certificate content)
1078
Vasyl Saienko11ac9732018-10-02 17:04:33 +00001079Controlling access by `tls_allowed_dn_list`.
1080Enable an access control list of client certificate Distinguished Names (DNs)
1081which can connect to the TLS port on this server. The default is that DNs are
1082not checked. This list may contain wildcards such as
1083"C=GB,ST=London,L=London,O=Libvirt Project,CN=*" See the POSIX fnmatch function
1084for the format of the wildcards.
1085Note that if this is an empty list, no client can connect.
1086Note also that GnuTLS returns DNs without spaces after commas between
1087the fields (and this is what we check against), but the openssl x509 tool
1088shows spaces.
1089
1090.. code-block:: yaml
1091
1092 nova:
1093 compute:
1094 libvirt:
1095 tls:
1096 tls_allowed_dn_list:
1097 host1:
1098 enabled: true
1099 value: 'C=foo,CN=cmp1'
1100 host2:
1101 enabled: true
1102 value: 'C=foo,CN=cmp2'
1103
1104
Oleksandr Shyshko1c020d12018-05-24 12:47:08 +03001105You can read more about live migration over TLS here:
OlgaGusarenko9dd01c92018-07-31 00:49:30 +03001106https://wiki.libvirt.org/page/TLSCreateServerCerts
Oleksandr Shyshko981b4fa2018-05-02 15:39:30 +03001107
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001108Enable transport + authentication for VNC over TLS
1109---------------------
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001110# Only for Queens. Communication between noVNC proxy service and QEMU
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001111
1112By default communication between nova-novncproxy and qemu service is unsecure.
1113
1114compute:
1115 qemu:
1116 vnc:
1117 tls:
1118 enabled: True
1119
1120controller:
1121 novncproxy:
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001122 # This section responsible for communication between noVNC proxy and client machine
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001123 tls:
1124 enabled: True
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001125 # This section responsible for communication between nova-novncproxy and qemu service
1126 vencrypt:
1127 tls:
1128 enabled: True
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001129
1130You able to set custom certificates in pillar:
1131
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001132nova:
1133 compute:
1134 qemu:
1135 vnc:
1136 tls:
1137 cacert (certificate content)
1138 cert (certificate content)
1139 key (certificate content)
1140
1141nova:
1142 controller:
1143 novncproxy:
1144 tls:
1145 server:
1146 cert (certificate content)
1147 key (certificate content)
1148 vencrypt:
1149 tls:
1150 cacert (certificate content)
1151 cert (certificate content)
1152 key (certificate content)
1153
1154
1155You can read more about it here:
1156 https://docs.openstack.org/nova/queens/admin/remote-console-access.html
1157
1158Enable communication between noVNC proxy and client machine over TLS
1159---------------------
1160
1161By default communication between noVNC proxy and client machine is unsecure.
1162
1163 controller:
1164 novncproxy:
1165 tls:
1166 enabled: True
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001167
1168 nova:
1169 controller:
1170 novncproxy:
1171 tls:
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001172 server:
1173 cert (certificate content)
1174 key (certificate content)
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001175
1176You can read more about it here:
Oleksandr Shyshkod8337cf2018-07-11 17:55:58 +03001177 https://docs.openstack.org/mitaka/config-reference/dashboard/configure.html
Oleksandr Shyshko1195fca2018-07-09 18:22:59 +03001178
Oleksandr Shyshko55eeac72018-08-03 18:23:28 +03001179Enable x509 and ssl communication between Nova and Galera cluster.
1180---------------------
1181By default communication between Nova and Galera is unsecure.
1182
Oleksandr Shyshkocbe87352018-09-07 13:42:57 +03001183nova:
1184 controller:
1185 database:
1186 x509:
1187 enabled: True
1188
Oleksandr Shyshko55eeac72018-08-03 18:23:28 +03001189You able to set custom certificates in pillar:
Oleksandr Shyshko55eeac72018-08-03 18:23:28 +03001190
1191nova:
1192 controller:
1193 database:
1194 x509:
Oleksandr Shyshkocbe87352018-09-07 13:42:57 +03001195 cacert: (certificate content)
1196 cert: (certificate content)
1197 key: (certificate content)
Oleksandr Shyshko55eeac72018-08-03 18:23:28 +03001198
1199You can read more about it here:
1200 https://docs.openstack.org/security-guide/databases/database-access-control.html
1201
obryndziif7957912019-01-31 00:55:56 +00001202Nova database connection setup:
1203========
1204
1205.. code-block:: yaml
1206
1207 nova:
1208 controller:
1209 enabled: True
1210 ...
1211 database:
1212 idle_timeout: 180
1213 min_pool_size: 100
1214 max_pool_size: 700
1215 max_overflow: 100
1216 retry_interval: 5
1217 max_retries: '-1'
1218 db_max_retries: 3
1219 db_retry_interval: 1
1220 connection_debug: 10
1221 pool_timeout: 120
1222
Oleksandr Bryndzii6d821f52019-02-20 15:51:15 +02001223
1224Configure nova to use service user tokens:
1225========
1226Long-running operations such as live migration or snapshot can sometimes overrun the
1227expiry of the user token. In such cases, post operations such as cleaning up after a
1228live migration can fail when the nova-compute service needs to cleanup resources in
1229other services, such as in the block-storage (cinder) or networking (neutron) services.
1230
1231This patch enables nova to use service user tokens to supplement the regular user token
1232used to initiate the operation. The identity service (keystone) will then authenticate
1233a request using the service user token if the user token has already expired.
1234
1235.. code-block:: yaml
1236
1237 nova:
1238 controller:
1239 enabled: True
1240 ...
1241 service_user:
1242 enabled: True
1243 user_domain_id: default
1244 project_domain_id: default
1245 project_name: service
1246 username: nova
1247 password: pswd
1248
1249
1250
Oleh Hryhorov63ee8452018-08-14 09:16:02 +00001251Upgrades
1252========
1253
1254Each openstack formula provide set of phases (logical bloks) that will help to
1255build flexible upgrade orchestration logic for particular components. The list
1256of phases might and theirs descriptions are listed in table below:
1257
1258+-------------------------------+------------------------------------------------------+
1259| State | Description |
1260+===============================+======================================================+
1261| <app>.upgrade.service_running | Ensure that all services for particular application |
1262| | are enabled for autostart and running |
1263+-------------------------------+------------------------------------------------------+
1264| <app>.upgrade.service_stopped | Ensure that all services for particular application |
1265| | disabled for autostart and dead |
1266+-------------------------------+------------------------------------------------------+
1267| <app>.upgrade.pkgs_latest | Ensure that packages used by particular application |
1268| | are installed to latest available version. |
1269| | This will not upgrade data plane packages like qemu |
1270| | and openvswitch as usually minimal required version |
1271| | in openstack services is really old. The data plane |
1272| | packages should be upgraded separately by `apt-get |
1273| | upgrade` or `apt-get dist-upgrade` |
1274| | Applying this state will not autostart service. |
1275+-------------------------------+------------------------------------------------------+
1276| <app>.upgrade.render_config | Ensure configuration is rendered actual version. +
1277+-------------------------------+------------------------------------------------------+
1278| <app>.upgrade.pre | We assume this state is applied on all nodes in the |
1279| | cloud before running upgrade. |
1280| | Only non destructive actions will be applied during |
1281| | this phase. Perform service built in service check |
1282| | like (keystone-manage doctor and nova-status upgrade)|
1283+-------------------------------+------------------------------------------------------+
1284| <app>.upgrade.upgrade.pre | Mostly applicable for data plane nodes. During this |
1285| | phase resources will be gracefully removed from |
1286| | current node if it is allowed. Services for upgraded |
1287| | application will be set to admin disabled state to |
1288| | make sure node will not participate in resources |
1289| | scheduling. For example on gtw nodes this will set |
1290| | all agents to admin disable state and will move all |
1291| | routers to other agents. |
1292+-------------------------------+------------------------------------------------------+
1293| <app>.upgrade.upgrade | This state will basically upgrade application on |
1294| | particular target. Stop services, render |
1295| | configuration, install new packages, run offline |
1296| | dbsync (for ctl), start services. Data plane should |
1297| | not be affected, only OpenStack python services. |
1298+-------------------------------+------------------------------------------------------+
1299| <app>.upgrade.upgrade.post | Add services back to scheduling. |
1300+-------------------------------+------------------------------------------------------+
1301| <app>.upgrade.post | This phase should be launched only when upgrade of |
1302| | the cloud is completed. Cleanup temporary files, |
1303| | perform other post upgrade tasks. |
1304+-------------------------------+------------------------------------------------------+
1305| <app>.upgrade.verify | Here we will do basic health checks (API CRUD |
1306| | operations, verify do not have dead network |
1307| | agents/compute services) |
1308+-------------------------------+------------------------------------------------------+