Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 1 | |
Aleš Komárek | 7215285 | 2017-04-11 13:48:48 +0200 | [diff] [blame] | 2 | ============ |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 3 | Usage |
Aleš Komárek | 7215285 | 2017-04-11 13:48:48 +0200 | [diff] [blame] | 4 | ============ |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 5 | |
Jakub Pavlik | fcf34f8 | 2016-05-20 09:35:51 +0200 | [diff] [blame] | 6 | OpenStack Nova provides a cloud computing fabric controller, supporting a wide |
| 7 | variety of virtualization technologies, including KVM, Xen, LXC, VMware, and |
| 8 | more. In addition to its native API, it includes compatibility with the |
| 9 | commonly encountered Amazon EC2 and S3 APIs. |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 10 | |
Aleš Komárek | 7215285 | 2017-04-11 13:48:48 +0200 | [diff] [blame] | 11 | Sample Pillars |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 12 | ============== |
| 13 | |
| 14 | Controller nodes |
| 15 | ---------------- |
| 16 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 17 | Nova services on the controller node: |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 18 | |
| 19 | .. code-block:: yaml |
| 20 | |
| 21 | nova: |
| 22 | controller: |
| 23 | version: juno |
| 24 | enabled: true |
| 25 | security_group: true |
Lachlan Evenson | b72de50 | 2016-01-20 15:34:04 -0800 | [diff] [blame] | 26 | cpu_allocation_ratio: 8.0 |
| 27 | ram_allocation_ratio: 1.0 |
Jiri Konecny | 9344a37 | 2016-03-21 19:25:48 +0100 | [diff] [blame] | 28 | disk_allocation_ratio: 1.0 |
Dmitry Stremkovskiy | 2bcba8d | 2017-07-30 21:43:59 +0300 | [diff] [blame] | 29 | cross_az_attach: false |
Jiri Konecny | b5a80e4 | 2016-03-22 11:51:01 +0100 | [diff] [blame] | 30 | workers: 8 |
Jakub Pavlik | 617a896 | 2016-09-04 18:50:06 +0200 | [diff] [blame] | 31 | report_interval: 60 |
Michel Nederlof | 8ff9933 | 2017-10-23 14:29:15 +0200 | [diff] [blame] | 32 | dhcp_domain: novalocal |
Vasyl Saienko | 09b6ac3 | 2019-01-17 15:23:58 +0200 | [diff] [blame] | 33 | vif_plugging_timeout: 300 |
| 34 | vif_plugging_is_fatal: false |
Vasyl Saienko | 2adac3f | 2019-02-18 12:32:52 +0200 | [diff] [blame] | 35 | instance_build_timeout: 600 |
sgarbuz | cc02c7f | 2018-10-25 14:29:30 +0300 | [diff] [blame] | 36 | consoleauth: |
| 37 | token_ttl: 600 |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 38 | 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 Hryhorov | f5093b8 | 2018-10-17 11:16:08 +0000 | [diff] [blame] | 63 | pci: |
| 64 | alias: |
| 65 | alias1: |
| 66 | device_type: "type-PF" |
| 67 | name: "a1" |
| 68 | product_id: "154d" |
| 69 | vendor_id: "8086" |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 70 | network: |
| 71 | engine: neutron |
| 72 | host: 127.0.0.1 |
| 73 | port: 9696 |
Jakub Pavlik | 617a896 | 2016-09-04 18:50:06 +0200 | [diff] [blame] | 74 | extension_sync_interval: 600 |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 75 | 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 Michalec | aa23dc0 | 2016-11-29 16:30:25 +0100 | [diff] [blame] | 84 | audit: |
| 85 | enabled: false |
Simon Pasquier | 8683b7a | 2017-02-03 16:00:16 +0100 | [diff] [blame] | 86 | osapi_max_limit: 500 |
Oleg Iurchenko | 370c10d | 2017-10-19 14:03:37 +0300 | [diff] [blame] | 87 | barbican: |
| 88 | enabled: true |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 89 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 90 | Nova services from custom package repository: |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 91 | |
| 92 | .. code-block:: yaml |
| 93 | |
| 94 | nova: |
| 95 | controller: |
| 96 | version: juno |
| 97 | source: |
| 98 | engine: pkg |
| 99 | address: http://... |
| 100 | .... |
| 101 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 102 | Client-side RabbitMQ HA setup: |
Jiri Konecny | e31f2c5 | 2016-04-14 17:16:02 +0200 | [diff] [blame] | 103 | |
| 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 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 120 | Enable auditing filter, i.e: CADF: |
Petr Michalec | aa23dc0 | 2016-11-29 16:30:25 +0100 | [diff] [blame] | 121 | |
| 122 | .. code-block:: yaml |
| 123 | |
| 124 | nova: |
| 125 | controller: |
Simon Pasquier | 6a3c8f7 | 2016-12-19 15:37:24 +0100 | [diff] [blame] | 126 | audit: |
Petr Michalec | aa23dc0 | 2016-11-29 16:30:25 +0100 | [diff] [blame] | 127 | enabled: true |
| 128 | .... |
| 129 | filter_factory: 'keystonemiddleware.audit:filter_factory' |
| 130 | map_file: '/etc/pycadf/nova_api_audit_map.conf' |
| 131 | .... |
| 132 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 133 | Enable CORS parameters: |
Ondrej Smola | 25b53cb | 2017-04-28 10:56:19 +0200 | [diff] [blame] | 134 | |
| 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 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 147 | Configuration of the ``policy.json`` file: |
Dmitry Ukov | 3562a08 | 2017-05-04 00:00:48 +0400 | [diff] [blame] | 148 | |
| 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 Smola | 25b53cb | 2017-04-28 10:56:19 +0200 | [diff] [blame] | 159 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 160 | Enable Barbican integration: |
Oleg Iurchenko | 370c10d | 2017-10-19 14:03:37 +0300 | [diff] [blame] | 161 | |
| 162 | .. code-block:: yaml |
| 163 | |
| 164 | nova: |
| 165 | controller: |
| 166 | .... |
| 167 | barbican: |
| 168 | enabled: true |
| 169 | |
Oleh Hryhorov | f5093b8 | 2018-10-17 11:16:08 +0000 | [diff] [blame] | 170 | Define 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 Broulik | 789179a | 2018-02-13 16:16:46 +0100 | [diff] [blame] | 184 | Enable cells update: |
| 185 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 186 | .. note:: Useful when upgrading Openstack. To update cells to test |
| 187 | sync db agains duplicated production database. |
Jiri Broulik | 789179a | 2018-02-13 16:16:46 +0100 | [diff] [blame] | 188 | |
| 189 | .. code-block:: yaml |
| 190 | |
| 191 | nova: |
| 192 | controller: |
| 193 | update_cells: true |
| 194 | |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 195 | |
Kirill Bespalov | a0eaca7 | 2017-11-20 13:40:42 +0300 | [diff] [blame] | 196 | Configuring TLS communications |
| 197 | ------------------------------ |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 198 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 199 | .. note:: By default system wide installed CA certs are used, |
| 200 | so ``cacert_file`` param is optional, as well as ``cacert``. |
Kirill Bespalov | a0eaca7 | 2017-11-20 13:40:42 +0300 | [diff] [blame] | 201 | |
| 202 | - **RabbitMQ TLS** |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 203 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 204 | .. code-block:: yaml |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 205 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 206 | 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 Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 215 | |
Kirill Bespalov | a0eaca7 | 2017-11-20 13:40:42 +0300 | [diff] [blame] | 216 | - **MySQL TLS** |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 217 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 218 | .. code-block:: yaml |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 219 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 220 | 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 Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 227 | |
Kirill Bespalov | a0eaca7 | 2017-11-20 13:40:42 +0300 | [diff] [blame] | 228 | - **Openstack HTTPS API** |
| 229 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 230 | Set the ``https`` as protocol at ``nova:compute`` and |
| 231 | ``nova:controller`` sections : |
Kirill Bespalov | a0eaca7 | 2017-11-20 13:40:42 +0300 | [diff] [blame] | 232 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 233 | .. code-block:: yaml |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 234 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 235 | 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 Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 246 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 247 | .. code-block:: yaml |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 248 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 249 | 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 Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 263 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 264 | .. note:: Barbican, Cinder, and placement url endpoints are discovering |
| 265 | using service catalog. |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 266 | |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 267 | Compute nodes |
| 268 | ------------- |
| 269 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 270 | Nova controller services on compute node: |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 271 | |
| 272 | .. code-block:: yaml |
| 273 | |
| 274 | nova: |
| 275 | compute: |
| 276 | version: juno |
| 277 | enabled: true |
Mykyta Karpin | 5ef9f98 | 2019-02-07 18:40:00 +0200 | [diff] [blame] | 278 | timeout_nbd: 10 |
| 279 | heal_instance_info_cache_interval: 60 |
Dmitry Stremkovskiy | 2bcba8d | 2017-07-30 21:43:59 +0300 | [diff] [blame] | 280 | cross_az_attach: false |
Dmitry Stremkovskiy | 35e53b7 | 2017-07-29 12:50:39 +0300 | [diff] [blame] | 281 | disk_cachemodes: network=writeback,block=none |
Jiri Broulik | 70d9e3f | 2017-02-15 18:37:13 +0100 | [diff] [blame] | 282 | availability_zone: availability_zone_01 |
Damian Szeluga | e192241 | 2017-04-18 16:36:46 +0200 | [diff] [blame] | 283 | aggregates: |
| 284 | - hosts_with_fc |
| 285 | - hosts_with_ssd |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 286 | security_group: true |
Petr Michalec | f03e488 | 2017-04-10 10:26:18 +0200 | [diff] [blame] | 287 | resume_guests_state_on_host_boot: False |
Michael Polenchuk | 159c254 | 2018-06-09 15:31:51 +0400 | [diff] [blame] | 288 | preallocate_images: space # Default is 'none' |
Dmitry Stremkovskiy | 8a0ff51 | 2017-07-25 20:54:13 +0300 | [diff] [blame] | 289 | my_ip: 10.1.0.16 |
Vasyl Saienko | 09b6ac3 | 2019-01-17 15:23:58 +0200 | [diff] [blame] | 290 | vif_plugging_timeout: 300 |
| 291 | vif_plugging_is_fatal: false |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 292 | 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 Hryhorov | f5093b8 | 2018-10-17 11:16:08 +0000 | [diff] [blame] | 322 | pci: |
| 323 | alias: |
| 324 | alias1: |
| 325 | device_type: "type-PF" |
| 326 | name: "a1" |
| 327 | product_id: "154d" |
| 328 | vendor_id: "8086" |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 329 | network: |
| 330 | engine: neutron |
| 331 | host: 127.0.0.1 |
| 332 | port: 9696 |
| 333 | identity: |
| 334 | engine: keystone |
| 335 | host: 127.0.0.1 |
| 336 | port: 35357 |
| 337 | user: neutron |
| 338 | password: pwd |
| 339 | tenant: service |
| 340 | qemu: |
| 341 | max_files: 4096 |
| 342 | max_processes: 4096 |
Dmitry Stremkovskiy | 96281f5 | 2017-07-26 00:39:22 +0300 | [diff] [blame] | 343 | host: node-12.domain.tld |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 344 | |
Vasyl Saienko | cab3a90 | 2018-07-12 13:17:17 +0300 | [diff] [blame] | 345 | Compute with vmware driver. Each vmware cluster requires a separate process of nova-compute. |
| 346 | Each process should have uniq host identifier. However multiple computes might be running on |
| 347 | single host. It is not recommended to have multiple computes running on different hosts that |
| 348 | manage the same vmware cluster. To achive this pacemaker/corosync or keepalived might be used. |
| 349 | |
| 350 | .. code-block:: yaml |
| 351 | |
| 352 | nova: |
| 353 | compute: |
| 354 | compute_driver: vmwareapi.VMwareVCDriver |
| 355 | vmware: |
| 356 | host_username: vmware |
| 357 | host_password: vmware |
| 358 | cluster_name: vmware_cluster01 |
| 359 | host_ip: 1.2.3.4 |
| 360 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 361 | Group and user to be used for QEMU processes run by the system instance: |
kkalynovskyi | f50f0c0 | 2017-12-12 17:52:57 +0200 | [diff] [blame] | 362 | |
| 363 | .. code-block:: yaml |
| 364 | |
| 365 | nova: |
| 366 | compute: |
| 367 | enabled: true |
| 368 | ... |
| 369 | qemu: |
| 370 | user: nova |
| 371 | group: cinder |
| 372 | dynamic_ownership: 1 |
| 373 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 374 | Group membership for user nova (upgrade related): |
Dmitry Stremkovskiy | 3cd6ba8 | 2017-07-25 17:15:36 +0300 | [diff] [blame] | 375 | |
| 376 | .. code-block:: yaml |
| 377 | |
| 378 | nova: |
| 379 | compute: |
| 380 | enabled: true |
| 381 | ... |
| 382 | user: |
| 383 | groups: |
| 384 | - libvirt |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 385 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 386 | Nova services on compute node with OpenContrail: |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 387 | |
| 388 | .. code-block:: yaml |
| 389 | |
| 390 | nova: |
| 391 | compute: |
| 392 | enabled: true |
| 393 | ... |
| 394 | networking: contrail |
| 395 | |
Oleksandr Bryndzii | bb8abfe | 2018-09-28 22:21:43 +0000 | [diff] [blame] | 396 | Nova services on compute node with memcached caching and security strategy: |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 397 | |
| 398 | .. code-block:: yaml |
| 399 | |
| 400 | nova: |
| 401 | compute: |
| 402 | enabled: true |
| 403 | ... |
| 404 | cache: |
| 405 | engine: memcached |
| 406 | members: |
| 407 | - host: 127.0.0.1 |
| 408 | port: 11211 |
| 409 | - host: 127.0.0.1 |
| 410 | port: 11211 |
Oleksandr Bryndzii | bb8abfe | 2018-09-28 22:21:43 +0000 | [diff] [blame] | 411 | security: |
| 412 | enabled: true |
| 413 | strategy: ENCRYPT |
| 414 | secret_key: secret |
Filip Pytloun | 4a72d79 | 2015-10-06 16:28:32 +0200 | [diff] [blame] | 415 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 416 | Client-side RabbitMQ HA setup: |
Jiri Konecny | e31f2c5 | 2016-04-14 17:16:02 +0200 | [diff] [blame] | 417 | |
| 418 | .. code-block:: yaml |
| 419 | |
| 420 | nova: |
Kirill Bespalov | 6461717 | 2017-07-11 14:43:14 +0300 | [diff] [blame] | 421 | compute: |
Jiri Konecny | e31f2c5 | 2016-04-14 17:16:02 +0200 | [diff] [blame] | 422 | .... |
| 423 | message_queue: |
| 424 | engine: rabbitmq |
| 425 | members: |
| 426 | - host: 10.0.16.1 |
| 427 | - host: 10.0.16.2 |
| 428 | - host: 10.0.16.3 |
| 429 | user: openstack |
| 430 | password: pwd |
| 431 | virtual_host: '/openstack' |
| 432 | .... |
| 433 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 434 | Nova with ephemeral configured with Ceph: |
maxstack | 39e6aca | 2016-05-04 13:50:13 +0000 | [diff] [blame] | 435 | |
| 436 | .. code-block:: yaml |
| 437 | |
| 438 | nova: |
| 439 | compute: |
| 440 | enabled: true |
| 441 | ... |
| 442 | ceph: |
| 443 | ephemeral: yes |
| 444 | rbd_pool: nova |
| 445 | rbd_user: nova |
| 446 | secret_uuid: 03006edd-d957-40a3-ac4c-26cd254b3731 |
Kalynovskyi | 0bc7969 | 2017-07-21 16:22:09 +0300 | [diff] [blame] | 447 | .... |
maxstack | 39e6aca | 2016-05-04 13:50:13 +0000 | [diff] [blame] | 448 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 449 | Nova with ephemeral configured with LVM: |
Kalynovskyi | 0bc7969 | 2017-07-21 16:22:09 +0300 | [diff] [blame] | 450 | |
| 451 | .. code-block:: yaml |
| 452 | |
| 453 | nova: |
| 454 | compute: |
| 455 | enabled: true |
| 456 | ... |
| 457 | lvm: |
| 458 | ephemeral: yes |
| 459 | images_volume_group: nova_vg |
| 460 | |
| 461 | linux: |
| 462 | storage: |
| 463 | lvm: |
| 464 | nova_vg: |
| 465 | name: nova_vg |
| 466 | devices: |
| 467 | - /dev/sdf |
| 468 | - /dev/sdd |
| 469 | - /dev/sdg |
| 470 | - /dev/sde |
| 471 | - /dev/sdc |
| 472 | - /dev/sdj |
| 473 | - /dev/sdh |
maxstack | 39e6aca | 2016-05-04 13:50:13 +0000 | [diff] [blame] | 474 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 475 | Enable Barbican integration: |
Oleg Iurchenko | 370c10d | 2017-10-19 14:03:37 +0300 | [diff] [blame] | 476 | |
| 477 | .. code-block:: yaml |
| 478 | |
| 479 | nova: |
| 480 | compute: |
| 481 | .... |
| 482 | barbican: |
| 483 | enabled: true |
| 484 | |
Oleh Hryhorov | f5093b8 | 2018-10-17 11:16:08 +0000 | [diff] [blame] | 485 | Define aliases for PCI devices: |
| 486 | .. code-block:: yaml |
| 487 | |
| 488 | nova: |
| 489 | compute: |
| 490 | ... |
| 491 | pci: |
| 492 | alias: |
| 493 | alias1: |
| 494 | device_type: "type-PF" |
| 495 | name: "a1" |
| 496 | product_id: "154d" |
| 497 | vendor_id: "8086" |
| 498 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 499 | Nova metadata custom bindings: |
Vasyl Saienko | 2d59128 | 2018-02-05 14:19:02 +0200 | [diff] [blame] | 500 | |
| 501 | .. code-block:: yaml |
| 502 | |
| 503 | nova: |
| 504 | controller: |
| 505 | enabled: true |
| 506 | ... |
| 507 | metadata: |
| 508 | bind: |
| 509 | address: 1.2.3.4 |
| 510 | port: 8776 |
| 511 | |
Oleh Hryhorov | 08482aa | 2018-11-19 14:07:47 +0200 | [diff] [blame] | 512 | Define multipath for nova compute: |
| 513 | |
| 514 | .. code-block:: yaml |
| 515 | |
| 516 | nova: |
| 517 | compute: |
| 518 | .... |
| 519 | libvirt: |
| 520 | volume_use_multipath: True |
| 521 | |
Jiri Broulik | 0ce9fc9 | 2017-02-01 23:10:40 +0100 | [diff] [blame] | 522 | Client role |
| 523 | ----------- |
| 524 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 525 | Nova configured with NFS: |
Dmitry Stremkovskiy | 665c728 | 2017-07-05 17:36:27 +0300 | [diff] [blame] | 526 | |
| 527 | .. code-block:: yaml |
| 528 | |
| 529 | nova: |
| 530 | compute: |
| 531 | instances_path: /mnt/nova/instances |
| 532 | |
| 533 | linux: |
| 534 | storage: |
| 535 | enabled: true |
| 536 | mount: |
| 537 | nfs_nova: |
| 538 | enabled: true |
| 539 | path: ${nova:compute:instances_path} |
| 540 | device: 172.31.35.145:/data |
| 541 | file_system: nfs |
| 542 | opts: rw,vers=3 |
| 543 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 544 | Nova flavors: |
Jiri Broulik | 0ce9fc9 | 2017-02-01 23:10:40 +0100 | [diff] [blame] | 545 | |
| 546 | .. code-block:: yaml |
| 547 | |
| 548 | nova: |
| 549 | client: |
| 550 | enabled: true |
| 551 | server: |
| 552 | identity: |
| 553 | flavor: |
Jiri Broulik | 70d9e3f | 2017-02-15 18:37:13 +0100 | [diff] [blame] | 554 | flavor1: |
Jiri Broulik | 0ce9fc9 | 2017-02-01 23:10:40 +0100 | [diff] [blame] | 555 | flavor_id: 10 |
| 556 | ram: 4096 |
| 557 | disk: 10 |
| 558 | vcpus: 1 |
Jiri Broulik | 70d9e3f | 2017-02-15 18:37:13 +0100 | [diff] [blame] | 559 | flavor2: |
| 560 | flavor_id: auto |
| 561 | ram: 4096 |
| 562 | disk: 20 |
| 563 | vcpus: 2 |
Jiri Broulik | 0ce9fc9 | 2017-02-01 23:10:40 +0100 | [diff] [blame] | 564 | identity1: |
| 565 | flavor: |
| 566 | ... |
| 567 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 568 | Availability zones: |
Jiri Broulik | 70d9e3f | 2017-02-15 18:37:13 +0100 | [diff] [blame] | 569 | |
| 570 | .. code-block:: yaml |
| 571 | |
| 572 | nova: |
| 573 | client: |
| 574 | enabled: true |
| 575 | server: |
| 576 | identity: |
| 577 | availability_zones: |
| 578 | - availability_zone_01 |
| 579 | - availability_zone_02 |
| 580 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 581 | Aggregates: |
Damian Szeluga | 5dca0f0 | 2017-04-13 17:27:15 +0200 | [diff] [blame] | 582 | |
| 583 | .. code-block:: yaml |
| 584 | |
| 585 | nova: |
| 586 | client: |
| 587 | enabled: true |
| 588 | server: |
| 589 | identity: |
| 590 | aggregates: |
| 591 | - aggregate1 |
| 592 | - aggregate2 |
| 593 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 594 | Upgrade levels: |
Dmitry Stremkovskiy | 91f4585 | 2017-07-18 16:22:31 +0300 | [diff] [blame] | 595 | |
| 596 | .. code-block:: yaml |
| 597 | |
| 598 | nova: |
| 599 | controller: |
| 600 | upgrade_levels: |
| 601 | compute: juno |
| 602 | |
| 603 | nova: |
| 604 | compute: |
| 605 | upgrade_levels: |
| 606 | compute: juno |
| 607 | |
Petr Jediný | d855ef2 | 2017-03-06 22:24:33 +0100 | [diff] [blame] | 608 | SR-IOV |
Jakub Pavlik | 39a0594 | 2017-02-13 23:03:08 +0100 | [diff] [blame] | 609 | ------ |
| 610 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 611 | Add ``PciPassthroughFilter`` into scheduler filters and NICs on |
| 612 | specific compute nodes: |
Jakub Pavlik | 39a0594 | 2017-02-13 23:03:08 +0100 | [diff] [blame] | 613 | |
| 614 | .. code-block:: yaml |
| 615 | |
| 616 | nova: |
| 617 | controller: |
| 618 | sriov: true |
sandriichenko | 4fe321d | 2018-01-22 17:34:06 +0000 | [diff] [blame] | 619 | scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,PciPassthroughFilter" |
Jakub Pavlik | 39a0594 | 2017-02-13 23:03:08 +0100 | [diff] [blame] | 620 | |
| 621 | nova: |
| 622 | compute: |
| 623 | sriov: |
| 624 | nic_one: |
| 625 | devname: eth1 |
| 626 | physical_network: physnet1 |
| 627 | |
Oleh Hryhorov | f5093b8 | 2018-10-17 11:16:08 +0000 | [diff] [blame] | 628 | .. note:: Parameters located under nova:compute:sriov:<nic_name> are copied to passthrough_whitelist parameter into |
| 629 | nova.conf file in appropriate format. |
| 630 | |
Jakub Pavlik | 26fb85c | 2017-02-16 22:29:22 +0100 | [diff] [blame] | 631 | CPU pinning & Hugepages |
| 632 | ----------------------- |
| 633 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 634 | CPU pinning of virtual machine instances to dedicated physical |
| 635 | CPU cores. Hugepages mount point for libvirt. |
Jakub Pavlik | 26fb85c | 2017-02-16 22:29:22 +0100 | [diff] [blame] | 636 | |
| 637 | .. code-block:: yaml |
| 638 | |
| 639 | nova: |
| 640 | controller: |
sandriichenko | 4fe321d | 2018-01-22 17:34:06 +0000 | [diff] [blame] | 641 | scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,NUMATopologyFilter,AggregateInstanceExtraSpecsFilter" |
Jakub Pavlik | 26fb85c | 2017-02-16 22:29:22 +0100 | [diff] [blame] | 642 | |
| 643 | nova: |
| 644 | compute: |
| 645 | vcpu_pin_set: 2,3,4,5 |
| 646 | hugepages: |
| 647 | mount_points: |
| 648 | - path: /mnt/hugepages_1GB |
| 649 | - path: /mnt/hugepages_2MB |
Jiri Broulik | 0ce9fc9 | 2017-02-01 23:10:40 +0100 | [diff] [blame] | 650 | |
Michel Nederlof | 171c7ac | 2017-04-13 12:54:14 +0200 | [diff] [blame] | 651 | Custom Scheduler filters |
| 652 | ------------------------ |
| 653 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 654 | If you have a custom filter, that needs to be included in the |
| 655 | scheduler, then you can include it like so: |
Michel Nederlof | 171c7ac | 2017-04-13 12:54:14 +0200 | [diff] [blame] | 656 | |
| 657 | .. code-block:: yaml |
| 658 | |
| 659 | nova: |
| 660 | controller: |
| 661 | scheduler_custom_filters: |
| 662 | - my_custom_driver.nova.scheduler.filters.my_custom_filter.MyCustomFilter |
| 663 | |
| 664 | # Then add your custom filter on the end (make sure to include all other ones that you need as well) |
sandriichenko | 4fe321d | 2018-01-22 17:34:06 +0000 | [diff] [blame] | 665 | scheduler_default_filters: "DifferentHostFilter,SameHostFilter,RetryFilter,AvailabilityZoneFilter,RamFilter,CoreFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter,PciPassthroughFilter,MyCustomFilter" |
Michel Nederlof | 171c7ac | 2017-04-13 12:54:14 +0200 | [diff] [blame] | 666 | |
Michael Polenchuk | 2bce2cb | 2018-09-17 16:05:43 +0400 | [diff] [blame] | 667 | # Since Queens version a sequence could be used as well: |
| 668 | ~scheduler_default_filters: |
| 669 | - DifferentHostFilter |
| 670 | - SameHostFilter |
| 671 | ... |
| 672 | - MyCustomFilter |
| 673 | |
| 674 | |
Michel Nederlof | eb566f6 | 2017-04-21 15:37:47 +0200 | [diff] [blame] | 675 | Hardware Trip/Unmap Support |
| 676 | --------------------------- |
| 677 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 678 | To enable TRIM support for ephemeral images (thru nova managed |
| 679 | images), libvirt has this option: |
Michel Nederlof | eb566f6 | 2017-04-21 15:37:47 +0200 | [diff] [blame] | 680 | |
| 681 | .. code-block:: yaml |
| 682 | |
| 683 | nova: |
| 684 | compute: |
| 685 | libvirt: |
| 686 | hw_disk_discard: unmap |
| 687 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 688 | To actually utilize this feature, the following metadata must be |
| 689 | set on the image as well, so the SCSI unmap is supported: |
Michel Nederlof | eb566f6 | 2017-04-21 15:37:47 +0200 | [diff] [blame] | 690 | |
| 691 | .. code-block:: bash |
| 692 | |
| 693 | glance image-update --property hw_scsi_model=virtio-scsi <image> |
| 694 | glance image-update --property hw_disk_bus=scsi <image> |
Filip Pytloun | 5bc9e9f | 2017-02-02 13:05:40 +0100 | [diff] [blame] | 695 | |
Thom Gerdes | f582f1e | 2017-05-02 18:05:50 +0000 | [diff] [blame] | 696 | Scheduler Host Manager |
| 697 | ---------------------- |
| 698 | |
| 699 | Specify a custom host manager. |
| 700 | |
Thom Gerdes | ec00afd | 2017-04-07 18:06:59 +0000 | [diff] [blame] | 701 | libvirt CPU mode |
| 702 | ---------------- |
| 703 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 704 | Allow setting the model of CPU that is exposed to a VM. This |
| 705 | allows for better support live migration between hypervisors with |
| 706 | different hardware, among other things. Defaults to host-passthrough. |
Jakub Pavlik | 7046b9c | 2017-09-19 12:04:19 +0200 | [diff] [blame] | 707 | |
Thom Gerdes | f582f1e | 2017-05-02 18:05:50 +0000 | [diff] [blame] | 708 | .. code-block:: yaml |
| 709 | |
| 710 | nova: |
| 711 | controller: |
| 712 | scheduler_host_manager: ironic_host_manager |
| 713 | |
Thom Gerdes | ec00afd | 2017-04-07 18:06:59 +0000 | [diff] [blame] | 714 | compute: |
| 715 | cpu_mode: host-model |
| 716 | |
Dzmitry Stremkouski | 7da9bf1 | 2018-04-25 22:30:37 +0200 | [diff] [blame] | 717 | Nova compute cpu model |
| 718 | ---------------------- |
| 719 | |
| 720 | .. code-block:: yaml |
| 721 | |
| 722 | nova: |
| 723 | compute: |
| 724 | cpu_mode: custom |
| 725 | libvirt: |
| 726 | cpu_model: IvyBridge |
| 727 | |
| 728 | |
Michel Nederlof | f7eefb2 | 2017-07-10 11:14:33 +0200 | [diff] [blame] | 729 | Nova compute workarounds |
| 730 | ------------------------ |
| 731 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 732 | Live snapshotting is disabled by default in nova. To enable |
| 733 | this, it needs a manual switch. |
Michel Nederlof | f7eefb2 | 2017-07-10 11:14:33 +0200 | [diff] [blame] | 734 | |
| 735 | From manual: |
| 736 | |
| 737 | .. code-block:: yaml |
| 738 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 739 | When using libvirt 1.2.2 live snapshots fail intermittently under load |
| 740 | (likely related to concurrent libvirt/qemu operations). This config |
| 741 | option provides a mechanism to disable live snapshot, in favor of cold |
| 742 | snapshot, while this is resolved. Cold snapshot causes an instance |
| 743 | outage while the guest is going through the snapshotting process. |
| 744 | |
| 745 | For more information, refer to the bug report: |
| 746 | |
| 747 | https://bugs.launchpad.net/nova/+bug/1334398 |
Michel Nederlof | f7eefb2 | 2017-07-10 11:14:33 +0200 | [diff] [blame] | 748 | |
| 749 | Configurable pillar data: |
| 750 | |
| 751 | .. code-block:: yaml |
| 752 | |
| 753 | nova: |
| 754 | compute: |
Michel Nederlof | e322ebb | 2017-07-10 12:29:21 +0200 | [diff] [blame] | 755 | workaround: |
Michel Nederlof | f7eefb2 | 2017-07-10 11:14:33 +0200 | [diff] [blame] | 756 | disable_libvirt_livesnapshot: False |
| 757 | |
Michel Nederlof | b51a514 | 2017-06-27 08:31:35 +0200 | [diff] [blame] | 758 | Config drive options |
| 759 | -------------------- |
| 760 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 761 | See example below on how to configure the options for the |
| 762 | config drive: |
Michel Nederlof | b51a514 | 2017-06-27 08:31:35 +0200 | [diff] [blame] | 763 | |
| 764 | .. code-block:: yaml |
| 765 | |
| 766 | nova: |
| 767 | compute: |
| 768 | config_drive: |
| 769 | forced: True # Default: True |
| 770 | cdrom: True # Default: False |
| 771 | format: iso9660 # Default: vfat |
| 772 | inject_password: False # Default: False |
| 773 | |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 774 | Number of concurrent live migrates |
| 775 | ---------------------------------- |
| 776 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 777 | Default is to have no concurrent live migrations (so 1 |
| 778 | live-migration at a time). |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 779 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 780 | Excerpt from config options page |
| 781 | https://docs.openstack.org/ocata/config-reference/compute/config-options.html: |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 782 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 783 | Maximum number of live migrations to run concurrently. This limit is |
| 784 | enforced to avoid outbound live migrations overwhelming the host/network |
| 785 | and causing failures. It is not recommended that you change this unless |
| 786 | you are very sure that doing so is safe and stable in your environment. |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 787 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 788 | Possible values: |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 789 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 790 | - 0 : treated as unlimited. |
| 791 | - Negative value defaults to 0. |
| 792 | - Any positive integer representing maximum number of live migrations |
| 793 | to run concurrently. |
Michel Nederlof | f81919b | 2017-11-20 09:37:07 +0100 | [diff] [blame] | 794 | |
| 795 | To configure this option: |
| 796 | |
| 797 | .. code-block:: yaml |
| 798 | |
| 799 | nova: |
| 800 | compute: |
| 801 | max_concurrent_live_migrations: 1 # (1 is the default) |
| 802 | |
Sergio Lystopad | 9d31cba | 2018-05-15 11:29:11 +0300 | [diff] [blame] | 803 | Live migration with auto converge |
| 804 | ---------------------------------- |
| 805 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 806 | Auto converge throttles down CPU if a progress of on-going live |
| 807 | migration is slow |
| 808 | https://docs.openstack.org/ocata/config-reference/compute/config-options.html: |
Sergio Lystopad | 9d31cba | 2018-05-15 11:29:11 +0300 | [diff] [blame] | 809 | |
| 810 | .. code-block:: yaml |
| 811 | |
| 812 | nova: |
| 813 | compute: |
| 814 | libvirt: |
| 815 | live_migration_permit_auto_converge: False # (False is the default) |
| 816 | |
| 817 | .. code-block:: yaml |
| 818 | |
| 819 | nova: |
| 820 | controller: |
| 821 | libvirt: |
| 822 | live_migration_permit_auto_converge: False # (False is the default) |
| 823 | |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 824 | Enhanced logging with logging.conf |
| 825 | ---------------------------------- |
| 826 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 827 | By default ``logging.conf`` is disabled. |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 828 | |
| 829 | That is possible to enable per-binary logging.conf with new variables: |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 830 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 831 | * ``openstack_log_appender`` |
| 832 | Set to true to enable log_config_append for all OpenStack services |
| 833 | |
| 834 | * ``openstack_fluentd_handler_enabled`` |
| 835 | Set to true to enable FluentHandler for all Openstack services |
| 836 | |
| 837 | * ``openstack_ossyslog_handler_enabled`` |
| 838 | Set to true to enable OSSysLogHandler for all Openstack services |
| 839 | |
| 840 | Only ``WatchedFileHandler``, ``OSSysLogHandler``, and ``FluentHandler`` |
| 841 | are available. |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 842 | |
Dmitry Kalashnik | 8da249c | 2018-01-16 17:58:00 +0400 | [diff] [blame] | 843 | Also it is possible to configure this with pillar: |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 844 | |
| 845 | .. code-block:: yaml |
| 846 | |
| 847 | nova: |
| 848 | controller: |
| 849 | logging: |
| 850 | log_appender: true |
| 851 | log_handlers: |
| 852 | watchedfile: |
| 853 | enabled: true |
| 854 | fluentd: |
| 855 | enabled: true |
Oleksii Chupryn | 99e3503 | 2018-02-06 01:59:40 +0200 | [diff] [blame] | 856 | ossyslog: |
| 857 | enabled: true |
Dmitry Kalashnik | e58fe08 | 2017-12-01 16:31:14 +0400 | [diff] [blame] | 858 | |
| 859 | compute: |
| 860 | logging: |
| 861 | log_appender: true |
| 862 | log_handlers: |
| 863 | watchedfile: |
| 864 | enabled: true |
| 865 | fluentd: |
| 866 | enabled: true |
Oleksii Chupryn | 99e3503 | 2018-02-06 01:59:40 +0200 | [diff] [blame] | 867 | ossyslog: |
| 868 | enabled: true |
Thom Gerdes | f582f1e | 2017-05-02 18:05:50 +0000 | [diff] [blame] | 869 | |
Vasyl Saienko | 7243a95 | 2018-05-11 21:26:54 +0300 | [diff] [blame] | 870 | The log level might be configured per logger by using the |
| 871 | following pillar structure: |
| 872 | |
| 873 | .. code-block:: yaml |
| 874 | |
| 875 | nova: |
| 876 | compute: |
| 877 | logging: |
| 878 | loggers: |
| 879 | <logger_name>: |
| 880 | level: WARNING |
| 881 | |
| 882 | nova: |
| 883 | compute: |
| 884 | logging: |
| 885 | loggers: |
| 886 | <logger_name>: |
| 887 | level: WARNING |
| 888 | |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 889 | Configure syslog parameters for libvirtd |
| 890 | ---------------------------------------- |
| 891 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 892 | To configure syslog parameters for libvirtd the below pillar |
| 893 | structure should be used with values which are supported |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 894 | by libvirtd. These values might be known from the documentation. |
| 895 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 896 | .. code-block:: yaml |
| 897 | |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 898 | nova: |
| 899 | compute: |
| 900 | libvirt: |
| 901 | logging: |
| 902 | level: 3 |
| 903 | filters: '3:remote 4:event' |
| 904 | outputs: '3:syslog:libvirtd' |
| 905 | buffer_size: 64 |
| 906 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 907 | Logging controls: |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 908 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 909 | Logging level: 4 errors, 3 warnings, 2 information, 1 debug |
| 910 | basically 1 will log everything possible ``log_level = 3`` |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 911 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 912 | Logging filters: |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 913 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 914 | A filter allows to select a different logging level for a given category |
| 915 | of logs. |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 916 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 917 | The format for a filter is one of: |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 918 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 919 | * ``x:name`` |
| 920 | * ``x:+name`` |
| 921 | where name is a string which is matched against source file name, |
| 922 | e.g., ``remote``, ``qemu``, or ``util/json``, the optional ``+`` prefix |
| 923 | tells libvirt to log stack trace for each message matching name, |
| 924 | and x is the minimal level where matching messages should be logged: |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 925 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 926 | * ``1: DEBUG`` |
| 927 | * ``2: INFO`` |
| 928 | * ``3: WARNING`` |
| 929 | * ``4: ERROR`` |
| 930 | |
| 931 | Multiple filter can be defined in a single @filters, they just |
| 932 | need to be separated by spaces. |
| 933 | |
| 934 | For example, to only get warning or errors from the remote layer |
| 935 | and only errors from the event layer: ``log_filters="3:remote 4:event`` |
| 936 | |
| 937 | Logging outputs: |
| 938 | |
| 939 | An output is one of the places to save logging information |
| 940 | The format for an output can be: |
| 941 | |
| 942 | * ``x:stderr`` |
| 943 | Output goes to stderr |
| 944 | |
| 945 | * ``x:syslog:name`` |
| 946 | Use syslog for the output and use the given name as the ident |
| 947 | |
| 948 | * ``x:file:file_path`` |
| 949 | output to a file, with the given filepath |
| 950 | |
| 951 | In all case the x prefix is the minimal level, acting as a filter |
| 952 | |
| 953 | * ``1: DEBUG`` |
| 954 | * ``2: INFO`` |
| 955 | * ``3: WARNING`` |
| 956 | * ``4: ERROR`` |
| 957 | |
| 958 | Multiple output can be defined, they just need to be separated by spaces. |
| 959 | For example, to log all warnings and errors to syslog under the libvirt |
| 960 | dident: ``log_outputs="3:syslog:libvirtd`` |
| 961 | |
| 962 | Log debug buffer size: default 64 |
| 963 | The daemon keeps an internal debug log buffer which will be dumped |
| 964 | in case of crash or upon receiving a ``SIGUSR2`` signal. This setting |
| 965 | allows to override the default buffer size in kilobytes. |
| 966 | If value is ``0`` or less the debug log buffer is deactivated |
| 967 | ``log_buffer_size = 64`` |
| 968 | |
| 969 | To configure the logging parameters for QEMU, the below pillar |
| 970 | structure and logging parameters should be used: |
| 971 | |
| 972 | .. code-block:: yaml |
| 973 | |
| 974 | nova: |
| 975 | compute: |
| 976 | qemu: |
| 977 | logging: |
| 978 | handler: logd |
| 979 | virtlog: |
| 980 | enabled: true |
| 981 | level: 4 |
| 982 | filters: '3:remote 3:event' |
| 983 | outputs: '4:syslog:virtlogd' |
| 984 | max_clients: 512 |
| 985 | max_size: 2097100 |
| 986 | max_backups: 2 |
Oleh Hryhorov | e38525d | 2018-05-15 08:58:59 +0000 | [diff] [blame] | 987 | |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 988 | Inject password to VM |
| 989 | --------------------- |
| 990 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 991 | By default nova blocks up any inject to VM because |
| 992 | ``inject_partition`` param is equal to ``-2``. |
| 993 | If you want to inject password to VM, you will need to |
| 994 | define ``inject_partition`` greater or equal to ``-1`` and |
| 995 | define ``inject_password`` to ``True`` |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 996 | |
| 997 | For example: |
| 998 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 999 | .. code-block:: yaml |
| 1000 | |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 1001 | nova: |
| 1002 | compute: |
| 1003 | inject_partition: '-1' |
| 1004 | inject_password: True |
| 1005 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1006 | Allow the injection of an admin password for instance only at |
| 1007 | ``create`` and ``rebuild`` process. |
| 1008 | |
| 1009 | There is no agent needed within the image to do this. If *libguestfs* is |
| 1010 | available on the host, it will be used. Otherwise *nbd* is used. The file |
| 1011 | system of the image will be mounted and the admin password, which is provided |
| 1012 | in the REST API call will be injected as password for the root user. If no |
| 1013 | root user is available, the instance won't be launched and an error is thrown. |
| 1014 | Be aware that the injection is *not* possible when the instance gets launched |
| 1015 | from a volume. |
| 1016 | |
| 1017 | Possible values: |
| 1018 | |
| 1019 | * ``True`` |
| 1020 | Allows the injection |
| 1021 | |
| 1022 | * ``False`` (default) |
| 1023 | Disallows the injection. Any via the REST API provided |
| 1024 | admin password will be silently ignored. |
| 1025 | |
| 1026 | Related options: |
| 1027 | |
| 1028 | * ``inject_partition`` |
| 1029 | Decides about the discovery and usage of the file system. |
| 1030 | It also can disable the injection at all. |
| 1031 | (boolean value) |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 1032 | |
| 1033 | You can read more about injecting the administrator password here: |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1034 | https://docs.openstack.org/nova/queens/admin/admin-password-injection.html |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 1035 | |
Oleksandr Shyshko | 1c020d1 | 2018-05-24 12:47:08 +0300 | [diff] [blame] | 1036 | Enable libvirt control channel over TLS |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1037 | --------------------------------------- |
Oleksandr Shyshko | 1c020d1 | 2018-05-24 12:47:08 +0300 | [diff] [blame] | 1038 | |
| 1039 | By default TLS is disabled. |
| 1040 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1041 | Enable TLS transport: |
| 1042 | |
| 1043 | .. code-block:: yaml |
Oleksandr Shyshko | 1c020d1 | 2018-05-24 12:47:08 +0300 | [diff] [blame] | 1044 | |
| 1045 | compute: |
| 1046 | libvirt: |
| 1047 | tls: |
| 1048 | enabled: True |
| 1049 | |
| 1050 | You able to set custom certificates in pillar: |
| 1051 | |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1052 | .. code-block:: yaml |
| 1053 | |
Oleksandr Shyshko | 1c020d1 | 2018-05-24 12:47:08 +0300 | [diff] [blame] | 1054 | nova: |
| 1055 | compute: |
| 1056 | libvirt: |
| 1057 | tls: |
| 1058 | key: (certificate content) |
| 1059 | cert: (certificate content) |
| 1060 | cacert: (certificate content) |
| 1061 | client: |
| 1062 | key: (certificate content) |
| 1063 | cert: (certificate content) |
| 1064 | |
Vasyl Saienko | 11ac973 | 2018-10-02 17:04:33 +0000 | [diff] [blame] | 1065 | Controlling access by `tls_allowed_dn_list`. |
| 1066 | Enable an access control list of client certificate Distinguished Names (DNs) |
| 1067 | which can connect to the TLS port on this server. The default is that DNs are |
| 1068 | not checked. This list may contain wildcards such as |
| 1069 | "C=GB,ST=London,L=London,O=Libvirt Project,CN=*" See the POSIX fnmatch function |
| 1070 | for the format of the wildcards. |
| 1071 | Note that if this is an empty list, no client can connect. |
| 1072 | Note also that GnuTLS returns DNs without spaces after commas between |
| 1073 | the fields (and this is what we check against), but the openssl x509 tool |
| 1074 | shows spaces. |
| 1075 | |
| 1076 | .. code-block:: yaml |
| 1077 | |
| 1078 | nova: |
| 1079 | compute: |
| 1080 | libvirt: |
| 1081 | tls: |
| 1082 | tls_allowed_dn_list: |
| 1083 | host1: |
| 1084 | enabled: true |
| 1085 | value: 'C=foo,CN=cmp1' |
| 1086 | host2: |
| 1087 | enabled: true |
| 1088 | value: 'C=foo,CN=cmp2' |
| 1089 | |
| 1090 | |
Oleksandr Shyshko | 1c020d1 | 2018-05-24 12:47:08 +0300 | [diff] [blame] | 1091 | You can read more about live migration over TLS here: |
OlgaGusarenko | 9dd01c9 | 2018-07-31 00:49:30 +0300 | [diff] [blame] | 1092 | https://wiki.libvirt.org/page/TLSCreateServerCerts |
Oleksandr Shyshko | 981b4fa | 2018-05-02 15:39:30 +0300 | [diff] [blame] | 1093 | |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1094 | Enable transport + authentication for VNC over TLS |
| 1095 | --------------------- |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1096 | # Only for Queens. Communication between noVNC proxy service and QEMU |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1097 | |
| 1098 | By default communication between nova-novncproxy and qemu service is unsecure. |
| 1099 | |
| 1100 | compute: |
| 1101 | qemu: |
| 1102 | vnc: |
| 1103 | tls: |
| 1104 | enabled: True |
| 1105 | |
| 1106 | controller: |
| 1107 | novncproxy: |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1108 | # This section responsible for communication between noVNC proxy and client machine |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1109 | tls: |
| 1110 | enabled: True |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1111 | # This section responsible for communication between nova-novncproxy and qemu service |
| 1112 | vencrypt: |
| 1113 | tls: |
| 1114 | enabled: True |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1115 | |
| 1116 | You able to set custom certificates in pillar: |
| 1117 | |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1118 | nova: |
| 1119 | compute: |
| 1120 | qemu: |
| 1121 | vnc: |
| 1122 | tls: |
| 1123 | cacert (certificate content) |
| 1124 | cert (certificate content) |
| 1125 | key (certificate content) |
| 1126 | |
| 1127 | nova: |
| 1128 | controller: |
| 1129 | novncproxy: |
| 1130 | tls: |
| 1131 | server: |
| 1132 | cert (certificate content) |
| 1133 | key (certificate content) |
| 1134 | vencrypt: |
| 1135 | tls: |
| 1136 | cacert (certificate content) |
| 1137 | cert (certificate content) |
| 1138 | key (certificate content) |
| 1139 | |
| 1140 | |
| 1141 | You can read more about it here: |
| 1142 | https://docs.openstack.org/nova/queens/admin/remote-console-access.html |
| 1143 | |
| 1144 | Enable communication between noVNC proxy and client machine over TLS |
| 1145 | --------------------- |
| 1146 | |
| 1147 | By default communication between noVNC proxy and client machine is unsecure. |
| 1148 | |
| 1149 | controller: |
| 1150 | novncproxy: |
| 1151 | tls: |
| 1152 | enabled: True |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1153 | |
| 1154 | nova: |
| 1155 | controller: |
| 1156 | novncproxy: |
| 1157 | tls: |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1158 | server: |
| 1159 | cert (certificate content) |
| 1160 | key (certificate content) |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1161 | |
| 1162 | You can read more about it here: |
Oleksandr Shyshko | d8337cf | 2018-07-11 17:55:58 +0300 | [diff] [blame] | 1163 | https://docs.openstack.org/mitaka/config-reference/dashboard/configure.html |
Oleksandr Shyshko | 1195fca | 2018-07-09 18:22:59 +0300 | [diff] [blame] | 1164 | |
Oleksandr Shyshko | 55eeac7 | 2018-08-03 18:23:28 +0300 | [diff] [blame] | 1165 | Enable x509 and ssl communication between Nova and Galera cluster. |
| 1166 | --------------------- |
| 1167 | By default communication between Nova and Galera is unsecure. |
| 1168 | |
Oleksandr Shyshko | cbe8735 | 2018-09-07 13:42:57 +0300 | [diff] [blame] | 1169 | nova: |
| 1170 | controller: |
| 1171 | database: |
| 1172 | x509: |
| 1173 | enabled: True |
| 1174 | |
Oleksandr Shyshko | 55eeac7 | 2018-08-03 18:23:28 +0300 | [diff] [blame] | 1175 | You able to set custom certificates in pillar: |
Oleksandr Shyshko | 55eeac7 | 2018-08-03 18:23:28 +0300 | [diff] [blame] | 1176 | |
| 1177 | nova: |
| 1178 | controller: |
| 1179 | database: |
| 1180 | x509: |
Oleksandr Shyshko | cbe8735 | 2018-09-07 13:42:57 +0300 | [diff] [blame] | 1181 | cacert: (certificate content) |
| 1182 | cert: (certificate content) |
| 1183 | key: (certificate content) |
Oleksandr Shyshko | 55eeac7 | 2018-08-03 18:23:28 +0300 | [diff] [blame] | 1184 | |
| 1185 | You can read more about it here: |
| 1186 | https://docs.openstack.org/security-guide/databases/database-access-control.html |
| 1187 | |
obryndzii | f795791 | 2019-01-31 00:55:56 +0000 | [diff] [blame] | 1188 | Nova database connection setup: |
| 1189 | ======== |
| 1190 | |
| 1191 | .. code-block:: yaml |
| 1192 | |
| 1193 | nova: |
| 1194 | controller: |
| 1195 | enabled: True |
| 1196 | ... |
| 1197 | database: |
| 1198 | idle_timeout: 180 |
| 1199 | min_pool_size: 100 |
| 1200 | max_pool_size: 700 |
| 1201 | max_overflow: 100 |
| 1202 | retry_interval: 5 |
| 1203 | max_retries: '-1' |
| 1204 | db_max_retries: 3 |
| 1205 | db_retry_interval: 1 |
| 1206 | connection_debug: 10 |
| 1207 | pool_timeout: 120 |
| 1208 | |
Oleksandr Bryndzii | 6d821f5 | 2019-02-20 15:51:15 +0200 | [diff] [blame^] | 1209 | |
| 1210 | Configure nova to use service user tokens: |
| 1211 | ======== |
| 1212 | Long-running operations such as live migration or snapshot can sometimes overrun the |
| 1213 | expiry of the user token. In such cases, post operations such as cleaning up after a |
| 1214 | live migration can fail when the nova-compute service needs to cleanup resources in |
| 1215 | other services, such as in the block-storage (cinder) or networking (neutron) services. |
| 1216 | |
| 1217 | This patch enables nova to use service user tokens to supplement the regular user token |
| 1218 | used to initiate the operation. The identity service (keystone) will then authenticate |
| 1219 | a request using the service user token if the user token has already expired. |
| 1220 | |
| 1221 | .. code-block:: yaml |
| 1222 | |
| 1223 | nova: |
| 1224 | controller: |
| 1225 | enabled: True |
| 1226 | ... |
| 1227 | service_user: |
| 1228 | enabled: True |
| 1229 | user_domain_id: default |
| 1230 | project_domain_id: default |
| 1231 | project_name: service |
| 1232 | username: nova |
| 1233 | password: pswd |
| 1234 | |
| 1235 | |
| 1236 | |
Oleh Hryhorov | 63ee845 | 2018-08-14 09:16:02 +0000 | [diff] [blame] | 1237 | Upgrades |
| 1238 | ======== |
| 1239 | |
| 1240 | Each openstack formula provide set of phases (logical bloks) that will help to |
| 1241 | build flexible upgrade orchestration logic for particular components. The list |
| 1242 | of phases might and theirs descriptions are listed in table below: |
| 1243 | |
| 1244 | +-------------------------------+------------------------------------------------------+ |
| 1245 | | State | Description | |
| 1246 | +===============================+======================================================+ |
| 1247 | | <app>.upgrade.service_running | Ensure that all services for particular application | |
| 1248 | | | are enabled for autostart and running | |
| 1249 | +-------------------------------+------------------------------------------------------+ |
| 1250 | | <app>.upgrade.service_stopped | Ensure that all services for particular application | |
| 1251 | | | disabled for autostart and dead | |
| 1252 | +-------------------------------+------------------------------------------------------+ |
| 1253 | | <app>.upgrade.pkgs_latest | Ensure that packages used by particular application | |
| 1254 | | | are installed to latest available version. | |
| 1255 | | | This will not upgrade data plane packages like qemu | |
| 1256 | | | and openvswitch as usually minimal required version | |
| 1257 | | | in openstack services is really old. The data plane | |
| 1258 | | | packages should be upgraded separately by `apt-get | |
| 1259 | | | upgrade` or `apt-get dist-upgrade` | |
| 1260 | | | Applying this state will not autostart service. | |
| 1261 | +-------------------------------+------------------------------------------------------+ |
| 1262 | | <app>.upgrade.render_config | Ensure configuration is rendered actual version. + |
| 1263 | +-------------------------------+------------------------------------------------------+ |
| 1264 | | <app>.upgrade.pre | We assume this state is applied on all nodes in the | |
| 1265 | | | cloud before running upgrade. | |
| 1266 | | | Only non destructive actions will be applied during | |
| 1267 | | | this phase. Perform service built in service check | |
| 1268 | | | like (keystone-manage doctor and nova-status upgrade)| |
| 1269 | +-------------------------------+------------------------------------------------------+ |
| 1270 | | <app>.upgrade.upgrade.pre | Mostly applicable for data plane nodes. During this | |
| 1271 | | | phase resources will be gracefully removed from | |
| 1272 | | | current node if it is allowed. Services for upgraded | |
| 1273 | | | application will be set to admin disabled state to | |
| 1274 | | | make sure node will not participate in resources | |
| 1275 | | | scheduling. For example on gtw nodes this will set | |
| 1276 | | | all agents to admin disable state and will move all | |
| 1277 | | | routers to other agents. | |
| 1278 | +-------------------------------+------------------------------------------------------+ |
| 1279 | | <app>.upgrade.upgrade | This state will basically upgrade application on | |
| 1280 | | | particular target. Stop services, render | |
| 1281 | | | configuration, install new packages, run offline | |
| 1282 | | | dbsync (for ctl), start services. Data plane should | |
| 1283 | | | not be affected, only OpenStack python services. | |
| 1284 | +-------------------------------+------------------------------------------------------+ |
| 1285 | | <app>.upgrade.upgrade.post | Add services back to scheduling. | |
| 1286 | +-------------------------------+------------------------------------------------------+ |
| 1287 | | <app>.upgrade.post | This phase should be launched only when upgrade of | |
| 1288 | | | the cloud is completed. Cleanup temporary files, | |
| 1289 | | | perform other post upgrade tasks. | |
| 1290 | +-------------------------------+------------------------------------------------------+ |
| 1291 | | <app>.upgrade.verify | Here we will do basic health checks (API CRUD | |
| 1292 | | | operations, verify do not have dead network | |
| 1293 | | | agents/compute services) | |
| 1294 | +-------------------------------+------------------------------------------------------+ |