Puppet Class: nova::compute

Defined in:
manifests/compute.pp

Overview

Class: nova::compute

Installs the nova-compute service

Parameters:

enabled

(optional) Whether to enable the nova-compute service Defaults to true

heal_instance_info_cache_interval

(optional) Controls how often the instance info should be updated. Defaults to $facts To disable you can set the value to zero.

manage_service

(optional) Whether to start/stop the service Defaults to true

ensure_package

(optional) The state for the nova-compute package Defaults to ‘present’

vnc_enabled

(optional) Whether to use a VNC proxy Defaults to true

spice_enabled

(optional) Whether to use a SPICE html5 proxy Mutually exclusive with vnc_enabled. Defaults to false.

vncserver_proxyclient_address

(optional) The IP address of the server running the VNC proxy client Defaults to ‘127.0.0.1’

vncproxy_host

(optional) The host of the VNC proxy server Defaults to undef

vncproxy_protocol

(optional) The protocol to communicate with the VNC proxy server Defaults to ‘http’

vncproxy_port

(optional) The port to communicate with the VNC proxy server Defaults to 6080

vncproxy_path

(optional) The path at the end of the uri for communication with the VNC proxy server Defaults to ‘/vnc_auto.html’

force_config_drive

(optional) Whether to force the config drive to be attached to all VMs Defaults to $facts

instance_usage_audit

(optional) Generate periodic compute.instance.exists notifications. Defaults to $facts

instance_usage_audit_period

(optional) Time period to generate instance usages for. Time period must be hour, day, month or year with/without offset. Defaults to $facts

flat_injected

(optional) This option determines whether the network setup information is injected into the VM before it is booted. Defaults to $facts

mkisofs_cmd

(optional) Name or path of the tool used for ISO image creation. Defaults to $facts

use_cow_images

(optional) Enable use of copy-on-write (cow) images. Defaults to $facts

force_raw_images

(optional) Force backing images to raw format. Defaults to $facts

virt_mkfs

(optional) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> Defaults to $facts

reserved_host_cpus

(optional) Number of host CPUs reserved for the host. Defaults to $facts

reserved_host_memory

(optional) The amount of memory in MB reserved for the host. Defaults to $facts

reserved_host_disk

(optional) The amount of disk in MB reserved for the host. Defaults to $facts

update_resources_interval

(optional) Interval for updating compute resources. This option specifies how often the update_available_resources periodic task should run. A number less than 0 means to disable the task completely Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds. Defaults to $facts

reboot_timeout

(optional) Time interval after which an instance is hard rebooted automatically. Setting this option to a time period in seconds will automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Defaults to $facts

instance_build_timeout

(optional) Maximum time in seconds that an instance can take to build. If this timer expires, instance status will be changed to ERROR. Enabling this option will make sure an instance will not be stuck in BUILD state for a longer period. Defaults to $facts

rescue_timeout

(optional) Interval to wait before un-rescuing an instance stuck in RESCUE. Defaults to $facts

resize_confirm_window

(optional) Automatically confirm resizes after N seconds. Resize functionality will save the existing server before resizing. After the resize completes, user is requested to confirm the resize. The user has the opportunity to either confirm or revert all changes. Confirm resize removes the original server and changes server status from resized to active. Setting this option to a time period (in seconds) will automatically confirm the resize if the server is in resized state longer than that time. Defaults to $facts

shutdown_timeout

(optional) Total time to wait in seconds for an instance to perform a clean shutdown. It determines the overall period (in seconds) a VM is allowed to perform a clean shutdown. While performing stop, rescue and shelve, rebuild operations, configuring this option gives the VM a chance to perform a controlled shutdown before the instance is powered off. Defaults to $facts

cpu_shared_set

(optional) Mask of host CPUs that can be used for “VCPU“ resources and offloaded emulator threads. Defaults to $facts

cpu_dedicated_set

(optional) A list or range of host CPU cores to which processes for pinned instance CPUs (PCPUs) can be scheduled. Defaults to $facts

resume_guests_state_on_host_boot

(optional) This option specifies whether to start guests that were running before the host rebooted. It ensures that all of the instances on a Nova compute node resume their state each time the compute node boots or restarts. Defaults to $facts

max_concurrent_builds

(optional) Maximum number of instance builds to run concurrently Defaults to $facts

max_concurrent_live_migrations

(optional) Maximum number of live migrations to run in parallel. Defaults to $facts

sync_power_state_pool_size

(optional) Maximum number of greenthreads to use when syncing power states. Defaults to $facts

sync_power_state_interval

(optional) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate. Defaults to $facts

consecutive_build_service_disable_threshold

(optional) Max number of consecutive build failures before the nova-compute will disable itself. Defaults to $facts

reserved_huge_pages

(optional) Number of huge memory pages to reserved per NUMA host cell. Defaults to $facts Accepts a string e.g “node:0,size:1GB,count:4” or a list of strings e.g:

“node:0,size:1GB,count:4”, “node:1,size:1GB,count:4”
neutron_physnets_numa_nodes_mapping

(optional) Map of physnet name as key and list of NUMA nodes as value. Defaults to {}

neutron_tunnel_numa_nodes

(optional) List of NUMA nodes to configure NUMA affinity for all tunneled networks. Defaults to []

live_migration_wait_for_vif_plug

(optional) whether to wait for “network-vif-plugged“ events before starting guest transfer Defaults to $facts

max_disk_devices_to_attach

(optional) specifies max number of devices that can be attached to a single server. Note that the number of disks supported by an server depends on the bus used. For example, the ide disk bus is limited to 4 attached devices. The configured maximum is enforced during server create, rebuild, evacuate, unshelve, live migrate, and attach volume. Defaults to $facts

default_access_ip_network_name

(optional) Name of the network to be used to set access IPs for instances. If there are multiple IPs to choose from, an arbitrary one will be chosen. Defaults to $facts

running_deleted_instance_action

(optional) The compute service periodically checks for instances that have been deleted in the database but remain running on the compute node. This option enables action to be taken when such instances are identified Defaults to $facts

running_deleted_instance_poll_interval

(optional) Time interval in seconds to wait between runs for the clean up action. If set to 0, deleted instances check will be disabled. Defaults to $facts

running_deleted_instance_timeout

(optional) Time interval in seconds to wait for the instances that have been marked as deleted in database to be eligible for cleanup. Defaults to $facts

compute_monitors

(optional) A comma-separated list of monitors that can be used for getting compute metrics. Only one monitor per namespace (For example: cpu) can be loaded at a time. Defaults to $facts

default_ephemeral_format

(optional) The default format an ephemeral_volume will be formatted with on creation. Defaults to $facts

image_type_exclude_list

(optional) List of image formats that should not be advertised as supported by the compute service.

block_device_allocate_retries

(optional) Number of times to retry block device allocation on failures Defaults to $facts

block_device_allocate_retries_interval

(optional) Waiting time interval (seconds) between block device allocation retries on failures Defaults to $facts

DEPRECATED PARAMETERS

config_drive_format

(optional) Config drive format. One of iso9660 (default) or vfat Defaults to undef

Parameters:

  • enabled (Boolean) (defaults to: true)
  • manage_service (Boolean) (defaults to: true)
  • ensure_package (Any) (defaults to: 'present')
  • vnc_enabled (Boolean) (defaults to: true)
  • spice_enabled (Boolean) (defaults to: false)
  • vncserver_proxyclient_address (Any) (defaults to: $facts['os_service_default'])
  • vncproxy_host (Optional[String[1]]) (defaults to: undef)
  • vncproxy_protocol (Enum['http', 'https']) (defaults to: 'http')
  • vncproxy_port (Stdlib::Port) (defaults to: 6080)
  • vncproxy_path (String) (defaults to: '/vnc_auto.html')
  • force_config_drive (Any) (defaults to: $facts['os_service_default'])
  • instance_usage_audit (Any) (defaults to: $facts['os_service_default'])
  • instance_usage_audit_period (Any) (defaults to: $facts['os_service_default'])
  • flat_injected (Any) (defaults to: $facts['os_service_default'])
  • mkisofs_cmd (Any) (defaults to: $facts['os_service_default'])
  • use_cow_images (Any) (defaults to: $facts['os_service_default'])
  • force_raw_images (Any) (defaults to: $facts['os_service_default'])
  • virt_mkfs (Any) (defaults to: $facts['os_service_default'])
  • reserved_host_cpus (Any) (defaults to: $facts['os_service_default'])
  • reserved_host_memory (Any) (defaults to: $facts['os_service_default'])
  • reserved_host_disk (Any) (defaults to: $facts['os_service_default'])
  • heal_instance_info_cache_interval (Any) (defaults to: $facts['os_service_default'])
  • update_resources_interval (Any) (defaults to: $facts['os_service_default'])
  • reboot_timeout (Any) (defaults to: $facts['os_service_default'])
  • instance_build_timeout (Any) (defaults to: $facts['os_service_default'])
  • rescue_timeout (Any) (defaults to: $facts['os_service_default'])
  • resize_confirm_window (Any) (defaults to: $facts['os_service_default'])
  • shutdown_timeout (Any) (defaults to: $facts['os_service_default'])
  • cpu_shared_set (Any) (defaults to: $facts['os_service_default'])
  • cpu_dedicated_set (Any) (defaults to: $facts['os_service_default'])
  • resume_guests_state_on_host_boot (Any) (defaults to: $facts['os_service_default'])
  • max_concurrent_builds (Any) (defaults to: $facts['os_service_default'])
  • max_concurrent_live_migrations (Any) (defaults to: $facts['os_service_default'])
  • sync_power_state_pool_size (Any) (defaults to: $facts['os_service_default'])
  • sync_power_state_interval (Any) (defaults to: $facts['os_service_default'])
  • consecutive_build_service_disable_threshold (Any) (defaults to: $facts['os_service_default'])
  • reserved_huge_pages (Any) (defaults to: $facts['os_service_default'])
  • neutron_physnets_numa_nodes_mapping (Hash) (defaults to: {})
  • neutron_tunnel_numa_nodes (Any) (defaults to: [])
  • live_migration_wait_for_vif_plug (Any) (defaults to: $facts['os_service_default'])
  • max_disk_devices_to_attach (Any) (defaults to: $facts['os_service_default'])
  • default_access_ip_network_name (Any) (defaults to: $facts['os_service_default'])
  • running_deleted_instance_action (Any) (defaults to: $facts['os_service_default'])
  • running_deleted_instance_poll_interval (Any) (defaults to: $facts['os_service_default'])
  • running_deleted_instance_timeout (Any) (defaults to: $facts['os_service_default'])
  • compute_monitors (Any) (defaults to: $facts['os_service_default'])
  • default_ephemeral_format (Any) (defaults to: $facts['os_service_default'])
  • image_type_exclude_list (Any) (defaults to: $facts['os_service_default'])
  • block_device_allocate_retries (Any) (defaults to: $facts['os_service_default'])
  • block_device_allocate_retries_interval (Any) (defaults to: $facts['os_service_default'])
  • config_drive_format (Any) (defaults to: undef)


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'manifests/compute.pp', line 265

class nova::compute (
  Boolean $enabled                             = true,
  Boolean $manage_service                      = true,
  $ensure_package                              = 'present',
  Boolean $vnc_enabled                         = true,
  Boolean $spice_enabled                       = false,
  $vncserver_proxyclient_address               = $facts['os_service_default'],
  Optional[String[1]] $vncproxy_host           = undef,
  Enum['http', 'https'] $vncproxy_protocol     = 'http',
  Stdlib::Port $vncproxy_port                  = 6080,
  String $vncproxy_path                        = '/vnc_auto.html',
  $force_config_drive                          = $facts['os_service_default'],
  $instance_usage_audit                        = $facts['os_service_default'],
  $instance_usage_audit_period                 = $facts['os_service_default'],
  $flat_injected                               = $facts['os_service_default'],
  $mkisofs_cmd                                 = $facts['os_service_default'],
  $use_cow_images                              = $facts['os_service_default'],
  $force_raw_images                            = $facts['os_service_default'],
  $virt_mkfs                                   = $facts['os_service_default'],
  $reserved_host_cpus                          = $facts['os_service_default'],
  $reserved_host_memory                        = $facts['os_service_default'],
  $reserved_host_disk                          = $facts['os_service_default'],
  $heal_instance_info_cache_interval           = $facts['os_service_default'],
  $update_resources_interval                   = $facts['os_service_default'],
  $reboot_timeout                              = $facts['os_service_default'],
  $instance_build_timeout                      = $facts['os_service_default'],
  $rescue_timeout                              = $facts['os_service_default'],
  $resize_confirm_window                       = $facts['os_service_default'],
  $shutdown_timeout                            = $facts['os_service_default'],
  $cpu_shared_set                              = $facts['os_service_default'],
  $cpu_dedicated_set                           = $facts['os_service_default'],
  $resume_guests_state_on_host_boot            = $facts['os_service_default'],
  $max_concurrent_builds                       = $facts['os_service_default'],
  $max_concurrent_live_migrations              = $facts['os_service_default'],
  $sync_power_state_pool_size                  = $facts['os_service_default'],
  $sync_power_state_interval                   = $facts['os_service_default'],
  $consecutive_build_service_disable_threshold = $facts['os_service_default'],
  $reserved_huge_pages                         = $facts['os_service_default'],
  Hash $neutron_physnets_numa_nodes_mapping    = {},
  $neutron_tunnel_numa_nodes                   = [],
  $live_migration_wait_for_vif_plug            = $facts['os_service_default'],
  $max_disk_devices_to_attach                  = $facts['os_service_default'],
  $default_access_ip_network_name              = $facts['os_service_default'],
  $running_deleted_instance_action             = $facts['os_service_default'],
  $running_deleted_instance_poll_interval      = $facts['os_service_default'],
  $running_deleted_instance_timeout            = $facts['os_service_default'],
  $compute_monitors                            = $facts['os_service_default'],
  $default_ephemeral_format                    = $facts['os_service_default'],
  $image_type_exclude_list                     = $facts['os_service_default'],
  $block_device_allocate_retries               = $facts['os_service_default'],
  $block_device_allocate_retries_interval      = $facts['os_service_default'],
  # DEPRECATED PARAMETERS
  $config_drive_format                         = undef,
) {

  include nova::deps
  include nova::params

  if $config_drive_format != undef {
    warning('The config_drive_format parameter is deprecated.')
  }

  $image_type_exclude_list_real = pick(join(any2array($image_type_exclude_list), ','), $facts['os_service_default'])

  include nova::policy

  include nova::pci
  include nova::compute::pci
  include nova::compute::mdev

  if ($vnc_enabled and $spice_enabled) {
    fail('vnc_enabled and spice_enabled is mutually exclusive')
  }

  nova_config {
    'compute/cpu_shared_set':    value => join(any2array($cpu_shared_set), ',');
    'compute/cpu_dedicated_set': value => join(any2array($cpu_dedicated_set), ',');
  }

  if !empty($neutron_physnets_numa_nodes_mapping) {
    $neutron_physnets_real = keys($neutron_physnets_numa_nodes_mapping)
    nova_config {
      'neutron/physnets': value => join(any2array($neutron_physnets_real), ',');
    }

    $neutron_physnets_numa_nodes_mapping.each |$physnet, $numa_nodes| {
      nova_config {
        "neutron_physnet_${physnet}/numa_nodes": value => join(any2array($numa_nodes), ',');
      }
    }
  } else {
    nova_config {
      'neutron/physnets': ensure => absent;
    }
  }

  if !empty($neutron_tunnel_numa_nodes) {
    nova_config {
      'neutron_tunnel/numa_nodes': value => join(any2array($neutron_tunnel_numa_nodes), ',');
    }
  } else {
    nova_config {
      'neutron_tunnel/numa_nodes': ensure => absent;
    }
  }

  $reserved_huge_pages_real = $reserved_huge_pages ? {
    String  => $reserved_huge_pages,
    Array   => $reserved_huge_pages,
    default => fail("Invalid reserved_huge_pages parameter value: ${reserved_huge_pages}")
  }

  include nova::availability_zone

  nova_config {
    'DEFAULT/use_cow_images':                    value => $use_cow_images;
    'DEFAULT/mkisofs_cmd':                       value => $mkisofs_cmd;
    'DEFAULT/force_raw_images':                  value => $force_raw_images;
    'DEFAULT/virt_mkfs':                         value => $virt_mkfs;
    'DEFAULT/reserved_host_cpus':                value => $reserved_host_cpus;
    'DEFAULT/reserved_host_memory_mb':           value => $reserved_host_memory;
    'DEFAULT/reserved_host_disk_mb':             value => $reserved_host_disk;
    'DEFAULT/reserved_huge_pages':               value => $reserved_huge_pages_real;
    'DEFAULT/heal_instance_info_cache_interval': value => $heal_instance_info_cache_interval;
    'DEFAULT/update_resources_interval':         value => $update_resources_interval;
    'DEFAULT/reboot_timeout':                    value => $reboot_timeout;
    'DEFAULT/instance_build_timeout':            value => $instance_build_timeout;
    'DEFAULT/rescue_timeout':                    value => $rescue_timeout;
    'DEFAULT/resize_confirm_window':             value => $resize_confirm_window;
    'DEFAULT/shutdown_timeout':                  value => $shutdown_timeout;
    'DEFAULT/resume_guests_state_on_host_boot':  value => $resume_guests_state_on_host_boot;
    'DEFAULT/max_concurrent_builds':             value => $max_concurrent_builds;
    'DEFAULT/max_concurrent_live_migrations':    value => $max_concurrent_live_migrations;
    'DEFAULT/sync_power_state_pool_size':        value => $sync_power_state_pool_size;
    'DEFAULT/sync_power_state_interval':         value => $sync_power_state_interval;
    'compute/consecutive_build_service_disable_threshold':
      value => $consecutive_build_service_disable_threshold;
    'compute/live_migration_wait_for_vif_plug':  value => $live_migration_wait_for_vif_plug;
    'compute/max_disk_devices_to_attach':        value => $max_disk_devices_to_attach;
    'DEFAULT/default_access_ip_network_name':    value => $default_access_ip_network_name;
    'DEFAULT/running_deleted_instance_action':   value => $running_deleted_instance_action;
    'DEFAULT/running_deleted_instance_poll_interval':
      value => $running_deleted_instance_poll_interval;
    'DEFAULT/running_deleted_instance_timeout':  value => $running_deleted_instance_timeout;
    'DEFAULT/compute_monitors':                  value => join(any2array($compute_monitors), ',');
    'DEFAULT/default_ephemeral_format':          value => $default_ephemeral_format;
    'compute/image_type_exclude_list':           value => $image_type_exclude_list_real;
    'DEFAULT/block_device_allocate_retries':     value => $block_device_allocate_retries;
    'DEFAULT/block_device_allocate_retries_interval':
      value => $block_device_allocate_retries_interval;
  }

  if ($vnc_enabled) {
    include nova::vncproxy::common

    nova_config {
      'vnc/server_proxyclient_address': value => $vncserver_proxyclient_address;
    }
  } else {
    nova_config {
      'vnc/server_proxyclient_address': ensure => absent;
    }
  }

  nova_config {
    'vnc/enabled':   value => $vnc_enabled;
    'spice/enabled': value => $spice_enabled;
  }

  nova::generic_service { 'compute':
    enabled        => $enabled,
    manage_service => $manage_service,
    package_name   => $::nova::params::compute_package_name,
    service_name   => $::nova::params::compute_service_name,
    ensure_package => $ensure_package,
  }

  nova_config {
    'DEFAULT/force_config_drive':          value => $force_config_drive;
    'DEFAULT/instance_usage_audit':        value => $instance_usage_audit;
    'DEFAULT/instance_usage_audit_period': value => $instance_usage_audit_period;
    'DEFAULT/flat_injected':               value => $flat_injected;
    'DEFAULT/config_drive_format':         value => pick($config_drive_format, $facts['os_service_default']);
  }
}