blob: b13d4a862739a64b18bae8c048259f8c22293860 [file] [log] [blame]
Jakub Pavlik02a01c72017-04-11 16:04:51 +02001{%- from "nova/map.jinja" import compute with context %}
2[DEFAULT]
3
4#
5# From nova.conf
6#
7compute_manager=nova.compute.manager.ComputeManager
8network_device_mtu=65000
9use_neutron = True
10security_group_api=neutron
11image_service=nova.image.glance.GlanceImageService
12
13# DEPRECATED:
14# When returning instance metadata, this is the class that is used
15# for getting vendor metadata when that class isn't specified in the individual
16# request. The value should be the full dot-separated path to the class to use.
17#
18# Possible values:
19#
20# * Any valid dot-separated class path that can be imported.
21# (string value)
22# This option is deprecated for removal since 13.0.0.
23# Its value may be silently ignored in the future.
24#vendordata_driver=nova.api.metadata.vendordata_json.JsonFileVendorData
25
26# DEPRECATED:
27# This option is used to enable or disable quota checking for tenant networks.
28#
29# Related options:
30#
31# * quota_networks
32# (boolean value)
33# This option is deprecated for removal since 14.0.0.
34# Its value may be silently ignored in the future.
35# Reason:
36# CRUD operations on tenant networks are only available when using nova-network
37# and nova-network is itself deprecated.
38#enable_network_quota=false
39
40# DEPRECATED:
41# This option controls the number of private networks that can be created per
42# project (or per tenant).
43#
44# Related options:
45#
46# * enable_network_quota
47# (integer value)
48# Minimum value: 0
49# This option is deprecated for removal since 14.0.0.
50# Its value may be silently ignored in the future.
51# Reason:
52# CRUD operations on tenant networks are only available when using nova-network
53# and nova-network is itself deprecated.
54#quota_networks=3
55
56#
57# This option specifies the name of the availability zone for the
58# internal services. Services like nova-scheduler, nova-network,
59# nova-conductor are internal services. These services will appear in
60# their own internal availability_zone.
61#
62# Possible values:
63#
64# * Any string representing an availability zone name
65# * 'internal' is the default value
66#
67# (string value)
68#internal_service_availability_zone=internal
69
70#
71# Default compute node availability_zone.
72#
73# This option determines the availability zone to be used when it is not
74# specified in the VM creation request. If this option is not set,
75# the default availability zone 'nova' is used.
76#
77# Possible values:
78#
79# * Any string representing an availability zone name
80# * 'nova' is the default value
81#
82# (string value)
83#default_availability_zone=nova
84
85# Length of generated instance admin passwords. (integer value)
86# Minimum value: 0
87#password_length=12
88
89#
90# Time period to generate instance usages for. It is possible to define optional
91# offset to given period by appending @ character followed by a number defining
92# offset.
93#
94# Possible values:
95#
96# * period, example: ``hour``, ``day``, ``month` or ``year``
97# * period with offset, example: ``month@15`` will result in monthly audits
98# starting on 15th day of month.
99# (string value)
100#instance_usage_audit_period=month
101{% if pillar.ceilometer is defined %}
102instance_usage_audit = True
103instance_usage_audit_period = hour
104{%- endif %}
105#
106# Start and use a daemon that can run the commands that need to be run with
107# root privileges. This option is usually enabled on nodes that run nova compute
108# processes.
109# (boolean value)
110#use_rootwrap_daemon=false
111
112#
113# Path to the rootwrap configuration file.
114#
115# Goal of the root wrapper is to allow a service-specific unprivileged user to
116# run a number of actions as the root user in the safest manner possible.
117# The configuration file used here must match the one defined in the sudoers
118# entry.
119# (string value)
120#rootwrap_config=/etc/nova/rootwrap.conf
121rootwrap_config=/etc/nova/rootwrap.conf
122
123# Explicitly specify the temporary working directory. (string value)
124#tempdir=<None>
125
126#
127# Determine if monkey patching should be applied.
128#
129# Related options:
130#
131# * ``monkey_patch_modules``: This must have values set for this option to
132# have any effect
133# (boolean value)
134#monkey_patch=false
135
136#
137# List of modules/decorators to monkey patch.
138#
139# This option allows you to patch a decorator for all functions in specified
140# modules.
141#
142# Possible values:
143#
144# * nova.compute.api:nova.notifications.notify_decorator
145# * nova.api.ec2.cloud:nova.notifications.notify_decorator
146# * [...]
147#
148# Related options:
149#
150# * ``monkey_patch``: This must be set to ``True`` for this option to
151# have any effect
152# (list value)
153#monkey_patch_modules=nova.compute.api:nova.notifications.notify_decorator
154
155#
156# Defines which driver to use for controlling virtualization.
157#
158# Possible values:
159#
160# * ``libvirt.LibvirtDriver``
161# * ``xenapi.XenAPIDriver``
162# * ``fake.FakeDriver``
163# * ``ironic.IronicDriver``
164# * ``vmwareapi.VMwareVCDriver``
165# * ``hyperv.HyperVDriver``
166# (string value)
167#compute_driver=<None>
168compute_driver = libvirt.LibvirtDriver
169
170#
171# Allow destination machine to match source for resize. Useful when
172# testing in single-host environments. By default it is not allowed
173# to resize to the same host. Setting this option to true will add
174# the same host to the destination options.
175# (boolean value)
176#allow_resize_to_same_host=false
177allow_resize_to_same_host=true
178
179#
180# Availability zone to use when user doesn't specify one.
181#
182# This option is used by the scheduler to determine which availability
183# zone to place a new VM instance into if the user did not specify one
184# at the time of VM boot request.
185#
186# Possible values:
187#
188# * Any string representing an availability zone name
189# * Default value is None.
190# (string value)
191#default_schedule_zone=<None>
192
193#
194# Image properties that should not be inherited from the instance
195# when taking a snapshot.
196#
197# This option gives an opportunity to select which image-properties
198# should not be inherited by newly created snapshots.
199#
200# Possible values:
201#
202# * A list whose item is an image property. Usually only the image
203# properties that are only needed by base images can be included
204# here, since the snapshots that are created from the base images
205# doesn't need them.
206# * Default list: ['cache_in_nova', 'bittorrent']
207# (list value)
208#non_inheritable_image_properties=cache_in_nova,bittorrent
209
210# DEPRECATED:
211# This option is used to decide when an image should have no external
212# ramdisk or kernel. By default this is set to 'nokernel', so when an
213# image is booted with the property 'kernel_id' with the value
214# 'nokernel', Nova assumes the image doesn't require an external kernel
215# and ramdisk.
216# (string value)
217# This option is deprecated for removal since 15.0.0.
218# Its value may be silently ignored in the future.
219# Reason:
220# When an image is booted with the property 'kernel_id' with the value
221# 'nokernel', Nova assumes the image doesn't require an external kernel and
222# ramdisk. This option allows user to change the API behaviour which should not
223# be allowed and this value "nokernel" should be hard coded.
224#null_kernel=nokernel
225
226# DEPRECATED:
227# When creating multiple instances with a single request using the
228# os-multiple-create API extension, this template will be used to build
229# the display name for each instance. The benefit is that the instances
230# end up with different hostnames. Example display names when creating
231# two VM's: name-1, name-2.
232#
233# Possible values:
234#
235# * Valid keys for the template are: name, uuid, count.
236# (string value)
237# This option is deprecated for removal since 15.0.0.
238# Its value may be silently ignored in the future.
239# Reason:
240# This config changes API behaviour. All changes in API behaviour should be
241# discoverable.
242#multi_instance_display_name_template=%(name)s-%(count)d
243
244#
245# Maximum number of devices that will result in a local image being
246# created on the hypervisor node.
247#
248# A negative number means unlimited. Setting max_local_block_devices
249# to 0 means that any request that attempts to create a local disk
250# will fail. This option is meant to limit the number of local discs
251# (so root local disc that is the result of --image being used, and
252# any other ephemeral and swap disks). 0 does not mean that images
253# will be automatically converted to volumes and boot instances from
254# volumes - it just means that all requests that attempt to create a
255# local disk will fail.
256#
257# Possible values:
258#
259# * 0: Creating a local disk is not allowed.
260# * Negative number: Allows unlimited number of local discs.
261# * Positive number: Allows only these many number of local discs.
262# (Default value is 3).
263# (integer value)
264#max_local_block_devices=3
265
266#
267# A list of monitors that can be used for getting compute metrics.
268# You can use the alias/name from the setuptools entry points for
269# nova.compute.monitors.* namespaces. If no namespace is supplied,
270# the "cpu." namespace is assumed for backwards-compatibility.
271#
272# Possible values:
273#
274# * An empty list will disable the feature(Default).
275# * An example value that would enable both the CPU and NUMA memory
276# bandwidth monitors that used the virt driver variant:
277# ["cpu.virt_driver", "numa_mem_bw.virt_driver"]
278# (list value)
279#compute_monitors =
280
281#
282# The default format an ephemeral_volume will be formatted with on creation.
283#
284# Possible values:
285#
286# * ``ext2``
287# * ``ext3``
288# * ``ext4``
289# * ``xfs``
290# * ``ntfs`` (only for Windows guests)
291# (string value)
292#default_ephemeral_format=<None>
293
294#
295# Determine if instance should boot or fail on VIF plugging timeout.
296#
297# Nova sends a port update to Neutron after an instance has been scheduled,
298# providing Neutron with the necessary information to finish setup of the port.
299# Once completed, Neutron notifies Nova that it has finished setting up the
300# port, at which point Nova resumes the boot of the instance since network
301# connectivity is now supposed to be present. A timeout will occur if the reply
302# is not received after a given interval.
303#
304# This option determines what Nova does when the VIF plugging timeout event
305# happens. When enabled, the instance will error out. When disabled, the
306# instance will continue to boot on the assumption that the port is ready.
307#
308# Possible values:
309#
310# * True: Instances should fail after VIF plugging timeout
311# * False: Instances should continue booting after VIF plugging timeout
312# (boolean value)
313#vif_plugging_is_fatal=true
314vif_plugging_is_fatal=true
315
316#
317# Timeout for Neutron VIF plugging event message arrival.
318#
319# Number of seconds to wait for Neutron vif plugging events to
320# arrive before continuing or failing (see 'vif_plugging_is_fatal').
321#
322# Related options:
323#
324# * vif_plugging_is_fatal - If ``vif_plugging_timeout`` is set to zero and
325# ``vif_plugging_is_fatal`` is False, events should not be expected to
326# arrive at all.
327# (integer value)
328# Minimum value: 0
329#vif_plugging_timeout=300
330vif_plugging_timeout=300
331
332# Path to '/etc/network/interfaces' template.
333#
334# The path to a template file for the '/etc/network/interfaces'-style file,
335# which
336# will be populated by nova and subsequently used by cloudinit. This provides a
337# method to configure network connectivity in environments without a DHCP
338# server.
339#
340# The template will be rendered using Jinja2 template engine, and receive a
341# top-level key called ``interfaces``. This key will contain a list of
342# dictionaries, one for each interface.
343#
344# Refer to the cloudinit documentaion for more information:
345#
346# https://cloudinit.readthedocs.io/en/latest/topics/datasources.html
347#
348# Possible values:
349#
350# * A path to a Jinja2-formatted template for a Debian '/etc/network/interfaces'
351# file. This applies even if using a non Debian-derived guest.
352#
353# Related options:
354#
355# * ``flat_inject``: This must be set to ``True`` to ensure nova embeds network
356# configuration information in the metadata provided through the config drive.
357# (string value)
358#injected_network_template=$pybasedir/nova/virt/interfaces.template
359
360#
361# The image preallocation mode to use.
362#
363# Image preallocation allows storage for instance images to be allocated up
364# front
365# when the instance is initially provisioned. This ensures immediate feedback is
366# given if enough space isn't available. In addition, it should significantly
367# improve performance on writes to new blocks and may even improve I/O
368# performance to prewritten blocks due to reduced fragmentation.
369#
370# Possible values:
371#
372# * "none" => no storage provisioning is done up front
373# * "space" => storage is fully allocated at instance start
374# (string value)
375# Allowed values: none, space
376#preallocate_images=none
377
378#
379# Enable use of copy-on-write (cow) images.
380#
381# QEMU/KVM allow the use of qcow2 as backing files. By disabling this,
382# backing files will not be used.
383# (boolean value)
384#use_cow_images=true
385{%- if compute.image.use_cow is defined %}
386use_cow_images = {{ compute.image.use_cow }}
387{%- endif %}
388
389#
390# Force conversion of backing images to raw format.
391#
392# Possible values:
393#
394# * True: Backing image files will be converted to raw image format
395# * False: Backing image files will not be converted
396#
397# Related options:
398#
399# * ``compute_driver``: Only the libvirt driver uses this option.
400# (boolean value)
401#force_raw_images=true
402force_raw_images=true
403
404#
405# Name of the mkfs commands for ephemeral device.
406#
407# The format is <os_type>=<mkfs command>
408# (multi valued)
409#virt_mkfs =
410
411#
412# Enable resizing of filesystems via a block device.
413#
414# If enabled, attempt to resize the filesystem by accessing the image over a
415# block device. This is done by the host and may not be necessary if the image
416# contains a recent version of cloud-init. Possible mechanisms require the nbd
417# driver (for qcow and raw), or loop (for raw).
418# (boolean value)
419#resize_fs_using_block_device=false
420
421# Amount of time, in seconds, to wait for NBD device start up. (integer value)
422# Minimum value: 0
423#timeout_nbd=10
424
425#
426# Location of cached images.
427#
428# This is NOT the full path - just a folder name relative to '$instances_path'.
429# For per-compute-host cached images, set to '_base_$my_ip'
430# (string value)
431#image_cache_subdirectory_name=_base
432
433# Should unused base images be removed? (boolean value)
434#remove_unused_base_images=true
435
436#
437# Unused unresized base images younger than this will not be removed.
438# (integer value)
439#remove_unused_original_minimum_age_seconds=86400
440remove_unused_original_minimum_age_seconds=86400
441
442#
443# Generic property to specify the pointer type.
444#
445# Input devices allow interaction with a graphical framebuffer. For
446# example to provide a graphic tablet for absolute cursor movement.
447#
448# If set, the 'hw_pointer_model' image property takes precedence over
449# this configuration option.
450#
451# Possible values:
452#
453# * None: Uses default behavior provided by drivers (mouse on PS2 for
454# libvirt x86)
455# * ps2mouse: Uses relative movement. Mouse connected by PS2
456# * usbtablet: Uses absolute movement. Tablet connect by USB
457#
458# Related options:
459#
460# * usbtablet must be configured with VNC enabled or SPICE enabled and SPICE
461# agent disabled. When used with libvirt the instance mode should be
462# configured as HVM.
463# (string value)
464# Allowed values: <None>, ps2mouse, usbtablet
465#pointer_model=usbtablet
466
467#
468# Defines which physical CPUs (pCPUs) can be used by instance
469# virtual CPUs (vCPUs).
470#
471# Possible values:
472#
473# * A comma-separated list of physical CPU numbers that virtual CPUs can be
474# allocated to by default. Each element should be either a single CPU number,
475# a range of CPU numbers, or a caret followed by a CPU number to be
476# excluded from a previous range. For example:
477#
478# vcpu_pin_set = "4-12,^8,15"
479# (string value)
480#vcpu_pin_set=<None>
481{%- if compute.vcpu_pin_set is defined %}
482vcpu_pin_set={{ compute.vcpu_pin_set }}
483{%- endif %}
484
485#
486# Number of huge/large memory pages to reserved per NUMA host cell.
487#
488# Possible values:
489#
490# * A list of valid key=value which reflect NUMA node ID, page size
491# (Default unit is KiB) and number of pages to be reserved.
492#
493# reserved_huge_pages = node:0,size:2048,count:64
494# reserved_huge_pages = node:1,size:1GB,count:1
495#
496# In this example we are reserving on NUMA node 0 64 pages of 2MiB
497# and on NUMA node 1 1 page of 1GiB.
498# (dict value)
499#reserved_huge_pages=<None>
500
501#
502# Amount of disk resources in MB to make them always available to host. The
503# disk usage gets reported back to the scheduler from nova-compute running
504# on the compute nodes. To prevent the disk resources from being considered
505# as available, this option can be used to reserve disk space for that host.
506#
507# Possible values:
508#
509# * Any positive integer representing amount of disk in MB to reserve
510# for the host.
511# (integer value)
512# Minimum value: 0
513#reserved_host_disk_mb=0
514
515#
516# Amount of memory in MB to reserve for the host so that it is always available
517# to host processes. The host resources usage is reported back to the scheduler
518# continuously from nova-compute running on the compute node. To prevent the
519# host
520# memory from being considered as available, this option is used to reserve
521# memory for the host.
522#
523# Possible values:
524#
525# * Any positive integer representing amount of memory in MB to reserve
526# for the host.
527# (integer value)
528# Minimum value: 0
529#reserved_host_memory_mb=512
530reserved_host_memory_mb = {{ compute.get('reserved_host_memory_mb', '512') }}
531
532#
533# This option helps you specify virtual CPU to physical CPU allocation ratio.
534#
535# From Ocata (15.0.0) this is used to influence the hosts selected by
536# the Placement API. Note that when Placement is used, the CoreFilter
537# is redundant, because the Placement API will have already filtered
538# out hosts that would have failed the CoreFilter.
539#
540# This configuration specifies ratio for CoreFilter which can be set
541# per compute node. For AggregateCoreFilter, it will fall back to this
542# configuration value if no per-aggregate setting is found.
543#
544# NOTE: This can be set per-compute, or if set to 0.0, the value
545# set on the scheduler node(s) or compute node(s) will be used
546# and defaulted to 16.0'.
547#
548# Possible values:
549#
550# * Any valid positive integer or float value
551# (floating point value)
552# Minimum value: 0
553#cpu_allocation_ratio=0.0
554
555#
556# This option helps you specify virtual RAM to physical RAM
557# allocation ratio.
558#
559# From Ocata (15.0.0) this is used to influence the hosts selected by
560# the Placement API. Note that when Placement is used, the RamFilter
561# is redundant, because the Placement API will have already filtered
562# out hosts that would have failed the RamFilter.
563#
564# This configuration specifies ratio for RamFilter which can be set
565# per compute node. For AggregateRamFilter, it will fall back to this
566# configuration value if no per-aggregate setting found.
567#
568# NOTE: This can be set per-compute, or if set to 0.0, the value
569# set on the scheduler node(s) or compute node(s) will be used and
570# defaulted to 1.5.
571#
572# Possible values:
573#
574# * Any valid positive integer or float value
575# (floating point value)
576# Minimum value: 0
577#ram_allocation_ratio=0.0
578
579#
580# This option helps you specify virtual disk to physical disk
581# allocation ratio.
582#
583# From Ocata (15.0.0) this is used to influence the hosts selected by
584# the Placement API. Note that when Placement is used, the DiskFilter
585# is redundant, because the Placement API will have already filtered
586# out hosts that would have failed the DiskFilter.
587#
588# A ratio greater than 1.0 will result in over-subscription of the
589# available physical disk, which can be useful for more
590# efficiently packing instances created with images that do not
591# use the entire virtual disk, such as sparse or compressed
592# images. It can be set to a value between 0.0 and 1.0 in order
593# to preserve a percentage of the disk for uses other than
594# instances.
595#
596# NOTE: This can be set per-compute, or if set to 0.0, the value
597# set on the scheduler node(s) or compute node(s) will be used and
598# defaulted to 1.0'.
599#
600# Possible values:
601#
602# * Any valid positive integer or float value
603# (floating point value)
604# Minimum value: 0
605#disk_allocation_ratio=0.0
606
607#
608# Console proxy host to be used to connect to instances on this host. It is the
609# publicly visible name for the console host.
610#
611# Possible values:
612#
613# * Current hostname (default) or any string representing hostname.
614# (string value)
615#console_host=socket.gethostname()
616
617#
618# Name of the network to be used to set access IPs for instances. If there are
619# multiple IPs to choose from, an arbitrary one will be chosen.
620#
621# Possible values:
622#
623# * None (default)
624# * Any string representing network name.
625# (string value)
626#default_access_ip_network_name=<None>
627
628#
629# Whether to batch up the application of IPTables rules during a host restart
630# and apply all at the end of the init phase.
631# (boolean value)
632#defer_iptables_apply=false
633
634#
635# Specifies where instances are stored on the hypervisor's disk.
636# It can point to locally attached storage or a directory on NFS.
637#
638# Possible values:
639#
640# * $state_path/instances where state_path is a config option that specifies
641# the top-level directory for maintaining nova's state. (default) or
642# Any string representing directory path.
643# (string value)
644#instances_path=$state_path/instances
645
646#
647# This option enables periodic compute.instance.exists notifications. Each
648# compute node must be configured to generate system usage data. These
649# notifications are consumed by OpenStack Telemetry service.
650# (boolean value)
651#instance_usage_audit=false
652
653#
654# Maximum number of 1 second retries in live_migration. It specifies number
655# of retries to iptables when it complains. It happens when an user continuously
656# sends live-migration request to same host leading to concurrent request
657# to iptables.
658#
659# Possible values:
660#
661# * Any positive integer representing retry count.
662# (integer value)
663# Minimum value: 0
664#live_migration_retry_count=30
665
666#
667# This option specifies whether to start guests that were running before the
668# host rebooted. It ensures that all of the instances on a Nova compute node
669# resume their state each time the compute node boots or restarts.
670# (boolean value)
671#resume_guests_state_on_host_boot=false
Sergey Kreysb732cfd2017-04-14 12:43:26 +0300672resume_guests_state_on_host_boot={{ compute.get('resume_guests_state_on_host_boot', True) }}
Jakub Pavlik02a01c72017-04-11 16:04:51 +0200673
674#
675# Number of times to retry network allocation. It is required to attempt network
676# allocation retries if the virtual interface plug fails.
677#
678# Possible values:
679#
680# * Any positive integer representing retry count.
681# (integer value)
682# Minimum value: 0
683#network_allocate_retries=0
684
685#
686# Limits the maximum number of instance builds to run concurrently by
687# nova-compute. Compute service can attempt to build an infinite number of
688# instances, if asked to do so. This limit is enforced to avoid building
689# unlimited instance concurrently on a compute node. This value can be set
690# per compute node.
691#
692# Possible Values:
693#
694# * 0 : treated as unlimited.
695# * Any positive integer representing maximum concurrent builds.
696# (integer value)
697# Minimum value: 0
698#max_concurrent_builds=10
699
700#
701# Maximum number of live migrations to run concurrently. This limit is enforced
702# to avoid outbound live migrations overwhelming the host/network and causing
703# failures. It is not recommended that you change this unless you are very sure
704# that doing so is safe and stable in your environment.
705#
706# Possible values:
707#
708# * 0 : treated as unlimited.
709# * Negative value defaults to 0.
710# * Any positive integer representing maximum number of live migrations
711# to run concurrently.
712# (integer value)
713#max_concurrent_live_migrations=1
714
715#
716# Number of times to retry block device allocation on failures. Starting with
717# Liberty, Cinder can use image volume cache. This may help with block device
718# allocation performance. Look at the cinder image_volume_cache_enabled
719# configuration option.
720#
721# Possible values:
722#
723# * 60 (default)
724# * If value is 0, then one attempt is made.
725# * Any negative value is treated as 0.
726# * For any value > 0, total attempts are (value + 1)
727# (integer value)
728#block_device_allocate_retries=60
729block_device_allocate_retries=600
730
731#
732# Number of greenthreads available for use to sync power states.
733#
734# This option can be used to reduce the number of concurrent requests
735# made to the hypervisor or system with real instance power states
736# for performance reasons, for example, with Ironic.
737#
738# Possible values:
739#
740# * Any positive integer representing greenthreads count.
741# (integer value)
742#sync_power_state_pool_size=1000
743
744#
745# Number of seconds to wait between runs of the image cache manager.
746#
747# Possible values:
748# * 0: run at the default rate.
749# * -1: disable
750# * Any other value
751# (integer value)
752# Minimum value: -1
753#image_cache_manager_interval=2400
754image_cache_manager_interval=0
755
756#
757# Interval to pull network bandwidth usage info.
758#
759# Not supported on all hypervisors. If a hypervisor doesn't support bandwidth
760# usage, it will not get the info in the usage events.
761#
762# Possible values:
763#
764# * 0: Will run at the default periodic interval.
765# * Any value < 0: Disables the option.
766# * Any positive integer in seconds.
767# (integer value)
768#bandwidth_poll_interval=600
769
770#
771# Interval to sync power states between the database and the hypervisor.
772#
773# The interval that Nova checks the actual virtual machine power state
774# and the power state that Nova has in its database. If a user powers
775# down their VM, Nova updates the API to report the VM has been
776# powered down. Should something turn on the VM unexpectedly,
777# Nova will turn the VM back off to keep the system in the expected
778# state.
779#
780# Possible values:
781#
782# * 0: Will run at the default periodic interval.
783# * Any value < 0: Disables the option.
784# * Any positive integer in seconds.
785#
786# Related options:
787#
788# * If ``handle_virt_lifecycle_events`` in workarounds_group is
789# false and this option is negative, then instances that get out
790# of sync between the hypervisor and the Nova database will have
791# to be synchronized manually.
792# (integer value)
793#sync_power_state_interval=600
794
795#
796# Interval between instance network information cache updates.
797#
798# Number of seconds after which each compute node runs the task of
799# querying Neutron for all of its instances networking information,
800# then updates the Nova db with that information. Nova will never
801# update it's cache if this option is set to 0. If we don't update the
802# cache, the metadata service and nova-api endpoints will be proxying
803# incorrect network data about the instance. So, it is not recommended
804# to set this option to 0.
805#
806# Possible values:
807#
808# * Any positive integer in seconds.
809# * Any value <=0 will disable the sync. This is not recommended.
810# (integer value)
811#heal_instance_info_cache_interval=60
812heal_instance_info_cache_interval = {{ compute.heal_instance_info_cache_interval }}
813
814#
815# Interval for reclaiming deleted instances.
816#
817# A value greater than 0 will enable SOFT_DELETE of instances.
818# This option decides whether the server to be deleted will be put into
819# the SOFT_DELETED state. If this value is greater than 0, the deleted
820# server will not be deleted immediately, instead it will be put into
821# a queue until it's too old (deleted time greater than the value of
822# reclaim_instance_interval). The server can be recovered from the
823# delete queue by using the restore action. If the deleted server remains
824# longer than the value of reclaim_instance_interval, it will be
825# deleted by a periodic task in the compute service automatically.
826#
827# Note that this option is read from both the API and compute nodes, and
828# must be set globally otherwise servers could be put into a soft deleted
829# state in the API and never actually reclaimed (deleted) on the compute
830# node.
831#
832# Possible values:
833#
834# * Any positive integer(in seconds) greater than 0 will enable
835# this option.
836# * Any value <=0 will disable the option.
837# (integer value)
838#reclaim_instance_interval=0
839
840#
841# Interval for gathering volume usages.
842#
843# This option updates the volume usage cache for every
844# volume_usage_poll_interval number of seconds.
845#
846# Possible values:
847#
848# * Any positive integer(in seconds) greater than 0 will enable
849# this option.
850# * Any value <=0 will disable the option.
851# (integer value)
852#volume_usage_poll_interval=0
853
854#
855# Interval for polling shelved instances to offload.
856#
857# The periodic task runs for every shelved_poll_interval number
858# of seconds and checks if there are any shelved instances. If it
859# finds a shelved instance, based on the 'shelved_offload_time' config
860# value it offloads the shelved instances. Check 'shelved_offload_time'
861# config option description for details.
862#
863# Possible values:
864#
865# * Any value <= 0: Disables the option.
866# * Any positive integer in seconds.
867#
868# Related options:
869#
870# * ``shelved_offload_time``
871# (integer value)
872#shelved_poll_interval=3600
873
874#
875# Time before a shelved instance is eligible for removal from a host.
876#
877# By default this option is set to 0 and the shelved instance will be
878# removed from the hypervisor immediately after shelve operation.
879# Otherwise, the instance will be kept for the value of
880# shelved_offload_time(in seconds) so that during the time period the
881# unshelve action will be faster, then the periodic task will remove
882# the instance from hypervisor after shelved_offload_time passes.
883#
884# Possible values:
885#
886# * 0: Instance will be immediately offloaded after being
887# shelved.
888# * Any value < 0: An instance will never offload.
889# * Any positive integer in seconds: The instance will exist for
890# the specified number of seconds before being offloaded.
891# (integer value)
892#shelved_offload_time=0
893
894#
895# Interval for retrying failed instance file deletes.
896#
897# This option depends on 'maximum_instance_delete_attempts'.
898# This option specifies how often to retry deletes whereas
899# 'maximum_instance_delete_attempts' specifies the maximum number
900# of retry attempts that can be made.
901#
902# Possible values:
903#
904# * 0: Will run at the default periodic interval.
905# * Any value < 0: Disables the option.
906# * Any positive integer in seconds.
907#
908# Related options:
909#
910# * ``maximum_instance_delete_attempts`` from instance_cleaning_opts
911# group.
912# (integer value)
913#instance_delete_interval=300
914
915#
916# Interval (in seconds) between block device allocation retries on failures.
917#
918# This option allows the user to specify the time interval between
919# consecutive retries. 'block_device_allocate_retries' option specifies
920# the maximum number of retries.
921#
922# Possible values:
923#
924# * 0: Disables the option.
925# * Any positive integer in seconds enables the option.
926#
927# Related options:
928#
929# * ``block_device_allocate_retries`` in compute_manager_opts group.
930# (integer value)
931# Minimum value: 0
932#block_device_allocate_retries_interval=3
933block_device_allocate_retries_interval=10
934
935#
936# Interval between sending the scheduler a list of current instance UUIDs to
937# verify that its view of instances is in sync with nova.
938#
939# If the CONF option 'scheduler_tracks_instance_changes' is
940# False, the sync calls will not be made. So, changing this option will
941# have no effect.
942#
943# If the out of sync situations are not very common, this interval
944# can be increased to lower the number of RPC messages being sent.
945# Likewise, if sync issues turn out to be a problem, the interval
946# can be lowered to check more frequently.
947#
948# Possible values:
949#
950# * 0: Will run at the default periodic interval.
951# * Any value < 0: Disables the option.
952# * Any positive integer in seconds.
953#
954# Related options:
955#
956# * This option has no impact if ``scheduler_tracks_instance_changes``
957# is set to False.
958# (integer value)
959#scheduler_instance_sync_interval=120
960
961#
962# Interval for updating compute resources.
963#
964# This option specifies how often the update_available_resources
965# periodic task should run. A number less than 0 means to disable the
966# task completely. Leaving this at the default of 0 will cause this to
967# run at the default periodic interval. Setting it to any positive
968# value will cause it to run at approximately that number of seconds.
969#
970# Possible values:
971#
972# * 0: Will run at the default periodic interval.
973# * Any value < 0: Disables the option.
974# * Any positive integer in seconds.
975# (integer value)
976#update_resources_interval=0
977
978#
979# Time interval after which an instance is hard rebooted automatically.
980#
981# When doing a soft reboot, it is possible that a guest kernel is
982# completely hung in a way that causes the soft reboot task
983# to not ever finish. Setting this option to a time period in seconds
984# will automatically hard reboot an instance if it has been stuck
985# in a rebooting state longer than N seconds.
986#
987# Possible values:
988#
989# * 0: Disables the option (default).
990# * Any positive integer in seconds: Enables the option.
991# (integer value)
992# Minimum value: 0
993#reboot_timeout=0
994
995#
996# Maximum time in seconds that an instance can take to build.
997#
998# If this timer expires, instance status will be changed to ERROR.
999# Enabling this option will make sure an instance will not be stuck
1000# in BUILD state for a longer period.
1001#
1002# Possible values:
1003#
1004# * 0: Disables the option (default)
1005# * Any positive integer in seconds: Enables the option.
1006# (integer value)
1007# Minimum value: 0
1008#instance_build_timeout=0
1009
1010#
1011# Interval to wait before un-rescuing an instance stuck in RESCUE.
1012#
1013# Possible values:
1014#
1015# * 0: Disables the option (default)
1016# * Any positive integer in seconds: Enables the option.
1017# (integer value)
1018# Minimum value: 0
1019#rescue_timeout=0
1020
1021#
1022# Automatically confirm resizes after N seconds.
1023#
1024# Resize functionality will save the existing server before resizing.
1025# After the resize completes, user is requested to confirm the resize.
1026# The user has the opportunity to either confirm or revert all
1027# changes. Confirm resize removes the original server and changes
1028# server status from resized to active. Setting this option to a time
1029# period (in seconds) will automatically confirm the resize if the
1030# server is in resized state longer than that time.
1031#
1032# Possible values:
1033#
1034# * 0: Disables the option (default)
1035# * Any positive integer in seconds: Enables the option.
1036# (integer value)
1037# Minimum value: 0
1038#resize_confirm_window=0
1039
1040#
1041# Total time to wait in seconds for an instance toperform a clean
1042# shutdown.
1043#
1044# It determines the overall period (in seconds) a VM is allowed to
1045# perform a clean shutdown. While performing stop, rescue and shelve,
1046# rebuild operations, configuring this option gives the VM a chance
1047# to perform a controlled shutdown before the instance is powered off.
1048# The default timeout is 60 seconds.
1049#
1050# The timeout value can be overridden on a per image basis by means
1051# of os_shutdown_timeout that is an image metadata setting allowing
1052# different types of operating systems to specify how much time they
1053# need to shut down cleanly.
1054#
1055# Possible values:
1056#
1057# * Any positive integer in seconds (default value is 60).
1058# (integer value)
1059# Minimum value: 1
1060#shutdown_timeout=60
1061
1062#
1063# The compute service periodically checks for instances that have been
1064# deleted in the database but remain running on the compute node. The
1065# above option enables action to be taken when such instances are
1066# identified.
1067#
1068# Possible values:
1069#
1070# * reap: Powers down the instances and deletes them(default)
1071# * log: Logs warning message about deletion of the resource
1072# * shutdown: Powers down instances and marks them as non-
1073# bootable which can be later used for debugging/analysis
1074# * noop: Takes no action
1075#
1076# Related options:
1077#
1078# * running_deleted_instance_poll
1079# * running_deleted_instance_timeout
1080# (string value)
1081# Allowed values: noop, log, shutdown, reap
1082#running_deleted_instance_action=reap
1083
1084#
1085# Time interval in seconds to wait between runs for the clean up action.
1086# If set to 0, above check will be disabled. If "running_deleted_instance
1087# _action" is set to "log" or "reap", a value greater than 0 must be set.
1088#
1089# Possible values:
1090#
1091# * Any positive integer in seconds enables the option.
1092# * 0: Disables the option.
1093# * 1800: Default value.
1094#
1095# Related options:
1096#
1097# * running_deleted_instance_action
1098# (integer value)
1099#running_deleted_instance_poll_interval=1800
1100
1101#
1102# Time interval in seconds to wait for the instances that have
1103# been marked as deleted in database to be eligible for cleanup.
1104#
1105# Possible values:
1106#
1107# * Any positive integer in seconds(default is 0).
1108#
1109# Related options:
1110#
1111# * "running_deleted_instance_action"
1112# (integer value)
1113#running_deleted_instance_timeout=0
1114
1115#
1116# The number of times to attempt to reap an instance's files.
1117#
1118# This option specifies the maximum number of retry attempts
1119# that can be made.
1120#
1121# Possible values:
1122#
1123# * Any positive integer defines how many attempts are made.
1124# * Any value <=0 means no delete attempts occur, but you should use
1125# ``instance_delete_interval`` to disable the delete attempts.
1126#
1127# Related options:
1128# * ``instance_delete_interval`` in interval_opts group can be used to disable
1129# this option.
1130# (integer value)
1131#maximum_instance_delete_attempts=5
1132
1133# DEPRECATED:
1134# This is the message queue topic that the compute service 'listens' on. It is
1135# used when the compute service is started up to configure the queue, and
1136# whenever an RPC call to the compute service is made.
1137#
1138# Possible values:
1139#
1140# * Any string, but there is almost never any reason to ever change this value
1141# from its default of 'compute'.
1142# (string value)
1143# This option is deprecated for removal since 15.0.0.
1144# Its value may be silently ignored in the future.
1145# Reason:
1146# There is no need to let users choose the RPC topic for all services - there
1147# is little gain from this. Furthermore, it makes it really easy to break Nova
1148# by using this option.
1149#compute_topic=compute
1150
1151#
1152# Sets the scope of the check for unique instance names.
1153#
1154# The default doesn't check for unique names. If a scope for the name check is
1155# set, a launch of a new instance or an update of an existing instance with a
1156# duplicate name will result in an ''InstanceExists'' error. The uniqueness is
1157# case-insensitive. Setting this option can increase the usability for end
1158# users as they don't have to distinguish among instances with the same name
1159# by their IDs.
1160#
1161# Possible values:
1162#
1163# * '': An empty value means that no uniqueness check is done and duplicate
1164# names are possible.
1165# * "project": The instance name check is done only for instances within the
1166# same project.
1167# * "global": The instance name check is done for all instances regardless of
1168# the project.
1169# (string value)
1170# Allowed values: '', project, global
1171#osapi_compute_unique_server_name_scope =
1172
1173#
1174# Enable new services on this host automatically.
1175#
1176# When a new service (for example "nova-compute") starts up, it gets
1177# registered in the database as an enabled service. Sometimes it can be useful
1178# to register new services in disabled state and then enabled them at a later
1179# point in time. This option can set this behavior for all services per host.
1180#
1181# Possible values:
1182#
1183# * ``True``: Each new service is enabled as soon as it registers itself.
1184# * ``False``: Services must be enabled via a REST API call or with the CLI
1185# with ``nova service-enable <hostname> <binary>``, otherwise they are not
1186# ready to use.
1187# (boolean value)
1188#enable_new_services=true
1189
1190#
1191# Template string to be used to generate instance names.
1192#
1193# This template controls the creation of the database name of an instance. This
1194# is *not* the display name you enter when creating an instance (via Horizon
1195# or CLI). For a new deployment it is advisable to change the default value
1196# (which uses the database autoincrement) to another value which makes use
1197# of the attributes of an instance, like ``instance-%(uuid)s``. If you
1198# already have instances in your deployment when you change this, your
1199# deployment will break.
1200#
1201# Possible values:
1202#
1203# * A string which either uses the instance database ID (like the
1204# default)
1205# * A string with a list of named database columns, for example ``%(id)d``
1206# or ``%(uuid)s`` or ``%(hostname)s``.
1207#
1208# Related options:
1209#
1210# * not to be confused with: ``multi_instance_display_name_template``
1211# (string value)
1212#instance_name_template=instance-%08x
1213
1214#
1215# Number of times to retry live-migration before failing.
1216#
1217# Possible values:
1218#
1219# * If == -1, try until out of hosts (default)
1220# * If == 0, only try once, no retries
1221# * Integer greater than 0
1222# (integer value)
1223# Minimum value: -1
1224#migrate_max_retries=-1
1225
1226#
1227# Configuration drive format
1228#
1229# Configuration drive format that will contain metadata attached to the
1230# instance when it boots.
1231#
1232# Possible values:
1233#
1234# * iso9660: A file system image standard that is widely supported across
1235# operating systems. NOTE: Mind the libvirt bug
1236# (https://bugs.launchpad.net/nova/+bug/1246201) - If your hypervisor
1237# driver is libvirt, and you want live migrate to work without shared storage,
1238# then use VFAT.
1239# * vfat: For legacy reasons, you can configure the configuration drive to
1240# use VFAT format instead of ISO 9660.
1241#
1242# Related options:
1243#
1244# * This option is meaningful when one of the following alternatives occur:
1245# 1. force_config_drive option set to 'true'
1246# 2. the REST API call to create the instance contains an enable flag for
1247# config drive option
1248# 3. the image used to create the instance requires a config drive,
1249# this is defined by img_config_drive property for that image.
1250# * A compute node running Hyper-V hypervisor can be configured to attach
1251# configuration drive as a CD drive. To attach the configuration drive as a CD
1252# drive, set config_drive_cdrom option at hyperv section, to true.
1253# (string value)
1254# Allowed values: iso9660, vfat
1255#config_drive_format=iso9660
1256config_drive_format=vfat
1257
1258#
1259# Force injection to take place on a config drive
1260#
1261# When this option is set to true configuration drive functionality will be
1262# forced enabled by default, otherwise user can still enable configuration
1263# drives via the REST API or image metadata properties.
1264#
1265# Possible values:
1266#
1267# * True: Force to use of configuration drive regardless the user's input in the
1268# REST API call.
1269# * False: Do not force use of configuration drive. Config drives can still be
1270# enabled via the REST API or image metadata properties.
1271#
1272# Related options:
1273#
1274# * Use the 'mkisofs_cmd' flag to set the path where you install the
1275# genisoimage program. If genisoimage is in same path as the
1276# nova-compute service, you do not need to set this flag.
1277# * To use configuration drive with Hyper-V, you must set the
1278# 'mkisofs_cmd' value to the full path to an mkisofs.exe installation.
1279# Additionally, you must set the qemu_img_cmd value in the hyperv
1280# configuration section to the full path to an qemu-img command
1281# installation.
1282# (boolean value)
1283#force_config_drive=false
1284force_config_drive=true
1285
1286#
1287# Name or path of the tool used for ISO image creation
1288#
1289# Use the mkisofs_cmd flag to set the path where you install the genisoimage
1290# program. If genisoimage is on the system path, you do not need to change
1291# the default value.
1292#
1293# To use configuration drive with Hyper-V, you must set the mkisofs_cmd value
1294# to the full path to an mkisofs.exe installation. Additionally, you must set
1295# the qemu_img_cmd value in the hyperv configuration section to the full path
1296# to an qemu-img command installation.
1297#
1298# Possible values:
1299#
1300# * Name of the ISO image creator program, in case it is in the same directory
1301# as the nova-compute service
1302# * Path to ISO image creator program
1303#
1304# Related options:
1305#
1306# * This option is meaningful when config drives are enabled.
1307# * To use configuration drive with Hyper-V, you must set the qemu_img_cmd
1308# value in the hyperv configuration section to the full path to an qemu-img
1309# command installation.
1310# (string value)
1311#mkisofs_cmd=genisoimage
1312
1313# DEPRECATED:
1314# nova-console-proxy is used to set up multi-tenant VM console access.
1315# This option allows pluggable driver program for the console session
1316# and represents driver to use for the console proxy.
1317#
1318# Possible values:
1319#
1320# * A string representing fully classified class name of console driver.
1321# (string value)
1322# This option is deprecated for removal since 15.0.0.
1323# Its value may be silently ignored in the future.
1324# Reason:
1325# This option no longer does anything. Previously this option had only two
1326# valid,
1327# in-tree values: nova.console.xvp.XVPConsoleProxy and
1328# nova.console.fake.FakeConsoleProxy. The latter of these was only used in tests
1329# and has since been replaced.
1330#console_driver=nova.console.xvp.XVPConsoleProxy
1331
1332# DEPRECATED:
1333# Represents the message queue topic name used by nova-console
1334# service when communicating via the AMQP server. The Nova API uses a message
1335# queue to communicate with nova-console to retrieve a console URL for that
1336# host.
1337#
1338# Possible values:
1339#
1340# * A string representing topic exchange name
1341# (string value)
1342# This option is deprecated for removal since 15.0.0.
1343# Its value may be silently ignored in the future.
1344# Reason:
1345# There is no need to let users choose the RPC topic for all services - there
1346# is little gain from this. Furthermore, it makes it really easy to break Nova
1347# by using this option.
1348#console_topic=console
1349
1350# DEPRECATED:
1351# This option allows you to change the message topic used by nova-consoleauth
1352# service when communicating via the AMQP server. Nova Console Authentication
1353# server authenticates nova consoles. Users can then access their instances
1354# through VNC clients. The Nova API service uses a message queue to
1355# communicate with nova-consoleauth to get a VNC console.
1356#
1357# Possible Values:
1358#
1359# * 'consoleauth' (default) or Any string representing topic exchange name.
1360# (string value)
1361# This option is deprecated for removal since 15.0.0.
1362# Its value may be silently ignored in the future.
1363# Reason:
1364# There is no need to let users choose the RPC topic for all services - there
1365# is little gain from this. Furthermore, it makes it really easy to break Nova
1366# by using this option.
1367#consoleauth_topic=consoleauth
1368
1369# DEPRECATED: The driver to use for database access (string value)
1370# This option is deprecated for removal since 13.0.0.
1371# Its value may be silently ignored in the future.
1372#db_driver=nova.db
1373
1374# DEPRECATED:
1375# Default flavor to use for the EC2 API only.
1376# The Nova API does not support a default flavor.
1377# (string value)
1378# This option is deprecated for removal since 14.0.0.
1379# Its value may be silently ignored in the future.
1380# Reason: The EC2 API is deprecated.
1381#default_flavor=m1.small
1382
1383#
1384# Default pool for floating IPs.
1385#
1386# This option specifies the default floating IP pool for allocating floating
1387# IPs.
1388#
1389# While allocating a floating ip, users can optionally pass in the name of the
1390# pool they want to allocate from, otherwise it will be pulled from the
1391# default pool.
1392#
1393# If this option is not set, then 'nova' is used as default floating pool.
1394#
1395# Possible values:
1396#
1397# * Any string representing a floating IP pool name
1398# (string value)
1399#default_floating_pool=nova
1400
1401# DEPRECATED:
1402# Autoassigning floating IP to VM
1403#
1404# When set to True, floating IP is auto allocated and associated
1405# to the VM upon creation.
1406#
1407# Related options:
1408#
1409# * use_neutron: this options only works with nova-network.
1410# (boolean value)
1411# This option is deprecated for removal since 15.0.0.
1412# Its value may be silently ignored in the future.
1413# Reason:
1414# nova-network is deprecated, as are any related configuration options.
1415#auto_assign_floating_ip=false
1416
1417# DEPRECATED:
1418# Full class name for the DNS Manager for floating IPs.
1419#
1420# This option specifies the class of the driver that provides functionality
1421# to manage DNS entries associated with floating IPs.
1422#
1423# When a user adds a DNS entry for a specified domain to a floating IP,
1424# nova will add a DNS entry using the specified floating DNS driver.
1425# When a floating IP is deallocated, its DNS entry will automatically be
1426# deleted.
1427#
1428# Possible values:
1429#
1430# * Full Python path to the class to be used
1431#
1432# Related options:
1433#
1434# * use_neutron: this options only works with nova-network.
1435# (string value)
1436# This option is deprecated for removal since 15.0.0.
1437# Its value may be silently ignored in the future.
1438# Reason:
1439# nova-network is deprecated, as are any related configuration options.
1440#floating_ip_dns_manager=nova.network.noop_dns_driver.NoopDNSDriver
1441
1442# DEPRECATED:
1443# Full class name for the DNS Manager for instance IPs.
1444#
1445# This option specifies the class of the driver that provides functionality
1446# to manage DNS entries for instances.
1447#
1448# On instance creation, nova will add DNS entries for the instance name and
1449# id, using the specified instance DNS driver and domain. On instance deletion,
1450# nova will remove the DNS entries.
1451#
1452# Possible values:
1453#
1454# * Full Python path to the class to be used
1455#
1456# Related options:
1457#
1458# * use_neutron: this options only works with nova-network.
1459# (string value)
1460# This option is deprecated for removal since 15.0.0.
1461# Its value may be silently ignored in the future.
1462# Reason:
1463# nova-network is deprecated, as are any related configuration options.
1464#instance_dns_manager=nova.network.noop_dns_driver.NoopDNSDriver
1465
1466# DEPRECATED:
1467# If specified, Nova checks if the availability_zone of every instance matches
1468# what the database says the availability_zone should be for the specified
1469# dns_domain.
1470#
1471# Related options:
1472#
1473# * use_neutron: this options only works with nova-network.
1474# (string value)
1475# This option is deprecated for removal since 15.0.0.
1476# Its value may be silently ignored in the future.
1477# Reason:
1478# nova-network is deprecated, as are any related configuration options.
1479#instance_dns_domain =
1480
1481#
1482# Abstracts out IPv6 address generation to pluggable backends.
1483#
1484# nova-network can be put into dual-stack mode, so that it uses
1485# both IPv4 and IPv6 addresses. In dual-stack mode, by default, instances
1486# acquire IPv6 global unicast addresses with the help of stateless address
1487# auto-configuration mechanism.
1488#
1489# Related options:
1490#
1491# * use_neutron: this option only works with nova-network.
1492# * use_ipv6: this option only works if ipv6 is enabled for nova-network.
1493# (string value)
1494# Allowed values: rfc2462, account_identifier
1495#ipv6_backend=rfc2462
1496
1497#
1498# The IP address which the host is using to connect to the management network.
1499#
1500# Possible values:
1501#
1502# * String with valid IP address. Default is IPv4 address of this host.
1503#
1504# Related options:
1505#
1506# * metadata_host
1507# * my_block_storage_ip
1508# * routing_source_ip
1509# * vpn_ip
1510# (string value)
1511#my_ip=10.89.104.70
1512
1513#
1514# The IP address which is used to connect to the block storage network.
1515#
1516# Possible values:
1517#
1518# * String with valid IP address. Default is IP address of this host.
1519#
1520# Related options:
1521#
1522# * my_ip - if my_block_storage_ip is not set, then my_ip value is used.
1523# (string value)
1524#my_block_storage_ip=$my_ip
1525
1526#
1527# Hostname, FQDN or IP address of this host. Must be valid within AMQP key.
1528#
1529# Possible values:
1530#
1531# * String with hostname, FQDN or IP address. Default is hostname of this host.
1532# (string value)
1533#host=lcy01-22
1534
1535#
1536# Assign IPv6 and IPv4 addresses when creating instances.
1537#
1538# Related options:
1539#
1540# * use_neutron: this only works with nova-network.
1541# (boolean value)
1542#use_ipv6=false
1543
1544#
1545# This option is a list of full paths to one or more configuration files for
1546# dhcpbridge. In most cases the default path of '/etc/nova/nova-dhcpbridge.conf'
1547# should be sufficient, but if you have special needs for configuring
1548# dhcpbridge,
1549# you can change or add to this list.
1550#
1551# Possible values
1552#
1553# A list of strings, where each string is the full path to a dhcpbridge
1554# configuration file.
1555# (multi valued)
1556dhcpbridge_flagfile=/etc/nova/nova.conf
1557
1558#
1559# The location where the network configuration files will be kept. The default
1560# is
1561# the 'networks' directory off of the location where nova's Python module is
1562# installed.
1563#
1564# Possible values
1565#
1566# A string containing the full path to the desired configuration directory
1567# (string value)
1568#networks_path=$state_path/networks
1569
1570#
1571# This is the name of the network interface for public IP addresses. The default
1572# is 'eth0'.
1573#
1574# Possible values:
1575#
1576# Any string representing a network interface name
1577# (string value)
1578#public_interface=eth0
1579
1580#
1581# The location of the binary nova-dhcpbridge. By default it is the binary named
1582# 'nova-dhcpbridge' that is installed with all the other nova binaries.
1583#
1584# Possible values:
1585#
1586# Any string representing the full path to the binary for dhcpbridge
1587# (string value)
1588dhcpbridge=/usr/bin/nova-dhcpbridge
1589
1590#
1591# This is the public IP address of the network host. It is used when creating a
1592# SNAT rule.
1593#
1594# Possible values:
1595#
1596# Any valid IP address
1597#
1598# Related options:
1599#
1600# force_snat_range
1601# (string value)
1602#routing_source_ip=$my_ip
1603
1604#
1605# The lifetime of a DHCP lease, in seconds. The default is 86400 (one day).
1606#
1607# Possible values:
1608#
1609# Any positive integer value.
1610# (integer value)
1611# Minimum value: 1
1612#dhcp_lease_time=86400
1613
1614#
1615# Despite the singular form of the name of this option, it is actually a list of
1616# zero or more server addresses that dnsmasq will use for DNS nameservers. If
1617# this is not empty, dnsmasq will not read /etc/resolv.conf, but will only use
1618# the servers specified in this option. If the option use_network_dns_servers is
1619# True, the dns1 and dns2 servers from the network will be appended to this
1620# list,
1621# and will be used as DNS servers, too.
1622#
1623# Possible values:
1624#
1625# A list of strings, where each string is either an IP address or a FQDN.
1626#
1627# Related options:
1628#
1629# use_network_dns_servers
1630# (multi valued)
1631#dns_server =
1632
1633#
1634# When this option is set to True, the dns1 and dns2 servers for the network
1635# specified by the user on boot will be used for DNS, as well as any specified
1636# in
1637# the `dns_server` option.
1638#
1639# Related options:
1640#
1641# dns_server
1642# (boolean value)
1643#use_network_dns_servers=false
1644
1645#
1646# This option is a list of zero or more IP address ranges in your network's DMZ
1647# that should be accepted.
1648#
1649# Possible values:
1650#
1651# A list of strings, each of which should be a valid CIDR.
1652# (list value)
1653#dmz_cidr =
1654
1655#
1656# This is a list of zero or more IP ranges that traffic from the
1657# `routing_source_ip` will be SNATted to. If the list is empty, then no SNAT
1658# rules are created.
1659#
1660# Possible values:
1661#
1662# A list of strings, each of which should be a valid CIDR.
1663#
1664# Related options:
1665#
1666# routing_source_ip
1667# (multi valued)
1668#force_snat_range =
1669
1670#
1671# The path to the custom dnsmasq configuration file, if any.
1672#
1673# Possible values:
1674#
1675# The full path to the configuration file, or an empty string if there is no
1676# custom dnsmasq configuration file.
1677# (string value)
1678#dnsmasq_config_file =
1679
1680#
1681# This is the class used as the ethernet device driver for linuxnet bridge
1682# operations. The default value should be all you need for most cases, but if
1683# you
1684# wish to use a customized class, set this option to the full dot-separated
1685# import path for that class.
1686#
1687# Possible values:
1688#
1689# Any string representing a dot-separated class path that Nova can import.
1690# (string value)
1691#linuxnet_interface_driver=nova.network.linux_net.LinuxBridgeInterfaceDriver
1692
1693#
1694# The name of the Open vSwitch bridge that is used with linuxnet when connecting
1695# with Open vSwitch."
1696#
1697# Possible values:
1698#
1699# Any string representing a valid bridge name.
1700# (string value)
1701#linuxnet_ovs_integration_bridge=br-int
1702
1703#
1704# When True, when a device starts up, and upon binding floating IP addresses,
1705# arp
1706# messages will be sent to ensure that the arp caches on the compute hosts are
1707# up-to-date.
1708#
1709# Related options:
1710#
1711# send_arp_for_ha_count
1712# (boolean value)
1713#send_arp_for_ha=false
1714
1715#
1716# When arp messages are configured to be sent, they will be sent with the count
1717# set to the value of this option. Of course, if this is set to zero, no arp
1718# messages will be sent.
1719#
1720# Possible values:
1721#
1722# Any integer greater than or equal to 0
1723#
1724# Related options:
1725#
1726# send_arp_for_ha
1727# (integer value)
1728#send_arp_for_ha_count=3
1729
1730#
1731# When set to True, only the firt nic of a VM will get its default gateway from
1732# the DHCP server.
1733# (boolean value)
1734#use_single_default_gateway=false
1735
1736#
1737# One or more interfaces that bridges can forward traffic to. If any of the
1738# items
1739# in this list is the special keyword 'all', then all traffic will be forwarded.
1740#
1741# Possible values:
1742#
1743# A list of zero or more interface names, or the word 'all'.
1744# (multi valued)
1745#forward_bridge_interface=all
1746
1747#
1748# This option determines the IP address for the network metadata API server.
1749#
1750# Possible values:
1751#
1752# * Any valid IP address. The default is the address of the Nova API server.
1753#
1754# Related options:
1755#
1756# * metadata_port
1757# (string value)
1758#metadata_host=$my_ip
1759
1760#
1761# This option determines the port used for the metadata API server.
1762#
1763# Related options:
1764#
1765# * metadata_host
1766# (port value)
1767# Minimum value: 0
1768# Maximum value: 65535
1769#metadata_port=8775
1770
1771#
1772# This expression, if defined, will select any matching iptables rules and place
1773# them at the top when applying metadata changes to the rules.
1774#
1775# Possible values:
1776#
1777# * Any string representing a valid regular expression, or an empty string
1778#
1779# Related options:
1780#
1781# * iptables_bottom_regex
1782# (string value)
1783#iptables_top_regex =
1784
1785#
1786# This expression, if defined, will select any matching iptables rules and place
1787# them at the bottom when applying metadata changes to the rules.
1788#
1789# Possible values:
1790#
1791# * Any string representing a valid regular expression, or an empty string
1792#
1793# Related options:
1794#
1795# * iptables_top_regex
1796# (string value)
1797#iptables_bottom_regex =
1798
1799#
1800# By default, packets that do not pass the firewall are DROPped. In many cases,
1801# though, an operator may find it more useful to change this from DROP to
1802# REJECT,
1803# so that the user issuing those packets may have a better idea as to what's
1804# going on, or LOGDROP in order to record the blocked traffic before DROPping.
1805#
1806# Possible values:
1807#
1808# * A string representing an iptables chain. The default is DROP.
1809# (string value)
1810#iptables_drop_action=DROP
1811
1812#
1813# This option represents the period of time, in seconds, that the ovs_vsctl
1814# calls
1815# will wait for a response from the database before timing out. A setting of 0
1816# means that the utility should wait forever for a response.
1817#
1818# Possible values:
1819#
1820# * Any positive integer if a limited timeout is desired, or zero if the
1821# calls should wait forever for a response.
1822# (integer value)
1823# Minimum value: 0
1824#ovs_vsctl_timeout=120
1825
1826#
1827# This option is used mainly in testing to avoid calls to the underlying network
1828# utilities.
1829# (boolean value)
1830#fake_network=false
1831
1832#
1833# This option determines the number of times to retry ebtables commands before
1834# giving up. The minimum number of retries is 1.
1835#
1836# Possible values:
1837#
1838# * Any positive integer
1839#
1840# Related options:
1841#
1842# * ebtables_retry_interval
1843# (integer value)
1844# Minimum value: 1
1845#ebtables_exec_attempts=3
1846
1847#
1848# This option determines the time, in seconds, that the system will sleep in
1849# between ebtables retries. Note that each successive retry waits a multiple of
1850# this value, so for example, if this is set to the default of 1.0 seconds, and
1851# ebtables_exec_attempts is 4, after the first failure, the system will sleep
1852# for
1853# 1 * 1.0 seconds, after the second failure it will sleep 2 * 1.0 seconds, and
1854# after the third failure it will sleep 3 * 1.0 seconds.
1855#
1856# Possible values:
1857#
1858# * Any non-negative float or integer. Setting this to zero will result in
1859# no
1860# waiting between attempts.
1861#
1862# Related options:
1863#
1864# * ebtables_exec_attempts
1865# (floating point value)
1866#ebtables_retry_interval=1.0
1867
1868#
1869# This option determines whether the network setup information is injected into
1870# the VM before it is booted. While it was originally designed to be used only
1871# by
1872# nova-network, it is also used by the vmware and xenapi virt drivers to control
1873# whether network information is injected into a VM.
1874# (boolean value)
1875#flat_injected=false
1876
1877# DEPRECATED:
1878# This option determines the bridge used for simple network interfaces when no
1879# bridge is specified in the VM creation request.
1880#
1881# Please note that this option is only used when using nova-network instead of
1882# Neutron in your deployment.
1883#
1884# Possible values:
1885#
1886# Any string representing a valid network bridge, such as 'br100'
1887#
1888# Related options:
1889#
1890# ``use_neutron``
1891# (string value)
1892# This option is deprecated for removal since 15.0.0.
1893# Its value may be silently ignored in the future.
1894# Reason:
1895# nova-network is deprecated, as are any related configuration options.
1896#flat_network_bridge=<None>
1897
1898# DEPRECATED:
1899# This is the address of the DNS server for a simple network. If this option is
1900# not specified, the default of '8.8.4.4' is used.
1901#
1902# Please note that this option is only used when using nova-network instead of
1903# Neutron in your deployment.
1904#
1905# Possible values:
1906#
1907# Any valid IP address.
1908#
1909# Related options:
1910#
1911# ``use_neutron``
1912# (string value)
1913# This option is deprecated for removal since 15.0.0.
1914# Its value may be silently ignored in the future.
1915# Reason:
1916# nova-network is deprecated, as are any related configuration options.
1917#flat_network_dns=8.8.4.4
1918
1919# DEPRECATED:
1920# This option is the name of the virtual interface of the VM on which the bridge
1921# will be built. While it was originally designed to be used only by
1922# nova-network, it is also used by libvirt for the bridge interface name.
1923#
1924# Possible values:
1925#
1926# Any valid virtual interface name, such as 'eth0'
1927# (string value)
1928# This option is deprecated for removal since 15.0.0.
1929# Its value may be silently ignored in the future.
1930# Reason:
1931# nova-network is deprecated, as are any related configuration options.
1932#flat_interface=<None>
1933
1934# DEPRECATED:
1935# This is the VLAN number used for private networks. Note that the when creating
1936# the networks, if the specified number has already been assigned, nova-network
1937# will increment this number until it finds an available VLAN.
1938#
1939# Please note that this option is only used when using nova-network instead of
1940# Neutron in your deployment. It also will be ignored if the configuration
1941# option
1942# for `network_manager` is not set to the default of
1943# 'nova.network.manager.VlanManager'.
1944#
1945# Possible values:
1946#
1947# Any integer between 1 and 4094. Values outside of that range will raise a
1948# ValueError exception. Default = 100.
1949#
1950# Related options:
1951#
1952# ``network_manager``, ``use_neutron``
1953# (integer value)
1954# Minimum value: 1
1955# Maximum value: 4094
1956# This option is deprecated for removal since 15.0.0.
1957# Its value may be silently ignored in the future.
1958# Reason:
1959# nova-network is deprecated, as are any related configuration options.
1960#vlan_start=100
1961
1962# DEPRECATED:
1963# This option is the name of the virtual interface of the VM on which the VLAN
1964# bridge will be built. While it was originally designed to be used only by
1965# nova-network, it is also used by libvirt and xenapi for the bridge interface
1966# name.
1967#
1968# Please note that this setting will be ignored in nova-network if the
1969# configuration option for `network_manager` is not set to the default of
1970# 'nova.network.manager.VlanManager'.
1971#
1972# Possible values:
1973#
1974# Any valid virtual interface name, such as 'eth0'
1975# (string value)
1976# This option is deprecated for removal since 15.0.0.
1977# Its value may be silently ignored in the future.
1978# Reason:
1979# nova-network is deprecated, as are any related configuration options. While
1980# this option has an effect when using neutron, it incorrectly override the
1981# value
1982# provided by neutron and should therefore not be used.
1983#vlan_interface=<None>
1984
1985# DEPRECATED:
1986# This option represents the number of networks to create if not explicitly
1987# specified when the network is created. The only time this is used is if a CIDR
1988# is specified, but an explicit network_size is not. In that case, the subnets
1989# are created by diving the IP address space of the CIDR by num_networks. The
1990# resulting subnet sizes cannot be larger than the configuration option
1991# `network_size`; in that event, they are reduced to `network_size`, and a
1992# warning is logged.
1993#
1994# Please note that this option is only used when using nova-network instead of
1995# Neutron in your deployment.
1996#
1997# Possible values:
1998#
1999# Any positive integer is technically valid, although there are practical
2000# limits based upon available IP address space and virtual interfaces. The
2001# default is 1.
2002#
2003# Related options:
2004#
2005# ``use_neutron``, ``network_size``
2006# (integer value)
2007# Minimum value: 1
2008# This option is deprecated for removal since 15.0.0.
2009# Its value may be silently ignored in the future.
2010# Reason:
2011# nova-network is deprecated, as are any related configuration options.
2012#num_networks=1
2013
2014# DEPRECATED:
2015# This is the public IP address for the cloudpipe VPN servers. It defaults to
2016# the
2017# IP address of the host.
2018#
2019# Please note that this option is only used when using nova-network instead of
2020# Neutron in your deployment. It also will be ignored if the configuration
2021# option
2022# for `network_manager` is not set to the default of
2023# 'nova.network.manager.VlanManager'.
2024#
2025# Possible values:
2026#
2027# Any valid IP address. The default is $my_ip, the IP address of the VM.
2028#
2029# Related options:
2030#
2031# ``network_manager``, ``use_neutron``, ``vpn_start``
2032# (string value)
2033# This option is deprecated for removal since 15.0.0.
2034# Its value may be silently ignored in the future.
2035# Reason:
2036# nova-network is deprecated, as are any related configuration options.
2037#vpn_ip=$my_ip
2038
2039# DEPRECATED:
2040# This is the port number to use as the first VPN port for private networks.
2041#
2042# Please note that this option is only used when using nova-network instead of
2043# Neutron in your deployment. It also will be ignored if the configuration
2044# option
2045# for `network_manager` is not set to the default of
2046# 'nova.network.manager.VlanManager', or if you specify a value the 'vpn_start'
2047# parameter when creating a network.
2048#
2049# Possible values:
2050#
2051# Any integer representing a valid port number. The default is 1000.
2052#
2053# Related options:
2054#
2055# ``use_neutron``, ``vpn_ip``, ``network_manager``
2056# (port value)
2057# Minimum value: 0
2058# Maximum value: 65535
2059# This option is deprecated for removal since 15.0.0.
2060# Its value may be silently ignored in the future.
2061# Reason:
2062# nova-network is deprecated, as are any related configuration options.
2063#vpn_start=1000
2064
2065# DEPRECATED:
2066# This option determines the number of addresses in each private subnet.
2067#
2068# Please note that this option is only used when using nova-network instead of
2069# Neutron in your deployment.
2070#
2071# Possible values:
2072#
2073# Any positive integer that is less than or equal to the available network
2074# size. Note that if you are creating multiple networks, they must all fit
2075# in
2076# the available IP address space. The default is 256.
2077#
2078# Related options:
2079#
2080# ``use_neutron``, ``num_networks``
2081# (integer value)
2082# Minimum value: 1
2083# This option is deprecated for removal since 15.0.0.
2084# Its value may be silently ignored in the future.
2085# Reason:
2086# nova-network is deprecated, as are any related configuration options.
2087#network_size=256
2088
2089# DEPRECATED:
2090# This option determines the fixed IPv6 address block when creating a network.
2091#
2092# Please note that this option is only used when using nova-network instead of
2093# Neutron in your deployment.
2094#
2095# Possible values:
2096#
2097# Any valid IPv6 CIDR. The default value is "fd00::/48".
2098#
2099# Related options:
2100#
2101# ``use_neutron``
2102# (string value)
2103# This option is deprecated for removal since 15.0.0.
2104# Its value may be silently ignored in the future.
2105# Reason:
2106# nova-network is deprecated, as are any related configuration options.
2107#fixed_range_v6=fd00::/48
2108
2109# DEPRECATED:
2110# This is the default IPv4 gateway. It is used only in the testing suite.
2111#
2112# Please note that this option is only used when using nova-network instead of
2113# Neutron in your deployment.
2114#
2115# Possible values:
2116#
2117# Any valid IP address.
2118#
2119# Related options:
2120#
2121# ``use_neutron``, ``gateway_v6``
2122# (string value)
2123# This option is deprecated for removal since 15.0.0.
2124# Its value may be silently ignored in the future.
2125# Reason:
2126# nova-network is deprecated, as are any related configuration options.
2127#gateway=<None>
2128
2129# DEPRECATED:
2130# This is the default IPv6 gateway. It is used only in the testing suite.
2131#
2132# Please note that this option is only used when using nova-network instead of
2133# Neutron in your deployment.
2134#
2135# Possible values:
2136#
2137# Any valid IP address.
2138#
2139# Related options:
2140#
2141# ``use_neutron``, ``gateway``
2142# (string value)
2143# This option is deprecated for removal since 15.0.0.
2144# Its value may be silently ignored in the future.
2145# Reason:
2146# nova-network is deprecated, as are any related configuration options.
2147#gateway_v6=<None>
2148
2149# DEPRECATED:
2150# This option represents the number of IP addresses to reserve at the top of the
2151# address range for VPN clients. It also will be ignored if the configuration
2152# option for `network_manager` is not set to the default of
2153# 'nova.network.manager.VlanManager'.
2154#
2155# Possible values:
2156#
2157# Any integer, 0 or greater. The default is 0.
2158#
2159# Related options:
2160#
2161# ``use_neutron``, ``network_manager``
2162# (integer value)
2163# Minimum value: 0
2164# This option is deprecated for removal since 15.0.0.
2165# Its value may be silently ignored in the future.
2166# Reason:
2167# nova-network is deprecated, as are any related configuration options.
2168#cnt_vpn_clients=0
2169
2170# DEPRECATED:
2171# This is the number of seconds to wait before disassociating a deallocated
2172# fixed
2173# IP address. This is only used with the nova-network service, and has no effect
2174# when using neutron for networking.
2175#
2176# Possible values:
2177#
2178# Any integer, zero or greater. The default is 600 (10 minutes).
2179#
2180# Related options:
2181#
2182# ``use_neutron``
2183# (integer value)
2184# Minimum value: 0
2185# This option is deprecated for removal since 15.0.0.
2186# Its value may be silently ignored in the future.
2187# Reason:
2188# nova-network is deprecated, as are any related configuration options.
2189#fixed_ip_disassociate_timeout=600
2190
2191# DEPRECATED:
2192# This option determines how many times nova-network will attempt to create a
2193# unique MAC address before giving up and raising a
2194# `VirtualInterfaceMacAddressException` error.
2195#
2196# Possible values:
2197#
2198# Any positive integer. The default is 5.
2199#
2200# Related options:
2201#
2202# ``use_neutron``
2203# (integer value)
2204# Minimum value: 1
2205# This option is deprecated for removal since 15.0.0.
2206# Its value may be silently ignored in the future.
2207# Reason:
2208# nova-network is deprecated, as are any related configuration options.
2209#create_unique_mac_address_attempts=5
2210
2211# DEPRECATED:
2212# Determines whether unused gateway devices, both VLAN and bridge, are deleted
2213# if
2214# the network is in nova-network VLAN mode and is multi-hosted.
2215#
2216# Related options:
2217#
2218# ``use_neutron``, ``vpn_ip``, ``fake_network``
2219# (boolean value)
2220# This option is deprecated for removal since 15.0.0.
2221# Its value may be silently ignored in the future.
2222# Reason:
2223# nova-network is deprecated, as are any related configuration options.
2224#teardown_unused_network_gateway=false
2225
2226# DEPRECATED:
2227# When this option is True, a call is made to release the DHCP for the instance
2228# when that instance is terminated.
2229#
2230# Related options:
2231#
2232# ``use_neutron``
2233# (boolean value)
2234# This option is deprecated for removal since 15.0.0.
2235# Its value may be silently ignored in the future.
2236# Reason:
2237# nova-network is deprecated, as are any related configuration options.
2238force_dhcp_release=true
2239
2240# DEPRECATED:
2241# When this option is True, whenever a DNS entry must be updated, a fanout cast
2242# message is sent to all network hosts to update their DNS entries in multi-host
2243# mode.
2244#
2245# Related options:
2246#
2247# ``use_neutron``
2248# (boolean value)
2249# This option is deprecated for removal since 15.0.0.
2250# Its value may be silently ignored in the future.
2251# Reason:
2252# nova-network is deprecated, as are any related configuration options.
2253#update_dns_entries=false
2254
2255# DEPRECATED:
2256# This option determines the time, in seconds, to wait between refreshing DNS
2257# entries for the network.
2258#
2259# Possible values:
2260#
2261# Either -1 (default), or any positive integer. A negative value will
2262# disable
2263# the updates.
2264#
2265# Related options:
2266#
2267# ``use_neutron``
2268# (integer value)
2269# Minimum value: -1
2270# This option is deprecated for removal since 15.0.0.
2271# Its value may be silently ignored in the future.
2272# Reason:
2273# nova-network is deprecated, as are any related configuration options.
2274#dns_update_periodic_interval=-1
2275
2276# DEPRECATED:
2277# This option allows you to specify the domain for the DHCP server.
2278#
2279# Possible values:
2280#
2281# Any string that is a valid domain name.
2282#
2283# Related options:
2284#
2285# ``use_neutron``
2286# (string value)
2287# This option is deprecated for removal since 15.0.0.
2288# Its value may be silently ignored in the future.
2289# Reason:
2290# nova-network is deprecated, as are any related configuration options.
2291#dhcp_domain=novalocal
2292dhcp_domain={{ compute.get('dhcp_domain', 'novalocal') }}
2293
2294# DEPRECATED:
2295# This option allows you to specify the L3 management library to be used.
2296#
2297# Possible values:
2298#
2299# Any dot-separated string that represents the import path to an L3
2300# networking library.
2301#
2302# Related options:
2303#
2304# ``use_neutron``
2305# (string value)
2306# This option is deprecated for removal since 15.0.0.
2307# Its value may be silently ignored in the future.
2308# Reason:
2309# nova-network is deprecated, as are any related configuration options.
2310#l3_lib=nova.network.l3.LinuxNetL3
2311
2312# DEPRECATED:
2313# THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK.
2314#
2315# If True in multi_host mode, all compute hosts share the same dhcp address. The
2316# same IP address used for DHCP will be added on each nova-network node which is
2317# only visible to the VMs on the same host.
2318#
2319# The use of this configuration has been deprecated and may be removed in any
2320# release after Mitaka. It is recommended that instead of relying on this
2321# option,
2322# an explicit value should be passed to 'create_networks()' as a keyword
2323# argument
2324# with the name 'share_address'.
2325# (boolean value)
2326# This option is deprecated for removal since 2014.2.
2327# Its value may be silently ignored in the future.
2328#share_dhcp_address=false
2329
2330# DEPRECATED: Whether to use Neutron or Nova Network as the back end for
2331# networking. Defaults to False (indicating Nova network).Set to True to use
2332# neutron. (boolean value)
2333# This option is deprecated for removal since 15.0.0.
2334# Its value may be silently ignored in the future.
2335# Reason:
2336# nova-network is deprecated, as are any related configuration options.
2337#use_neutron=true
2338
2339#
2340# URL for LDAP server which will store DNS entries
2341#
2342# Possible values:
2343#
2344# * A valid LDAP URL representing the server
2345# (uri value)
2346#ldap_dns_url=ldap://ldap.example.com:389
2347
2348# Bind user for LDAP server (string value)
2349#ldap_dns_user=uid=admin,ou=people,dc=example,dc=org
2350
2351# Bind user's password for LDAP server (string value)
2352#ldap_dns_password=password
2353
2354#
2355# Hostmaster for LDAP DNS driver Statement of Authority
2356#
2357# Possible values:
2358#
2359# * Any valid string representing LDAP DNS hostmaster.
2360# (string value)
2361#ldap_dns_soa_hostmaster=hostmaster@example.org
2362
2363#
2364# DNS Servers for LDAP DNS driver
2365#
2366# Possible values:
2367#
2368# * A valid URL representing a DNS server
2369# (multi valued)
2370#ldap_dns_servers=dns.example.org
2371
2372#
2373# Base distinguished name for the LDAP search query
2374#
2375# This option helps to decide where to look up the host in LDAP.
2376# (string value)
2377#ldap_dns_base_dn=ou=hosts,dc=example,dc=org
2378
2379#
2380# Refresh interval (in seconds) for LDAP DNS driver Start of Authority
2381#
2382# Time interval, a secondary/slave DNS server waits before requesting for
2383# primary DNS server's current SOA record. If the records are different,
2384# secondary DNS server will request a zone transfer from primary.
2385#
2386# NOTE: Lower values would cause more traffic.
2387# (integer value)
2388#ldap_dns_soa_refresh=1800
2389
2390#
2391# Retry interval (in seconds) for LDAP DNS driver Start of Authority
2392#
2393# Time interval, a secondary/slave DNS server should wait, if an
2394# attempt to transfer zone failed during the previous refresh interval.
2395# (integer value)
2396#ldap_dns_soa_retry=3600
2397
2398#
2399# Expiry interval (in seconds) for LDAP DNS driver Start of Authority
2400#
2401# Time interval, a secondary/slave DNS server holds the information
2402# before it is no longer considered authoritative.
2403# (integer value)
2404#ldap_dns_soa_expiry=86400
2405
2406#
2407# Minimum interval (in seconds) for LDAP DNS driver Start of Authority
2408#
2409# It is Minimum time-to-live applies for all resource records in the
2410# zone file. This value is supplied to other servers how long they
2411# should keep the data in cache.
2412# (integer value)
2413#ldap_dns_soa_minimum=7200
2414
2415# DEPRECATED: The topic network nodes listen on (string value)
2416# This option is deprecated for removal since 15.0.0.
2417# Its value may be silently ignored in the future.
2418# Reason:
2419# There is no need to let users choose the RPC topic for all services - there
2420# is little gain from this. Furthermore, it makes it really easy to break Nova
2421# by using this option.
2422#network_topic=network
2423
2424# DEPRECATED:
2425# Default value for multi_host in networks.
2426#
2427# nova-network service can operate in a multi-host or single-host mode.
2428# In multi-host mode each compute node runs a copy of nova-network and the
2429# instances on that compute node use the compute node as a gateway to the
2430# Internet. Where as in single-host mode, a central server runs the nova-network
2431# service. All compute nodes forward traffic from the instances to the
2432# cloud controller which then forwards traffic to the Internet.
2433#
2434# If this options is set to true, some rpc network calls will be sent directly
2435# to host.
2436#
2437# Note that this option is only used when using nova-network instead of
2438# Neutron in your deployment.
2439#
2440# Related options:
2441#
2442# * use_neutron
2443# (boolean value)
2444# This option is deprecated for removal since 15.0.0.
2445# Its value may be silently ignored in the future.
2446# Reason:
2447# nova-network is deprecated, as are any related configuration options.
2448#multi_host=false
2449
2450# DEPRECATED:
2451# Driver to use for network creation.
2452#
2453# Network driver initializes (creates bridges and so on) only when the
2454# first VM lands on a host node. All network managers configure the
2455# network using network drivers. The driver is not tied to any particular
2456# network manager.
2457#
2458# The default Linux driver implements vlans, bridges, and iptables rules
2459# using linux utilities.
2460#
2461# Note that this option is only used when using nova-network instead
2462# of Neutron in your deployment.
2463#
2464# Related options:
2465#
2466# * use_neutron
2467# (string value)
2468# This option is deprecated for removal since 15.0.0.
2469# Its value may be silently ignored in the future.
2470# Reason:
2471# nova-network is deprecated, as are any related configuration options.
2472#network_driver=nova.network.linux_net
2473
2474#
2475# Firewall driver to use with ``nova-network`` service.
2476#
2477# This option only applies when using the ``nova-network`` service. When using
2478# another networking services, such as Neutron, this should be to set to the
2479# ``nova.virt.firewall.NoopFirewallDriver``.
2480#
2481# If unset (the default), this will default to the hypervisor-specified
2482# default driver.
2483#
2484# Possible values:
2485#
2486# * nova.virt.firewall.IptablesFirewallDriver
2487# * nova.virt.firewall.NoopFirewallDriver
2488# * nova.virt.libvirt.firewall.IptablesFirewallDriver
2489# * [...]
2490#
2491# Related options:
2492#
2493# * ``use_neutron``: This must be set to ``False`` to enable ``nova-network``
2494# networking
2495# (string value)
2496#firewall_driver=<None>
2497firewall_driver = nova.virt.firewall.NoopFirewallDriver
2498
2499#
2500# Determine whether to allow network traffic from same network.
2501#
2502# When set to true, hosts on the same subnet are not filtered and are allowed
2503# to pass all types of traffic between them. On a flat network, this allows
2504# all instances from all projects unfiltered communication. With VLAN
2505# networking, this allows access between instances within the same project.
2506#
2507# This option only applies when using the ``nova-network`` service. When using
2508# another networking services, such as Neutron, security groups or other
2509# approaches should be used.
2510#
2511# Possible values:
2512#
2513# * True: Network traffic should be allowed pass between all instances on the
2514# same network, regardless of their tenant and security policies
2515# * False: Network traffic should not be allowed pass between instances unless
2516# it is unblocked in a security group
2517#
2518# Related options:
2519#
2520# * ``use_neutron``: This must be set to ``False`` to enable ``nova-network``
2521# networking
2522# * ``firewall_driver``: This must be set to
2523# ``nova.virt.libvirt.firewall.IptablesFirewallDriver`` to ensure the
2524# libvirt firewall driver is enabled.
2525# (boolean value)
2526#allow_same_net_traffic=true
2527
2528#
2529# Filename that will be used for storing websocket frames received
2530# and sent by a proxy service (like VNC, spice, serial) running on this host.
2531# If this is not set, no recording will be done.
2532# (string value)
2533#record=<None>
2534
2535# Run as a background process. (boolean value)
2536#daemon=false
2537
2538# Disallow non-encrypted connections. (boolean value)
2539#ssl_only=false
2540
2541# Set to True if source host is addressed with IPv6. (boolean value)
2542#source_is_ipv6=false
2543
2544# Path to SSL certificate file. (string value)
2545#cert=self.pem
2546
2547# SSL key file (if separate from cert). (string value)
2548#key=<None>
2549
2550#
2551# Path to directory with content which will be served by a web server.
2552# (string value)
2553#web=/usr/share/spice-html5
2554
2555#
2556# The directory where the Nova python modules are installed.
2557#
2558# This directory is used to store template files for networking and remote
2559# console access. It is also the default path for other config options which
2560# need to persist Nova internal data. It is very unlikely that you need to
2561# change this option from its default value.
2562#
2563# Possible values:
2564#
2565# * The full path to a directory.
2566#
2567# Related options:
2568#
2569# * ``state_path``
2570# (string value)
2571#pybasedir=/build/nova-elxmSs/nova-15.0.2
2572
2573#
2574# The directory where the Nova binaries are installed.
2575#
2576# This option is only relevant if the networking capabilities from Nova are
2577# used (see services below). Nova's networking capabilities are targeted to
2578# be fully replaced by Neutron in the future. It is very unlikely that you need
2579# to change this option from its default value.
2580#
2581# Possible values:
2582#
2583# * The full path to a directory.
2584# (string value)
2585#bindir=/usr/local/bin
2586
2587#
2588# The top-level directory for maintaining Nova's state.
2589#
2590# This directory is used to store Nova's internal state. It is used by a
2591# variety of other config options which derive from this. In some scenarios
2592# (for example migrations) it makes sense to use a storage location which is
2593# shared between multiple compute hosts (for example via NFS). Unless the
2594# option ``instances_path`` gets overwritten, this directory can grow very
2595# large.
2596#
2597# Possible values:
2598#
2599# * The full path to a directory. Defaults to value provided in ``pybasedir``.
2600# (string value)
2601state_path=/var/lib/nova
2602
2603#
2604# Number of seconds indicating how frequently the state of services on a
2605# given hypervisor is reported. Nova needs to know this to determine the
2606# overall health of the deployment.
2607#
2608# Related Options:
2609#
2610# * service_down_time
2611# report_interval should be less than service_down_time. If service_down_time
2612# is less than report_interval, services will routinely be considered down,
2613# because they report in too rarely.
2614# (integer value)
2615#report_interval=10
2616report_interval = {{ compute.get('report_interval', '60') }}
2617
2618#
2619# Maximum time in seconds since last check-in for up service
2620#
2621# Each compute node periodically updates their database status based on the
2622# specified report interval. If the compute node hasn't updated the status
2623# for more than service_down_time, then the compute node is considered down.
2624#
2625# Related Options:
2626#
2627# * report_interval (service_down_time should not be less than report_interval)
2628# (integer value)
2629#service_down_time=60
2630service_down_time=90
2631
2632#
2633# Enable periodic tasks.
2634#
2635# If set to true, this option allows services to periodically run tasks
2636# on the manager.
2637#
2638# In case of running multiple schedulers or conductors you may want to run
2639# periodic tasks on only one host - in this case disable this option for all
2640# hosts but one.
2641# (boolean value)
2642#periodic_enable=true
2643
2644#
2645# Number of seconds to randomly delay when starting the periodic task
2646# scheduler to reduce stampeding.
2647#
2648# When compute workers are restarted in unison across a cluster,
2649# they all end up running the periodic tasks at the same time
2650# causing problems for the external services. To mitigate this
2651# behavior, periodic_fuzzy_delay option allows you to introduce a
2652# random initial delay when starting the periodic task scheduler.
2653#
2654# Possible Values:
2655#
2656# * Any positive integer (in seconds)
2657# * 0 : disable the random delay
2658# (integer value)
2659# Minimum value: 0
2660#periodic_fuzzy_delay=60
2661
2662# List of APIs to be enabled by default. (list value)
2663enabled_apis=osapi_compute,metadata
2664
2665#
2666# List of APIs with enabled SSL.
2667#
2668# Nova provides SSL support for the API servers. enabled_ssl_apis option
2669# allows configuring the SSL support.
2670# (list value)
2671#enabled_ssl_apis =
2672
2673#
2674# IP address on which the OpenStack API will listen.
2675#
2676# The OpenStack API service listens on this IP address for incoming
2677# requests.
2678# (string value)
2679#osapi_compute_listen=0.0.0.0
2680
2681#
2682# Port on which the OpenStack API will listen.
2683#
2684# The OpenStack API service listens on this port number for incoming
2685# requests.
2686# (port value)
2687# Minimum value: 0
2688# Maximum value: 65535
2689#osapi_compute_listen_port=8774
2690
2691#
2692# Number of workers for OpenStack API service. The default will be the number
2693# of CPUs available.
2694#
2695# OpenStack API services can be configured to run as multi-process (workers).
2696# This overcomes the problem of reduction in throughput when API request
2697# concurrency increases. OpenStack API service will run in the specified
2698# number of processes.
2699#
2700# Possible Values:
2701#
2702# * Any positive integer
2703# * None (default value)
2704# (integer value)
2705# Minimum value: 1
2706#osapi_compute_workers=<None>
2707
2708#
2709# IP address on which the metadata API will listen.
2710#
2711# The metadata API service listens on this IP address for incoming
2712# requests.
2713# (string value)
2714#metadata_listen=0.0.0.0
2715
2716#
2717# Port on which the metadata API will listen.
2718#
2719# The metadata API service listens on this port number for incoming
2720# requests.
2721# (port value)
2722# Minimum value: 0
2723# Maximum value: 65535
2724#metadata_listen_port=8775
2725
2726#
2727# Number of workers for metadata service. If not specified the number of
2728# available CPUs will be used.
2729#
2730# The metadata service can be configured to run as multi-process (workers).
2731# This overcomes the problem of reduction in throughput when API request
2732# concurrency increases. The metadata service will run in the specified
2733# number of processes.
2734#
2735# Possible Values:
2736#
2737# * Any positive integer
2738# * None (default value)
2739# (integer value)
2740# Minimum value: 1
2741#metadata_workers=<None>
2742
2743# Full class name for the Manager for network (string value)
2744# Allowed values: nova.network.manager.FlatManager, nova.network.manager.FlatDHCPManager, nova.network.manager.VlanManager
2745#network_manager=nova.network.manager.VlanManager
2746
2747#
2748# This option specifies the driver to be used for the servicegroup service.
2749#
2750# ServiceGroup API in nova enables checking status of a compute node. When a
2751# compute worker running the nova-compute daemon starts, it calls the join API
2752# to join the compute group. Services like nova scheduler can query the
2753# ServiceGroup API to check if a node is alive. Internally, the ServiceGroup
2754# client driver automatically updates the compute worker status. There are
2755# multiple backend implementations for this service: Database ServiceGroup
2756# driver
2757# and Memcache ServiceGroup driver.
2758#
2759# Possible Values:
2760#
2761# * db : Database ServiceGroup driver
2762# * mc : Memcache ServiceGroup driver
2763#
2764# Related Options:
2765#
2766# * service_down_time (maximum time since last check-in for up service)
2767# (string value)
2768# Allowed values: db, mc
2769#servicegroup_driver=db
2770
2771#
2772# From oslo.log
2773#
2774
2775# If set to true, the logging level will be set to DEBUG instead of the default
2776# INFO level. (boolean value)
2777# Note: This option can be changed without restarting.
2778#debug=false
2779debug=false
2780
2781# DEPRECATED: If set to false, the logging level will be set to WARNING instead
2782# of the default INFO level. (boolean value)
2783# This option is deprecated for removal.
2784# Its value may be silently ignored in the future.
2785#verbose=true
2786verbose=true
2787
2788# The name of a logging configuration file. This file is appended to any
2789# existing logging configuration files. For details about logging configuration
2790# files, see the Python logging module documentation. Note that when logging
2791# configuration files are used then all logging configuration is set in the
2792# configuration file and other logging configuration options are ignored (for
2793# example, logging_context_format_string). (string value)
2794# Note: This option can be changed without restarting.
2795# Deprecated group/name - [DEFAULT]/log_config
2796#log_config_append=<None>
2797
2798# Defines the format string for %%(asctime)s in log records. Default:
2799# %(default)s . This option is ignored if log_config_append is set. (string
2800# value)
2801#log_date_format=%Y-%m-%d %H:%M:%S
2802
2803# (Optional) Name of log file to send logging output to. If no default is set,
2804# logging will go to stderr as defined by use_stderr. This option is ignored if
2805# log_config_append is set. (string value)
2806# Deprecated group/name - [DEFAULT]/logfile
2807#log_file=<None>
2808
2809# (Optional) The base directory used for relative log_file paths. This option
2810# is ignored if log_config_append is set. (string value)
2811# Deprecated group/name - [DEFAULT]/logdir
2812log_dir=/var/log/nova
2813
2814# Uses logging handler designed to watch file system. When log file is moved or
2815# removed this handler will open a new log file with specified path
2816# instantaneously. It makes sense only if log_file option is specified and Linux
2817# platform is used. This option is ignored if log_config_append is set. (boolean
2818# value)
2819#watch_log_file=false
2820
2821# Use syslog for logging. Existing syslog format is DEPRECATED and will be
2822# changed later to honor RFC5424. This option is ignored if log_config_append is
2823# set. (boolean value)
2824#use_syslog=false
2825
2826# Syslog facility to receive log lines. This option is ignored if
2827# log_config_append is set. (string value)
2828#syslog_log_facility=LOG_USER
2829
2830# Log output to standard error. This option is ignored if log_config_append is
2831# set. (boolean value)
2832#use_stderr=false
2833
2834# Format string to use for log messages with context. (string value)
2835#logging_context_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
2836
2837# Format string to use for log messages when context is undefined. (string
2838# value)
2839#logging_default_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
2840
2841# Additional data to append to log message when logging level for the message is
2842# DEBUG. (string value)
2843#logging_debug_format_suffix=%(funcName)s %(pathname)s:%(lineno)d
2844
2845# Prefix each line of exception output with this format. (string value)
2846#logging_exception_prefix=%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
2847
2848# Defines the format string for %(user_identity)s that is used in
2849# logging_context_format_string. (string value)
2850#logging_user_identity_format=%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
2851
2852# List of package logging levels in logger=LEVEL pairs. This option is ignored
2853# if log_config_append is set. (list value)
2854#default_log_levels=amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
2855
2856# Enables or disables publication of error events. (boolean value)
2857#publish_errors=false
2858
2859# The format for an instance that is passed with the log message. (string value)
2860#instance_format="[instance: %(uuid)s] "
2861
2862# The format for an instance UUID that is passed with the log message. (string
2863# value)
2864#instance_uuid_format="[instance: %(uuid)s] "
2865
2866# Interval, number of seconds, of log rate limiting. (integer value)
2867#rate_limit_interval=0
2868
2869# Maximum number of logged messages per rate_limit_interval. (integer value)
2870#rate_limit_burst=0
2871
2872# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or
2873# empty string. Logs with level greater or equal to rate_limit_except_level are
2874# not filtered. An empty string means that all levels are filtered. (string
2875# value)
2876#rate_limit_except_level=CRITICAL
2877
2878# Enables or disables fatal status of deprecations. (boolean value)
2879#fatal_deprecations=false
2880
2881#
2882# From oslo.messaging
2883#
2884
2885# Size of RPC connection pool. (integer value)
2886# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size
2887#rpc_conn_pool_size=30
2888
2889# The pool size limit for connections expiration policy (integer value)
2890#conn_pool_min_size=2
2891
2892# The time-to-live in sec of idle connections in the pool (integer value)
2893#conn_pool_ttl=1200
2894
2895# ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP.
2896# The "host" option should point or resolve to this address. (string value)
2897# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_address
2898#rpc_zmq_bind_address=*
2899
2900# MatchMaker driver. (string value)
2901# Allowed values: redis, sentinel, dummy
2902# Deprecated group/name - [DEFAULT]/rpc_zmq_matchmaker
2903#rpc_zmq_matchmaker=redis
2904
2905# Number of ZeroMQ contexts, defaults to 1. (integer value)
2906# Deprecated group/name - [DEFAULT]/rpc_zmq_contexts
2907#rpc_zmq_contexts=1
2908
2909# Maximum number of ingress messages to locally buffer per topic. Default is
2910# unlimited. (integer value)
2911# Deprecated group/name - [DEFAULT]/rpc_zmq_topic_backlog
2912#rpc_zmq_topic_backlog=<None>
2913
2914# Directory for holding IPC sockets. (string value)
2915# Deprecated group/name - [DEFAULT]/rpc_zmq_ipc_dir
2916#rpc_zmq_ipc_dir=/var/run/openstack
2917
2918# Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
2919# "host" option, if running Nova. (string value)
2920# Deprecated group/name - [DEFAULT]/rpc_zmq_host
2921#rpc_zmq_host=localhost
2922
2923# Number of seconds to wait before all pending messages will be sent after
2924# closing a socket. The default value of -1 specifies an infinite linger period.
2925# The value of 0 specifies no linger period. Pending messages shall be discarded
2926# immediately when the socket is closed. Positive values specify an upper bound
2927# for the linger period. (integer value)
2928# Deprecated group/name - [DEFAULT]/rpc_cast_timeout
2929#zmq_linger=-1
2930zmq_linger=30
2931
2932# The default number of seconds that poll should wait. Poll raises timeout
2933# exception when timeout expired. (integer value)
2934# Deprecated group/name - [DEFAULT]/rpc_poll_timeout
2935#rpc_poll_timeout=1
2936
2937# Expiration timeout in seconds of a name service record about existing target (
2938# < 0 means no timeout). (integer value)
2939# Deprecated group/name - [DEFAULT]/zmq_target_expire
2940#zmq_target_expire=300
2941
2942# Update period in seconds of a name service record about existing target.
2943# (integer value)
2944# Deprecated group/name - [DEFAULT]/zmq_target_update
2945#zmq_target_update=180
2946
2947# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean
2948# value)
2949# Deprecated group/name - [DEFAULT]/use_pub_sub
2950#use_pub_sub=false
2951
2952# Use ROUTER remote proxy. (boolean value)
2953# Deprecated group/name - [DEFAULT]/use_router_proxy
2954#use_router_proxy=false
2955
2956# This option makes direct connections dynamic or static. It makes sense only
2957# with use_router_proxy=False which means to use direct connections for direct
2958# message types (ignored otherwise). (boolean value)
2959#use_dynamic_connections=false
2960
2961# How many additional connections to a host will be made for failover reasons.
2962# This option is actual only in dynamic connections mode. (integer value)
2963#zmq_failover_connections=2
2964
2965# Minimal port number for random ports range. (port value)
2966# Minimum value: 0
2967# Maximum value: 65535
2968# Deprecated group/name - [DEFAULT]/rpc_zmq_min_port
2969#rpc_zmq_min_port=49153
2970
2971# Maximal port number for random ports range. (integer value)
2972# Minimum value: 1
2973# Maximum value: 65536
2974# Deprecated group/name - [DEFAULT]/rpc_zmq_max_port
2975#rpc_zmq_max_port=65536
2976
2977# Number of retries to find free port number before fail with ZMQBindError.
2978# (integer value)
2979# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_port_retries
2980#rpc_zmq_bind_port_retries=100
2981
2982# Default serialization mechanism for serializing/deserializing
2983# outgoing/incoming messages (string value)
2984# Allowed values: json, msgpack
2985# Deprecated group/name - [DEFAULT]/rpc_zmq_serialization
2986#rpc_zmq_serialization=json
2987
2988# This option configures round-robin mode in zmq socket. True means not keeping
2989# a queue when server side disconnects. False means to keep queue and messages
2990# even if server is disconnected, when the server appears we send all
2991# accumulated messages to it. (boolean value)
2992#zmq_immediate=true
2993
2994# Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any
2995# other negative value) means to skip any overrides and leave it to OS default;
2996# 0 and 1 (or any other positive value) mean to disable and enable the option
2997# respectively. (integer value)
2998#zmq_tcp_keepalive=-1
2999
3000# The duration between two keepalive transmissions in idle condition. The unit
3001# is platform dependent, for example, seconds in Linux, milliseconds in Windows
3002# etc. The default value of -1 (or any other negative value and 0) means to skip
3003# any overrides and leave it to OS default. (integer value)
3004#zmq_tcp_keepalive_idle=-1
3005
3006# The number of retransmissions to be carried out before declaring that remote
3007# end is not available. The default value of -1 (or any other negative value and
3008# 0) means to skip any overrides and leave it to OS default. (integer value)
3009#zmq_tcp_keepalive_cnt=-1
3010
3011# The duration between two successive keepalive retransmissions, if
3012# acknowledgement to the previous keepalive transmission is not received. The
3013# unit is platform dependent, for example, seconds in Linux, milliseconds in
3014# Windows etc. The default value of -1 (or any other negative value and 0) means
3015# to skip any overrides and leave it to OS default. (integer value)
3016#zmq_tcp_keepalive_intvl=-1
3017
3018# Maximum number of (green) threads to work concurrently. (integer value)
3019#rpc_thread_pool_size=100
3020
3021# Expiration timeout in seconds of a sent/received message after which it is not
3022# tracked anymore by a client/server. (integer value)
3023#rpc_message_ttl=300
3024
3025# Wait for message acknowledgements from receivers. This mechanism works only
3026# via proxy without PUB/SUB. (boolean value)
3027#rpc_use_acks=false
3028
3029# Number of seconds to wait for an ack from a cast/call. After each retry
3030# attempt this timeout is multiplied by some specified multiplier. (integer
3031# value)
3032#rpc_ack_timeout_base=15
3033
3034# Number to multiply base ack timeout by after each retry attempt. (integer
3035# value)
3036#rpc_ack_timeout_multiplier=2
3037
3038# Default number of message sending attempts in case of any problems occurred:
3039# positive value N means at most N retries, 0 means no retries, None or -1 (or
3040# any other negative values) mean to retry forever. This option is used only if
3041# acknowledgments are enabled. (integer value)
3042#rpc_retry_attempts=3
3043
3044# List of publisher hosts SubConsumer can subscribe on. This option has higher
3045# priority then the default publishers list taken from the matchmaker. (list
3046# value)
3047#subscribe_on =
3048
3049# Size of executor thread pool. (integer value)
3050# Deprecated group/name - [DEFAULT]/rpc_thread_pool_size
3051#executor_thread_pool_size=64
3052executor_thread_pool_size=70
3053
3054# Seconds to wait for a response from a call. (integer value)
3055#rpc_response_timeout=60
3056rpc_response_timeout = 3600
3057
3058{%- if compute.message_queue.members is defined %}
3059transport_url = rabbit://{% for member in compute.message_queue.members -%}
3060 {{ compute.message_queue.user }}:{{ compute.message_queue.password }}@{{ member.host }}:{{ member.get('port', 5672) }}
3061 {%- if not loop.last -%},{%- endif -%}
3062 {%- endfor -%}
3063 /{{ compute.message_queue.virtual_host }}
3064{%- else %}
Andrey Shestakov3e742642017-05-06 00:12:02 +03003065transport_url = rabbit://{{ compute.message_queue.user }}:{{ compute.message_queue.password }}@{{ compute.message_queue.host }}:{{ compute.message_queue.port }}{{ compute.message_queue.virtual_host }}
Jakub Pavlik02a01c72017-04-11 16:04:51 +02003066{%- endif %}
3067
3068rpc_backend=rabbit
3069# DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers
3070# include amqp and zmq. (string value)
3071# This option is deprecated for removal.
3072# Its value may be silently ignored in the future.
3073# Reason: Replaced by [DEFAULT]/transport_url
3074#rpc_backend=rabbit
3075
3076# The default exchange under which topics are scoped. May be overridden by an
3077# exchange name specified in the transport_url option. (string value)
3078#control_exchange=openstack
3079
3080#
3081# From oslo.service.periodic_task
3082#
3083
3084# Some periodic tasks can be run in a separate process. Should we run them here?
3085# (boolean value)
3086#run_external_periodic_tasks=true
3087
3088#
3089# From oslo.service.service
3090#
3091
3092# Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>,
3093# where 0 results in listening on a random tcp port number; <port> results in
3094# listening on the specified port number (and not enabling backdoor if that port
3095# is in use); and <start>:<end> results in listening on the smallest unused port
3096# number within the specified range of port numbers. The chosen port is
3097# displayed in the service's log file. (string value)
3098#backdoor_port=<None>
3099
3100# Enable eventlet backdoor, using the provided path as a unix socket that can
3101# receive connections. This option is mutually exclusive with 'backdoor_port' in
3102# that only one should be provided. If both are provided then the existence of
3103# this option overrides the usage of that option. (string value)
3104#backdoor_socket=<None>
3105
3106# Enables or disables logging values of all registered options when starting a
3107# service (at DEBUG level). (boolean value)
3108#log_options=true
3109
3110# Specify a timeout after which a gracefully shutdown server will exit. Zero
3111# value means endless wait. (integer value)
3112#graceful_shutdown_timeout=60
3113
3114
3115[api]
3116#
3117# Options under this group are used to define Nova API.
3118
3119#
3120# From nova.conf
3121#
3122
3123#
3124# This determines the strategy to use for authentication: keystone or noauth2.
3125# 'noauth2' is designed for testing only, as it does no actual credential
3126# checking. 'noauth2' provides administrative credentials only if 'admin' is
3127# specified as the username.
3128# (string value)
3129# Allowed values: keystone, noauth2
3130# Deprecated group/name - [DEFAULT]/auth_strategy
3131#auth_strategy=keystone
3132auth_strategy=keystone
3133
3134#
3135# When True, the 'X-Forwarded-For' header is treated as the canonical remote
3136# address. When False (the default), the 'remote_address' header is used.
3137#
3138# You should only enable this if you have an HTML sanitizing proxy.
3139# (boolean value)
3140# Deprecated group/name - [DEFAULT]/use_forwarded_for
3141#use_forwarded_for=false
3142
3143#
3144# When gathering the existing metadata for a config drive, the EC2-style
3145# metadata is returned for all versions that don't appear in this option.
3146# As of the Liberty release, the available versions are:
3147#
3148# * 1.0
3149# * 2007-01-19
3150# * 2007-03-01
3151# * 2007-08-29
3152# * 2007-10-10
3153# * 2007-12-15
3154# * 2008-02-01
3155# * 2008-09-01
3156# * 2009-04-04
3157#
3158# The option is in the format of a single string, with each version separated
3159# by a space.
3160#
3161# Possible values:
3162#
3163# * Any string that represents zero or more versions, separated by spaces.
3164# (string value)
3165# Deprecated group/name - [DEFAULT]/config_drive_skip_versions
3166#config_drive_skip_versions=1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01
3167
3168#
3169# A list of vendordata providers.
3170#
3171# vendordata providers are how deployers can provide metadata via configdrive
3172# and metadata that is specific to their deployment. There are currently two
3173# supported providers: StaticJSON and DynamicJSON.
3174#
3175# StaticJSON reads a JSON file configured by the flag vendordata_jsonfile_path
3176# and places the JSON from that file into vendor_data.json and
3177# vendor_data2.json.
3178#
3179# DynamicJSON is configured via the vendordata_dynamic_targets flag, which is
3180# documented separately. For each of the endpoints specified in that flag, a
3181# section is added to the vendor_data2.json.
3182#
3183# For more information on the requirements for implementing a vendordata
3184# dynamic endpoint, please see the vendordata.rst file in the nova developer
3185# reference.
3186#
3187# Possible values:
3188#
3189# * A list of vendordata providers, with StaticJSON and DynamicJSON being
3190# current options.
3191#
3192# Related options:
3193#
3194# * vendordata_dynamic_targets
3195# * vendordata_dynamic_ssl_certfile
3196# * vendordata_dynamic_connect_timeout
3197# * vendordata_dynamic_read_timeout
3198# * vendordata_dynamic_failure_fatal
3199# (list value)
3200# Deprecated group/name - [DEFAULT]/vendordata_providers
3201#vendordata_providers =
3202
3203#
3204# A list of targets for the dynamic vendordata provider. These targets are of
3205# the form <name>@<url>.
3206#
3207# The dynamic vendordata provider collects metadata by contacting external REST
3208# services and querying them for information about the instance. This behaviour
3209# is documented in the vendordata.rst file in the nova developer reference.
3210# (list value)
3211# Deprecated group/name - [DEFAULT]/vendordata_dynamic_targets
3212#vendordata_dynamic_targets =
3213
3214#
3215# Path to an optional certificate file or CA bundle to verify dynamic
3216# vendordata REST services ssl certificates against.
3217#
3218# Possible values:
3219#
3220# * An empty string, or a path to a valid certificate file
3221#
3222# Related options:
3223#
3224# * vendordata_providers
3225# * vendordata_dynamic_targets
3226# * vendordata_dynamic_connect_timeout
3227# * vendordata_dynamic_read_timeout
3228# * vendordata_dynamic_failure_fatal
3229# (string value)
3230# Deprecated group/name - [DEFAULT]/vendordata_dynamic_ssl_certfile
3231#vendordata_dynamic_ssl_certfile =
3232
3233#
3234# Maximum wait time for an external REST service to connect.
3235#
3236# Possible values:
3237#
3238# * Any integer with a value greater than three (the TCP packet retransmission
3239# timeout). Note that instance start may be blocked during this wait time,
3240# so this value should be kept small.
3241#
3242# Related options:
3243#
3244# * vendordata_providers
3245# * vendordata_dynamic_targets
3246# * vendordata_dynamic_ssl_certfile
3247# * vendordata_dynamic_read_timeout
3248# * vendordata_dynamic_failure_fatal
3249# (integer value)
3250# Minimum value: 3
3251# Deprecated group/name - [DEFAULT]/vendordata_dynamic_connect_timeout
3252#vendordata_dynamic_connect_timeout=5
3253
3254#
3255# Maximum wait time for an external REST service to return data once connected.
3256#
3257# Possible values:
3258#
3259# * Any integer. Note that instance start is blocked during this wait time,
3260# so this value should be kept small.
3261#
3262# Related options:
3263#
3264# * vendordata_providers
3265# * vendordata_dynamic_targets
3266# * vendordata_dynamic_ssl_certfile
3267# * vendordata_dynamic_connect_timeout
3268# * vendordata_dynamic_failure_fatal
3269# (integer value)
3270# Minimum value: 0
3271# Deprecated group/name - [DEFAULT]/vendordata_dynamic_read_timeout
3272#vendordata_dynamic_read_timeout=5
3273
3274#
3275# Should failures to fetch dynamic vendordata be fatal to instance boot?
3276#
3277# Related options:
3278#
3279# * vendordata_providers
3280# * vendordata_dynamic_targets
3281# * vendordata_dynamic_ssl_certfile
3282# * vendordata_dynamic_connect_timeout
3283# * vendordata_dynamic_read_timeout
3284# (boolean value)
3285#vendordata_dynamic_failure_fatal=false
3286
3287#
3288# This option is the time (in seconds) to cache metadata. When set to 0,
3289# metadata caching is disabled entirely; this is generally not recommended for
3290# performance reasons. Increasing this setting should improve response times
3291# of the metadata API when under heavy load. Higher values may increase memory
3292# usage, and result in longer times for host metadata changes to take effect.
3293# (integer value)
3294# Minimum value: 0
3295# Deprecated group/name - [DEFAULT]/metadata_cache_expiration
3296#metadata_cache_expiration=15
3297
3298#
3299# Cloud providers may store custom data in vendor data file that will then be
3300# available to the instances via the metadata service, and to the rendering of
3301# config-drive. The default class for this, JsonFileVendorData, loads this
3302# information from a JSON file, whose path is configured by this option. If
3303# there is no path set by this option, the class returns an empty dictionary.
3304#
3305# Possible values:
3306#
3307# * Any string representing the path to the data file, or an empty string
3308# (default).
3309# (string value)
3310# Deprecated group/name - [DEFAULT]/vendordata_jsonfile_path
3311#vendordata_jsonfile_path=<None>
3312
3313#
3314# As a query can potentially return many thousands of items, you can limit the
3315# maximum number of items in a single response by setting this option.
3316# (integer value)
3317# Minimum value: 0
3318# Deprecated group/name - [DEFAULT]/osapi_max_limit
3319#max_limit=1000
3320
3321#
3322# This string is prepended to the normal URL that is returned in links to the
3323# OpenStack Compute API. If it is empty (the default), the URLs are returned
3324# unchanged.
3325#
3326# Possible values:
3327#
3328# * Any string, including an empty string (the default).
3329# (string value)
3330# Deprecated group/name - [DEFAULT]/osapi_compute_link_prefix
3331#compute_link_prefix=<None>
3332
3333#
3334# This string is prepended to the normal URL that is returned in links to
3335# Glance resources. If it is empty (the default), the URLs are returned
3336# unchanged.
3337#
3338# Possible values:
3339#
3340# * Any string, including an empty string (the default).
3341# (string value)
3342# Deprecated group/name - [DEFAULT]/osapi_glance_link_prefix
3343#glance_link_prefix=<None>
3344
3345#
3346# Operators can turn off the ability for a user to take snapshots of their
3347# instances by setting this option to False. When disabled, any attempt to
3348# take a snapshot will result in a HTTP 400 response ("Bad Request").
3349# (boolean value)
3350# Deprecated group/name - [DEFAULT]/allow_instance_snapshots
3351#allow_instance_snapshots=true
3352
3353#
3354# This option is a list of all instance states for which network address
3355# information should not be returned from the API.
3356#
3357# Possible values:
3358#
3359# A list of strings, where each string is a valid VM state, as defined in
3360# nova/compute/vm_states.py. As of the Newton release, they are:
3361#
3362# * "active"
3363# * "building"
3364# * "paused"
3365# * "suspended"
3366# * "stopped"
3367# * "rescued"
3368# * "resized"
3369# * "soft-delete"
3370# * "deleted"
3371# * "error"
3372# * "shelved"
3373# * "shelved_offloaded"
3374# (list value)
3375# Deprecated group/name - [DEFAULT]/osapi_hide_server_address_states
3376#hide_server_address_states=building
3377
3378# The full path to the fping binary. (string value)
3379# Deprecated group/name - [DEFAULT]/fping_path
3380#fping_path=/usr/sbin/fping
3381
3382#
3383# When True, the TenantNetworkController will query the Neutron API to get the
3384# default networks to use.
3385#
3386# Related options:
3387#
3388# * neutron_default_tenant_id
3389# (boolean value)
3390# Deprecated group/name - [DEFAULT]/use_neutron_default_nets
3391#use_neutron_default_nets=false
3392
3393#
3394# Tenant ID for getting the default network from Neutron API (also referred in
3395# some places as the 'project ID') to use.
3396#
3397# Related options:
3398#
3399# * use_neutron_default_nets
3400# (string value)
3401# Deprecated group/name - [DEFAULT]/neutron_default_tenant_id
3402#neutron_default_tenant_id=default
3403
3404#
3405# Enables returning of the instance password by the relevant server API calls
3406# such as create, rebuild, evacuate, or rescue. If the hypervisor does not
3407# support password injection, then the password returned will not be correct,
3408# so if your hypervisor does not support password injection, set this to False.
3409# (boolean value)
3410# Deprecated group/name - [DEFAULT]/enable_instance_password
3411#enable_instance_password=true
3412
3413
3414[api_database]
3415#
3416# The *Nova API Database* is a separate database which is used for information
3417# which is used across *cells*. This database is mandatory since the Mitaka
3418# release (13.0.0).
3419
3420#
3421# From nova.conf
3422#
3423
3424# The SQLAlchemy connection string to use to connect to the database. (string
3425# value)
3426connection=sqlite:////var/lib/nova/nova.sqlite
3427
3428# If True, SQLite uses synchronous mode. (boolean value)
3429#sqlite_synchronous=true
3430
3431# The SQLAlchemy connection string to use to connect to the slave database.
3432# (string value)
3433#slave_connection=<None>
3434
3435# The SQL mode to be used for MySQL sessions. This option, including the
3436# default, overrides any server-set SQL mode. To use whatever SQL mode is set by
3437# the server configuration, set this to no value. Example: mysql_sql_mode=
3438# (string value)
3439#mysql_sql_mode=TRADITIONAL
3440
3441# Timeout before idle SQL connections are reaped. (integer value)
3442#idle_timeout=3600
3443
3444# Maximum number of SQL connections to keep open in a pool. Setting a value of 0
3445# indicates no limit. (integer value)
3446#max_pool_size=<None>
3447
3448# Maximum number of database connection retries during startup. Set to -1 to
3449# specify an infinite retry count. (integer value)
3450#max_retries=10
3451
3452# Interval between retries of opening a SQL connection. (integer value)
3453#retry_interval=10
3454
3455# If set, use this value for max_overflow with SQLAlchemy. (integer value)
3456#max_overflow=<None>
3457
3458# Verbosity of SQL debugging information: 0=None, 100=Everything. (integer
3459# value)
3460#connection_debug=0
3461
3462# Add Python stack traces to SQL as comment strings. (boolean value)
3463#connection_trace=false
3464
3465# If set, use this value for pool_timeout with SQLAlchemy. (integer value)
3466#pool_timeout=<None>
3467
3468
3469[barbican]
3470
3471#
3472# From nova.conf
3473#
3474
3475# Use this endpoint to connect to Barbican, for example:
3476# "http://localhost:9311/" (string value)
3477#barbican_endpoint=<None>
3478
3479# Version of the Barbican API, for example: "v1" (string value)
3480#barbican_api_version=<None>
3481
3482# Use this endpoint to connect to Keystone (string value)
3483#auth_endpoint=http://localhost:5000/v3
3484
3485# Number of seconds to wait before retrying poll for key creation completion
3486# (integer value)
3487#retry_delay=1
3488
3489# Number of times to retry poll for key creation completion (integer value)
3490#number_of_retries=60
3491
3492
3493[cache]
3494
3495#
3496# From nova.conf
3497#
3498{%- if compute.cache is defined %}
3499backend = oslo_cache.memcache_pool
3500enabled = true
3501memcache_servers={%- for member in compute.cache.members %}{{ member.host }}:11211{% if not loop.last %},{% endif %}{%- endfor %}
3502{%- endif %}
3503# Prefix for building the configuration dictionary for the cache region. This
3504# should not need to be changed unless there is another dogpile.cache region
3505# with the same configuration name. (string value)
3506#config_prefix=cache.oslo
3507
3508# Default TTL, in seconds, for any cached item in the dogpile.cache region. This
3509# applies to any cached method that doesn't have an explicit cache expiration
3510# time defined for it. (integer value)
3511#expiration_time=600
3512
3513# Dogpile.cache backend module. It is recommended that Memcache or Redis
3514# (dogpile.cache.redis) be used in production deployments. For eventlet-based or
3515# highly threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is
3516# recommended. For low thread servers, dogpile.cache.memcached is recommended.
3517# Test environments with a single instance of the server can use the
3518# dogpile.cache.memory backend. (string value)
3519#backend=dogpile.cache.null
3520
3521# Arguments supplied to the backend module. Specify this option once per
3522# argument to be passed to the dogpile.cache backend. Example format:
3523# "<argname>:<value>". (multi valued)
3524#backend_argument =
3525
3526# Proxy classes to import that will affect the way the dogpile.cache backend
3527# functions. See the dogpile.cache documentation on changing-backend-behavior.
3528# (list value)
3529#proxies =
3530
3531# Global toggle for caching. (boolean value)
3532#enabled=false
3533
3534# Extra debugging from the cache backend (cache keys, get/set/delete/etc calls).
3535# This is only really useful if you need to see the specific cache-backend
3536# get/set/delete calls with the keys/values. Typically this should be left set
3537# to false. (boolean value)
3538#debug_cache_backend=false
3539
3540# Memcache servers in the format of "host:port". (dogpile.cache.memcache and
3541# oslo_cache.memcache_pool backends only). (list value)
3542#memcache_servers=localhost:11211
3543
3544# Number of seconds memcached server is considered dead before it is tried
3545# again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
3546# (integer value)
3547#memcache_dead_retry=300
3548
3549# Timeout in seconds for every call to a server. (dogpile.cache.memcache and
3550# oslo_cache.memcache_pool backends only). (integer value)
3551#memcache_socket_timeout=3
3552
3553# Max total number of open connections to every memcached server.
3554# (oslo_cache.memcache_pool backend only). (integer value)
3555#memcache_pool_maxsize=10
3556
3557# Number of seconds a connection to memcached is held unused in the pool before
3558# it is closed. (oslo_cache.memcache_pool backend only). (integer value)
3559#memcache_pool_unused_timeout=60
3560
3561# Number of seconds that an operation will wait to get a memcache client
3562# connection. (integer value)
3563#memcache_pool_connection_get_timeout=10
3564
3565
3566[cells]
3567#
3568# Cells options allow you to use cells functionality in openstack
3569# deployment.
3570#
3571# Note that the options in this group are only for cells v1 functionality, which
3572# is considered experimental and not recommended for new deployments. Cells v1
3573# is being replaced with cells v2, which starting in the 15.0.0 Ocata release is
3574# required and all Nova deployments will be at least a cells v2 cell of one.
3575#
3576
3577#
3578# From nova.conf
3579#
3580
3581# DEPRECATED:
3582# Topic.
3583#
3584# This is the message queue topic that cells nodes listen on. It is
3585# used when the cells service is started up to configure the queue,
3586# and whenever an RPC call to the scheduler is made.
3587#
3588# Possible values:
3589#
3590# * cells: This is the recommended and the default value.
3591# (string value)
3592# This option is deprecated for removal since 15.0.0.
3593# Its value may be silently ignored in the future.
3594# Reason:
3595# Configurable RPC topics provide little value and can result in a wide variety
3596# of errors. They should not be used.
3597#topic=cells
3598
3599#
3600# Enable cell v1 functionality.
3601#
3602# Note that cells v1 is considered experimental and not recommended for new
3603# Nova deployments. Cells v1 is being replaced by cells v2 which starting in
3604# the 15.0.0 Ocata release, all Nova deployments are at least a cells v2 cell
3605# of one. Setting this option, or any other options in the [cells] group, is
3606# not required for cells v2.
3607#
3608# When this functionality is enabled, it lets you to scale an OpenStack
3609# Compute cloud in a more distributed fashion without having to use
3610# complicated technologies like database and message queue clustering.
3611# Cells are configured as a tree. The top-level cell should have a host
3612# that runs a nova-api service, but no nova-compute services. Each
3613# child cell should run all of the typical nova-* services in a regular
3614# Compute cloud except for nova-api. You can think of cells as a normal
3615# Compute deployment in that each cell has its own database server and
3616# message queue broker.
3617#
3618# Related options:
3619#
3620# * name: A unique cell name must be given when this functionality
3621# is enabled.
3622# * cell_type: Cell type should be defined for all cells.
3623# (boolean value)
3624enable=False
3625
3626#
3627# Name of the current cell.
3628#
3629# This value must be unique for each cell. Name of a cell is used as
3630# its id, leaving this option unset or setting the same name for
3631# two or more cells may cause unexpected behaviour.
3632#
3633# Related options:
3634#
3635# * enabled: This option is meaningful only when cells service
3636# is enabled
3637# (string value)
3638#name=nova
3639
3640#
3641# Cell capabilities.
3642#
3643# List of arbitrary key=value pairs defining capabilities of the
3644# current cell to be sent to the parent cells. These capabilities
3645# are intended to be used in cells scheduler filters/weighers.
3646#
3647# Possible values:
3648#
3649# * key=value pairs list for example;
3650# ``hypervisor=xenserver;kvm,os=linux;windows``
3651# (list value)
3652#capabilities=hypervisor=xenserver;kvm,os=linux;windows
3653
3654#
3655# Call timeout.
3656#
3657# Cell messaging module waits for response(s) to be put into the
3658# eventlet queue. This option defines the seconds waited for
3659# response from a call to a cell.
3660#
3661# Possible values:
3662#
3663# * An integer, corresponding to the interval time in seconds.
3664# (integer value)
3665# Minimum value: 0
3666#call_timeout=60
3667
3668#
3669# Reserve percentage
3670#
3671# Percentage of cell capacity to hold in reserve, so the minimum
3672# amount of free resource is considered to be;
3673#
3674# min_free = total * (reserve_percent / 100.0)
3675#
3676# This option affects both memory and disk utilization.
3677#
3678# The primary purpose of this reserve is to ensure some space is
3679# available for users who want to resize their instance to be larger.
3680# Note that currently once the capacity expands into this reserve
3681# space this option is ignored.
3682#
3683# Possible values:
3684#
3685# * An integer or float, corresponding to the percentage of cell capacity to
3686# be held in reserve.
3687# (floating point value)
3688#reserve_percent=10.0
3689
3690#
3691# Type of cell.
3692#
3693# When cells feature is enabled the hosts in the OpenStack Compute
3694# cloud are partitioned into groups. Cells are configured as a tree.
3695# The top-level cell's cell_type must be set to ``api``. All other
3696# cells are defined as a ``compute cell`` by default.
3697#
3698# Related option:
3699#
3700# * quota_driver: Disable quota checking for the child cells.
3701# (nova.quota.NoopQuotaDriver)
3702# (string value)
3703# Allowed values: api, compute
3704#cell_type=compute
3705
3706#
3707# Mute child interval.
3708#
3709# Number of seconds after which a lack of capability and capacity
3710# update the child cell is to be treated as a mute cell. Then the
3711# child cell will be weighed as recommend highly that it be skipped.
3712#
3713# Possible values:
3714#
3715# * An integer, corresponding to the interval time in seconds.
3716# (integer value)
3717#mute_child_interval=300
3718
3719#
3720# Bandwidth update interval.
3721#
3722# Seconds between bandwidth usage cache updates for cells.
3723#
3724# Possible values:
3725#
3726# * An integer, corresponding to the interval time in seconds.
3727# (integer value)
3728#bandwidth_update_interval=600
3729
3730#
3731# Instance update sync database limit.
3732#
3733# Number of instances to pull from the database at one time for
3734# a sync. If there are more instances to update the results will
3735# be paged through.
3736#
3737# Possible values:
3738#
3739# * An integer, corresponding to a number of instances.
3740# (integer value)
3741#instance_update_sync_database_limit=100
3742
3743#
3744# Mute weight multiplier.
3745#
3746# Multiplier used to weigh mute children. Mute children cells are
3747# recommended to be skipped so their weight is multiplied by this
3748# negative value.
3749#
3750# Possible values:
3751#
3752# * Negative numeric number
3753# (floating point value)
3754#mute_weight_multiplier=-10000.0
3755
3756#
3757# Ram weight multiplier.
3758#
3759# Multiplier used for weighing ram. Negative numbers indicate that
3760# Compute should stack VMs on one host instead of spreading out new
3761# VMs to more hosts in the cell.
3762#
3763# Possible values:
3764#
3765# * Numeric multiplier
3766# (floating point value)
3767#ram_weight_multiplier=10.0
3768
3769#
3770# Offset weight multiplier
3771#
3772# Multiplier used to weigh offset weigher. Cells with higher
3773# weight_offsets in the DB will be preferred. The weight_offset
3774# is a property of a cell stored in the database. It can be used
3775# by a deployer to have scheduling decisions favor or disfavor
3776# cells based on the setting.
3777#
3778# Possible values:
3779#
3780# * Numeric multiplier
3781# (floating point value)
3782#offset_weight_multiplier=1.0
3783
3784#
3785# Instance updated at threshold
3786#
3787# Number of seconds after an instance was updated or deleted to
3788# continue to update cells. This option lets cells manager to only
3789# attempt to sync instances that have been updated recently.
3790# i.e., a threshold of 3600 means to only update instances that
3791# have modified in the last hour.
3792#
3793# Possible values:
3794#
3795# * Threshold in seconds
3796#
3797# Related options:
3798#
3799# * This value is used with the ``instance_update_num_instances``
3800# value in a periodic task run.
3801# (integer value)
3802#instance_updated_at_threshold=3600
3803
3804#
3805# Instance update num instances
3806#
3807# On every run of the periodic task, nova cells manager will attempt to
3808# sync instance_updated_at_threshold number of instances. When the
3809# manager gets the list of instances, it shuffles them so that multiple
3810# nova-cells services do not attempt to sync the same instances in
3811# lockstep.
3812#
3813# Possible values:
3814#
3815# * Positive integer number
3816#
3817# Related options:
3818#
3819# * This value is used with the ``instance_updated_at_threshold``
3820# value in a periodic task run.
3821# (integer value)
3822#instance_update_num_instances=1
3823
3824#
3825# Maximum hop count
3826#
3827# When processing a targeted message, if the local cell is not the
3828# target, a route is defined between neighbouring cells. And the
3829# message is processed across the whole routing path. This option
3830# defines the maximum hop counts until reaching the target.
3831#
3832# Possible values:
3833#
3834# * Positive integer value
3835# (integer value)
3836#max_hop_count=10
3837
3838#
3839# Cells scheduler.
3840#
3841# The class of the driver used by the cells scheduler. This should be
3842# the full Python path to the class to be used. If nothing is specified
3843# in this option, the CellsScheduler is used.
3844# (string value)
3845#scheduler=nova.cells.scheduler.CellsScheduler
3846
3847#
3848# RPC driver queue base.
3849#
3850# When sending a message to another cell by JSON-ifying the message
3851# and making an RPC cast to 'process_message', a base queue is used.
3852# This option defines the base queue name to be used when communicating
3853# between cells. Various topics by message type will be appended to this.
3854#
3855# Possible values:
3856#
3857# * The base queue name to be used when communicating between cells.
3858# (string value)
3859#rpc_driver_queue_base=cells.intercell
3860
3861#
3862# Scheduler filter classes.
3863#
3864# Filter classes the cells scheduler should use. An entry of
3865# "nova.cells.filters.all_filters" maps to all cells filters
3866# included with nova. As of the Mitaka release the following
3867# filter classes are available:
3868#
3869# Different cell filter: A scheduler hint of 'different_cell'
3870# with a value of a full cell name may be specified to route
3871# a build away from a particular cell.
3872#
3873# Image properties filter: Image metadata named
3874# 'hypervisor_version_requires' with a version specification
3875# may be specified to ensure the build goes to a cell which
3876# has hypervisors of the required version. If either the version
3877# requirement on the image or the hypervisor capability of the
3878# cell is not present, this filter returns without filtering out
3879# the cells.
3880#
3881# Target cell filter: A scheduler hint of 'target_cell' with a
3882# value of a full cell name may be specified to route a build to
3883# a particular cell. No error handling is done as there's no way
3884# to know whether the full path is a valid.
3885#
3886# As an admin user, you can also add a filter that directs builds
3887# to a particular cell.
3888#
3889# (list value)
3890#scheduler_filter_classes=nova.cells.filters.all_filters
3891
3892#
3893# Scheduler weight classes.
3894#
3895# Weigher classes the cells scheduler should use. An entry of
3896# "nova.cells.weights.all_weighers" maps to all cell weighers
3897# included with nova. As of the Mitaka release the following
3898# weight classes are available:
3899#
3900# mute_child: Downgrades the likelihood of child cells being
3901# chosen for scheduling requests, which haven't sent capacity
3902# or capability updates in a while. Options include
3903# mute_weight_multiplier (multiplier for mute children; value
3904# should be negative).
3905#
3906# ram_by_instance_type: Select cells with the most RAM capacity
3907# for the instance type being requested. Because higher weights
3908# win, Compute returns the number of available units for the
3909# instance type requested. The ram_weight_multiplier option defaults
3910# to 10.0 that adds to the weight by a factor of 10. Use a negative
3911# number to stack VMs on one host instead of spreading out new VMs
3912# to more hosts in the cell.
3913#
3914# weight_offset: Allows modifying the database to weight a particular
3915# cell. The highest weight will be the first cell to be scheduled for
3916# launching an instance. When the weight_offset of a cell is set to 0,
3917# it is unlikely to be picked but it could be picked if other cells
3918# have a lower weight, like if they're full. And when the weight_offset
3919# is set to a very high value (for example, '999999999999999'), it is
3920# likely to be picked if another cell do not have a higher weight.
3921# (list value)
3922#scheduler_weight_classes=nova.cells.weights.all_weighers
3923
3924#
3925# Scheduler retries.
3926#
3927# How many retries when no cells are available. Specifies how many
3928# times the scheduler tries to launch a new instance when no cells
3929# are available.
3930#
3931# Possible values:
3932#
3933# * Positive integer value
3934#
3935# Related options:
3936#
3937# * This value is used with the ``scheduler_retry_delay`` value
3938# while retrying to find a suitable cell.
3939# (integer value)
3940#scheduler_retries=10
3941
3942#
3943# Scheduler retry delay.
3944#
3945# Specifies the delay (in seconds) between scheduling retries when no
3946# cell can be found to place the new instance on. When the instance
3947# could not be scheduled to a cell after ``scheduler_retries`` in
3948# combination with ``scheduler_retry_delay``, then the scheduling
3949# of the instance failed.
3950#
3951# Possible values:
3952#
3953# * Time in seconds.
3954#
3955# Related options:
3956#
3957# * This value is used with the ``scheduler_retries`` value
3958# while retrying to find a suitable cell.
3959# (integer value)
3960#scheduler_retry_delay=2
3961
3962#
3963# DB check interval.
3964#
3965# Cell state manager updates cell status for all cells from the DB
3966# only after this particular interval time is passed. Otherwise cached
3967# status are used. If this value is 0 or negative all cell status are
3968# updated from the DB whenever a state is needed.
3969#
3970# Possible values:
3971#
3972# * Interval time, in seconds.
3973#
3974# (integer value)
3975#db_check_interval=60
3976
3977#
3978# Optional cells configuration.
3979#
3980# Configuration file from which to read cells configuration. If given,
3981# overrides reading cells from the database.
3982#
3983# Cells store all inter-cell communication data, including user names
3984# and passwords, in the database. Because the cells data is not updated
3985# very frequently, use this option to specify a JSON file to store
3986# cells data. With this configuration, the database is no longer
3987# consulted when reloading the cells data. The file must have columns
3988# present in the Cell model (excluding common database fields and the
3989# id column). You must specify the queue connection information through
3990# a transport_url field, instead of username, password, and so on.
3991#
3992# The transport_url has the following form:
3993# rabbit://USERNAME:PASSWORD@HOSTNAME:PORT/VIRTUAL_HOST
3994#
3995# Possible values:
3996#
3997# The scheme can be either qpid or rabbit, the following sample shows
3998# this optional configuration:
3999#
4000# {
4001# "parent": {
4002# "name": "parent",
4003# "api_url": "http://api.example.com:8774",
4004# "transport_url": "rabbit://rabbit.example.com",
4005# "weight_offset": 0.0,
4006# "weight_scale": 1.0,
4007# "is_parent": true
4008# },
4009# "cell1": {
4010# "name": "cell1",
4011# "api_url": "http://api.example.com:8774",
4012# "transport_url": "rabbit://rabbit1.example.com",
4013# "weight_offset": 0.0,
4014# "weight_scale": 1.0,
4015# "is_parent": false
4016# },
4017# "cell2": {
4018# "name": "cell2",
4019# "api_url": "http://api.example.com:8774",
4020# "transport_url": "rabbit://rabbit2.example.com",
4021# "weight_offset": 0.0,
4022# "weight_scale": 1.0,
4023# "is_parent": false
4024# }
4025# }
4026#
4027# (string value)
4028#cells_config=<None>
4029
4030
4031[cinder]
4032
4033#
4034# From nova.conf
4035#
4036os_region_name = {{ compute.identity.region }}
4037catalog_info=volumev2:cinderv2:internalURL
4038#
4039# Info to match when looking for cinder in the service catalog.
4040#
4041# Possible values:
4042#
4043# * Format is separated values of the form:
4044# <service_type>:<service_name>:<endpoint_type>
4045#
4046# Note: Nova does not support the Cinder v1 API since the Nova 15.0.0 Ocata
4047# release.
4048#
4049# Related options:
4050#
4051# * endpoint_template - Setting this option will override catalog_info
4052# (string value)
4053#catalog_info=volumev2:cinderv2:publicURL
4054
4055#
4056# If this option is set then it will override service catalog lookup with
4057# this template for cinder endpoint
4058#
4059# Possible values:
4060#
4061# * URL for cinder endpoint API
4062# e.g. http://localhost:8776/v2/%(project_id)s
4063#
4064# Note: Nova does not support the Cinder v1 API since the Nova 15.0.0 Ocata
4065# release.
4066#
4067# Related options:
4068#
4069# * catalog_info - If endpoint_template is not set, catalog_info will be used.
4070# (string value)
4071#endpoint_template=<None>
4072
4073#
4074# Region name of this node. This is used when picking the URL in the service
4075# catalog.
4076#
4077# Possible values:
4078#
4079# * Any string representing region name
4080# (string value)
4081#os_region_name=<None>
4082
4083#
4084# Number of times cinderclient should retry on any failed http call.
4085# 0 means connection is attempted only once. Setting it to any positive integer
4086# means that on failure connection is retried that many times e.g. setting it
4087# to 3 means total attempts to connect will be 4.
4088#
4089# Possible values:
4090#
4091# * Any integer value. 0 means connection is attempted only once
4092# (integer value)
4093# Minimum value: 0
4094#http_retries=3
4095
4096#
4097# Allow attach between instance and volume in different availability zones.
4098#
4099# If False, volumes attached to an instance must be in the same availability
4100# zone in Cinder as the instance availability zone in Nova.
4101# This also means care should be taken when booting an instance from a volume
4102# where source is not "volume" because Nova will attempt to create a volume
4103# using
4104# the same availability zone as what is assigned to the instance.
4105# If that AZ is not in Cinder (or allow_availability_zone_fallback=False in
4106# cinder.conf), the volume create request will fail and the instance will fail
4107# the build request.
4108# By default there is no availability zone restriction on volume attach.
4109# (boolean value)
4110#cross_az_attach=true
4111
4112
4113[cloudpipe]
4114
4115#
4116# From nova.conf
4117#
4118
4119#
4120# Image ID used when starting up a cloudpipe VPN client.
4121#
4122# An empty instance is created and configured with OpenVPN using
4123# boot_script_template. This instance would be snapshotted and stored
4124# in glance. ID of the stored image is used in 'vpn_image_id' to
4125# create cloudpipe VPN client.
4126#
4127# Possible values:
4128#
4129# * Any valid ID of a VPN image
4130# (string value)
4131# Deprecated group/name - [DEFAULT]/vpn_image_id
4132#vpn_image_id=0
4133
4134#
4135# Flavor for VPN instances.
4136#
4137# Possible values:
4138#
4139# * Any valid flavor name
4140# (string value)
4141# Deprecated group/name - [DEFAULT]/vpn_flavor
4142#vpn_flavor=m1.tiny
4143
4144#
4145# Template for cloudpipe instance boot script.
4146#
4147# Possible values:
4148#
4149# * Any valid path to a cloudpipe instance boot script template
4150#
4151# Related options:
4152#
4153# The following options are required to configure cloudpipe-managed
4154# OpenVPN server.
4155#
4156# * dmz_net
4157# * dmz_mask
4158# * cnt_vpn_clients
4159# (string value)
4160# Deprecated group/name - [DEFAULT]/boot_script_template
4161#boot_script_template=$pybasedir/nova/cloudpipe/bootscript.template
4162
4163#
4164# Network to push into OpenVPN config.
4165#
4166# Note: Above mentioned OpenVPN config can be found at
4167# /etc/openvpn/server.conf.
4168#
4169# Possible values:
4170#
4171# * Any valid IPv4/IPV6 address
4172#
4173# Related options:
4174#
4175# * boot_script_template - dmz_net is pushed into bootscript.template
4176# to configure cloudpipe-managed OpenVPN server
4177# (IP address value)
4178# Deprecated group/name - [DEFAULT]/dmz_net
4179#dmz_net=10.0.0.0
4180
4181#
4182# Netmask to push into OpenVPN config.
4183#
4184# Possible values:
4185#
4186# * Any valid IPv4/IPV6 netmask
4187#
4188# Related options:
4189#
4190# * dmz_net - dmz_net and dmz_mask is pushed into bootscript.template
4191# to configure cloudpipe-managed OpenVPN server
4192# * boot_script_template
4193# (IP address value)
4194# Deprecated group/name - [DEFAULT]/dmz_mask
4195#dmz_mask=255.255.255.0
4196
4197#
4198# Suffix to add to project name for VPN key and secgroups
4199#
4200# Possible values:
4201#
4202# * Any string value representing the VPN key suffix
4203# (string value)
4204# Deprecated group/name - [DEFAULT]/vpn_key_suffix
4205#vpn_key_suffix=-vpn
4206
4207
4208[conductor]
4209#
4210# Options under this group are used to define Conductor's communication,
4211# which manager should be act as a proxy between computes and database,
4212# and finally, how many worker processes will be used.
4213
4214#
4215# From nova.conf
4216#
4217
4218# DEPRECATED:
4219# Topic exchange name on which conductor nodes listen.
4220# (string value)
4221# This option is deprecated for removal since 15.0.0.
4222# Its value may be silently ignored in the future.
4223# Reason:
4224# There is no need to let users choose the RPC topic for all services - there
4225# is little gain from this. Furthermore, it makes it really easy to break Nova
4226# by using this option.
4227#topic=conductor
4228
4229#
4230# Number of workers for OpenStack Conductor service. The default will be the
4231# number of CPUs available.
4232# (integer value)
4233#workers=<None>
4234
4235
4236[console]
4237#
4238# Options under this group allow to tune the configuration of the console proxy
4239# service.
4240#
4241# Note: in configuration of every compute is a ``console_host`` option,
4242# which allows to select the console proxy service to connect to.
4243
4244#
4245# From nova.conf
4246#
4247
4248#
4249# Adds list of allowed origins to the console websocket proxy to allow
4250# connections from other origin hostnames.
4251# Websocket proxy matches the host header with the origin header to
4252# prevent cross-site requests. This list specifies if any there are
4253# values other than host are allowed in the origin header.
4254#
4255# Possible values:
4256#
4257# * A list where each element is an allowed origin hostnames, else an empty list
4258# (list value)
4259# Deprecated group/name - [DEFAULT]/console_allowed_origins
4260#allowed_origins =
4261
4262
4263[consoleauth]
4264
4265#
4266# From nova.conf
4267#
4268
4269#
4270# The lifetime of a console auth token.
4271#
4272# A console auth token is used in authorizing console access for a user.
4273# Once the auth token time to live count has elapsed, the token is
4274# considered expired. Expired tokens are then deleted.
4275# (integer value)
4276# Minimum value: 0
4277# Deprecated group/name - [DEFAULT]/console_token_ttl
4278#token_ttl=600
4279
4280
4281[cors]
4282
4283#
4284# From oslo.middleware
4285#
4286
4287# Indicate whether this resource may be shared with the domain received in the
4288# requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing
4289# slash. Example: https://horizon.example.com (list value)
4290#allowed_origin=<None>
4291
4292# Indicate that the actual request can include user credentials (boolean value)
4293#allow_credentials=true
4294
4295# Indicate which headers are safe to expose to the API. Defaults to HTTP Simple
4296# Headers. (list value)
4297#expose_headers=X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token,X-Service-Token
4298
4299# Maximum cache age of CORS preflight requests. (integer value)
4300#max_age=3600
4301
4302# Indicate which methods can be used during the actual request. (list value)
4303#allow_methods=GET,PUT,POST,DELETE,PATCH
4304
4305# Indicate which header field names may be used during the actual request. (list
4306# value)
4307#allow_headers=X-Auth-Token,X-Openstack-Request-Id,X-Identity-Status,X-Roles,X-Service-Catalog,X-User-Id,X-Tenant-Id
4308
4309
4310[cors.subdomain]
4311
4312#
4313# From oslo.middleware
4314#
4315
4316# Indicate whether this resource may be shared with the domain received in the
4317# requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing
4318# slash. Example: https://horizon.example.com (list value)
4319#allowed_origin=<None>
4320
4321# Indicate that the actual request can include user credentials (boolean value)
4322#allow_credentials=true
4323
4324# Indicate which headers are safe to expose to the API. Defaults to HTTP Simple
4325# Headers. (list value)
4326#expose_headers=X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token,X-Service-Token
4327
4328# Maximum cache age of CORS preflight requests. (integer value)
4329#max_age=3600
4330
4331# Indicate which methods can be used during the actual request. (list value)
4332#allow_methods=GET,PUT,POST,DELETE,PATCH
4333
4334# Indicate which header field names may be used during the actual request. (list
4335# value)
4336#allow_headers=X-Auth-Token,X-Openstack-Request-Id,X-Identity-Status,X-Roles,X-Service-Catalog,X-User-Id,X-Tenant-Id
4337
4338
4339[crypto]
4340
4341#
4342# From nova.conf
4343#
4344
4345#
4346# Filename of root CA (Certificate Authority). This is a container format
4347# and includes root certificates.
4348#
4349# Possible values:
4350#
4351# * Any file name containing root CA, cacert.pem is default
4352#
4353# Related options:
4354#
4355# * ca_path
4356# (string value)
4357# Deprecated group/name - [DEFAULT]/ca_file
4358#ca_file=cacert.pem
4359
4360#
4361# Filename of a private key.
4362#
4363# Related options:
4364#
4365# * keys_path
4366# (string value)
4367# Deprecated group/name - [DEFAULT]/key_file
4368#key_file=private/cakey.pem
4369
4370#
4371# Filename of root Certificate Revocation List (CRL). This is a list of
4372# certificates that have been revoked, and therefore, entities presenting
4373# those (revoked) certificates should no longer be trusted.
4374#
4375# Related options:
4376#
4377# * ca_path
4378# (string value)
4379# Deprecated group/name - [DEFAULT]/crl_file
4380#crl_file=crl.pem
4381
4382#
4383# Directory path where keys are located.
4384#
4385# Related options:
4386#
4387# * key_file
4388# (string value)
4389# Deprecated group/name - [DEFAULT]/keys_path
4390#keys_path=$state_path/keys
4391
4392#
4393# Directory path where root CA is located.
4394#
4395# Related options:
4396#
4397# * ca_file
4398# (string value)
4399# Deprecated group/name - [DEFAULT]/ca_path
4400#ca_path=$state_path/CA
4401
4402# Option to enable/disable use of CA for each project. (boolean value)
4403# Deprecated group/name - [DEFAULT]/use_project_ca
4404#use_project_ca=false
4405
4406#
4407# Subject for certificate for users, %s for
4408# project, user, timestamp
4409# (string value)
4410# Deprecated group/name - [DEFAULT]/user_cert_subject
4411#user_cert_subject=/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=%.16s-%.16s-%s
4412
4413#
4414# Subject for certificate for projects, %s for
4415# project, timestamp
4416# (string value)
4417# Deprecated group/name - [DEFAULT]/project_cert_subject
4418#project_cert_subject=/C=US/ST=California/O=OpenStack/OU=NovaDev/CN=project-ca-%.16s-%s
4419
4420
4421[database]
4422
4423#
4424# From oslo.db
4425#
4426
4427# DEPRECATED: The file name to use with SQLite. (string value)
4428# Deprecated group/name - [DEFAULT]/sqlite_db
4429# This option is deprecated for removal.
4430# Its value may be silently ignored in the future.
4431# Reason: Should use config option connection or slave_connection to connect the
4432# database.
4433#sqlite_db=oslo.sqlite
4434
4435# If True, SQLite uses synchronous mode. (boolean value)
4436# Deprecated group/name - [DEFAULT]/sqlite_synchronous
4437#sqlite_synchronous=true
4438
4439# The back end to use for the database. (string value)
4440# Deprecated group/name - [DEFAULT]/db_backend
4441#backend=sqlalchemy
4442
4443# The SQLAlchemy connection string to use to connect to the database. (string
4444# value)
4445# Deprecated group/name - [DEFAULT]/sql_connection
4446# Deprecated group/name - [DATABASE]/sql_connection
4447# Deprecated group/name - [sql]/connection
4448#connection=<None>
4449
4450# The SQLAlchemy connection string to use to connect to the slave database.
4451# (string value)
4452#slave_connection=<None>
4453
4454# The SQL mode to be used for MySQL sessions. This option, including the
4455# default, overrides any server-set SQL mode. To use whatever SQL mode is set by
4456# the server configuration, set this to no value. Example: mysql_sql_mode=
4457# (string value)
4458#mysql_sql_mode=TRADITIONAL
4459
4460# Timeout before idle SQL connections are reaped. (integer value)
4461# Deprecated group/name - [DEFAULT]/sql_idle_timeout
4462# Deprecated group/name - [DATABASE]/sql_idle_timeout
4463# Deprecated group/name - [sql]/idle_timeout
4464#idle_timeout=3600
4465
4466# Minimum number of SQL connections to keep open in a pool. (integer value)
4467# Deprecated group/name - [DEFAULT]/sql_min_pool_size
4468# Deprecated group/name - [DATABASE]/sql_min_pool_size
4469#min_pool_size=1
4470
4471# Maximum number of SQL connections to keep open in a pool. Setting a value of 0
4472# indicates no limit. (integer value)
4473# Deprecated group/name - [DEFAULT]/sql_max_pool_size
4474# Deprecated group/name - [DATABASE]/sql_max_pool_size
4475#max_pool_size=5
4476
4477# Maximum number of database connection retries during startup. Set to -1 to
4478# specify an infinite retry count. (integer value)
4479# Deprecated group/name - [DEFAULT]/sql_max_retries
4480# Deprecated group/name - [DATABASE]/sql_max_retries
4481#max_retries=10
4482
4483# Interval between retries of opening a SQL connection. (integer value)
4484# Deprecated group/name - [DEFAULT]/sql_retry_interval
4485# Deprecated group/name - [DATABASE]/reconnect_interval
4486#retry_interval=10
4487
4488# If set, use this value for max_overflow with SQLAlchemy. (integer value)
4489# Deprecated group/name - [DEFAULT]/sql_max_overflow
4490# Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
4491#max_overflow=50
4492
4493# Verbosity of SQL debugging information: 0=None, 100=Everything. (integer
4494# value)
4495# Minimum value: 0
4496# Maximum value: 100
4497# Deprecated group/name - [DEFAULT]/sql_connection_debug
4498#connection_debug=0
4499
4500# Add Python stack traces to SQL as comment strings. (boolean value)
4501# Deprecated group/name - [DEFAULT]/sql_connection_trace
4502#connection_trace=false
4503
4504# If set, use this value for pool_timeout with SQLAlchemy. (integer value)
4505# Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
4506#pool_timeout=<None>
4507
4508# Enable the experimental use of database reconnect on connection lost. (boolean
4509# value)
4510#use_db_reconnect=false
4511
4512# Seconds between retries of a database transaction. (integer value)
4513#db_retry_interval=1
4514
4515# If True, increases the interval between retries of a database operation up to
4516# db_max_retry_interval. (boolean value)
4517#db_inc_retry_interval=true
4518
4519# If db_inc_retry_interval is set, the maximum seconds between retries of a
4520# database operation. (integer value)
4521#db_max_retry_interval=10
4522
4523# Maximum retries in case of connection error or deadlock error before error is
4524# raised. Set to -1 to specify an infinite retry count. (integer value)
4525#db_max_retries=20
4526
4527#
4528# From oslo.db.concurrency
4529#
4530
4531# Enable the experimental use of thread pooling for all DB API calls (boolean
4532# value)
4533# Deprecated group/name - [DEFAULT]/dbapi_use_tpool
4534#use_tpool=false
4535
4536
4537[ephemeral_storage_encryption]
4538
4539#
4540# From nova.conf
4541#
4542
4543#
4544# Enables/disables LVM ephemeral storage encryption.
4545# (boolean value)
4546#enabled=false
4547
4548#
4549# Cipher-mode string to be used.
4550#
4551# The cipher and mode to be used to encrypt ephemeral storage. The set of
4552# cipher-mode combinations available depends on kernel support.
4553#
4554# Possible values:
4555#
4556# * Any crypto option listed in ``/proc/crypto``.
4557# (string value)
4558#cipher=aes-xts-plain64
4559
4560#
4561# Encryption key length in bits.
4562#
4563# The bit length of the encryption key to be used to encrypt ephemeral storage.
4564# In XTS mode only half of the bits are used for encryption key.
4565# (integer value)
4566# Minimum value: 1
4567#key_size=512
4568
4569
4570[filter_scheduler]
4571
4572#
4573# From nova.conf
4574#
4575
4576#
4577# Size of subset of best hosts selected by scheduler.
4578#
4579# New instances will be scheduled on a host chosen randomly from a subset of the
4580# N best hosts, where N is the value set by this option.
4581#
4582# Setting this to a value greater than 1 will reduce the chance that multiple
4583# scheduler processes handling similar requests will select the same host,
4584# creating a potential race condition. By selecting a host randomly from the N
4585# hosts that best fit the request, the chance of a conflict is reduced. However,
4586# the higher you set this value, the less optimal the chosen host may be for a
4587# given request.
4588#
4589# This option is only used by the FilterScheduler and its subclasses; if you use
4590# a different scheduler, this option has no effect.
4591#
4592# Possible values:
4593#
4594# * An integer, where the integer corresponds to the size of a host subset. Any
4595# integer is valid, although any value less than 1 will be treated as 1
4596# (integer value)
4597# Minimum value: 1
4598# Deprecated group/name - [DEFAULT]/scheduler_host_subset_size
4599#host_subset_size=1
4600
4601#
4602# The number of instances that can be actively performing IO on a host.
4603#
4604# Instances performing IO includes those in the following states: build, resize,
4605# snapshot, migrate, rescue, unshelve.
4606#
4607# This option is only used by the FilterScheduler and its subclasses; if you use
4608# a different scheduler, this option has no effect. Also note that this setting
4609# only affects scheduling if the 'io_ops_filter' filter is enabled.
4610#
4611# Possible values:
4612#
4613# * An integer, where the integer corresponds to the max number of instances
4614# that can be actively performing IO on any given host.
4615# (integer value)
4616# Deprecated group/name - [DEFAULT]/max_io_ops_per_host
4617#max_io_ops_per_host=8
4618
4619#
4620# Maximum number of instances that be active on a host.
4621#
4622# If you need to limit the number of instances on any given host, set this
4623# option
4624# to the maximum number of instances you want to allow. The num_instances_filter
4625# will reject any host that has at least as many instances as this option's
4626# value.
4627#
4628# This option is only used by the FilterScheduler and its subclasses; if you use
4629# a different scheduler, this option has no effect. Also note that this setting
4630# only affects scheduling if the 'num_instances_filter' filter is enabled.
4631#
4632# Possible values:
4633#
4634# * An integer, where the integer corresponds to the max instances that can be
4635# scheduled on a host.
4636# (integer value)
4637# Deprecated group/name - [DEFAULT]/max_instances_per_host
4638#max_instances_per_host=50
4639
4640#
4641# Enable querying of individual hosts for instance information.
4642#
4643# The scheduler may need information about the instances on a host in order to
4644# evaluate its filters and weighers. The most common need for this information
4645# is
4646# for the (anti-)affinity filters, which need to choose a host based on the
4647# instances already running on a host.
4648#
4649# If the configured filters and weighers do not need this information, disabling
4650# this option will improve performance. It may also be disabled when the
4651# tracking
4652# overhead proves too heavy, although this will cause classes requiring host
4653# usage data to query the database on each request instead.
4654#
4655# This option is only used by the FilterScheduler and its subclasses; if you use
4656# a different scheduler, this option has no effect.
4657# (boolean value)
4658# Deprecated group/name - [DEFAULT]/scheduler_tracks_instance_changes
4659#track_instance_changes=true
4660
4661#
4662# Filters that the scheduler can use.
4663#
4664# An unordered list of the filter classes the nova scheduler may apply. Only
4665# the
4666# filters specified in the 'scheduler_enabled_filters' option will be used, but
4667# any filter appearing in that option must also be included in this list.
4668#
4669# By default, this is set to all filters that are included with nova.
4670#
4671# This option is only used by the FilterScheduler and its subclasses; if you use
4672# a different scheduler, this option has no effect.
4673#
4674# Possible values:
4675#
4676# * A list of zero or more strings, where each string corresponds to the name of
4677# a filter that may be used for selecting a host
4678#
4679# Related options:
4680#
4681# * scheduler_enabled_filters
4682# (multi valued)
4683# Deprecated group/name - [DEFAULT]/scheduler_available_filters
4684#available_filters=nova.scheduler.filters.all_filters
4685
4686#
4687# Filters that the scheduler will use.
4688#
4689# An ordered list of filter class names that will be used for filtering
4690# hosts. Ignore the word 'default' in the name of this option: these filters
4691# will
4692# *always* be applied, and they will be applied in the order they are listed so
4693# place your most restrictive filters first to make the filtering process more
4694# efficient.
4695#
4696# This option is only used by the FilterScheduler and its subclasses; if you use
4697# a different scheduler, this option has no effect.
4698#
4699# Possible values:
4700#
4701# * A list of zero or more strings, where each string corresponds to the name of
4702# a filter to be used for selecting a host
4703#
4704# Related options:
4705#
4706# * All of the filters in this option *must* be present in the
4707# 'scheduler_available_filters' option, or a SchedulerHostFilterNotFound
4708# exception will be raised.
4709# (list value)
4710# Deprecated group/name - [DEFAULT]/scheduler_default_filters
4711#enabled_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,DiskFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ServerGroupAntiAffinityFilter,ServerGroupAffinityFilter
4712
4713#
4714# Filters used for filtering baremetal hosts.
4715#
4716# Filters are applied in order, so place your most restrictive filters first to
4717# make the filtering process more efficient.
4718#
4719# This option is only used by the FilterScheduler and its subclasses; if you use
4720# a different scheduler, this option has no effect.
4721#
4722# Possible values:
4723#
4724# * A list of zero or more strings, where each string corresponds to the name of
4725# a filter to be used for selecting a baremetal host
4726#
4727# Related options:
4728#
4729# * If the 'scheduler_use_baremetal_filters' option is False, this option has
4730# no effect.
4731# (list value)
4732# Deprecated group/name - [DEFAULT]/baremetal_scheduler_default_filters
4733#baremetal_enabled_filters=RetryFilter,AvailabilityZoneFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,ExactRamFilter,ExactDiskFilter,ExactCoreFilter
4734
4735#
4736# Enable baremetal filters.
4737#
4738# Set this to True to tell the nova scheduler that it should use the filters
4739# specified in the 'baremetal_scheduler_enabled_filters' option. If you are not
4740# scheduling baremetal nodes, leave this at the default setting of False.
4741#
4742# This option is only used by the FilterScheduler and its subclasses; if you use
4743# a different scheduler, this option has no effect.
4744#
4745# Related options:
4746#
4747# * If this option is set to True, then the filters specified in the
4748# 'baremetal_scheduler_enabled_filters' are used instead of the filters
4749# specified in 'scheduler_enabled_filters'.
4750# (boolean value)
4751# Deprecated group/name - [DEFAULT]/scheduler_use_baremetal_filters
4752#use_baremetal_filters=false
4753
4754#
4755# Weighers that the scheduler will use.
4756#
4757# Only hosts which pass the filters are weighed. The weight for any host starts
4758# at 0, and the weighers order these hosts by adding to or subtracting from the
4759# weight assigned by the previous weigher. Weights may become negative. An
4760# instance will be scheduled to one of the N most-weighted hosts, where N is
4761# 'scheduler_host_subset_size'.
4762#
4763# By default, this is set to all weighers that are included with Nova.
4764#
4765# This option is only used by the FilterScheduler and its subclasses; if you use
4766# a different scheduler, this option has no effect.
4767#
4768# Possible values:
4769#
4770# * A list of zero or more strings, where each string corresponds to the name of
4771# a weigher that will be used for selecting a host
4772# (list value)
4773# Deprecated group/name - [DEFAULT]/scheduler_weight_classes
4774#weight_classes=nova.scheduler.weights.all_weighers
4775
4776#
4777# Ram weight multipler ratio.
4778#
4779# This option determines how hosts with more or less available RAM are weighed.
4780# A
4781# positive value will result in the scheduler preferring hosts with more
4782# available RAM, and a negative number will result in the scheduler preferring
4783# hosts with less available RAM. Another way to look at it is that positive
4784# values for this option will tend to spread instances across many hosts, while
4785# negative values will tend to fill up (stack) hosts as much as possible before
4786# scheduling to a less-used host. The absolute value, whether positive or
4787# negative, controls how strong the RAM weigher is relative to other weighers.
4788#
4789# This option is only used by the FilterScheduler and its subclasses; if you use
4790# a different scheduler, this option has no effect. Also note that this setting
4791# only affects scheduling if the 'ram' weigher is enabled.
4792#
4793# Possible values:
4794#
4795# * An integer or float value, where the value corresponds to the multipler
4796# ratio for this weigher.
4797# (floating point value)
4798# Deprecated group/name - [DEFAULT]/ram_weight_multiplier
4799#ram_weight_multiplier=1.0
4800
4801#
4802# Disk weight multipler ratio.
4803#
4804# Multiplier used for weighing free disk space. Negative numbers mean to
4805# stack vs spread.
4806#
4807# This option is only used by the FilterScheduler and its subclasses; if you use
4808# a different scheduler, this option has no effect. Also note that this setting
4809# only affects scheduling if the 'ram' weigher is enabled.
4810#
4811# Possible values:
4812#
4813# * An integer or float value, where the value corresponds to the multipler
4814# ratio for this weigher.
4815# (floating point value)
4816# Deprecated group/name - [DEFAULT]/disk_weight_multiplier
4817#disk_weight_multiplier=1.0
4818
4819#
4820# IO operations weight multipler ratio.
4821#
4822# This option determines how hosts with differing workloads are weighed.
4823# Negative
4824# values, such as the default, will result in the scheduler preferring hosts
4825# with
4826# lighter workloads whereas positive values will prefer hosts with heavier
4827# workloads. Another way to look at it is that positive values for this option
4828# will tend to schedule instances onto hosts that are already busy, while
4829# negative values will tend to distribute the workload across more hosts. The
4830# absolute value, whether positive or negative, controls how strong the io_ops
4831# weigher is relative to other weighers.
4832#
4833# This option is only used by the FilterScheduler and its subclasses; if you use
4834# a different scheduler, this option has no effect. Also note that this setting
4835# only affects scheduling if the 'io_ops' weigher is enabled.
4836#
4837# Possible values:
4838#
4839# * An integer or float value, where the value corresponds to the multipler
4840# ratio for this weigher.
4841# (floating point value)
4842# Deprecated group/name - [DEFAULT]/io_ops_weight_multiplier
4843#io_ops_weight_multiplier=-1.0
4844
4845#
4846# Multiplier used for weighing hosts for group soft-affinity.
4847#
4848# Possible values:
4849#
4850# * An integer or float value, where the value corresponds to weight multiplier
4851# for hosts with group soft affinity. Only a positive value are meaningful, as
4852# negative values would make this behave as a soft anti-affinity weigher.
4853# (floating point value)
4854# Deprecated group/name - [DEFAULT]/soft_affinity_weight_multiplier
4855#soft_affinity_weight_multiplier=1.0
4856
4857#
4858# Multiplier used for weighing hosts for group soft-anti-affinity.
4859#
4860# Possible values:
4861#
4862# * An integer or float value, where the value corresponds to weight multiplier
4863# for hosts with group soft anti-affinity. Only a positive value are
4864# meaningful, as negative values would make this behave as a soft affinity
4865# weigher.
4866# (floating point value)
4867# Deprecated group/name - [DEFAULT]/soft_anti_affinity_weight_multiplier
4868#soft_anti_affinity_weight_multiplier=1.0
4869
4870#
4871# List of UUIDs for images that can only be run on certain hosts.
4872#
4873# If there is a need to restrict some images to only run on certain designated
4874# hosts, list those image UUIDs here.
4875#
4876# This option is only used by the FilterScheduler and its subclasses; if you use
4877# a different scheduler, this option has no effect. Also note that this setting
4878# only affects scheduling if the 'IsolatedHostsFilter' filter is enabled.
4879#
4880# Possible values:
4881#
4882# * A list of UUID strings, where each string corresponds to the UUID of an
4883# image
4884#
4885# Related options:
4886#
4887# * scheduler/isolated_hosts
4888# * scheduler/restrict_isolated_hosts_to_isolated_images
4889# (list value)
4890# Deprecated group/name - [DEFAULT]/isolated_images
4891#isolated_images =
4892
4893#
4894# List of hosts that can only run certain images.
4895#
4896# If there is a need to restrict some images to only run on certain designated
4897# hosts, list those host names here.
4898#
4899# This option is only used by the FilterScheduler and its subclasses; if you use
4900# a different scheduler, this option has no effect. Also note that this setting
4901# only affects scheduling if the 'IsolatedHostsFilter' filter is enabled.
4902#
4903# Possible values:
4904#
4905# * A list of strings, where each string corresponds to the name of a host
4906#
4907# Related options:
4908#
4909# * scheduler/isolated_images
4910# * scheduler/restrict_isolated_hosts_to_isolated_images
4911# (list value)
4912# Deprecated group/name - [DEFAULT]/isolated_hosts
4913#isolated_hosts =
4914
4915#
4916# Prevent non-isolated images from being built on isolated hosts.
4917#
4918# This option is only used by the FilterScheduler and its subclasses; if you use
4919# a different scheduler, this option has no effect. Also note that this setting
4920# only affects scheduling if the 'IsolatedHostsFilter' filter is enabled. Even
4921# then, this option doesn't affect the behavior of requests for isolated images,
4922# which will *always* be restricted to isolated hosts.
4923#
4924# Related options:
4925#
4926# * scheduler/isolated_images
4927# * scheduler/isolated_hosts
4928# (boolean value)
4929# Deprecated group/name - [DEFAULT]/restrict_isolated_hosts_to_isolated_images
4930#restrict_isolated_hosts_to_isolated_images=true
4931
4932#
4933# Image property namespace for use in the host aggregate.
4934#
4935# Images and hosts can be configured so that certain images can only be
4936# scheduled
4937# to hosts in a particular aggregate. This is done with metadata values set on
4938# the host aggregate that are identified by beginning with the value of this
4939# option. If the host is part of an aggregate with such a metadata key, the
4940# image
4941# in the request spec must have the value of that metadata in its properties in
4942# order for the scheduler to consider the host as acceptable.
4943#
4944# This option is only used by the FilterScheduler and its subclasses; if you use
4945# a different scheduler, this option has no effect. Also note that this setting
4946# only affects scheduling if the 'aggregate_image_properties_isolation' filter
4947# is
4948# enabled.
4949#
4950# Possible values:
4951#
4952# * A string, where the string corresponds to an image property namespace
4953#
4954# Related options:
4955#
4956# * aggregate_image_properties_isolation_separator
4957# (string value)
4958# Deprecated group/name - [DEFAULT]/aggregate_image_properties_isolation_namespace
4959#aggregate_image_properties_isolation_namespace=<None>
4960
4961#
4962# Separator character(s) for image property namespace and name.
4963#
4964# When using the aggregate_image_properties_isolation filter, the relevant
4965# metadata keys are prefixed with the namespace defined in the
4966# aggregate_image_properties_isolation_namespace configuration option plus a
4967# separator. This option defines the separator to be used.
4968#
4969# This option is only used by the FilterScheduler and its subclasses; if you use
4970# a different scheduler, this option has no effect. Also note that this setting
4971# only affects scheduling if the 'aggregate_image_properties_isolation' filter
4972# is enabled.
4973#
4974# Possible values:
4975#
4976# * A string, where the string corresponds to an image property namespace
4977# separator character
4978#
4979# Related options:
4980#
4981# * aggregate_image_properties_isolation_namespace
4982# (string value)
4983# Deprecated group/name - [DEFAULT]/aggregate_image_properties_isolation_separator
4984#aggregate_image_properties_isolation_separator=.
4985
4986
4987[glance]
4988# Configuration options for the Image service
4989
4990#
4991# From nova.conf
4992#
4993
4994#
4995# List of glance api servers endpoints available to nova.
4996#
4997# https is used for ssl-based glance api servers.
4998#
4999# Possible values:
5000#
5001# * A list of any fully qualified url of the form
5002# "scheme://hostname:port[/path]"
5003# (i.e. "http://10.0.1.0:9292" or "https://my.glance.server/image").
5004# (list value)
5005#api_servers=<None>
5006api_servers={{ compute.image.host }}:9292
5007
5008#
5009# Enable insecure SSL (https) requests to glance.
5010#
5011# This setting can be used to turn off verification of the glance server
5012# certificate against the certificate authorities.
5013# (boolean value)
5014#api_insecure=false
5015
5016#
5017# Enable glance operation retries.
5018#
5019# Specifies the number of retries when uploading / downloading
5020# an image to / from glance. 0 means no retries.
5021# (integer value)
5022# Minimum value: 0
5023#num_retries=0
5024
5025#
5026# List of url schemes that can be directly accessed.
5027#
5028# This option specifies a list of url schemes that can be downloaded
5029# directly via the direct_url. This direct_URL can be fetched from
5030# Image metadata which can be used by nova to get the
5031# image more efficiently. nova-compute could benefit from this by
5032# invoking a copy when it has access to the same file system as glance.
5033#
5034# Possible values:
5035#
5036# * [file], Empty list (default)
5037# (list value)
5038#allowed_direct_url_schemes =
5039
5040#
5041# Enable image signature verification.
5042#
5043# nova uses the image signature metadata from glance and verifies the signature
5044# of a signed image while downloading that image. If the image signature cannot
5045# be verified or if the image signature metadata is either incomplete or
5046# unavailable, then nova will not boot the image and instead will place the
5047# instance into an error state. This provides end users with stronger assurances
5048# of the integrity of the image data they are using to create servers.
5049#
5050# Related options:
5051#
5052# * The options in the `key_manager` group, as the key_manager is used
5053# for the signature validation.
5054# (boolean value)
5055#verify_glance_signatures=false
5056
5057# Enable or disable debug logging with glanceclient. (boolean value)
5058#debug=false
5059
5060
5061[guestfs]
5062#
5063# libguestfs is a set of tools for accessing and modifying virtual
5064# machine (VM) disk images. You can use this for viewing and editing
5065# files inside guests, scripting changes to VMs, monitoring disk
5066# used/free statistics, creating guests, P2V, V2V, performing backups,
5067# cloning VMs, building VMs, formatting disks and resizing disks.
5068
5069#
5070# From nova.conf
5071#
5072
5073#
5074# Enable/disables guestfs logging.
5075#
5076# This configures guestfs to debug messages and push them to Openstack
5077# logging system. When set to True, it traces libguestfs API calls and
5078# enable verbose debug messages. In order to use the above feature,
5079# "libguestfs" package must be installed.
5080#
5081# Related options:
5082# Since libguestfs access and modifies VM's managed by libvirt, below options
5083# should be set to give access to those VM's.
5084# * libvirt.inject_key
5085# * libvirt.inject_partition
5086# * libvirt.inject_password
5087# (boolean value)
5088#debug=false
5089
5090
5091[healthcheck]
5092
5093#
5094# From oslo.middleware
5095#
5096
5097# DEPRECATED: The path to respond to healtcheck requests on. (string value)
5098# This option is deprecated for removal.
5099# Its value may be silently ignored in the future.
5100#path=/healthcheck
5101
5102# Show more detailed information as part of the response (boolean value)
5103#detailed=false
5104
5105# Additional backends that can perform health checks and report that information
5106# back as part of a request. (list value)
5107#backends =
5108
5109# Check the presence of a file to determine if an application is running on a
5110# port. Used by DisableByFileHealthcheck plugin. (string value)
5111#disable_by_file_path=<None>
5112
5113# Check the presence of a file based on a port to determine if an application is
5114# running on a port. Expects a "port:path" list of strings. Used by
5115# DisableByFilesPortsHealthcheck plugin. (list value)
5116#disable_by_file_paths =
5117
5118
5119[hyperv]
5120#
5121# The hyperv feature allows you to configure the Hyper-V hypervisor
5122# driver to be used within an OpenStack deployment.
5123
5124#
5125# From nova.conf
5126#
5127
5128#
5129# Dynamic memory ratio
5130#
5131# Enables dynamic memory allocation (ballooning) when set to a value
5132# greater than 1. The value expresses the ratio between the total RAM
5133# assigned to an instance and its startup RAM amount. For example a
5134# ratio of 2.0 for an instance with 1024MB of RAM implies 512MB of
5135# RAM allocated at startup.
5136#
5137# Possible values:
5138#
5139# * 1.0: Disables dynamic memory allocation (Default).
5140# * Float values greater than 1.0: Enables allocation of total implied
5141# RAM divided by this value for startup.
5142# (floating point value)
5143#dynamic_memory_ratio=1.0
5144
5145#
5146# Enable instance metrics collection
5147#
5148# Enables metrics collections for an instance by using Hyper-V's
5149# metric APIs. Collected data can by retrieved by other apps and
5150# services, e.g.: Ceilometer.
5151# (boolean value)
5152#enable_instance_metrics_collection=false
5153
5154#
5155# Instances path share
5156#
5157# The name of a Windows share mapped to the "instances_path" dir
5158# and used by the resize feature to copy files to the target host.
5159# If left blank, an administrative share (hidden network share) will
5160# be used, looking for the same "instances_path" used locally.
5161#
5162# Possible values:
5163#
5164# * "": An administrative share will be used (Default).
5165# * Name of a Windows share.
5166#
5167# Related options:
5168#
5169# * "instances_path": The directory which will be used if this option
5170# here is left blank.
5171# (string value)
5172#instances_path_share =
5173
5174#
5175# Limit CPU features
5176#
5177# This flag is needed to support live migration to hosts with
5178# different CPU features and checked during instance creation
5179# in order to limit the CPU features used by the instance.
5180# (boolean value)
5181#limit_cpu_features=false
5182
5183#
5184# Mounted disk query retry count
5185#
5186# The number of times to retry checking for a mounted disk.
5187# The query runs until the device can be found or the retry
5188# count is reached.
5189#
5190# Possible values:
5191#
5192# * Positive integer values. Values greater than 1 is recommended
5193# (Default: 10).
5194#
5195# Related options:
5196#
5197# * Time interval between disk mount retries is declared with
5198# "mounted_disk_query_retry_interval" option.
5199# (integer value)
5200# Minimum value: 0
5201#mounted_disk_query_retry_count=10
5202
5203#
5204# Mounted disk query retry interval
5205#
5206# Interval between checks for a mounted disk, in seconds.
5207#
5208# Possible values:
5209#
5210# * Time in seconds (Default: 5).
5211#
5212# Related options:
5213#
5214# * This option is meaningful when the mounted_disk_query_retry_count
5215# is greater than 1.
5216# * The retry loop runs with mounted_disk_query_retry_count and
5217# mounted_disk_query_retry_interval configuration options.
5218# (integer value)
5219# Minimum value: 0
5220#mounted_disk_query_retry_interval=5
5221
5222#
5223# Power state check timeframe
5224#
5225# The timeframe to be checked for instance power state changes.
5226# This option is used to fetch the state of the instance from Hyper-V
5227# through the WMI interface, within the specified timeframe.
5228#
5229# Possible values:
5230#
5231# * Timeframe in seconds (Default: 60).
5232# (integer value)
5233# Minimum value: 0
5234#power_state_check_timeframe=60
5235
5236#
5237# Power state event polling interval
5238#
5239# Instance power state change event polling frequency. Sets the
5240# listener interval for power state events to the given value.
5241# This option enhances the internal lifecycle notifications of
5242# instances that reboot themselves. It is unlikely that an operator
5243# has to change this value.
5244#
5245# Possible values:
5246#
5247# * Time in seconds (Default: 2).
5248# (integer value)
5249# Minimum value: 0
5250#power_state_event_polling_interval=2
5251
5252#
5253# qemu-img command
5254#
5255# qemu-img is required for some of the image related operations
5256# like converting between different image types. You can get it
5257# from here: (http://qemu.weilnetz.de/) or you can install the
5258# Cloudbase OpenStack Hyper-V Compute Driver
5259# (https://cloudbase.it/openstack-hyperv-driver/) which automatically
5260# sets the proper path for this config option. You can either give the
5261# full path of qemu-img.exe or set its path in the PATH environment
5262# variable and leave this option to the default value.
5263#
5264# Possible values:
5265#
5266# * Name of the qemu-img executable, in case it is in the same
5267# directory as the nova-compute service or its path is in the
5268# PATH environment variable (Default).
5269# * Path of qemu-img command (DRIVELETTER:\PATH\TO\QEMU-IMG\COMMAND).
5270#
5271# Related options:
5272#
5273# * If the config_drive_cdrom option is False, qemu-img will be used to
5274# convert the ISO to a VHD, otherwise the configuration drive will
5275# remain an ISO. To use configuration drive with Hyper-V, you must
5276# set the mkisofs_cmd value to the full path to an mkisofs.exe
5277# installation.
5278# (string value)
5279#qemu_img_cmd=qemu-img.exe
5280
5281#
5282# External virtual switch name
5283#
5284# The Hyper-V Virtual Switch is a software-based layer-2 Ethernet
5285# network switch that is available with the installation of the
5286# Hyper-V server role. The switch includes programmatically managed
5287# and extensible capabilities to connect virtual machines to both
5288# virtual networks and the physical network. In addition, Hyper-V
5289# Virtual Switch provides policy enforcement for security, isolation,
5290# and service levels. The vSwitch represented by this config option
5291# must be an external one (not internal or private).
5292#
5293# Possible values:
5294#
5295# * If not provided, the first of a list of available vswitches
5296# is used. This list is queried using WQL.
5297# * Virtual switch name.
5298# (string value)
5299#vswitch_name=<None>
5300
5301#
5302# Wait soft reboot seconds
5303#
5304# Number of seconds to wait for instance to shut down after soft
5305# reboot request is made. We fall back to hard reboot if instance
5306# does not shutdown within this window.
5307#
5308# Possible values:
5309#
5310# * Time in seconds (Default: 60).
5311# (integer value)
5312# Minimum value: 0
5313#wait_soft_reboot_seconds=60
5314
5315#
5316# Configuration drive cdrom
5317#
5318# OpenStack can be configured to write instance metadata to
5319# a configuration drive, which is then attached to the
5320# instance before it boots. The configuration drive can be
5321# attached as a disk drive (default) or as a CD drive.
5322#
5323# Possible values:
5324#
5325# * True: Attach the configuration drive image as a CD drive.
5326# * False: Attach the configuration drive image as a disk drive (Default).
5327#
5328# Related options:
5329#
5330# * This option is meaningful with force_config_drive option set to 'True'
5331# or when the REST API call to create an instance will have
5332# '--config-drive=True' flag.
5333# * config_drive_format option must be set to 'iso9660' in order to use
5334# CD drive as the configuration drive image.
5335# * To use configuration drive with Hyper-V, you must set the
5336# mkisofs_cmd value to the full path to an mkisofs.exe installation.
5337# Additionally, you must set the qemu_img_cmd value to the full path
5338# to an qemu-img command installation.
5339# * You can configure the Compute service to always create a configuration
5340# drive by setting the force_config_drive option to 'True'.
5341# (boolean value)
5342#config_drive_cdrom=false
5343
5344#
5345# Configuration drive inject password
5346#
5347# Enables setting the admin password in the configuration drive image.
5348#
5349# Related options:
5350#
5351# * This option is meaningful when used with other options that enable
5352# configuration drive usage with Hyper-V, such as force_config_drive.
5353# * Currently, the only accepted config_drive_format is 'iso9660'.
5354# (boolean value)
5355#config_drive_inject_password=false
5356
5357#
5358# Volume attach retry count
5359#
5360# The number of times to retry attaching a volume. Volume attachment
5361# is retried until success or the given retry count is reached.
5362#
5363# Possible values:
5364#
5365# * Positive integer values (Default: 10).
5366#
5367# Related options:
5368#
5369# * Time interval between attachment attempts is declared with
5370# volume_attach_retry_interval option.
5371# (integer value)
5372# Minimum value: 0
5373#volume_attach_retry_count=10
5374
5375#
5376# Volume attach retry interval
5377#
5378# Interval between volume attachment attempts, in seconds.
5379#
5380# Possible values:
5381#
5382# * Time in seconds (Default: 5).
5383#
5384# Related options:
5385#
5386# * This options is meaningful when volume_attach_retry_count
5387# is greater than 1.
5388# * The retry loop runs with volume_attach_retry_count and
5389# volume_attach_retry_interval configuration options.
5390# (integer value)
5391# Minimum value: 0
5392#volume_attach_retry_interval=5
5393
5394#
5395# Enable RemoteFX feature
5396#
5397# This requires at least one DirectX 11 capable graphics adapter for
5398# Windows / Hyper-V Server 2012 R2 or newer and RDS-Virtualization
5399# feature has to be enabled.
5400#
5401# Instances with RemoteFX can be requested with the following flavor
5402# extra specs:
5403#
5404# **os:resolution**. Guest VM screen resolution size. Acceptable values::
5405#
5406# 1024x768, 1280x1024, 1600x1200, 1920x1200, 2560x1600, 3840x2160
5407#
5408# ``3840x2160`` is only available on Windows / Hyper-V Server 2016.
5409#
5410# **os:monitors**. Guest VM number of monitors. Acceptable values::
5411#
5412# [1, 4] - Windows / Hyper-V Server 2012 R2
5413# [1, 8] - Windows / Hyper-V Server 2016
5414#
5415# **os:vram**. Guest VM VRAM amount. Only available on
5416# Windows / Hyper-V Server 2016. Acceptable values::
5417#
5418# 64, 128, 256, 512, 1024
5419# (boolean value)
5420#enable_remotefx=false
5421
5422#
5423# Use multipath connections when attaching iSCSI or FC disks.
5424#
5425# This requires the Multipath IO Windows feature to be enabled. MPIO must be
5426# configured to claim such devices.
5427# (boolean value)
5428#use_multipath_io=false
5429
5430#
5431# List of iSCSI initiators that will be used for estabilishing iSCSI sessions.
5432#
5433# If none are specified, the Microsoft iSCSI initiator service will choose the
5434# initiator.
5435# (list value)
5436#iscsi_initiator_list =
5437
5438
5439[image_file_url]
5440
5441#
5442# From nova.conf
5443#
5444
5445# DEPRECATED:
5446# List of file systems that are configured in this file in the
5447# image_file_url:<list entry name> sections
5448# (list value)
5449# This option is deprecated for removal since 14.0.0.
5450# Its value may be silently ignored in the future.
5451# Reason:
5452# The feature to download images from glance via filesystem is not used and will
5453# be removed in the future.
5454#filesystems =
5455
5456
5457[ironic]
5458#
5459# Configuration options for Ironic driver (Bare Metal).
5460# If using the Ironic driver following options must be set:
5461# * auth_type
5462# * auth_url
5463# * project_name
5464# * username
5465# * password
5466# * project_domain_id or project_domain_name
5467# * user_domain_id or user_domain_name
5468
5469#
5470# From nova.conf
5471#
5472
5473# URL override for the Ironic API endpoint. (string value)
5474#api_endpoint=http://ironic.example.org:6385/
5475
5476#
5477# The number of times to retry when a request conflicts.
5478# If set to 0, only try once, no retries.
5479#
5480# Related options:
5481#
5482# * api_retry_interval
5483# (integer value)
5484# Minimum value: 0
5485#api_max_retries=60
5486
5487#
5488# The number of seconds to wait before retrying the request.
5489#
5490# Related options:
5491#
5492# * api_max_retries
5493# (integer value)
5494# Minimum value: 0
5495#api_retry_interval=2
5496
5497# Timeout (seconds) to wait for node serial console state changed. Set to 0 to
5498# disable timeout. (integer value)
5499# Minimum value: 0
5500#serial_console_state_timeout=10
5501
5502# PEM encoded Certificate Authority to use when verifying HTTPs connections.
5503# (string value)
5504#cafile=<None>
5505
5506# PEM encoded client certificate cert file (string value)
5507#certfile=<None>
5508
5509# PEM encoded client certificate key file (string value)
5510#keyfile=<None>
5511
5512# Verify HTTPS connections. (boolean value)
5513#insecure=false
5514
5515# Timeout value for http requests (integer value)
5516#timeout=<None>
5517
5518# Authentication type to load (string value)
5519# Deprecated group/name - [ironic]/auth_plugin
5520#auth_type=<None>
5521
5522# Config Section from which to load plugin specific options (string value)
5523#auth_section=<None>
5524
5525# Authentication URL (string value)
5526#auth_url=<None>
5527
5528# Domain ID to scope to (string value)
5529#domain_id=<None>
5530
5531# Domain name to scope to (string value)
5532#domain_name=<None>
5533
5534# Project ID to scope to (string value)
5535#project_id=<None>
5536
5537# Project name to scope to (string value)
5538#project_name=<None>
5539
5540# Domain ID containing project (string value)
5541#project_domain_id=<None>
5542
5543# Domain name containing project (string value)
5544#project_domain_name=<None>
5545
5546# Trust ID (string value)
5547#trust_id=<None>
5548
5549# User ID (string value)
5550#user_id=<None>
5551
5552# Username (string value)
5553# Deprecated group/name - [ironic]/user-name
5554#username=<None>
5555
5556# User's domain id (string value)
5557#user_domain_id=<None>
5558
5559# User's domain name (string value)
5560#user_domain_name=<None>
5561
5562# User's password (string value)
5563#password=<None>
5564
5565
5566[key_manager]
5567
5568#
5569# From nova.conf
5570#
5571
5572#
5573# Fixed key returned by key manager, specified in hex.
5574#
5575# Possible values:
5576#
5577# * Empty string or a key in hex value
5578# (string value)
5579# Deprecated group/name - [keymgr]/fixed_key
5580#fixed_key=<None>
5581
5582# The full class name of the key manager API class (string value)
5583#api_class=castellan.key_manager.barbican_key_manager.BarbicanKeyManager
5584
5585# The type of authentication credential to create. Possible values are 'token',
5586# 'password', 'keystone_token', and 'keystone_password'. Required if no context
5587# is passed to the credential factory. (string value)
5588#auth_type=<None>
5589
5590# Token for authentication. Required for 'token' and 'keystone_token' auth_type
5591# if no context is passed to the credential factory. (string value)
5592#token=<None>
5593
5594# Username for authentication. Required for 'password' auth_type. Optional for
5595# the 'keystone_password' auth_type. (string value)
5596#username=<None>
5597
5598# Password for authentication. Required for 'password' and 'keystone_password'
5599# auth_type. (string value)
5600#password=<None>
5601
5602# User ID for authentication. Optional for 'keystone_token' and
5603# 'keystone_password' auth_type. (string value)
5604#user_id=<None>
5605
5606# User's domain ID for authentication. Optional for 'keystone_token' and
5607# 'keystone_password' auth_type. (string value)
5608#user_domain_id=<None>
5609
5610# User's domain name for authentication. Optional for 'keystone_token' and
5611# 'keystone_password' auth_type. (string value)
5612#user_domain_name=<None>
5613
5614# Trust ID for trust scoping. Optional for 'keystone_token' and
5615# 'keystone_password' auth_type. (string value)
5616#trust_id=<None>
5617
5618# Domain ID for domain scoping. Optional for 'keystone_token' and
5619# 'keystone_password' auth_type. (string value)
5620#domain_id=<None>
5621
5622# Domain name for domain scoping. Optional for 'keystone_token' and
5623# 'keystone_password' auth_type. (string value)
5624#domain_name=<None>
5625
5626# Project ID for project scoping. Optional for 'keystone_token' and
5627# 'keystone_password' auth_type. (string value)
5628#project_id=<None>
5629
5630# Project name for project scoping. Optional for 'keystone_token' and
5631# 'keystone_password' auth_type. (string value)
5632#project_name=<None>
5633
5634# Project's domain ID for project. Optional for 'keystone_token' and
5635# 'keystone_password' auth_type. (string value)
5636#project_domain_id=<None>
5637
5638# Project's domain name for project. Optional for 'keystone_token' and
5639# 'keystone_password' auth_type. (string value)
5640#project_domain_name=<None>
5641
5642# Allow fetching a new token if the current one is going to expire. Optional for
5643# 'keystone_token' and 'keystone_password' auth_type. (boolean value)
5644#reauthenticate=true
5645
5646
5647[keystone_authtoken]
5648
5649#
5650# From keystonemiddleware.auth_token
5651#
5652signing_dirname=/tmp/keystone-signing-nova
5653revocation_cache_time = 10
5654auth_type = password
5655user_domain_id = {{ compute.identity.get('domain', 'default') }}
5656project_domain_id = {{ compute.identity.get('domain', 'default') }}
5657project_name = {{ compute.identity.tenant }}
5658username = {{ compute.identity.user }}
5659password = {{ compute.identity.password }}
5660auth_uri=http://{{ compute.identity.host }}:5000
5661auth_url=http://{{ compute.identity.host }}:35357
5662{%- if compute.cache is defined %}
5663memcached_servers={%- for member in compute.cache.members %}{{ member.host }}:11211{% if not loop.last %},{% endif %}{%- endfor %}
5664{%- endif %}
5665# Complete "public" Identity API endpoint. This endpoint should not be an
5666# "admin" endpoint, as it should be accessible by all end users. Unauthenticated
5667# clients are redirected to this endpoint to authenticate. Although this
5668# endpoint should ideally be unversioned, client support in the wild varies.
5669# If you're using a versioned v2 endpoint here, then this should *not* be the
5670# same endpoint the service user utilizes for validating tokens, because normal
5671# end users may not be able to reach that endpoint. (string value)
5672#auth_uri=<None>
5673
5674# API version of the admin Identity API endpoint. (string value)
5675#auth_version=<None>
5676
5677# Do not handle authorization requests within the middleware, but delegate the
5678# authorization decision to downstream WSGI components. (boolean value)
5679#delay_auth_decision=false
5680
5681# Request timeout value for communicating with Identity API server. (integer
5682# value)
5683#http_connect_timeout=<None>
5684
5685# How many times are we trying to reconnect when communicating with Identity API
5686# Server. (integer value)
5687#http_request_max_retries=3
5688
5689# Request environment key where the Swift cache object is stored. When
5690# auth_token middleware is deployed with a Swift cache, use this option to have
5691# the middleware share a caching backend with swift. Otherwise, use the
5692# ``memcached_servers`` option instead. (string value)
5693#cache=<None>
5694
5695# Required if identity server requires client certificate (string value)
5696#certfile=<None>
5697
5698# Required if identity server requires client certificate (string value)
5699#keyfile=<None>
5700
5701# A PEM encoded Certificate Authority to use when verifying HTTPs connections.
5702# Defaults to system CAs. (string value)
5703#cafile=<None>
5704
5705# Verify HTTPS connections. (boolean value)
5706#insecure=false
5707
5708# The region in which the identity server can be found. (string value)
5709#region_name=<None>
5710
5711# DEPRECATED: Directory used to cache files related to PKI tokens. This option
5712# has been deprecated in the Ocata release and will be removed in the P release.
5713# (string value)
5714# This option is deprecated for removal since Ocata.
5715# Its value may be silently ignored in the future.
5716# Reason: PKI token format is no longer supported.
5717#signing_dir=<None>
5718
5719# Optionally specify a list of memcached server(s) to use for caching. If left
5720# undefined, tokens will instead be cached in-process. (list value)
5721# Deprecated group/name - [keystone_authtoken]/memcache_servers
5722#memcached_servers=<None>
5723
5724# In order to prevent excessive effort spent validating tokens, the middleware
5725# caches previously-seen tokens for a configurable duration (in seconds). Set to
5726# -1 to disable caching completely. (integer value)
5727#token_cache_time=300
5728
5729# DEPRECATED: Determines the frequency at which the list of revoked tokens is
5730# retrieved from the Identity service (in seconds). A high number of revocation
5731# events combined with a low cache duration may significantly reduce
5732# performance. Only valid for PKI tokens. This option has been deprecated in the
5733# Ocata release and will be removed in the P release. (integer value)
5734# This option is deprecated for removal since Ocata.
5735# Its value may be silently ignored in the future.
5736# Reason: PKI token format is no longer supported.
5737#revocation_cache_time=10
5738
5739# (Optional) If defined, indicate whether token data should be authenticated or
5740# authenticated and encrypted. If MAC, token data is authenticated (with HMAC)
5741# in the cache. If ENCRYPT, token data is encrypted and authenticated in the
5742# cache. If the value is not one of these options or empty, auth_token will
5743# raise an exception on initialization. (string value)
5744# Allowed values: None, MAC, ENCRYPT
5745#memcache_security_strategy=None
5746
5747# (Optional, mandatory if memcache_security_strategy is defined) This string is
5748# used for key derivation. (string value)
5749#memcache_secret_key=<None>
5750
5751# (Optional) Number of seconds memcached server is considered dead before it is
5752# tried again. (integer value)
5753#memcache_pool_dead_retry=300
5754
5755# (Optional) Maximum total number of open connections to every memcached server.
5756# (integer value)
5757#memcache_pool_maxsize=10
5758
5759# (Optional) Socket timeout in seconds for communicating with a memcached
5760# server. (integer value)
5761#memcache_pool_socket_timeout=3
5762
5763# (Optional) Number of seconds a connection to memcached is held unused in the
5764# pool before it is closed. (integer value)
5765#memcache_pool_unused_timeout=60
5766
5767# (Optional) Number of seconds that an operation will wait to get a memcached
5768# client connection from the pool. (integer value)
5769#memcache_pool_conn_get_timeout=10
5770
5771# (Optional) Use the advanced (eventlet safe) memcached client pool. The
5772# advanced pool will only work under python 2.x. (boolean value)
5773#memcache_use_advanced_pool=false
5774
5775# (Optional) Indicate whether to set the X-Service-Catalog header. If False,
5776# middleware will not ask for service catalog on token validation and will not
5777# set the X-Service-Catalog header. (boolean value)
5778#include_service_catalog=true
5779
5780# Used to control the use and type of token binding. Can be set to: "disabled"
5781# to not check token binding. "permissive" (default) to validate binding
5782# information if the bind type is of a form known to the server and ignore it if
5783# not. "strict" like "permissive" but if the bind type is unknown the token will
5784# be rejected. "required" any form of token binding is needed to be allowed.
5785# Finally the name of a binding method that must be present in tokens. (string
5786# value)
5787#enforce_token_bind=permissive
5788
5789# DEPRECATED: If true, the revocation list will be checked for cached tokens.
5790# This requires that PKI tokens are configured on the identity server. (boolean
5791# value)
5792# This option is deprecated for removal since Ocata.
5793# Its value may be silently ignored in the future.
5794# Reason: PKI token format is no longer supported.
5795#check_revocations_for_cached=false
5796
5797# DEPRECATED: Hash algorithms to use for hashing PKI tokens. This may be a
5798# single algorithm or multiple. The algorithms are those supported by Python
5799# standard hashlib.new(). The hashes will be tried in the order given, so put
5800# the preferred one first for performance. The result of the first hash will be
5801# stored in the cache. This will typically be set to multiple values only while
5802# migrating from a less secure algorithm to a more secure one. Once all the old
5803# tokens are expired this option should be set to a single value for better
5804# performance. (list value)
5805# This option is deprecated for removal since Ocata.
5806# Its value may be silently ignored in the future.
5807# Reason: PKI token format is no longer supported.
5808#hash_algorithms=md5
5809
5810# A choice of roles that must be present in a service token. Service tokens are
5811# allowed to request that an expired token can be used and so this check should
5812# tightly control that only actual services should be sending this token. Roles
5813# here are applied as an ANY check so any role in this list must be present. For
5814# backwards compatibility reasons this currently only affects the allow_expired
5815# check. (list value)
5816#service_token_roles=service
5817
5818# For backwards compatibility reasons we must let valid service tokens pass that
5819# don't pass the service_token_roles check as valid. Setting this true will
5820# become the default in a future release and should be enabled if possible.
5821# (boolean value)
5822#service_token_roles_required=false
5823
5824# Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
5825# (string value)
5826#auth_admin_prefix =
5827
5828# Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
5829# (string value)
5830#auth_host=127.0.0.1
5831
5832# Port of the admin Identity API endpoint. Deprecated, use identity_uri.
5833# (integer value)
5834#auth_port=35357
5835
5836# Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
5837# (string value)
5838# Allowed values: http, https
5839#auth_protocol=https
5840
5841# Complete admin Identity API endpoint. This should specify the unversioned root
5842# endpoint e.g. https://localhost:35357/ (string value)
5843#identity_uri=<None>
5844
5845# This option is deprecated and may be removed in a future release. Single
5846# shared secret with the Keystone configuration used for bootstrapping a
5847# Keystone installation, or otherwise bypassing the normal authentication
5848# process. This option should not be used, use `admin_user` and `admin_password`
5849# instead. (string value)
5850#admin_token=<None>
5851
5852# Service username. (string value)
5853#admin_user=<None>
5854
5855# Service user password. (string value)
5856#admin_password=<None>
5857
5858# Service tenant name. (string value)
5859#admin_tenant_name=admin
5860
5861# Authentication type to load (string value)
5862# Deprecated group/name - [keystone_authtoken]/auth_plugin
5863#auth_type=<None>
5864
5865# Config Section from which to load plugin specific options (string value)
5866#auth_section=<None>
5867
5868
5869[libvirt]
5870#
5871# Libvirt options allows cloud administrator to configure related
5872# libvirt hypervisor driver to be used within an OpenStack deployment.
5873#
5874# Almost all of the libvirt config options are influence by ``virt_type`` config
5875# which describes the virtualization type (or so called domain type) libvirt
5876# should use for specific features such as live migration, snapshot.
5877
5878#
5879# From nova.conf
5880#
5881cpu_mode = host-passthrough
5882virt_type = kvm
5883inject_partition=-2
5884inject_password=True
5885disk_cachemodes="network=writeback,block=none"
5886block_migration_flag=VIR_MIGRATE_UNDEFINE_SOURCE,VIR_MIGRATE_PEER2PEER,VIR_MIGRATE_LIVE,VIR_MIGRATE_NON_SHARED_INC
5887live_migration_flag=VIR_MIGRATE_UNDEFINE_SOURCE,VIR_MIGRATE_PEER2PEER,VIR_MIGRATE_LIVE,VIR_MIGRATE_PERSIST_DEST
5888inject_key=True
5889vif_driver=nova.virt.libvirt.vif.LibvirtGenericVIFDriver
5890
5891{%- if compute.get('ceph', {}).ephemeral is defined %}
5892images_type=rbd
5893images_rbd_pool={{ compute.ceph.rbd_pool }}
5894images_rbd_ceph_conf=/etc/ceph/ceph.conf
5895rbd_user={{ compute.ceph.rbd_user }}
5896rbd_secret_uuid={{ compute.ceph.secret_uuid }}
5897inject_password=false
5898inject_key=false
5899{%- endif %}
5900
5901{%- if compute.get('libvirt', {}).uri is defined %}
5902connection_uri={{ compute.libvirt.uri }}
5903{%- endif %}
5904#
5905# The ID of the image to boot from to rescue data from a corrupted instance.
5906#
5907# If the rescue REST API operation doesn't provide an ID of an image to
5908# use, the image which is referenced by this ID is used. If this
5909# option is not set, the image from the instance is used.
5910#
5911# Possible values:
5912#
5913# * An ID of an image or nothing. If it points to an *Amazon Machine
5914# Image* (AMI), consider to set the config options ``rescue_kernel_id``
5915# and ``rescue_ramdisk_id`` too. If nothing is set, the image of the instance
5916# is used.
5917#
5918# Related options:
5919#
5920# * ``rescue_kernel_id``: If the chosen rescue image allows the separate
5921# definition of its kernel disk, the value of this option is used,
5922# if specified. This is the case when *Amazon*'s AMI/AKI/ARI image
5923# format is used for the rescue image.
5924# * ``rescue_ramdisk_id``: If the chosen rescue image allows the separate
5925# definition of its RAM disk, the value of this option is used if,
5926# specified. This is the case when *Amazon*'s AMI/AKI/ARI image
5927# format is used for the rescue image.
5928# (string value)
5929#rescue_image_id=<None>
5930
5931#
5932# The ID of the kernel (AKI) image to use with the rescue image.
5933#
5934# If the chosen rescue image allows the separate definition of its kernel
5935# disk, the value of this option is used, if specified. This is the case
5936# when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
5937#
5938# Possible values:
5939#
5940# * An ID of an kernel image or nothing. If nothing is specified, the kernel
5941# disk from the instance is used if it was launched with one.
5942#
5943# Related options:
5944#
5945# * ``rescue_image_id``: If that option points to an image in *Amazon*'s
5946# AMI/AKI/ARI image format, it's useful to use ``rescue_kernel_id`` too.
5947# (string value)
5948#rescue_kernel_id=<None>
5949
5950#
5951# The ID of the RAM disk (ARI) image to use with the rescue image.
5952#
5953# If the chosen rescue image allows the separate definition of its RAM
5954# disk, the value of this option is used, if specified. This is the case
5955# when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
5956#
5957# Possible values:
5958#
5959# * An ID of a RAM disk image or nothing. If nothing is specified, the RAM
5960# disk from the instance is used if it was launched with one.
5961#
5962# Related options:
5963#
5964# * ``rescue_image_id``: If that option points to an image in *Amazon*'s
5965# AMI/AKI/ARI image format, it's useful to use ``rescue_ramdisk_id`` too.
5966# (string value)
5967#rescue_ramdisk_id=<None>
5968
5969#
5970# Describes the virtualization type (or so called domain type) libvirt should
5971# use.
5972#
5973# The choice of this type must match the underlying virtualization strategy
5974# you have chosen for this host.
5975#
5976# Possible values:
5977#
5978# * See the predefined set of case-sensitive values.
5979#
5980# Related options:
5981#
5982# * ``connection_uri``: depends on this
5983# * ``disk_prefix``: depends on this
5984# * ``cpu_mode``: depends on this
5985# * ``cpu_model``: depends on this
5986# (string value)
5987# Allowed values: kvm, lxc, qemu, uml, xen, parallels
5988#virt_type=kvm
5989
5990#
5991# Overrides the default libvirt URI of the chosen virtualization type.
5992#
5993# If set, Nova will use this URI to connect to libvirt.
5994#
5995# Possible values:
5996#
5997# * An URI like ``qemu:///system`` or ``xen+ssh://oirase/`` for example.
5998# This is only necessary if the URI differs to the commonly known URIs
5999# for the chosen virtualization type.
6000#
6001# Related options:
6002#
6003# * ``virt_type``: Influences what is used as default value here.
6004# (string value)
6005#connection_uri =
6006
6007#
6008# Allow the injection of an admin password for instance only at ``create`` and
6009# ``rebuild`` process.
6010#
6011# There is no agent needed within the image to do this. If *libguestfs* is
6012# available on the host, it will be used. Otherwise *nbd* is used. The file
6013# system of the image will be mounted and the admin password, which is provided
6014# in the REST API call will be injected as password for the root user. If no
6015# root user is available, the instance won't be launched and an error is thrown.
6016# Be aware that the injection is *not* possible when the instance gets launched
6017# from a volume.
6018#
6019# Possible values:
6020#
6021# * True: Allows the injection.
6022# * False (default): Disallows the injection. Any via the REST API provided
6023# admin password will be silently ignored.
6024#
6025# Related options:
6026#
6027# * ``inject_partition``: That option will decide about the discovery and usage
6028# of the file system. It also can disable the injection at all.
6029# (boolean value)
6030#inject_password=false
6031
6032#
6033# Allow the injection of an SSH key at boot time.
6034#
6035# There is no agent needed within the image to do this. If *libguestfs* is
6036# available on the host, it will be used. Otherwise *nbd* is used. The file
6037# system of the image will be mounted and the SSH key, which is provided
6038# in the REST API call will be injected as SSH key for the root user and
6039# appended to the ``authorized_keys`` of that user. The SELinux context will
6040# be set if necessary. Be aware that the injection is *not* possible when the
6041# instance gets launched from a volume.
6042#
6043# This config option will enable directly modifying the instance disk and does
6044# not affect what cloud-init may do using data from config_drive option or the
6045# metadata service.
6046#
6047# Related options:
6048#
6049# * ``inject_partition``: That option will decide about the discovery and usage
6050# of the file system. It also can disable the injection at all.
6051# (boolean value)
6052#inject_key=false
6053
6054#
6055# Determines the way how the file system is chosen to inject data into it.
6056#
6057# *libguestfs* will be used a first solution to inject data. If that's not
6058# available on the host, the image will be locally mounted on the host as a
6059# fallback solution. If libguestfs is not able to determine the root partition
6060# (because there are more or less than one root partition) or cannot mount the
6061# file system it will result in an error and the instance won't be boot.
6062#
6063# Possible values:
6064#
6065# * -2 => disable the injection of data.
6066# * -1 => find the root partition with the file system to mount with libguestfs
6067# * 0 => The image is not partitioned
6068# * >0 => The number of the partition to use for the injection
6069#
6070# Related options:
6071#
6072# * ``inject_key``: If this option allows the injection of a SSH key it depends
6073# on value greater or equal to -1 for ``inject_partition``.
6074# * ``inject_password``: If this option allows the injection of an admin
6075# password
6076# it depends on value greater or equal to -1 for ``inject_partition``.
6077# * ``guestfs`` You can enable the debug log level of libguestfs with this
6078# config option. A more verbose output will help in debugging issues.
6079# * ``virt_type``: If you use ``lxc`` as virt_type it will be treated as a
6080# single partition image
6081# (integer value)
6082# Minimum value: -2
6083#inject_partition=-2
6084
6085# DEPRECATED:
6086# Enable a mouse cursor within a graphical VNC or SPICE sessions.
6087#
6088# This will only be taken into account if the VM is fully virtualized and VNC
6089# and/or SPICE is enabled. If the node doesn't support a graphical framebuffer,
6090# then it is valid to set this to False.
6091#
6092# Related options:
6093# * ``[vnc]enabled``: If VNC is enabled, ``use_usb_tablet`` will have an effect.
6094# * ``[spice]enabled`` + ``[spice].agent_enabled``: If SPICE is enabled and the
6095# spice agent is disabled, the config value of ``use_usb_tablet`` will have
6096# an effect.
6097# (boolean value)
6098# This option is deprecated for removal since 14.0.0.
6099# Its value may be silently ignored in the future.
6100# Reason: This option is being replaced by the 'pointer_model' option.
6101#use_usb_tablet=true
6102
6103#
6104# The IP address or hostname to be used as the target for live migration
6105# traffic.
6106#
6107# If this option is set to None, the hostname of the migration target compute
6108# node will be used.
6109#
6110# This option is useful in environments where the live-migration traffic can
6111# impact the network plane significantly. A separate network for live-migration
6112# traffic can then use this config option and avoids the impact on the
6113# management network.
6114#
6115# Possible values:
6116#
6117# * A valid IP address or hostname, else None.
6118# (string value)
6119#live_migration_inbound_addr=<None>
6120
6121# DEPRECATED:
6122# Live migration target URI to use.
6123#
6124# Override the default libvirt live migration target URI (which is dependent
6125# on virt_type). Any included "%s" is replaced with the migration target
6126# hostname.
6127#
6128# If this option is set to None (which is the default), Nova will automatically
6129# generate the `live_migration_uri` value based on only 3 supported `virt_type`
6130# in following list:
6131# * 'kvm': 'qemu+tcp://%s/system'
6132# * 'qemu': 'qemu+tcp://%s/system'
6133# * 'xen': 'xenmigr://%s/system'
6134#
6135# Related options:
6136# * ``live_migration_inbound_addr``: If ``live_migration_inbound_addr`` value
6137# is not None, the ip/hostname address of target compute node is used instead
6138# of ``live_migration_uri`` as the uri for live migration.
6139# * ``live_migration_scheme``: If ``live_migration_uri`` is not set, the scheme
6140# used for live migration is taken from ``live_migration_scheme`` instead.
6141# (string value)
6142# This option is deprecated for removal since 15.0.0.
6143# Its value may be silently ignored in the future.
6144# Reason:
6145# live_migration_uri is deprecated for removal in favor of two other options
6146# that
6147# allow to change live migration scheme and target URI:
6148# ``live_migration_scheme``
6149# and ``live_migration_inbound_addr`` respectively.
6150#live_migration_uri=<None>
6151
6152#
6153# Schema used for live migration.
6154#
6155# Override the default libvirt live migration scheme (which is dependant on
6156# virt_type). If this option is set to None, nova will automatically choose a
6157# sensible default based on the hypervisor. It is not recommended that you
6158# change
6159# this unless you are very sure that hypervisor supports a particular scheme.
6160#
6161# Related options:
6162# * ``virt_type``: This option is meaningful only when ``virt_type`` is set to
6163# `kvm` or `qemu`.
6164# * ``live_migration_uri``: If ``live_migration_uri`` value is not None, the
6165# scheme used for live migration is taken from ``live_migration_uri`` instead.
6166# (string value)
6167#live_migration_scheme=<None>
6168
6169#
6170# Enable tunnelled migration.
6171#
6172# This option enables the tunnelled migration feature, where migration data is
6173# transported over the libvirtd connection. If enabled, we use the
6174# VIR_MIGRATE_TUNNELLED migration flag, avoiding the need to configure
6175# the network to allow direct hypervisor to hypervisor communication.
6176# If False, use the native transport. If not set, Nova will choose a
6177# sensible default based on, for example the availability of native
6178# encryption support in the hypervisor. Enable this option will definitely
6179# impact performance massively.
6180#
6181# Note that this option is NOT compatible with use of block migration.
6182#
6183# Possible values:
6184#
6185# * Supersedes and (if set) overrides the deprecated 'live_migration_flag' and
6186# 'block_migration_flag' to enable tunneled migration.
6187# (boolean value)
6188#live_migration_tunnelled=false
6189live_migration_tunnelled=true
6190
6191#
6192# Maximum bandwidth(in MiB/s) to be used during migration.
6193#
6194# If set to 0, the hypervisor will choose a suitable default. Some hypervisors
6195# do not support this feature and will return an error if bandwidth is not 0.
6196# Please refer to the libvirt documentation for further details.
6197# (integer value)
6198#live_migration_bandwidth=0
6199
6200#
6201# Maximum permitted downtime, in milliseconds, for live migration
6202# switchover.
6203#
6204# Will be rounded up to a minimum of 100ms. You can increase this value
6205# if you want to allow live-migrations to complete faster, or avoid
6206# live-migration timeout errors by allowing the guest to be paused for
6207# longer during the live-migration switch over.
6208#
6209# Related options:
6210#
6211# * live_migration_completion_timeout
6212# (integer value)
6213#live_migration_downtime=500
6214
6215#
6216# Number of incremental steps to reach max downtime value.
6217#
6218# Will be rounded up to a minimum of 3 steps.
6219# (integer value)
6220#live_migration_downtime_steps=10
6221
6222#
6223# Time to wait, in seconds, between each step increase of the migration
6224# downtime.
6225#
6226# Minimum delay is 10 seconds. Value is per GiB of guest RAM + disk to be
6227# transferred, with lower bound of a minimum of 2 GiB per device.
6228# (integer value)
6229#live_migration_downtime_delay=75
6230
6231#
6232# Time to wait, in seconds, for migration to successfully complete transferring
6233# data before aborting the operation.
6234#
6235# Value is per GiB of guest RAM + disk to be transferred, with lower bound of
6236# a minimum of 2 GiB. Should usually be larger than downtime delay * downtime
6237# steps. Set to 0 to disable timeouts.
6238#
6239# Related options:
6240#
6241# * live_migration_downtime
6242# * live_migration_downtime_steps
6243# * live_migration_downtime_delay
6244# (integer value)
6245# Note: This option can be changed without restarting.
6246#live_migration_completion_timeout=800
6247
6248# DEPRECATED:
6249# Time to wait, in seconds, for migration to make forward progress in
6250# transferring data before aborting the operation.
6251#
6252# Set to 0 to disable timeouts.
6253#
6254# This is deprecated, and now disabled by default because we have found serious
6255# bugs in this feature that caused false live-migration timeout failures. This
6256# feature will be removed or replaced in a future release.
6257# (integer value)
6258# Note: This option can be changed without restarting.
6259# This option is deprecated for removal.
6260# Its value may be silently ignored in the future.
6261# Reason: Serious bugs found in this feature.
6262#live_migration_progress_timeout=0
6263
6264#
6265# This option allows nova to switch an on-going live migration to post-copy
6266# mode, i.e., switch the active VM to the one on the destination node before the
6267# migration is complete, therefore ensuring an upper bound on the memory that
6268# needs to be transferred. Post-copy requires libvirt>=1.3.3 and QEMU>=2.5.0.
6269#
6270# When permitted, post-copy mode will be automatically activated if a
6271# live-migration memory copy iteration does not make percentage increase of at
6272# least 10% over the last iteration.
6273#
6274# The live-migration force complete API also uses post-copy when permitted. If
6275# post-copy mode is not available, force complete falls back to pausing the VM
6276# to ensure the live-migration operation will complete.
6277#
6278# When using post-copy mode, if the source and destination hosts loose network
6279# connectivity, the VM being live-migrated will need to be rebooted. For more
6280# details, please see the Administration guide.
6281#
6282# Related options:
6283#
6284# * live_migration_permit_auto_converge
6285# (boolean value)
6286#live_migration_permit_post_copy=false
6287
6288#
6289# This option allows nova to start live migration with auto converge on.
6290#
6291# Auto converge throttles down CPU if a progress of on-going live migration
6292# is slow. Auto converge will only be used if this flag is set to True and
6293# post copy is not permitted or post copy is unavailable due to the version
6294# of libvirt and QEMU in use. Auto converge requires libvirt>=1.2.3 and
6295# QEMU>=1.6.0.
6296#
6297# Related options:
6298#
6299# * live_migration_permit_post_copy
6300# (boolean value)
6301#live_migration_permit_auto_converge=false
6302
6303#
6304# Determine the snapshot image format when sending to the image service.
6305#
6306# If set, this decides what format is used when sending the snapshot to the
6307# image service.
6308# If not set, defaults to same type as source image.
6309#
6310# Possible values:
6311#
6312# * ``raw``: RAW disk format
6313# * ``qcow2``: KVM default disk format
6314# * ``vmdk``: VMWare default disk format
6315# * ``vdi``: VirtualBox default disk format
6316# * If not set, defaults to same type as source image.
6317# (string value)
6318# Allowed values: raw, qcow2, vmdk, vdi
6319#snapshot_image_format=<None>
6320
6321#
6322# Override the default disk prefix for the devices attached to an instance.
6323#
6324# If set, this is used to identify a free disk device name for a bus.
6325#
6326# Possible values:
6327#
6328# * Any prefix which will result in a valid disk device name like 'sda' or 'hda'
6329# for example. This is only necessary if the device names differ to the
6330# commonly known device name prefixes for a virtualization type such as: sd,
6331# xvd, uvd, vd.
6332#
6333# Related options:
6334#
6335# * ``virt_type``: Influences which device type is used, which determines
6336# the default disk prefix.
6337# (string value)
6338#disk_prefix=<None>
6339
6340# Number of seconds to wait for instance to shut down after soft reboot request
6341# is made. We fall back to hard reboot if instance does not shutdown within this
6342# window. (integer value)
6343#wait_soft_reboot_seconds=120
6344
6345#
6346# Is used to set the CPU mode an instance should have.
6347#
6348# If virt_type="kvm|qemu", it will default to "host-model", otherwise it will
6349# default to "none".
6350#
6351# Possible values:
6352#
6353# * ``host-model``: Clones the host CPU feature flags.
6354# * ``host-passthrough``: Use the host CPU model exactly;
6355# * ``custom``: Use a named CPU model;
6356# * ``none``: Not set any CPU model.
6357#
6358# Related options:
6359#
6360# * ``cpu_model``: If ``custom`` is used for ``cpu_mode``, set this config
6361# option too, otherwise this would result in an error and the instance won't
6362# be launched.
6363# (string value)
6364# Allowed values: host-model, host-passthrough, custom, none
6365#cpu_mode=<None>
6366
6367#
6368# Set the name of the libvirt CPU model the instance should use.
6369#
6370# Possible values:
6371#
6372# * The names listed in /usr/share/libvirt/cpu_map.xml
6373#
6374# Related options:
6375#
6376# * ``cpu_mode``: Don't set this when ``cpu_mode`` is NOT set to ``custom``.
6377# This would result in an error and the instance won't be launched.
6378# * ``virt_type``: Only the virtualization types ``kvm`` and ``qemu`` use this.
6379# (string value)
6380#cpu_model=<None>
6381
6382# Location where libvirt driver will store snapshots before uploading them to
6383# image service (string value)
6384#snapshots_directory=$instances_path/snapshots
6385
6386# Location where the Xen hvmloader is kept (string value)
6387#xen_hvmloader_path=/usr/lib/xen/boot/hvmloader
6388
6389# Specific cachemodes to use for different disk types e.g:
6390# file=directsync,block=none (list value)
6391#disk_cachemodes =
6392
6393# A path to a device that will be used as source of entropy on the host.
6394# Permitted options are: /dev/random or /dev/hwrng (string value)
6395#rng_dev_path=<None>
6396
6397# For qemu or KVM guests, set this option to specify a default machine type per
6398# host architecture. You can find a list of supported machine types in your
6399# environment by checking the output of the "virsh capabilities"command. The
6400# format of the value for this config option is host-arch=machine-type. For
6401# example: x86_64=machinetype1,armv7l=machinetype2 (list value)
6402#hw_machine_type=<None>
6403
6404# The data source used to the populate the host "serial" UUID exposed to guest
6405# in the virtual BIOS. (string value)
6406# Allowed values: none, os, hardware, auto
6407#sysinfo_serial=auto
6408
6409# A number of seconds to memory usage statistics period. Zero or negative value
6410# mean to disable memory usage statistics. (integer value)
6411#mem_stats_period_seconds=10
6412
6413# List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5
6414# allowed. (list value)
6415#uid_maps =
6416
6417# List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5
6418# allowed. (list value)
6419#gid_maps =
6420
6421# In a realtime host context vCPUs for guest will run in that scheduling
6422# priority. Priority depends on the host kernel (usually 1-99) (integer value)
6423#realtime_scheduler_priority=1
6424
6425#
6426# This is a performance event list which could be used as monitor. These events
6427# will be passed to libvirt domain xml while creating a new instances.
6428# Then event statistics data can be collected from libvirt. The minimum
6429# libvirt version is 2.0.0. For more information about `Performance monitoring
6430# events`, refer https://libvirt.org/formatdomain.html#elementsPerf .
6431#
6432# Possible values:
6433# * A string list. For example: ``enabled_perf_events = cmt, mbml, mbmt``
6434# The supported events list can be found in
6435# https://libvirt.org/html/libvirt-libvirt-domain.html ,
6436# which you may need to search key words ``VIR_PERF_PARAM_*``
6437# (list value)
6438#enabled_perf_events =
6439
6440#
6441# VM Images format.
6442#
6443# If default is specified, then use_cow_images flag is used instead of this
6444# one.
6445#
6446# Related options:
6447#
6448# * virt.use_cow_images
6449# * images_volume_group
6450# (string value)
6451# Allowed values: raw, flat, qcow2, lvm, rbd, ploop, default
6452#images_type=default
6453
6454#
6455# LVM Volume Group that is used for VM images, when you specify images_type=lvm
6456#
6457# Related options:
6458#
6459# * images_type
6460# (string value)
6461#images_volume_group=<None>
6462
6463#
6464# Create sparse logical volumes (with virtualsize) if this flag is set to True.
6465# (boolean value)
6466#sparse_logical_volumes=false
6467
6468# The RADOS pool in which rbd volumes are stored (string value)
6469#images_rbd_pool=rbd
6470
6471# Path to the ceph configuration file to use (string value)
6472#images_rbd_ceph_conf =
6473
6474#
6475# Discard option for nova managed disks.
6476#
6477# Requires:
6478#
6479# * Libvirt >= 1.0.6
6480# * Qemu >= 1.5 (raw format)
6481# * Qemu >= 1.6 (qcow2 format)
6482# (string value)
6483# Allowed values: ignore, unmap
6484#hw_disk_discard=<None>
Michel Nederlofeb566f62017-04-21 15:37:47 +02006485{%- if compute.libvirt.hw_disk_discard is defined %}
6486hw_disk_discard={{ compute.libvirt.hw_disk_discard }}
6487{%- endif %}
Jakub Pavlik02a01c72017-04-11 16:04:51 +02006488
6489# DEPRECATED: Allows image information files to be stored in non-standard
6490# locations (string value)
6491# This option is deprecated for removal since 14.0.0.
6492# Its value may be silently ignored in the future.
6493# Reason: Image info files are no longer used by the image cache
6494#image_info_filename_pattern=$instances_path/$image_cache_subdirectory_name/%(image)s.info
6495
6496# Unused resized base images younger than this will not be removed (integer
6497# value)
6498#remove_unused_resized_minimum_age_seconds=3600
6499
6500# DEPRECATED: Write a checksum for files in _base to disk (boolean value)
6501# This option is deprecated for removal since 14.0.0.
6502# Its value may be silently ignored in the future.
6503# Reason: The image cache no longer periodically calculates checksums of stored
6504# images. Data integrity can be checked at the block or filesystem level.
6505#checksum_base_images=false
6506
6507# DEPRECATED: How frequently to checksum base images (integer value)
6508# This option is deprecated for removal since 14.0.0.
6509# Its value may be silently ignored in the future.
6510# Reason: The image cache no longer periodically calculates checksums of stored
6511# images. Data integrity can be checked at the block or filesystem level.
6512#checksum_interval_seconds=3600
6513
6514#
6515# Method used to wipe ephemeral disks when they are deleted. Only takes effect
6516# if LVM is set as backing storage.
6517#
6518# Possible values:
6519#
6520# * none - do not wipe deleted volumes
6521# * zero - overwrite volumes with zeroes
6522# * shred - overwrite volume repeatedly
6523#
6524# Related options:
6525#
6526# * images_type - must be set to ``lvm``
6527# * volume_clear_size
6528# (string value)
6529# Allowed values: none, zero, shred
6530#volume_clear=zero
6531
6532#
6533# Size of area in MiB, counting from the beginning of the allocated volume,
6534# that will be cleared using method set in ``volume_clear`` option.
6535#
6536# Possible values:
6537#
6538# * 0 - clear whole volume
6539# * >0 - clear specified amount of MiB
6540#
6541# Related options:
6542#
6543# * images_type - must be set to ``lvm``
6544# * volume_clear - must be set and the value must be different than ``none``
6545# for this option to have any impact
6546# (integer value)
6547# Minimum value: 0
6548#volume_clear_size=0
6549
6550#
6551# Enable snapshot compression for ``qcow2`` images.
6552#
6553# Note: you can set ``snapshot_image_format`` to ``qcow2`` to force all
6554# snapshots to be in ``qcow2`` format, independently from their original image
6555# type.
6556#
6557# Related options:
6558#
6559# * snapshot_image_format
6560# (boolean value)
6561#snapshot_compression=false
6562
6563# Use virtio for bridge interfaces with KVM/QEMU (boolean value)
6564#use_virtio_for_bridges=true
6565
6566#
6567# Protocols listed here will be accessed directly from QEMU.
6568#
6569# If gluster is present in qemu_allowed_storage_drivers, glusterfs's backend
6570# will
6571# pass a disk configuration to QEMU. This allows QEMU to access the volume using
6572# libgfapi rather than mounting GlusterFS via fuse.
6573#
6574# Possible values:
6575#
6576# * [gluster]
6577# (list value)
6578#qemu_allowed_storage_drivers =
6579
6580#
6581# Use multipath connection of the iSCSI or FC volume
6582#
6583# Volumes can be connected in the LibVirt as multipath devices. This will
6584# provide high availability and fault tolerance.
6585# (boolean value)
6586# Deprecated group/name - [libvirt]/iscsi_use_multipath
6587#volume_use_multipath=false
6588
6589#
6590# Number of times to rediscover AoE target to find volume.
6591#
6592# Nova provides support for block storage attaching to hosts via AOE (ATA over
6593# Ethernet). This option allows the user to specify the maximum number of retry
6594# attempts that can be made to discover the AoE device.
6595# (integer value)
6596#num_aoe_discover_tries=3
6597
6598#
6599# Absolute path to the directory where the glusterfs volume is mounted on the
6600# compute node.
6601# (string value)
6602#glusterfs_mount_point_base=$state_path/mnt
6603
6604#
6605# Number of times to scan iSCSI target to find volume.
6606# (integer value)
6607#num_iscsi_scan_tries=5
6608
6609#
6610# The iSCSI transport iface to use to connect to target in case offload support
6611# is desired.
6612#
6613# Default format is of the form <transport_name>.<hwaddress> where
6614# <transport_name> is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and
6615# <hwaddress> is the MAC address of the interface and can be generated via the
6616# iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be
6617# provided here with the actual transport name.
6618# (string value)
6619# Deprecated group/name - [libvirt]/iscsi_transport
6620#iscsi_iface=<None>
6621
6622#
6623# Number of times to scan iSER target to find volume.
6624#
6625# iSER is a server network protocol that extends iSCSI protocol to use Remote
6626# Direct Memory Access (RDMA). This option allows the user to specify the
6627# maximum
6628# number of scan attempts that can be made to find iSER volume.
6629# (integer value)
6630#num_iser_scan_tries=5
6631
6632#
6633# Use multipath connection of the iSER volume.
6634#
6635# iSER volumes can be connected as multipath devices. This will provide high
6636# availability and fault tolerance.
6637# (boolean value)
6638#iser_use_multipath=false
6639
6640#
6641# The RADOS client name for accessing rbd(RADOS Block Devices) volumes.
6642#
6643# Libvirt will refer to this user when connecting and authenticating with
6644# the Ceph RBD server.
6645# (string value)
6646#rbd_user=<None>
6647
6648#
6649# The libvirt UUID of the secret for the rbd_user volumes.
6650# (string value)
6651#rbd_secret_uuid=<None>
6652
6653#
6654# Directory where the NFS volume is mounted on the compute node.
6655# The default is 'mnt' directory of the location where nova's Python module
6656# is installed.
6657#
6658# NFS provides shared storage for the OpenStack Block Storage service.
6659#
6660# Possible values:
6661#
6662# * A string representing absolute path of mount point.
6663# (string value)
6664#nfs_mount_point_base=$state_path/mnt
6665
6666#
6667# Mount options passed to the NFS client. See section of the nfs man page
6668# for details.
6669#
6670# Mount options controls the way the filesystem is mounted and how the
6671# NFS client behaves when accessing files on this mount point.
6672#
6673# Possible values:
6674#
6675# * Any string representing mount options separated by commas.
6676# * Example string: vers=3,lookupcache=pos
6677# (string value)
6678#nfs_mount_options=<None>
6679
6680#
6681# Directory where the Quobyte volume is mounted on the compute node.
6682#
6683# Nova supports Quobyte volume driver that enables storing Block Storage
6684# service volumes on a Quobyte storage back end. This Option sepcifies the
6685# path of the directory where Quobyte volume is mounted.
6686#
6687# Possible values:
6688#
6689# * A string representing absolute path of mount point.
6690# (string value)
6691#quobyte_mount_point_base=$state_path/mnt
6692
6693# Path to a Quobyte Client configuration file. (string value)
6694#quobyte_client_cfg=<None>
6695
6696#
6697# Path or URL to Scality SOFS(Scale-Out File Server) configuration file.
6698#
6699# The Scality SOFS provides OpenStack users the option of storing their
6700# data on a high capacity, replicated, highly available Scality Ring object
6701# storage cluster.
6702# (string value)
6703#scality_sofs_config=<None>
6704
6705#
6706# Base dir where Scality SOFS shall be mounted.
6707#
6708# The Scality volume driver in Nova mounts SOFS and lets the hypervisor access
6709# the volumes.
6710#
6711# Possible values:
6712#
6713# * $state_path/scality where state_path is a config option that specifies
6714# the top-level directory for maintaining nova's state or Any string
6715# containing the full directory path.
6716# (string value)
6717#scality_sofs_mount_point=$state_path/scality
6718
6719#
6720# Directory where the SMBFS shares are mounted on the compute node.
6721# (string value)
6722#smbfs_mount_point_base=$state_path/mnt
6723
6724#
6725# Mount options passed to the SMBFS client.
6726#
6727# Provide SMBFS options as a single string containing all parameters.
6728# See mount.cifs man page for details. Note that the libvirt-qemu ``uid``
6729# and ``gid`` must be specified.
6730# (string value)
6731#smbfs_mount_options =
6732
6733#
6734# libvirt's transport method for remote file operations.
6735#
6736# Because libvirt cannot use RPC to copy files over network to/from other
6737# compute nodes, other method must be used for:
6738#
6739# * creating directory on remote host
6740# * creating file on remote host
6741# * removing file from remote host
6742# * copying file to remote host
6743# (string value)
6744# Allowed values: ssh, rsync
6745#remote_filesystem_transport=ssh
6746
6747#
6748# Directory where the Virtuozzo Storage clusters are mounted on the compute
6749# node.
6750#
6751# This option defines non-standard mountpoint for Vzstorage cluster.
6752#
6753# Related options:
6754#
6755# * vzstorage_mount_* group of parameters
6756# (string value)
6757#vzstorage_mount_point_base=$state_path/mnt
6758
6759#
6760# Mount owner user name.
6761#
6762# This option defines the owner user of Vzstorage cluster mountpoint.
6763#
6764# Related options:
6765#
6766# * vzstorage_mount_* group of parameters
6767# (string value)
6768#vzstorage_mount_user=stack
6769
6770#
6771# Mount owner group name.
6772#
6773# This option defines the owner group of Vzstorage cluster mountpoint.
6774#
6775# Related options:
6776#
6777# * vzstorage_mount_* group of parameters
6778# (string value)
6779#vzstorage_mount_group=qemu
6780
6781#
6782# Mount access mode.
6783#
6784# This option defines the access bits of Vzstorage cluster mountpoint,
6785# in the format similar to one of chmod(1) utility, like this: 0770.
6786# It consists of one to four digits ranging from 0 to 7, with missing
6787# lead digits assumed to be 0's.
6788#
6789# Related options:
6790#
6791# * vzstorage_mount_* group of parameters
6792# (string value)
6793#vzstorage_mount_perms=0770
6794
6795#
6796# Path to vzstorage client log.
6797#
6798# This option defines the log of cluster operations,
6799# it should include "%(cluster_name)s" template to separate
6800# logs from multiple shares.
6801#
6802# Related options:
6803#
6804# * vzstorage_mount_opts may include more detailed logging options.
6805# (string value)
6806#vzstorage_log_path=/var/log/pstorage/%(cluster_name)s/nova.log.gz
6807
6808#
6809# Path to the SSD cache file.
6810#
6811# You can attach an SSD drive to a client and configure the drive to store
6812# a local cache of frequently accessed data. By having a local cache on a
6813# client's SSD drive, you can increase the overall cluster performance by
6814# up to 10 and more times.
6815# WARNING! There is a lot of SSD models which are not server grade and
6816# may loose arbitrary set of data changes on power loss.
6817# Such SSDs should not be used in Vstorage and are dangerous as may lead
6818# to data corruptions and inconsistencies. Please consult with the manual
6819# on which SSD models are known to be safe or verify it using
6820# vstorage-hwflush-check(1) utility.
6821#
6822# This option defines the path which should include "%(cluster_name)s"
6823# template to separate caches from multiple shares.
6824#
6825# Related options:
6826#
6827# * vzstorage_mount_opts may include more detailed cache options.
6828# (string value)
6829#vzstorage_cache_path=<None>
6830
6831#
6832# Extra mount options for pstorage-mount
6833#
6834# For full description of them, see
6835# https://static.openvz.org/vz-man/man1/pstorage-mount.1.gz.html
6836# Format is a python string representation of arguments list, like:
6837# "['-v', '-R', '500']"
6838# Shouldn't include -c, -l, -C, -u, -g and -m as those have
6839# explicit vzstorage_* options.
6840#
6841# Related options:
6842#
6843# * All other vzstorage_* options
6844# (list value)
6845#vzstorage_mount_opts =
6846
6847
6848[matchmaker_redis]
6849
6850#
6851# From oslo.messaging
6852#
6853
6854# DEPRECATED: Host to locate redis. (string value)
6855# This option is deprecated for removal.
6856# Its value may be silently ignored in the future.
6857# Reason: Replaced by [DEFAULT]/transport_url
6858#host=127.0.0.1
6859
6860# DEPRECATED: Use this port to connect to redis host. (port value)
6861# Minimum value: 0
6862# Maximum value: 65535
6863# This option is deprecated for removal.
6864# Its value may be silently ignored in the future.
6865# Reason: Replaced by [DEFAULT]/transport_url
6866#port=6379
6867
6868# DEPRECATED: Password for Redis server (optional). (string value)
6869# This option is deprecated for removal.
6870# Its value may be silently ignored in the future.
6871# Reason: Replaced by [DEFAULT]/transport_url
6872#password =
6873
6874# DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g.,
6875# [host:port, host1:port ... ] (list value)
6876# This option is deprecated for removal.
6877# Its value may be silently ignored in the future.
6878# Reason: Replaced by [DEFAULT]/transport_url
6879#sentinel_hosts =
6880
6881# Redis replica set name. (string value)
6882#sentinel_group_name=oslo-messaging-zeromq
6883
6884# Time in ms to wait between connection attempts. (integer value)
6885#wait_timeout=2000
6886
6887# Time in ms to wait before the transaction is killed. (integer value)
6888#check_timeout=20000
6889
6890# Timeout in ms on blocking socket operations. (integer value)
6891#socket_timeout=10000
6892
6893
6894[metrics]
6895#
6896# Configuration options for metrics
6897#
6898# Options under this group allow to adjust how values assigned to metrics are
6899# calculated.
6900
6901#
6902# From nova.conf
6903#
6904
6905#
6906# When using metrics to weight the suitability of a host, you can use this
6907# option
6908# to change how the calculated weight influences the weight assigned to a host
6909# as
6910# follows:
6911#
6912# * >1.0: increases the effect of the metric on overall weight
6913# * 1.0: no change to the calculated weight
6914# * >0.0,<1.0: reduces the effect of the metric on overall weight
6915# * 0.0: the metric value is ignored, and the value of the
6916# 'weight_of_unavailable' option is returned instead
6917# * >-1.0,<0.0: the effect is reduced and reversed
6918# * -1.0: the effect is reversed
6919# * <-1.0: the effect is increased proportionally and reversed
6920#
6921# This option is only used by the FilterScheduler and its subclasses; if you use
6922# a different scheduler, this option has no effect.
6923#
6924# Possible values:
6925#
6926# * An integer or float value, where the value corresponds to the multipler
6927# ratio for this weigher.
6928#
6929# Related options:
6930#
6931# * weight_of_unavailable
6932# (floating point value)
6933#weight_multiplier=1.0
6934
6935#
6936# This setting specifies the metrics to be weighed and the relative ratios for
6937# each metric. This should be a single string value, consisting of a series of
6938# one or more 'name=ratio' pairs, separated by commas, where 'name' is the name
6939# of the metric to be weighed, and 'ratio' is the relative weight for that
6940# metric.
6941#
6942# Note that if the ratio is set to 0, the metric value is ignored, and instead
6943# the weight will be set to the value of the 'weight_of_unavailable' option.
6944#
6945# As an example, let's consider the case where this option is set to:
6946#
6947# ``name1=1.0, name2=-1.3``
6948#
6949# The final weight will be:
6950#
6951# ``(name1.value * 1.0) + (name2.value * -1.3)``
6952#
6953# This option is only used by the FilterScheduler and its subclasses; if you use
6954# a different scheduler, this option has no effect.
6955#
6956# Possible values:
6957#
6958# * A list of zero or more key/value pairs separated by commas, where the key is
6959# a string representing the name of a metric and the value is a numeric weight
6960# for that metric. If any value is set to 0, the value is ignored and the
6961# weight will be set to the value of the 'weight_of_unavailable' option.
6962#
6963# Related options:
6964#
6965# * weight_of_unavailable
6966# (list value)
6967#weight_setting =
6968
6969#
6970# This setting determines how any unavailable metrics are treated. If this
6971# option
6972# is set to True, any hosts for which a metric is unavailable will raise an
6973# exception, so it is recommended to also use the MetricFilter to filter out
6974# those hosts before weighing.
6975#
6976# This option is only used by the FilterScheduler and its subclasses; if you use
6977# a different scheduler, this option has no effect.
6978#
6979# Possible values:
6980#
6981# * True or False, where False ensures any metric being unavailable for a host
6982# will set the host weight to 'weight_of_unavailable'.
6983#
6984# Related options:
6985#
6986# * weight_of_unavailable
6987# (boolean value)
6988#required=true
6989
6990#
6991# When any of the following conditions are met, this value will be used in place
6992# of any actual metric value:
6993#
6994# * One of the metrics named in 'weight_setting' is not available for a host,
6995# and the value of 'required' is False
6996# * The ratio specified for a metric in 'weight_setting' is 0
6997# * The 'weight_multiplier' option is set to 0
6998#
6999# This option is only used by the FilterScheduler and its subclasses; if you use
7000# a different scheduler, this option has no effect.
7001#
7002# Possible values:
7003#
7004# * An integer or float value, where the value corresponds to the multipler
7005# ratio for this weigher.
7006#
7007# Related options:
7008#
7009# * weight_setting
7010# * required
7011# * weight_multiplier
7012# (floating point value)
7013#weight_of_unavailable=-10000.0
7014
7015
7016[mks]
7017#
7018# Nova compute node uses WebMKS, a desktop sharing protocol to provide
7019# instance console access to VM's created by VMware hypervisors.
7020#
7021# Related options:
7022# Following options must be set to provide console access.
7023# * mksproxy_base_url
7024# * enabled
7025
7026#
7027# From nova.conf
7028#
7029
7030#
7031# Location of MKS web console proxy
7032#
7033# The URL in the response points to a WebMKS proxy which
7034# starts proxying between client and corresponding vCenter
7035# server where instance runs. In order to use the web based
7036# console access, WebMKS proxy should be installed and configured
7037#
7038# Possible values:
7039#
7040# * Must be a valid URL of the form:``http://host:port/``
7041# (string value)
7042#mksproxy_base_url=http://127.0.0.1:6090/
7043
7044#
7045# Enables graphical console access for virtual machines.
7046# (boolean value)
7047#enabled=false
7048
7049
7050[neutron]
7051#
7052# Configuration options for neutron (network connectivity as a service).
7053
7054#
7055# From nova.conf
7056#
7057username={{ compute.network.user }}
7058password={{ compute.network.password }}
7059project_name={{ compute.identity.tenant }}
7060auth_url=http://{{ compute.identity.host }}:{{ compute.identity.port }}/v3
7061url=http://{{ compute.network.host }}:{{ compute.network.port }}
7062region_name= {{ compute.network.region }}
7063extension_sync_interval={{ compute.network.get('extension_sync_interval', '600') }}
7064auth_type = v3password
7065project_domain_name = Default
7066user_domain_name = Default
7067timeout=30
7068#
7069# This option specifies the URL for connecting to Neutron.
7070#
7071# Possible values:
7072#
7073# * Any valid URL that points to the Neutron API service is appropriate here.
7074# This typically matches the URL returned for the 'network' service type
7075# from the Keystone service catalog.
7076# (uri value)
7077#url=http://127.0.0.1:9696
7078
7079#
7080# Region name for connecting to Neutron in admin context.
7081#
7082# This option is used in multi-region setups. If there are two Neutron
7083# servers running in two regions in two different machines, then two
7084# services need to be created in Keystone with two different regions and
7085# associate corresponding endpoints to those services. When requests are made
7086# to Keystone, the Keystone service uses the region_name to determine the
7087# region the request is coming from.
7088# (string value)
7089#region_name=RegionOne
7090
7091#
7092# Specifies the name of an integration bridge interface used by OpenvSwitch.
7093# This option is used only if Neutron does not specify the OVS bridge name.
7094#
7095# Possible values:
7096#
7097# * Any string representing OVS bridge name.
7098# (string value)
7099#ovs_bridge=br-int
7100
7101#
7102# Integer value representing the number of seconds to wait before querying
7103# Neutron for extensions. After this number of seconds the next time Nova
7104# needs to create a resource in Neutron it will requery Neutron for the
7105# extensions that it has loaded. Setting value to 0 will refresh the
7106# extensions with no wait.
7107# (integer value)
7108# Minimum value: 0
7109#extension_sync_interval=600
7110
7111#
7112# When set to True, this option indicates that Neutron will be used to proxy
7113# metadata requests and resolve instance ids. Otherwise, the instance ID must be
7114# passed to the metadata request in the 'X-Instance-ID' header.
7115#
7116# Related options:
7117#
7118# * metadata_proxy_shared_secret
7119# (boolean value)
7120#service_metadata_proxy=false
7121
7122#
7123# This option holds the shared secret string used to validate proxy requests to
7124# Neutron metadata requests. In order to be used, the
7125# 'X-Metadata-Provider-Signature' header must be supplied in the request.
7126#
7127# Related options:
7128#
7129# * service_metadata_proxy
7130# (string value)
7131#metadata_proxy_shared_secret =
7132
7133# PEM encoded Certificate Authority to use when verifying HTTPs connections.
7134# (string value)
7135#cafile=<None>
7136
7137# PEM encoded client certificate cert file (string value)
7138#certfile=<None>
7139
7140# PEM encoded client certificate key file (string value)
7141#keyfile=<None>
7142
7143# Verify HTTPS connections. (boolean value)
7144#insecure=false
7145
7146# Timeout value for http requests (integer value)
7147#timeout=<None>
7148timeout = 300
7149
7150# Authentication type to load (string value)
7151# Deprecated group/name - [neutron]/auth_plugin
7152#auth_type=<None>
7153
7154# Config Section from which to load plugin specific options (string value)
7155#auth_section=<None>
7156
7157# Authentication URL (string value)
7158#auth_url=<None>
7159
7160# Domain ID to scope to (string value)
7161#domain_id=<None>
7162
7163# Domain name to scope to (string value)
7164#domain_name=<None>
7165
7166# Project ID to scope to (string value)
7167#project_id=<None>
7168
7169# Project name to scope to (string value)
7170#project_name=<None>
7171
7172# Domain ID containing project (string value)
7173#project_domain_id=<None>
7174
7175# Domain name containing project (string value)
7176#project_domain_name=<None>
7177
7178# Trust ID (string value)
7179#trust_id=<None>
7180
7181# Optional domain ID to use with v3 and v2 parameters. It will be used for both
7182# the user and project domain in v3 and ignored in v2 authentication. (string
7183# value)
7184#default_domain_id=<None>
7185
7186# Optional domain name to use with v3 API and v2 parameters. It will be used for
7187# both the user and project domain in v3 and ignored in v2 authentication.
7188# (string value)
7189#default_domain_name=<None>
7190
7191# User ID (string value)
7192#user_id=<None>
7193
7194# Username (string value)
7195# Deprecated group/name - [neutron]/user-name
7196#username=<None>
7197
7198# User's domain id (string value)
7199#user_domain_id=<None>
7200
7201# User's domain name (string value)
7202#user_domain_name=<None>
7203
7204# User's password (string value)
7205#password=<None>
7206
7207# Tenant ID (string value)
7208#tenant_id=<None>
7209
7210# Tenant Name (string value)
7211#tenant_name=<None>
7212
7213
7214[notifications]
7215#
7216# Most of the actions in Nova which manipulate the system state generate
7217# notifications which are posted to the messaging component (e.g. RabbitMQ) and
7218# can be consumed by any service outside the Openstack. More technical details
7219# at http://docs.openstack.org/developer/nova/notifications.html
7220
7221#
7222# From nova.conf
7223#
7224
7225#
7226# If set, send compute.instance.update notifications on instance state
7227# changes.
7228#
7229# Please refer to https://wiki.openstack.org/wiki/SystemUsageData for
7230# additional information on notifications.
7231#
7232# Possible values:
7233#
7234# * None - no notifications
7235# * "vm_state" - notifications on VM state changes
7236# * "vm_and_task_state" - notifications on VM and task state changes
7237# (string value)
7238# Allowed values: <None>, vm_state, vm_and_task_state
7239# Deprecated group/name - [DEFAULT]/notify_on_state_change
7240#notify_on_state_change=<None>
7241{%- if compute.get('notification', {}).notify_on is defined %}
7242{%- for key, value in compute.notification.notify_on.iteritems() %}
7243notify_on_{{ key }} = {{ value }}
7244{%- endfor %}
7245{%- elif pillar.ceilometer is defined %}
7246notify_on_state_change = vm_and_task_state
7247{%- endif %}
7248
7249#
7250# If enabled, send api.fault notifications on caught exceptions in the
7251# API service.
7252# (boolean value)
7253# Deprecated group/name - [DEFAULT]/notify_api_faults
7254#notify_on_api_faults=false
7255notify_on_api_faults=false
7256
7257# Default notification level for outgoing notifications. (string value)
7258# Allowed values: DEBUG, INFO, WARN, ERROR, CRITICAL
7259# Deprecated group/name - [DEFAULT]/default_notification_level
7260#default_level=INFO
7261
7262#
7263# Default publisher_id for outgoing notifications. If you consider routing
7264# notifications using different publisher, change this value accordingly.
7265#
7266# Possible values:
7267#
7268# * Defaults to the IPv4 address of this host, but it can be any valid
7269# oslo.messaging publisher_id
7270#
7271# Related options:
7272#
7273# * my_ip - IP address of this host
7274# (string value)
7275# Deprecated group/name - [DEFAULT]/default_publisher_id
7276#default_publisher_id=$my_ip
7277
7278#
7279# Specifies which notification format shall be used by nova.
7280#
7281# The default value is fine for most deployments and rarely needs to be changed.
7282# This value can be set to 'versioned' once the infrastructure moves closer to
7283# consuming the newer format of notifications. After this occurs, this option
7284# will be removed (possibly in the "P" release).
7285#
7286# Possible values:
7287# * unversioned: Only the legacy unversioned notifications are emitted.
7288# * versioned: Only the new versioned notifications are emitted.
7289# * both: Both the legacy unversioned and the new versioned notifications are
7290# emitted. (Default)
7291#
7292# The list of versioned notifications is visible in
7293# http://docs.openstack.org/developer/nova/notifications.html
7294# (string value)
7295# Allowed values: unversioned, versioned, both
7296# Deprecated group/name - [DEFAULT]/notification_format
7297#notification_format=both
7298
7299
7300[osapi_v21]
7301
7302#
7303# From nova.conf
7304#
7305
7306# DEPRECATED:
7307# This option is a list of all of the v2.1 API extensions to never load.
7308#
7309# Possible values:
7310#
7311# * A list of strings, each being the alias of an extension that you do not
7312# wish to load.
7313#
7314# Related options:
7315#
7316# * enabled
7317# * extensions_whitelist
7318# (list value)
7319# This option is deprecated for removal since 12.0.0.
7320# Its value may be silently ignored in the future.
7321# Reason:
7322# API extensions are now part of the standard API. API extensions should be
7323# disabled using policy, rather than via these configuration options.
7324#extensions_blacklist =
7325
7326# DEPRECATED:
7327# This is a list of extensions. If it is empty, then *all* extensions except
7328# those specified in the extensions_blacklist option will be loaded. If it is
7329# not
7330# empty, then only those extensions in this list will be loaded, provided that
7331# they are also not in the extensions_blacklist option.
7332#
7333# Possible values:
7334#
7335# * A list of strings, each being the alias of an extension that you wish to
7336# load, or an empty list, which indicates that all extensions are to be run.
7337#
7338# Related options:
7339#
7340# * enabled
7341# * extensions_blacklist
7342# (list value)
7343# This option is deprecated for removal since 12.0.0.
7344# Its value may be silently ignored in the future.
7345# Reason:
7346# API extensions are now part of the standard API. API extensions should be
7347# disabled using policy, rather than via these configuration options.
7348#extensions_whitelist =
7349
7350# DEPRECATED:
7351# This option is a string representing a regular expression (regex) that matches
7352# the project_id as contained in URLs. If not set, it will match normal UUIDs
7353# created by keystone.
7354#
7355# Possible values:
7356#
7357# * A string representing any legal regular expression
7358# (string value)
7359# This option is deprecated for removal since 13.0.0.
7360# Its value may be silently ignored in the future.
7361# Reason:
7362# Recent versions of nova constrain project IDs to hexadecimal characters and
7363# dashes. If your installation uses IDs outside of this range, you should use
7364# this option to provide your own regex and give you time to migrate offending
7365# projects to valid IDs before the next release.
7366#project_id_regex=<None>
7367
7368
7369[oslo_concurrency]
7370
7371#
7372# From oslo.concurrency
7373#
7374
7375# Enables or disables inter-process locks. (boolean value)
7376# Deprecated group/name - [DEFAULT]/disable_process_locking
7377#disable_process_locking=false
7378
7379# Directory to use for lock files. For security, the specified directory should
7380# only be writable by the user running the processes that need locking. Defaults
7381# to environment variable OSLO_LOCK_PATH. If OSLO_LOCK_PATH is not set in the
7382# environment, use the Python tempfile.gettempdir function to find a suitable
7383# location. If external locks are used, a lock path must be set. (string value)
7384# Deprecated group/name - [DEFAULT]/lock_path
7385lock_path = /var/lib/nova/tmp
7386
7387
7388[oslo_messaging_amqp]
7389
7390#
7391# From oslo.messaging
7392#
7393
7394# Name for the AMQP container. must be globally unique. Defaults to a generated
7395# UUID (string value)
7396# Deprecated group/name - [amqp1]/container_name
7397#container_name=<None>
7398
7399# Timeout for inactive connections (in seconds) (integer value)
7400# Deprecated group/name - [amqp1]/idle_timeout
7401#idle_timeout=0
7402
7403# Debug: dump AMQP frames to stdout (boolean value)
7404# Deprecated group/name - [amqp1]/trace
7405#trace=false
7406
7407# CA certificate PEM file used to verify the server's certificate (string value)
7408# Deprecated group/name - [amqp1]/ssl_ca_file
7409#ssl_ca_file =
7410
7411# Self-identifying certificate PEM file for client authentication (string value)
7412# Deprecated group/name - [amqp1]/ssl_cert_file
7413#ssl_cert_file =
7414
7415# Private key PEM file used to sign ssl_cert_file certificate (optional) (string
7416# value)
7417# Deprecated group/name - [amqp1]/ssl_key_file
7418#ssl_key_file =
7419
7420# Password for decrypting ssl_key_file (if encrypted) (string value)
7421# Deprecated group/name - [amqp1]/ssl_key_password
7422#ssl_key_password=<None>
7423
7424# DEPRECATED: Accept clients using either SSL or plain TCP (boolean value)
7425# Deprecated group/name - [amqp1]/allow_insecure_clients
7426# This option is deprecated for removal.
7427# Its value may be silently ignored in the future.
7428# Reason: Not applicable - not a SSL server
7429#allow_insecure_clients=false
7430
7431# Space separated list of acceptable SASL mechanisms (string value)
7432# Deprecated group/name - [amqp1]/sasl_mechanisms
7433#sasl_mechanisms =
7434
7435# Path to directory that contains the SASL configuration (string value)
7436# Deprecated group/name - [amqp1]/sasl_config_dir
7437#sasl_config_dir =
7438
7439# Name of configuration file (without .conf suffix) (string value)
7440# Deprecated group/name - [amqp1]/sasl_config_name
7441#sasl_config_name =
7442
7443# User name for message broker authentication (string value)
7444# Deprecated group/name - [amqp1]/username
7445#username =
7446
7447# Password for message broker authentication (string value)
7448# Deprecated group/name - [amqp1]/password
7449#password =
7450
7451# Seconds to pause before attempting to re-connect. (integer value)
7452# Minimum value: 1
7453#connection_retry_interval=1
7454
7455# Increase the connection_retry_interval by this many seconds after each
7456# unsuccessful failover attempt. (integer value)
7457# Minimum value: 0
7458#connection_retry_backoff=2
7459
7460# Maximum limit for connection_retry_interval + connection_retry_backoff
7461# (integer value)
7462# Minimum value: 1
7463#connection_retry_interval_max=30
7464
7465# Time to pause between re-connecting an AMQP 1.0 link that failed due to a
7466# recoverable error. (integer value)
7467# Minimum value: 1
7468#link_retry_delay=10
7469
7470# The maximum number of attempts to re-send a reply message which failed due to
7471# a recoverable error. (integer value)
7472# Minimum value: -1
7473#default_reply_retry=0
7474
7475# The deadline for an rpc reply message delivery. (integer value)
7476# Minimum value: 5
7477#default_reply_timeout=30
7478
7479# The deadline for an rpc cast or call message delivery. Only used when caller
7480# does not provide a timeout expiry. (integer value)
7481# Minimum value: 5
7482#default_send_timeout=30
7483
7484# The deadline for a sent notification message delivery. Only used when caller
7485# does not provide a timeout expiry. (integer value)
7486# Minimum value: 5
7487#default_notify_timeout=30
7488
7489# The duration to schedule a purge of idle sender links. Detach link after
7490# expiry. (integer value)
7491# Minimum value: 1
7492#default_sender_link_timeout=600
7493
7494# Indicates the addressing mode used by the driver.
7495# Permitted values:
7496# 'legacy' - use legacy non-routable addressing
7497# 'routable' - use routable addresses
7498# 'dynamic' - use legacy addresses if the message bus does not support routing
7499# otherwise use routable addressing (string value)
7500#addressing_mode=dynamic
7501
7502# address prefix used when sending to a specific server (string value)
7503# Deprecated group/name - [amqp1]/server_request_prefix
7504#server_request_prefix=exclusive
7505
7506# address prefix used when broadcasting to all servers (string value)
7507# Deprecated group/name - [amqp1]/broadcast_prefix
7508#broadcast_prefix=broadcast
7509
7510# address prefix when sending to any server in group (string value)
7511# Deprecated group/name - [amqp1]/group_request_prefix
7512#group_request_prefix=unicast
7513
7514# Address prefix for all generated RPC addresses (string value)
7515#rpc_address_prefix=openstack.org/om/rpc
7516
7517# Address prefix for all generated Notification addresses (string value)
7518#notify_address_prefix=openstack.org/om/notify
7519
7520# Appended to the address prefix when sending a fanout message. Used by the
7521# message bus to identify fanout messages. (string value)
7522#multicast_address=multicast
7523
7524# Appended to the address prefix when sending to a particular RPC/Notification
7525# server. Used by the message bus to identify messages sent to a single
7526# destination. (string value)
7527#unicast_address=unicast
7528
7529# Appended to the address prefix when sending to a group of consumers. Used by
7530# the message bus to identify messages that should be delivered in a round-robin
7531# fashion across consumers. (string value)
7532#anycast_address=anycast
7533
7534# Exchange name used in notification addresses.
7535# Exchange name resolution precedence:
7536# Target.exchange if set
7537# else default_notification_exchange if set
7538# else control_exchange if set
7539# else 'notify' (string value)
7540#default_notification_exchange=<None>
7541
7542# Exchange name used in RPC addresses.
7543# Exchange name resolution precedence:
7544# Target.exchange if set
7545# else default_rpc_exchange if set
7546# else control_exchange if set
7547# else 'rpc' (string value)
7548#default_rpc_exchange=<None>
7549
7550# Window size for incoming RPC Reply messages. (integer value)
7551# Minimum value: 1
7552#reply_link_credit=200
7553
7554# Window size for incoming RPC Request messages (integer value)
7555# Minimum value: 1
7556#rpc_server_credit=100
7557
7558# Window size for incoming Notification messages (integer value)
7559# Minimum value: 1
7560#notify_server_credit=100
7561
7562# Send messages of this type pre-settled.
7563# Pre-settled messages will not receive acknowledgement
7564# from the peer. Note well: pre-settled messages may be
7565# silently discarded if the delivery fails.
7566# Permitted values:
7567# 'rpc-call' - send RPC Calls pre-settled
7568# 'rpc-reply'- send RPC Replies pre-settled
7569# 'rpc-cast' - Send RPC Casts pre-settled
7570# 'notify' - Send Notifications pre-settled
7571# (multi valued)
7572#pre_settled=rpc-cast
7573#pre_settled=rpc-reply
7574
7575
7576[oslo_messaging_kafka]
7577
7578#
7579# From oslo.messaging
7580#
7581
7582# DEPRECATED: Default Kafka broker Host (string value)
7583# This option is deprecated for removal.
7584# Its value may be silently ignored in the future.
7585# Reason: Replaced by [DEFAULT]/transport_url
7586#kafka_default_host=localhost
7587
7588# DEPRECATED: Default Kafka broker Port (port value)
7589# Minimum value: 0
7590# Maximum value: 65535
7591# This option is deprecated for removal.
7592# Its value may be silently ignored in the future.
7593# Reason: Replaced by [DEFAULT]/transport_url
7594#kafka_default_port=9092
7595
7596# Max fetch bytes of Kafka consumer (integer value)
7597#kafka_max_fetch_bytes=1048576
7598
7599# Default timeout(s) for Kafka consumers (integer value)
7600#kafka_consumer_timeout=1.0
7601
7602# Pool Size for Kafka Consumers (integer value)
7603#pool_size=10
7604
7605# The pool size limit for connections expiration policy (integer value)
7606#conn_pool_min_size=2
7607
7608# The time-to-live in sec of idle connections in the pool (integer value)
7609#conn_pool_ttl=1200
7610
7611# Group id for Kafka consumer. Consumers in one group will coordinate message
7612# consumption (string value)
7613#consumer_group=oslo_messaging_consumer
7614
7615# Upper bound on the delay for KafkaProducer batching in seconds (floating point
7616# value)
7617#producer_batch_timeout=0.0
7618
7619# Size of batch for the producer async send (integer value)
7620#producer_batch_size=16384
7621
7622
7623[oslo_messaging_notifications]
7624
7625#
7626# From oslo.messaging
7627#
7628{%- if compute.notification is mapping %}
7629driver = {{ compute.notification.get('driver', 'messagingv2') }}
7630{%- if compute.notification.topics is defined %}
7631topics = {{ compute.notification.topics }}
7632{%- endif %}
7633{%- elif compute.notification %}
7634driver = messagingv2
7635{%- endif %}
7636
7637# The Drivers(s) to handle sending notifications. Possible values are messaging,
7638# messagingv2, routing, log, test, noop (multi valued)
7639# Deprecated group/name - [DEFAULT]/notification_driver
7640#driver =
7641
7642# A URL representing the messaging driver to use for notifications. If not set,
7643# we fall back to the same configuration used for RPC. (string value)
7644# Deprecated group/name - [DEFAULT]/notification_transport_url
7645#transport_url=<None>
7646
7647# AMQP topic used for OpenStack notifications. (list value)
7648# Deprecated group/name - [rpc_notifier2]/topics
7649# Deprecated group/name - [DEFAULT]/notification_topics
7650#topics=notifications
7651
7652
7653[oslo_messaging_rabbit]
7654
7655#
7656# From oslo.messaging
7657#
7658
7659# Use durable queues in AMQP. (boolean value)
7660# Deprecated group/name - [DEFAULT]/amqp_durable_queues
7661# Deprecated group/name - [DEFAULT]/rabbit_durable_queues
7662#amqp_durable_queues=false
7663
7664# Auto-delete queues in AMQP. (boolean value)
7665# Deprecated group/name - [DEFAULT]/amqp_auto_delete
7666#amqp_auto_delete=false
7667
7668# SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and
7669# SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some
7670# distributions. (string value)
7671# Deprecated group/name - [DEFAULT]/kombu_ssl_version
7672#kombu_ssl_version =
7673
7674# SSL key file (valid only if SSL enabled). (string value)
7675# Deprecated group/name - [DEFAULT]/kombu_ssl_keyfile
7676#kombu_ssl_keyfile =
7677
7678# SSL cert file (valid only if SSL enabled). (string value)
7679# Deprecated group/name - [DEFAULT]/kombu_ssl_certfile
7680#kombu_ssl_certfile =
7681
7682# SSL certification authority file (valid only if SSL enabled). (string value)
7683# Deprecated group/name - [DEFAULT]/kombu_ssl_ca_certs
7684#kombu_ssl_ca_certs =
7685
7686# How long to wait before reconnecting in response to an AMQP consumer cancel
7687# notification. (floating point value)
7688# Deprecated group/name - [DEFAULT]/kombu_reconnect_delay
7689#kombu_reconnect_delay=1.0
7690
7691# EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not
7692# be used. This option may not be available in future versions. (string value)
7693#kombu_compression=<None>
7694
7695# How long to wait a missing client before abandoning to send it its replies.
7696# This value should not be longer than rpc_response_timeout. (integer value)
7697# Deprecated group/name - [oslo_messaging_rabbit]/kombu_reconnect_timeout
7698#kombu_missing_consumer_retry_timeout=60
7699
7700# Determines how the next RabbitMQ node is chosen in case the one we are
7701# currently connected to becomes unavailable. Takes effect only if more than one
7702# RabbitMQ node is provided in config. (string value)
7703# Allowed values: round-robin, shuffle
7704#kombu_failover_strategy=round-robin
7705
7706# DEPRECATED: The RabbitMQ broker address where a single node is used. (string
7707# value)
7708# Deprecated group/name - [DEFAULT]/rabbit_host
7709# This option is deprecated for removal.
7710# Its value may be silently ignored in the future.
7711# Reason: Replaced by [DEFAULT]/transport_url
7712#rabbit_host=localhost
7713
7714# DEPRECATED: The RabbitMQ broker port where a single node is used. (port value)
7715# Minimum value: 0
7716# Maximum value: 65535
7717# Deprecated group/name - [DEFAULT]/rabbit_port
7718# This option is deprecated for removal.
7719# Its value may be silently ignored in the future.
7720# Reason: Replaced by [DEFAULT]/transport_url
7721#rabbit_port=5672
7722
7723# DEPRECATED: RabbitMQ HA cluster host:port pairs. (list value)
7724# Deprecated group/name - [DEFAULT]/rabbit_hosts
7725# This option is deprecated for removal.
7726# Its value may be silently ignored in the future.
7727# Reason: Replaced by [DEFAULT]/transport_url
7728#rabbit_hosts=$rabbit_host:$rabbit_port
7729
7730# Connect over SSL for RabbitMQ. (boolean value)
7731# Deprecated group/name - [DEFAULT]/rabbit_use_ssl
7732#rabbit_use_ssl=false
7733
7734# DEPRECATED: The RabbitMQ userid. (string value)
7735# Deprecated group/name - [DEFAULT]/rabbit_userid
7736# This option is deprecated for removal.
7737# Its value may be silently ignored in the future.
7738# Reason: Replaced by [DEFAULT]/transport_url
7739#rabbit_userid=guest
7740
7741# DEPRECATED: The RabbitMQ password. (string value)
7742# Deprecated group/name - [DEFAULT]/rabbit_password
7743# This option is deprecated for removal.
7744# Its value may be silently ignored in the future.
7745# Reason: Replaced by [DEFAULT]/transport_url
7746#rabbit_password=guest
7747
7748# The RabbitMQ login method. (string value)
7749# Allowed values: PLAIN, AMQPLAIN, RABBIT-CR-DEMO
7750# Deprecated group/name - [DEFAULT]/rabbit_login_method
7751#rabbit_login_method=AMQPLAIN
7752
7753# DEPRECATED: The RabbitMQ virtual host. (string value)
7754# Deprecated group/name - [DEFAULT]/rabbit_virtual_host
7755# This option is deprecated for removal.
7756# Its value may be silently ignored in the future.
7757# Reason: Replaced by [DEFAULT]/transport_url
7758#rabbit_virtual_host=/
7759
7760# How frequently to retry connecting with RabbitMQ. (integer value)
7761#rabbit_retry_interval=1
7762
7763# How long to backoff for between retries when connecting to RabbitMQ. (integer
7764# value)
7765# Deprecated group/name - [DEFAULT]/rabbit_retry_backoff
7766#rabbit_retry_backoff=2
7767
7768# Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
7769# (integer value)
7770#rabbit_interval_max=30
7771
7772# DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0
7773# (infinite retry count). (integer value)
7774# Deprecated group/name - [DEFAULT]/rabbit_max_retries
7775# This option is deprecated for removal.
7776# Its value may be silently ignored in the future.
7777#rabbit_max_retries=0
7778
7779# Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this
7780# option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring
7781# is no longer controlled by the x-ha-policy argument when declaring a queue. If
7782# you just want to make sure that all queues (except those with auto-generated
7783# names) are mirrored across all nodes, run: "rabbitmqctl set_policy HA
7784# '^(?!amq\.).*' '{"ha-mode": "all"}' " (boolean value)
7785# Deprecated group/name - [DEFAULT]/rabbit_ha_queues
7786#rabbit_ha_queues=false
7787
7788# Positive integer representing duration in seconds for queue TTL (x-expires).
7789# Queues which are unused for the duration of the TTL are automatically deleted.
7790# The parameter affects only reply and fanout queues. (integer value)
7791# Minimum value: 1
7792#rabbit_transient_queues_ttl=1800
7793
7794# Specifies the number of messages to prefetch. Setting to zero allows unlimited
7795# messages. (integer value)
7796#rabbit_qos_prefetch_count=0
7797
7798# Number of seconds after which the Rabbit broker is considered down if
7799# heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL (integer
7800# value)
7801#heartbeat_timeout_threshold=60
7802
7803# How often times during the heartbeat_timeout_threshold we check the heartbeat.
7804# (integer value)
7805#heartbeat_rate=2
7806
7807# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
7808# Deprecated group/name - [DEFAULT]/fake_rabbit
7809#fake_rabbit=false
7810
7811# Maximum number of channels to allow (integer value)
7812#channel_max=<None>
7813
7814# The maximum byte size for an AMQP frame (integer value)
7815#frame_max=<None>
7816
7817# How often to send heartbeats for consumer's connections (integer value)
7818#heartbeat_interval=3
7819
7820# Enable SSL (boolean value)
7821#ssl=<None>
7822
7823# Arguments passed to ssl.wrap_socket (dict value)
7824#ssl_options=<None>
7825
7826# Set socket timeout in seconds for connection's socket (floating point value)
7827#socket_timeout=0.25
7828
7829# Set TCP_USER_TIMEOUT in seconds for connection's socket (floating point value)
7830#tcp_user_timeout=0.25
7831
7832# Set delay for reconnection to some host which has connection error (floating
7833# point value)
7834#host_connection_reconnect_delay=0.25
7835
7836# Connection factory implementation (string value)
7837# Allowed values: new, single, read_write
7838#connection_factory=single
7839
7840# Maximum number of connections to keep queued. (integer value)
7841#pool_max_size=30
7842
7843# Maximum number of connections to create above `pool_max_size`. (integer value)
7844#pool_max_overflow=0
7845
7846# Default number of seconds to wait for a connections to available (integer
7847# value)
7848#pool_timeout=30
7849
7850# Lifetime of a connection (since creation) in seconds or None for no recycling.
7851# Expired connections are closed on acquire. (integer value)
7852#pool_recycle=600
7853
7854# Threshold at which inactive (since release) connections are considered stale
7855# in seconds or None for no staleness. Stale connections are closed on acquire.
7856# (integer value)
7857#pool_stale=60
7858
7859# Default serialization mechanism for serializing/deserializing
7860# outgoing/incoming messages (string value)
7861# Allowed values: json, msgpack
7862#default_serializer_type=json
7863
7864# Persist notification messages. (boolean value)
7865#notification_persistence=false
7866
7867# Exchange name for sending notifications (string value)
7868#default_notification_exchange=${control_exchange}_notification
7869
7870# Max number of not acknowledged message which RabbitMQ can send to notification
7871# listener. (integer value)
7872#notification_listener_prefetch_count=100
7873
7874# Reconnecting retry count in case of connectivity problem during sending
7875# notification, -1 means infinite retry. (integer value)
7876#default_notification_retry_attempts=-1
7877
7878# Reconnecting retry delay in case of connectivity problem during sending
7879# notification message (floating point value)
7880#notification_retry_delay=0.25
7881
7882# Time to live for rpc queues without consumers in seconds. (integer value)
7883#rpc_queue_expiration=60
7884
7885# Exchange name for sending RPC messages (string value)
7886#default_rpc_exchange=${control_exchange}_rpc
7887
7888# Exchange name for receiving RPC replies (string value)
7889#rpc_reply_exchange=${control_exchange}_rpc_reply
7890
7891# Max number of not acknowledged message which RabbitMQ can send to rpc
7892# listener. (integer value)
7893#rpc_listener_prefetch_count=100
7894
7895# Max number of not acknowledged message which RabbitMQ can send to rpc reply
7896# listener. (integer value)
7897#rpc_reply_listener_prefetch_count=100
7898
7899# Reconnecting retry count in case of connectivity problem during sending reply.
7900# -1 means infinite retry during rpc_timeout (integer value)
7901#rpc_reply_retry_attempts=-1
7902
7903# Reconnecting retry delay in case of connectivity problem during sending reply.
7904# (floating point value)
7905#rpc_reply_retry_delay=0.25
7906
7907# Reconnecting retry count in case of connectivity problem during sending RPC
7908# message, -1 means infinite retry. If actual retry attempts in not 0 the rpc
7909# request could be processed more than one time (integer value)
7910#default_rpc_retry_attempts=-1
7911
7912# Reconnecting retry delay in case of connectivity problem during sending RPC
7913# message (floating point value)
7914#rpc_retry_delay=0.25
7915
7916
7917[oslo_messaging_zmq]
7918
7919#
7920# From oslo.messaging
7921#
7922
7923# ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP.
7924# The "host" option should point or resolve to this address. (string value)
7925# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_address
7926#rpc_zmq_bind_address=*
7927
7928# MatchMaker driver. (string value)
7929# Allowed values: redis, sentinel, dummy
7930# Deprecated group/name - [DEFAULT]/rpc_zmq_matchmaker
7931#rpc_zmq_matchmaker=redis
7932
7933# Number of ZeroMQ contexts, defaults to 1. (integer value)
7934# Deprecated group/name - [DEFAULT]/rpc_zmq_contexts
7935#rpc_zmq_contexts=1
7936
7937# Maximum number of ingress messages to locally buffer per topic. Default is
7938# unlimited. (integer value)
7939# Deprecated group/name - [DEFAULT]/rpc_zmq_topic_backlog
7940#rpc_zmq_topic_backlog=<None>
7941
7942# Directory for holding IPC sockets. (string value)
7943# Deprecated group/name - [DEFAULT]/rpc_zmq_ipc_dir
7944#rpc_zmq_ipc_dir=/var/run/openstack
7945
7946# Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
7947# "host" option, if running Nova. (string value)
7948# Deprecated group/name - [DEFAULT]/rpc_zmq_host
7949#rpc_zmq_host=localhost
7950
7951# Number of seconds to wait before all pending messages will be sent after
7952# closing a socket. The default value of -1 specifies an infinite linger period.
7953# The value of 0 specifies no linger period. Pending messages shall be discarded
7954# immediately when the socket is closed. Positive values specify an upper bound
7955# for the linger period. (integer value)
7956# Deprecated group/name - [DEFAULT]/rpc_cast_timeout
7957#zmq_linger=-1
7958
7959# The default number of seconds that poll should wait. Poll raises timeout
7960# exception when timeout expired. (integer value)
7961# Deprecated group/name - [DEFAULT]/rpc_poll_timeout
7962#rpc_poll_timeout=1
7963
7964# Expiration timeout in seconds of a name service record about existing target (
7965# < 0 means no timeout). (integer value)
7966# Deprecated group/name - [DEFAULT]/zmq_target_expire
7967#zmq_target_expire=300
7968
7969# Update period in seconds of a name service record about existing target.
7970# (integer value)
7971# Deprecated group/name - [DEFAULT]/zmq_target_update
7972#zmq_target_update=180
7973
7974# Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean
7975# value)
7976# Deprecated group/name - [DEFAULT]/use_pub_sub
7977#use_pub_sub=false
7978
7979# Use ROUTER remote proxy. (boolean value)
7980# Deprecated group/name - [DEFAULT]/use_router_proxy
7981#use_router_proxy=false
7982
7983# This option makes direct connections dynamic or static. It makes sense only
7984# with use_router_proxy=False which means to use direct connections for direct
7985# message types (ignored otherwise). (boolean value)
7986#use_dynamic_connections=false
7987
7988# How many additional connections to a host will be made for failover reasons.
7989# This option is actual only in dynamic connections mode. (integer value)
7990#zmq_failover_connections=2
7991
7992# Minimal port number for random ports range. (port value)
7993# Minimum value: 0
7994# Maximum value: 65535
7995# Deprecated group/name - [DEFAULT]/rpc_zmq_min_port
7996#rpc_zmq_min_port=49153
7997
7998# Maximal port number for random ports range. (integer value)
7999# Minimum value: 1
8000# Maximum value: 65536
8001# Deprecated group/name - [DEFAULT]/rpc_zmq_max_port
8002#rpc_zmq_max_port=65536
8003
8004# Number of retries to find free port number before fail with ZMQBindError.
8005# (integer value)
8006# Deprecated group/name - [DEFAULT]/rpc_zmq_bind_port_retries
8007#rpc_zmq_bind_port_retries=100
8008
8009# Default serialization mechanism for serializing/deserializing
8010# outgoing/incoming messages (string value)
8011# Allowed values: json, msgpack
8012# Deprecated group/name - [DEFAULT]/rpc_zmq_serialization
8013#rpc_zmq_serialization=json
8014
8015# This option configures round-robin mode in zmq socket. True means not keeping
8016# a queue when server side disconnects. False means to keep queue and messages
8017# even if server is disconnected, when the server appears we send all
8018# accumulated messages to it. (boolean value)
8019#zmq_immediate=true
8020
8021# Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any
8022# other negative value) means to skip any overrides and leave it to OS default;
8023# 0 and 1 (or any other positive value) mean to disable and enable the option
8024# respectively. (integer value)
8025#zmq_tcp_keepalive=-1
8026
8027# The duration between two keepalive transmissions in idle condition. The unit
8028# is platform dependent, for example, seconds in Linux, milliseconds in Windows
8029# etc. The default value of -1 (or any other negative value and 0) means to skip
8030# any overrides and leave it to OS default. (integer value)
8031#zmq_tcp_keepalive_idle=-1
8032
8033# The number of retransmissions to be carried out before declaring that remote
8034# end is not available. The default value of -1 (or any other negative value and
8035# 0) means to skip any overrides and leave it to OS default. (integer value)
8036#zmq_tcp_keepalive_cnt=-1
8037
8038# The duration between two successive keepalive retransmissions, if
8039# acknowledgement to the previous keepalive transmission is not received. The
8040# unit is platform dependent, for example, seconds in Linux, milliseconds in
8041# Windows etc. The default value of -1 (or any other negative value and 0) means
8042# to skip any overrides and leave it to OS default. (integer value)
8043#zmq_tcp_keepalive_intvl=-1
8044
8045# Maximum number of (green) threads to work concurrently. (integer value)
8046#rpc_thread_pool_size=100
8047
8048# Expiration timeout in seconds of a sent/received message after which it is not
8049# tracked anymore by a client/server. (integer value)
8050#rpc_message_ttl=300
8051
8052# Wait for message acknowledgements from receivers. This mechanism works only
8053# via proxy without PUB/SUB. (boolean value)
8054#rpc_use_acks=false
8055
8056# Number of seconds to wait for an ack from a cast/call. After each retry
8057# attempt this timeout is multiplied by some specified multiplier. (integer
8058# value)
8059#rpc_ack_timeout_base=15
8060
8061# Number to multiply base ack timeout by after each retry attempt. (integer
8062# value)
8063#rpc_ack_timeout_multiplier=2
8064
8065# Default number of message sending attempts in case of any problems occurred:
8066# positive value N means at most N retries, 0 means no retries, None or -1 (or
8067# any other negative values) mean to retry forever. This option is used only if
8068# acknowledgments are enabled. (integer value)
8069#rpc_retry_attempts=3
8070
8071# List of publisher hosts SubConsumer can subscribe on. This option has higher
8072# priority then the default publishers list taken from the matchmaker. (list
8073# value)
8074#subscribe_on =
8075
8076
8077[oslo_middleware]
8078
8079#
8080# From oslo.middleware
8081#
8082
8083# The maximum body size for each request, in bytes. (integer value)
8084# Deprecated group/name - [DEFAULT]/osapi_max_request_body_size
8085# Deprecated group/name - [DEFAULT]/max_request_body_size
8086#max_request_body_size=114688
8087
8088# DEPRECATED: The HTTP Header that will be used to determine what the original
8089# request protocol scheme was, even if it was hidden by a SSL termination proxy.
8090# (string value)
8091# This option is deprecated for removal.
8092# Its value may be silently ignored in the future.
8093#secure_proxy_ssl_header=X-Forwarded-Proto
8094
8095# Whether the application is behind a proxy or not. This determines if the
8096# middleware should parse the headers or not. (boolean value)
8097#enable_proxy_headers_parsing=false
8098
8099
8100[oslo_policy]
8101
8102#
8103# From oslo.policy
8104#
8105
8106# The file that defines policies. (string value)
8107# Deprecated group/name - [DEFAULT]/policy_file
8108#policy_file=policy.json
8109
8110# Default rule. Enforced when a requested rule is not found. (string value)
8111# Deprecated group/name - [DEFAULT]/policy_default_rule
8112#policy_default_rule=default
8113
8114# Directories where policy configuration files are stored. They can be relative
8115# to any directory in the search path defined by the config_dir option, or
8116# absolute paths. The file defined by policy_file must exist for these
8117# directories to be searched. Missing or empty directories are ignored. (multi
8118# valued)
8119# Deprecated group/name - [DEFAULT]/policy_dirs
8120#policy_dirs=policy.d
8121
8122
8123[pci]
8124
8125#
8126# From nova.conf
8127#
8128
8129#
8130# An alias for a PCI passthrough device requirement.
8131#
8132# This allows users to specify the alias in the extra_spec for a flavor, without
8133# needing to repeat all the PCI property requirements.
8134#
8135# Possible Values:
8136#
8137# * A list of JSON values which describe the aliases. For example:
8138#
8139# alias = {
8140# "name": "QuickAssist",
8141# "product_id": "0443",
8142# "vendor_id": "8086",
8143# "device_type": "type-PCI"
8144# }
8145#
8146# defines an alias for the Intel QuickAssist card. (multi valued). Valid key
8147# values are :
8148#
8149# * "name": Name of the PCI alias.
8150# * "product_id": Product ID of the device in hexadecimal.
8151# * "vendor_id": Vendor ID of the device in hexadecimal.
8152# * "device_type": Type of PCI device. Valid values are: "type-PCI",
8153# "type-PF" and "type-VF".
8154# (multi valued)
8155# Deprecated group/name - [DEFAULT]/pci_alias
8156#alias =
8157
8158#
8159# White list of PCI devices available to VMs.
8160#
8161# Possible values:
8162#
8163# * A JSON dictionary which describe a whitelisted PCI device. It should take
8164# the following format:
8165#
8166# ["vendor_id": "<id>",] ["product_id": "<id>",]
8167# ["address": "[[[[<domain>]:]<bus>]:][<slot>][.[<function>]]" |
8168# "devname": "<name>",]
8169# {"<tag>": "<tag_value>",}
8170#
8171# Where '[' indicates zero or one occurrences, '{' indicates zero or multiple
8172# occurrences, and '|' mutually exclusive options. Note that any missing
8173# fields are automatically wildcarded.
8174#
8175# Valid key values are :
8176#
8177# * "vendor_id": Vendor ID of the device in hexadecimal.
8178# * "product_id": Product ID of the device in hexadecimal.
8179# * "address": PCI address of the device.
8180# * "devname": Device name of the device (for e.g. interface name). Not all
8181# PCI devices have a name.
8182# * "<tag>": Additional <tag> and <tag_value> used for matching PCI devices.
8183# Supported <tag>: "physical_network".
8184#
8185# The address key supports traditional glob style and regular expression
8186# syntax. Valid examples are:
8187#
8188# passthrough_whitelist = {"devname":"eth0",
8189# "physical_network":"physnet"}
8190# passthrough_whitelist = {"address":"*:0a:00.*"}
8191# passthrough_whitelist = {"address":":0a:00.",
8192# "physical_network":"physnet1"}
8193# passthrough_whitelist = {"vendor_id":"1137",
8194# "product_id":"0071"}
8195# passthrough_whitelist = {"vendor_id":"1137",
8196# "product_id":"0071",
8197# "address": "0000:0a:00.1",
8198# "physical_network":"physnet1"}
8199# passthrough_whitelist = {"address":{"domain": ".*",
8200# "bus": "02", "slot": "01",
8201# "function": "[2-7]"},
8202# "physical_network":"physnet1"}
8203# passthrough_whitelist = {"address":{"domain": ".*",
8204# "bus": "02", "slot": "0[1-2]",
8205# "function": ".*"},
8206# "physical_network":"physnet1"}
8207#
8208# The following are invalid, as they specify mutually exclusive options:
8209#
8210# passthrough_whitelist = {"devname":"eth0",
8211# "physical_network":"physnet",
8212# "address":"*:0a:00.*"}
8213#
8214# * A JSON list of JSON dictionaries corresponding to the above format. For
8215# example:
8216#
8217# passthrough_whitelist = [{"product_id":"0001", "vendor_id":"8086"},
8218# {"product_id":"0002", "vendor_id":"8086"}]
8219# (multi valued)
8220# Deprecated group/name - [DEFAULT]/pci_passthrough_whitelist
8221#passthrough_whitelist =
8222{%- if compute.get('sriov', false) %}
8223{%- for nic_name, sriov in compute.sriov.iteritems() %}
8224passthrough_whitelist = {"devname":"{{ sriov.devname }}","physical_network":"{{ sriov.physical_network }}"}
8225{%- endfor %}
8226{%- endif %}
8227
8228[placement]
8229
8230#
8231# From nova.conf
8232#
8233auth_type = password
8234user_domain_id = {{ compute.identity.get('domain', 'default') }}
8235project_domain_id = {{ compute.identity.get('domain', 'default') }}
8236project_name = {{ compute.identity.tenant }}
8237username = {{ compute.identity.user }}
8238password = {{ compute.identity.password }}
8239auth_url=http://{{ compute.identity.host }}:35357/v3
Jan Cache2900c92017-05-03 15:02:27 +02008240os_interface = internal
Jakub Pavlik02a01c72017-04-11 16:04:51 +02008241
8242#
8243# Region name of this node. This is used when picking the URL in the service
8244# catalog.
8245#
8246# Possible values:
8247#
8248# * Any string representing region name
8249# (string value)
8250#os_region_name = openstack
8251os_region_name = {{ compute.identity.region }}
8252
8253#
8254# Endpoint interface for this node. This is used when picking the URL in the
8255# service catalog.
8256# (string value)
8257#os_interface=<None>
8258
8259# PEM encoded Certificate Authority to use when verifying HTTPs connections.
8260# (string value)
8261#cafile=<None>
8262
8263# PEM encoded client certificate cert file (string value)
8264#certfile=<None>
8265
8266# PEM encoded client certificate key file (string value)
8267#keyfile=<None>
8268
8269# Verify HTTPS connections. (boolean value)
8270#insecure=false
8271
8272# Timeout value for http requests (integer value)
8273#timeout=<None>
8274
8275# Authentication type to load (string value)
8276# Deprecated group/name - [placement]/auth_plugin
8277#auth_type=<None>
8278
8279# Config Section from which to load plugin specific options (string value)
8280#auth_section=<None>
8281
8282# Authentication URL (string value)
8283#auth_url=<None>
8284
8285# Domain ID to scope to (string value)
8286#domain_id=<None>
8287
8288# Domain name to scope to (string value)
8289#domain_name=<None>
8290
8291# Project ID to scope to (string value)
8292#project_id=<None>
8293
8294# Project name to scope to (string value)
8295#project_name=<None>
8296
8297# Domain ID containing project (string value)
8298#project_domain_id=<None>
8299
8300# Domain name containing project (string value)
8301#project_domain_name=<None>
8302
8303# Trust ID (string value)
8304#trust_id=<None>
8305
8306# Optional domain ID to use with v3 and v2 parameters. It will be used for both
8307# the user and project domain in v3 and ignored in v2 authentication. (string
8308# value)
8309#default_domain_id=<None>
8310
8311# Optional domain name to use with v3 API and v2 parameters. It will be used for
8312# both the user and project domain in v3 and ignored in v2 authentication.
8313# (string value)
8314#default_domain_name=<None>
8315
8316# User ID (string value)
8317#user_id=<None>
8318
8319# Username (string value)
8320# Deprecated group/name - [placement]/user-name
8321#username=<None>
8322
8323# User's domain id (string value)
8324#user_domain_id=<None>
8325
8326# User's domain name (string value)
8327#user_domain_name=<None>
8328
8329# User's password (string value)
8330#password=<None>
8331
8332# Tenant ID (string value)
8333#tenant_id=<None>
8334
8335# Tenant Name (string value)
8336#tenant_name=<None>
8337
8338
8339[quota]
8340#
8341# Quota options allow to manage quotas in openstack deployment.
8342
8343#
8344# From nova.conf
8345#
8346
8347#
8348# The number of instances allowed per project.
8349#
8350# Possible Values
8351#
8352# * A positive integer or 0.
8353# * -1 to disable the quota.
8354# (integer value)
8355# Minimum value: -1
8356# Deprecated group/name - [DEFAULT]/quota_instances
8357#instances=10
8358
8359#
8360# The number of instance cores or vCPUs allowed per project.
8361#
8362# Possible values:
8363#
8364# * A positive integer or 0.
8365# * -1 to disable the quota.
8366# (integer value)
8367# Minimum value: -1
8368# Deprecated group/name - [DEFAULT]/quota_cores
8369#cores=20
8370
8371#
8372# The number of megabytes of instance RAM allowed per project.
8373#
8374# Possible values:
8375#
8376# * A positive integer or 0.
8377# * -1 to disable the quota.
8378# (integer value)
8379# Minimum value: -1
8380# Deprecated group/name - [DEFAULT]/quota_ram
8381#ram=51200
8382
8383# DEPRECATED:
8384# The number of floating IPs allowed per project.
8385#
8386# Floating IPs are not allocated to instances by default. Users need to select
8387# them from the pool configured by the OpenStack administrator to attach to
8388# their
8389# instances.
8390#
8391# Possible values:
8392#
8393# * A positive integer or 0.
8394# * -1 to disable the quota.
8395# (integer value)
8396# Minimum value: -1
8397# Deprecated group/name - [DEFAULT]/quota_floating_ips
8398# This option is deprecated for removal since 15.0.0.
8399# Its value may be silently ignored in the future.
8400# Reason:
8401# nova-network is deprecated, as are any related configuration options.
8402#floating_ips=10
8403
8404# DEPRECATED:
8405# The number of fixed IPs allowed per project.
8406#
8407# Unlike floating IPs, fixed IPs are allocated dynamically by the network
8408# component when instances boot up. This quota value should be at least the
8409# number of instances allowed
8410#
8411# Possible values:
8412#
8413# * A positive integer or 0.
8414# * -1 to disable the quota.
8415# (integer value)
8416# Minimum value: -1
8417# Deprecated group/name - [DEFAULT]/quota_fixed_ips
8418# This option is deprecated for removal since 15.0.0.
8419# Its value may be silently ignored in the future.
8420# Reason:
8421# nova-network is deprecated, as are any related configuration options.
8422#fixed_ips=-1
8423
8424#
8425# The number of metadata items allowed per instance.
8426#
8427# Users can associate metadata with an instance during instance creation. This
8428# metadata takes the form of key-value pairs.
8429#
8430# Possible values:
8431#
8432# * A positive integer or 0.
8433# * -1 to disable the quota.
8434# (integer value)
8435# Minimum value: -1
8436# Deprecated group/name - [DEFAULT]/quota_metadata_items
8437#metadata_items=128
8438
8439#
8440# The number of injected files allowed.
8441#
8442# File injection allows users to customize the personality of an instance by
8443# injecting data into it upon boot. Only text file injection is permitted:
8444# binary
8445# or ZIP files are not accepted. During file injection, any existing files that
8446# match specified files are renamed to include ``.bak`` extension appended with
8447# a
8448# timestamp.
8449#
8450# Possible values:
8451#
8452# * A positive integer or 0.
8453# * -1 to disable the quota.
8454# (integer value)
8455# Minimum value: -1
8456# Deprecated group/name - [DEFAULT]/quota_injected_files
8457#injected_files=5
8458
8459#
8460# The number of bytes allowed per injected file.
8461#
8462# Possible values:
8463#
8464# * A positive integer or 0.
8465# * -1 to disable the quota.
8466# (integer value)
8467# Minimum value: -1
8468# Deprecated group/name - [DEFAULT]/quota_injected_file_content_bytes
8469#injected_file_content_bytes=10240
8470
8471#
8472# The maximum allowed injected file path length.
8473#
8474# Possible values:
8475#
8476# * A positive integer or 0.
8477# * -1 to disable the quota.
8478# (integer value)
8479# Minimum value: -1
8480# Deprecated group/name - [DEFAULT]/quota_injected_file_path_length
8481#injected_file_path_length=255
8482
8483# DEPRECATED:
8484# The number of security groups per project.
8485#
8486# Possible values:
8487#
8488# * A positive integer or 0.
8489# * -1 to disable the quota.
8490# (integer value)
8491# Minimum value: -1
8492# Deprecated group/name - [DEFAULT]/quota_security_groups
8493# This option is deprecated for removal since 15.0.0.
8494# Its value may be silently ignored in the future.
8495# Reason:
8496# nova-network is deprecated, as are any related configuration options.
8497#security_groups=10
8498
8499# DEPRECATED:
8500# The number of security rules per security group.
8501#
8502# The associated rules in each security group control the traffic to instances
8503# in
8504# the group.
8505#
8506# Possible values:
8507#
8508# * A positive integer or 0.
8509# * -1 to disable the quota.
8510# (integer value)
8511# Minimum value: -1
8512# Deprecated group/name - [DEFAULT]/quota_security_group_rules
8513# This option is deprecated for removal since 15.0.0.
8514# Its value may be silently ignored in the future.
8515# Reason:
8516# nova-network is deprecated, as are any related configuration options.
8517#security_group_rules=20
8518
8519#
8520# The maximum number of key pairs allowed per user.
8521#
8522# Users can create at least one key pair for each project and use the key pair
8523# for multiple instances that belong to that project.
8524#
8525# Possible values:
8526#
8527# * A positive integer or 0.
8528# * -1 to disable the quota.
8529# (integer value)
8530# Minimum value: -1
8531# Deprecated group/name - [DEFAULT]/quota_key_pairs
8532#key_pairs=100
8533
8534#
8535# The maxiumum number of server groups per project.
8536#
8537# Server groups are used to control the affinity and anti-affinity scheduling
8538# policy for a group of servers or instances. Reducing the quota will not affect
8539# any existing group, but new servers will not be allowed into groups that have
8540# become over quota.
8541#
8542# Possible values:
8543#
8544# * A positive integer or 0.
8545# * -1 to disable the quota.
8546# (integer value)
8547# Minimum value: -1
8548# Deprecated group/name - [DEFAULT]/quota_server_groups
8549#server_groups=10
8550
8551#
8552# The maximum number of servers per server group.
8553#
8554# Possible values:
8555#
8556# * A positive integer or 0.
8557# * -1 to disable the quota.
8558# (integer value)
8559# Minimum value: -1
8560# Deprecated group/name - [DEFAULT]/quota_server_group_members
8561#server_group_members=10
8562
8563#
8564# The number of seconds until a reservation expires.
8565#
8566# This quota represents the time period for invalidating quota reservations.
8567# (integer value)
8568# Deprecated group/name - [DEFAULT]/reservation_expire
8569#reservation_expire=86400
8570
8571#
8572# The count of reservations until usage is refreshed.
8573#
8574# This defaults to 0 (off) to avoid additional load but it is useful to turn on
8575# to help keep quota usage up-to-date and reduce the impact of out of sync usage
8576# issues.
8577# (integer value)
8578# Minimum value: 0
8579# Deprecated group/name - [DEFAULT]/until_refresh
8580#until_refresh=0
8581
8582#
8583# The number of seconds between subsequent usage refreshes.
8584#
8585# This defaults to 0 (off) to avoid additional load but it is useful to turn on
8586# to help keep quota usage up-to-date and reduce the impact of out of sync usage
8587# issues. Note that quotas are not updated on a periodic task, they will update
8588# on a new reservation if max_age has passed since the last reservation.
8589# (integer value)
8590# Minimum value: 0
8591# Deprecated group/name - [DEFAULT]/max_age
8592#max_age=0
8593
8594# DEPRECATED:
8595# The quota enforcer driver.
8596#
8597# Provides abstraction for quota checks. Users can configure a specific
8598# driver to use for quota checks.
8599#
8600# Possible values:
8601#
8602# * nova.quota.DbQuotaDriver (default) or any string representing fully
8603# qualified class name.
8604# (string value)
8605# Deprecated group/name - [DEFAULT]/quota_driver
8606# This option is deprecated for removal since 14.0.0.
8607# Its value may be silently ignored in the future.
8608#driver=nova.quota.DbQuotaDriver
8609
8610
8611[rdp]
8612#
8613# Options under this group enable and configure Remote Desktop Protocol (
8614# RDP) related features.
8615#
8616# This group is only relevant to Hyper-V users.
8617
8618#
8619# From nova.conf
8620#
8621
8622#
8623# Enable Remote Desktop Protocol (RDP) related features.
8624#
8625# Hyper-V, unlike the majority of the hypervisors employed on Nova compute
8626# nodes, uses RDP instead of VNC and SPICE as a desktop sharing protocol to
8627# provide instance console access. This option enables RDP for graphical
8628# console access for virtual machines created by Hyper-V.
8629#
8630# **Note:** RDP should only be enabled on compute nodes that support the Hyper-V
8631# virtualization platform.
8632#
8633# Related options:
8634#
8635# * ``compute_driver``: Must be hyperv.
8636#
8637# (boolean value)
8638#enabled=false
8639
8640#
8641# The URL an end user would use to connect to the RDP HTML5 console proxy.
8642# The console proxy service is called with this token-embedded URL and
8643# establishes the connection to the proper instance.
8644#
8645# An RDP HTML5 console proxy service will need to be configured to listen on the
8646# address configured here. Typically the console proxy service would be run on a
8647# controller node. The localhost address used as default would only work in a
8648# single node environment i.e. devstack.
8649#
8650# An RDP HTML5 proxy allows a user to access via the web the text or graphical
8651# console of any Windows server or workstation using RDP. RDP HTML5 console
8652# proxy services include FreeRDP, wsgate.
8653# See https://github.com/FreeRDP/FreeRDP-WebConnect
8654#
8655# Possible values:
8656#
8657# * <scheme>://<ip-address>:<port-number>/
8658#
8659# The scheme must be identical to the scheme configured for the RDP HTML5
8660# console proxy service.
8661#
8662# The IP address must be identical to the address on which the RDP HTML5
8663# console proxy service is listening.
8664#
8665# The port must be identical to the port on which the RDP HTML5 console proxy
8666# service is listening.
8667#
8668# Related options:
8669#
8670# * ``rdp.enabled``: Must be set to ``True`` for ``html5_proxy_base_url`` to be
8671# effective.
8672# (string value)
8673#html5_proxy_base_url=http://127.0.0.1:6083/
8674
8675
8676[remote_debug]
8677
8678#
8679# From nova.conf
8680#
8681
8682#
8683# Debug host (IP or name) to connect to. This command line parameter is used
8684# when
8685# you want to connect to a nova service via a debugger running on a different
8686# host.
8687#
8688# Note that using the remote debug option changes how Nova uses the eventlet
8689# library to support async IO. This could result in failures that do not occur
8690# under normal operation. Use at your own risk.
8691#
8692# Possible Values:
8693#
8694# * IP address of a remote host as a command line parameter
8695# to a nova service. For Example:
8696#
8697# /usr/local/bin/nova-compute --config-file /etc/nova/nova.conf
8698# --remote_debug-host <IP address where the debugger is running>
8699# (string value)
8700#host=<None>
8701
8702#
8703# Debug port to connect to. This command line parameter allows you to specify
8704# the port you want to use to connect to a nova service via a debugger running
8705# on different host.
8706#
8707# Note that using the remote debug option changes how Nova uses the eventlet
8708# library to support async IO. This could result in failures that do not occur
8709# under normal operation. Use at your own risk.
8710#
8711# Possible Values:
8712#
8713# * Port number you want to use as a command line parameter
8714# to a nova service. For Example:
8715#
8716# /usr/local/bin/nova-compute --config-file /etc/nova/nova.conf
8717# --remote_debug-host <IP address where the debugger is running>
8718# --remote_debug-port <port> it's listening on>.
8719# (port value)
8720# Minimum value: 0
8721# Maximum value: 65535
8722#port=<None>
8723
8724
8725[scheduler]
8726
8727#
8728# From nova.conf
8729#
8730
8731#
8732# The scheduler host manager to use.
8733#
8734# The host manager manages the in-memory picture of the hosts that the scheduler
8735# uses. The options values are chosen from the entry points under the namespace
8736# 'nova.scheduler.host_manager' in 'setup.cfg'.
8737# (string value)
8738# Allowed values: host_manager, ironic_host_manager
8739# Deprecated group/name - [DEFAULT]/scheduler_host_manager
8740#host_manager=host_manager
8741
8742#
8743# The class of the driver used by the scheduler.
8744#
8745# The options are chosen from the entry points under the namespace
8746# 'nova.scheduler.driver' in 'setup.cfg'.
8747#
8748# Possible values:
8749#
8750# * A string, where the string corresponds to the class name of a scheduler
8751# driver. There are a number of options available:
8752# ** 'caching_scheduler', which aggressively caches the system state for better
8753# individual scheduler performance at the risk of more retries when running
8754# multiple schedulers
8755# ** 'chance_scheduler', which simply picks a host at random
8756# ** 'fake_scheduler', which is used for testing
8757# ** A custom scheduler driver. In this case, you will be responsible for
8758# creating and maintaining the entry point in your 'setup.cfg' file
8759# (string value)
8760# Allowed values: filter_scheduler, caching_scheduler, chance_scheduler, fake_scheduler
8761# Deprecated group/name - [DEFAULT]/scheduler_driver
8762#driver=filter_scheduler
8763
8764#
8765# Periodic task interval.
8766#
8767# This value controls how often (in seconds) to run periodic tasks in the
8768# scheduler. The specific tasks that are run for each period are determined by
8769# the particular scheduler being used.
8770#
8771# If this is larger than the nova-service 'service_down_time' setting, Nova may
8772# report the scheduler service as down. This is because the scheduler driver is
8773# responsible for sending a heartbeat and it will only do that as often as this
8774# option allows. As each scheduler can work a little differently than the
8775# others,
8776# be sure to test this with your selected scheduler.
8777#
8778# Possible values:
8779#
8780# * An integer, where the integer corresponds to periodic task interval in
8781# seconds. 0 uses the default interval (60 seconds). A negative value disables
8782# periodic tasks.
8783#
8784# Related options:
8785#
8786# * ``nova-service service_down_time``
8787# (integer value)
8788# Deprecated group/name - [DEFAULT]/scheduler_driver_task_period
8789#periodic_task_interval=60
8790
8791#
8792# Maximum number of schedule attempts for a chosen host.
8793#
8794# This is the maximum number of attempts that will be made to schedule an
8795# instance before it is assumed that the failures aren't due to normal
8796# occasional
8797# race conflicts, but rather some other problem. When this is reached a
8798# MaxRetriesExceeded exception is raised, and the instance is set to an error
8799# state.
8800#
8801# Possible values:
8802#
8803# * A positive integer, where the integer corresponds to the max number of
8804# attempts that can be made when scheduling an instance.
8805# (integer value)
8806# Minimum value: 1
8807# Deprecated group/name - [DEFAULT]/scheduler_max_attempts
8808#max_attempts=3
8809
8810#
8811# Periodic task interval.
8812#
8813# This value controls how often (in seconds) the scheduler should attempt
8814# to discover new hosts that have been added to cells. If negative (the
8815# default), no automatic discovery will occur.
8816#
8817# Small deployments may want this periodic task enabled, as surveying the
8818# cells for new hosts is likely to be lightweight enough to not cause undue
8819# burdon to the scheduler. However, larger clouds (and those that are not
8820# adding hosts regularly) will likely want to disable this automatic
8821# behavior and instead use the `nova-manage cell_v2 discover_hosts` command
8822# when hosts have been added to a cell.
8823# (integer value)
8824# Minimum value: -1
8825#discover_hosts_in_cells_interval=-1
8826
8827
8828[serial_console]
8829#
8830# The serial console feature allows you to connect to a guest in case a
8831# graphical console like VNC, RDP or SPICE is not available. This is only
8832# currently supported for the libvirt, Ironic and hyper-v drivers.
8833
8834#
8835# From nova.conf
8836#
8837
8838#
8839# Enable the serial console feature.
8840#
8841# In order to use this feature, the service ``nova-serialproxy`` needs to run.
8842# This service is typically executed on the controller node.
8843# (boolean value)
8844#enabled=false
8845
8846#
8847# A range of TCP ports a guest can use for its backend.
8848#
8849# Each instance which gets created will use one port out of this range. If the
8850# range is not big enough to provide another port for an new instance, this
8851# instance won't get launched.
8852#
8853# Possible values:
8854#
8855# * Each string which passes the regex ``\d+:\d+`` For example ``10000:20000``.
8856# Be sure that the first port number is lower than the second port number
8857# and that both are in range from 0 to 65535.
8858# (string value)
8859#port_range=10000:20000
8860
8861#
8862# The URL an end user would use to connect to the ``nova-serialproxy`` service.
8863#
8864# The ``nova-serialproxy`` service is called with this token enriched URL
8865# and establishes the connection to the proper instance.
8866#
8867# Related options:
8868#
8869# * The IP address must be identical to the address to which the
8870# ``nova-serialproxy`` service is listening (see option ``serialproxy_host``
8871# in this section).
8872# * The port must be the same as in the option ``serialproxy_port`` of this
8873# section.
8874# * If you choose to use a secured websocket connection, then start this option
8875# with ``wss://`` instead of the unsecured ``ws://``. The options ``cert``
8876# and ``key`` in the ``[DEFAULT]`` section have to be set for that.
8877# (uri value)
8878#base_url=ws://127.0.0.1:6083/
8879
8880#
8881# The IP address to which proxy clients (like ``nova-serialproxy``) should
8882# connect to get the serial console of an instance.
8883#
8884# This is typically the IP address of the host of a ``nova-compute`` service.
8885# (string value)
8886#proxyclient_address=127.0.0.1
8887
8888#
8889# The IP address which is used by the ``nova-serialproxy`` service to listen
8890# for incoming requests.
8891#
8892# The ``nova-serialproxy`` service listens on this IP address for incoming
8893# connection requests to instances which expose serial console.
8894#
8895# Related options:
8896#
8897# * Ensure that this is the same IP address which is defined in the option
8898# ``base_url`` of this section or use ``0.0.0.0`` to listen on all addresses.
8899# (string value)
8900#serialproxy_host=0.0.0.0
8901
8902#
8903# The port number which is used by the ``nova-serialproxy`` service to listen
8904# for incoming requests.
8905#
8906# The ``nova-serialproxy`` service listens on this port number for incoming
8907# connection requests to instances which expose serial console.
8908#
8909# Related options:
8910#
8911# * Ensure that this is the same port number which is defined in the option
8912# ``base_url`` of this section.
8913# (port value)
8914# Minimum value: 0
8915# Maximum value: 65535
8916#serialproxy_port=6083
8917
8918
8919[service_user]
8920#
8921# Configuration options for service to service authentication using a service
8922# token. These options allow to send a service token along with the
8923# user's token when contacting external REST APIs.
8924
8925#
8926# From nova.conf
8927#
8928
8929#
8930# When True, if sending a user token to an REST API, also send a service token.
8931#
8932# Nova often reuses the user token provided to the nova-api to talk to other
8933# REST APIs, such as Cinder and Neutron. It is possible that while the
8934# user token was valid when the request was made to Nova, the token may expire
8935# before it reaches the other service. To avoid any failures, and to
8936# make it clear it is Nova calling the service on the users behalf, we include
8937# a server token along with the user token. Should the user's token have
8938# expired, a valid service token ensures the REST API request will still be
8939# accepted by the keystone middleware.
8940#
8941# This feature is currently experimental, and as such is turned off by default
8942# while full testing and performance tuning of this feature is completed.
8943# (boolean value)
8944#send_service_user_token=false
8945
8946# PEM encoded Certificate Authority to use when verifying HTTPs connections.
8947# (string value)
8948#cafile=<None>
8949
8950# PEM encoded client certificate cert file (string value)
8951#certfile=<None>
8952
8953# PEM encoded client certificate key file (string value)
8954#keyfile=<None>
8955
8956# Verify HTTPS connections. (boolean value)
8957#insecure=false
8958
8959# Timeout value for http requests (integer value)
8960#timeout=<None>
8961
8962# Authentication type to load (string value)
8963# Deprecated group/name - [service_user]/auth_plugin
8964#auth_type=<None>
8965
8966# Config Section from which to load plugin specific options (string value)
8967#auth_section=<None>
8968
8969# Authentication URL (string value)
8970#auth_url=<None>
8971
8972# Domain ID to scope to (string value)
8973#domain_id=<None>
8974
8975# Domain name to scope to (string value)
8976#domain_name=<None>
8977
8978# Project ID to scope to (string value)
8979#project_id=<None>
8980
8981# Project name to scope to (string value)
8982#project_name=<None>
8983
8984# Domain ID containing project (string value)
8985#project_domain_id=<None>
8986
8987# Domain name containing project (string value)
8988#project_domain_name=<None>
8989
8990# Trust ID (string value)
8991#trust_id=<None>
8992
8993# Optional domain ID to use with v3 and v2 parameters. It will be used for both
8994# the user and project domain in v3 and ignored in v2 authentication. (string
8995# value)
8996#default_domain_id=<None>
8997
8998# Optional domain name to use with v3 API and v2 parameters. It will be used for
8999# both the user and project domain in v3 and ignored in v2 authentication.
9000# (string value)
9001#default_domain_name=<None>
9002
9003# User ID (string value)
9004#user_id=<None>
9005
9006# Username (string value)
9007# Deprecated group/name - [service_user]/user-name
9008#username=<None>
9009
9010# User's domain id (string value)
9011#user_domain_id=<None>
9012
9013# User's domain name (string value)
9014#user_domain_name=<None>
9015
9016# User's password (string value)
9017#password=<None>
9018
9019# Tenant ID (string value)
9020#tenant_id=<None>
9021
9022# Tenant Name (string value)
9023#tenant_name=<None>
9024
9025
9026[spice]
9027#
9028# SPICE console feature allows you to connect to a guest virtual machine.
9029# SPICE is a replacement for fairly limited VNC protocol.
9030#
9031# Following requirements must be met in order to use SPICE:
9032#
9033# * Virtualization driver must be libvirt
9034# * spice.enabled set to True
9035# * vnc.enabled set to False
9036# * update html5proxy_base_url
9037# * update server_proxyclient_address
9038enabled = false
9039html5proxy_base_url = {{ compute.vncproxy_url }}/spice_auto.html
9040#
9041# From nova.conf
9042#
9043
9044#
9045# Enable SPICE related features.
9046#
9047# Related options:
9048#
9049# * VNC must be explicitly disabled to get access to the SPICE console. Set the
9050# enabled option to False in the [vnc] section to disable the VNC console.
9051# (boolean value)
9052#enabled=false
9053
9054#
9055# Enable the SPICE guest agent support on the instances.
9056#
9057# The Spice agent works with the Spice protocol to offer a better guest console
9058# experience. However, the Spice console can still be used without the Spice
9059# Agent. With the Spice agent installed the following features are enabled:
9060#
9061# * Copy & Paste of text and images between the guest and client machine
9062# * Automatic adjustment of resolution when the client screen changes - e.g.
9063# if you make the Spice console full screen the guest resolution will adjust
9064# to
9065# match it rather than letterboxing.
9066# * Better mouse integration - The mouse can be captured and released without
9067# needing to click inside the console or press keys to release it. The
9068# performance of mouse movement is also improved.
9069# (boolean value)
9070#agent_enabled=true
9071
9072#
9073# Location of the SPICE HTML5 console proxy.
9074#
9075# End user would use this URL to connect to the `nova-spicehtml5proxy``
9076# service. This service will forward request to the console of an instance.
9077#
9078# In order to use SPICE console, the service ``nova-spicehtml5proxy`` should be
9079# running. This service is typically launched on the controller node.
9080#
9081# Possible values:
9082#
9083# * Must be a valid URL of the form: ``http://host:port/spice_auto.html``
9084# where host is the node running ``nova-spicehtml5proxy`` and the port is
9085# typically 6082. Consider not using default value as it is not well defined
9086# for any real deployment.
9087#
9088# Related options:
9089#
9090# * This option depends on ``html5proxy_host`` and ``html5proxy_port`` options.
9091# The access URL returned by the compute node must have the host
9092# and port where the ``nova-spicehtml5proxy`` service is listening.
9093# (uri value)
9094#html5proxy_base_url=http://127.0.0.1:6082/spice_auto.html
9095
9096#
9097# The address where the SPICE server running on the instances should listen.
9098#
9099# Typically, the ``nova-spicehtml5proxy`` proxy client runs on the controller
9100# node and connects over the private network to this address on the compute
9101# node(s).
9102#
9103# Possible values:
9104#
9105# * IP address to listen on.
9106# (string value)
9107#server_listen=127.0.0.1
9108
9109#
9110# The address used by ``nova-spicehtml5proxy`` client to connect to instance
9111# console.
9112#
9113# Typically, the ``nova-spicehtml5proxy`` proxy client runs on the
9114# controller node and connects over the private network to this address on the
9115# compute node(s).
9116#
9117# Possible values:
9118#
9119# * Any valid IP address on the compute node.
9120#
9121# Related options:
9122#
9123# * This option depends on the ``server_listen`` option.
9124# The proxy client must be able to access the address specified in
9125# ``server_listen`` using the value of this option.
9126# (string value)
9127#server_proxyclient_address=127.0.0.1
9128
9129#
9130# A keyboard layout which is supported by the underlying hypervisor on this
9131# node.
9132#
9133# Possible values:
9134# * This is usually an 'IETF language tag' (default is 'en-us'). If you
9135# use QEMU as hypervisor, you should find the list of supported keyboard
9136# layouts at /usr/share/qemu/keymaps.
9137# (string value)
9138#keymap=en-us
9139
9140#
9141# IP address or a hostname on which the ``nova-spicehtml5proxy`` service
9142# listens for incoming requests.
9143#
9144# Related options:
9145#
9146# * This option depends on the ``html5proxy_base_url`` option.
9147# The ``nova-spicehtml5proxy`` service must be listening on a host that is
9148# accessible from the HTML5 client.
9149# (string value)
9150#html5proxy_host=0.0.0.0
9151
9152#
9153# Port on which the ``nova-spicehtml5proxy`` service listens for incoming
9154# requests.
9155#
9156# Related options:
9157#
9158# * This option depends on the ``html5proxy_base_url`` option.
9159# The ``nova-spicehtml5proxy`` service must be listening on a port that is
9160# accessible from the HTML5 client.
9161# (port value)
9162# Minimum value: 0
9163# Maximum value: 65535
9164#html5proxy_port=6082
9165
9166
9167[ssl]
9168
9169#
9170# From nova.conf
9171#
9172
9173# CA certificate file to use to verify connecting clients. (string value)
9174# Deprecated group/name - [DEFAULT]/ssl_ca_file
9175#ca_file=<None>
9176
9177# Certificate file to use when starting the server securely. (string value)
9178# Deprecated group/name - [DEFAULT]/ssl_cert_file
9179#cert_file=<None>
9180
9181# Private key file to use when starting the server securely. (string value)
9182# Deprecated group/name - [DEFAULT]/ssl_key_file
9183#key_file=<None>
9184
9185# SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and
9186# SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some
9187# distributions. (string value)
9188#version=<None>
9189
9190# Sets the list of available ciphers. value should be a string in the OpenSSL
9191# cipher list format. (string value)
9192#ciphers=<None>
9193
9194
9195[trusted_computing]
9196#
9197# Configuration options for enabling Trusted Platform Module.
9198
9199#
9200# From nova.conf
9201#
9202
9203#
9204# The host to use as the attestation server.
9205#
9206# Cloud computing pools can involve thousands of compute nodes located at
9207# different geographical locations, making it difficult for cloud providers to
9208# identify a node's trustworthiness. When using the Trusted filter, users can
9209# request that their VMs only be placed on nodes that have been verified by the
9210# attestation server specified in this option.
9211#
9212# This option is only used by the FilterScheduler and its subclasses; if you use
9213# a different scheduler, this option has no effect. Also note that this setting
9214# only affects scheduling if the 'TrustedFilter' filter is enabled.
9215#
9216# Possible values:
9217#
9218# * A string representing the host name or IP address of the attestation server,
9219# or an empty string.
9220#
9221# Related options:
9222#
9223# * attestation_server_ca_file
9224# * attestation_port
9225# * attestation_api_url
9226# * attestation_auth_blob
9227# * attestation_auth_timeout
9228# * attestation_insecure_ssl
9229# (string value)
9230#attestation_server=<None>
9231
9232#
9233# The absolute path to the certificate to use for authentication when connecting
9234# to the attestation server. See the `attestation_server` help text for more
9235# information about host verification.
9236#
9237# This option is only used by the FilterScheduler and its subclasses; if you use
9238# a different scheduler, this option has no effect. Also note that this setting
9239# only affects scheduling if the 'TrustedFilter' filter is enabled.
9240#
9241# Possible values:
9242#
9243# * A string representing the path to the authentication certificate for the
9244# attestation server, or an empty string.
9245#
9246# Related options:
9247#
9248# * attestation_server
9249# * attestation_port
9250# * attestation_api_url
9251# * attestation_auth_blob
9252# * attestation_auth_timeout
9253# * attestation_insecure_ssl
9254# (string value)
9255#attestation_server_ca_file=<None>
9256
9257#
9258# The port to use when connecting to the attestation server. See the
9259# `attestation_server` help text for more information about host verification.
9260#
9261# This option is only used by the FilterScheduler and its subclasses; if you use
9262# a different scheduler, this option has no effect. Also note that this setting
9263# only affects scheduling if the 'TrustedFilter' filter is enabled.
9264#
9265# Related options:
9266#
9267# * attestation_server
9268# * attestation_server_ca_file
9269# * attestation_api_url
9270# * attestation_auth_blob
9271# * attestation_auth_timeout
9272# * attestation_insecure_ssl
9273# (port value)
9274# Minimum value: 0
9275# Maximum value: 65535
9276#attestation_port=8443
9277
9278#
9279# The URL on the attestation server to use. See the `attestation_server` help
9280# text for more information about host verification.
9281#
9282# This value must be just that path portion of the full URL, as it will be
9283# joined
9284# to the host specified in the attestation_server option.
9285#
9286# This option is only used by the FilterScheduler and its subclasses; if you use
9287# a different scheduler, this option has no effect. Also note that this setting
9288# only affects scheduling if the 'TrustedFilter' filter is enabled.
9289#
9290# Possible values:
9291#
9292# * A valid URL string of the attestation server, or an empty string.
9293#
9294# Related options:
9295#
9296# * attestation_server
9297# * attestation_server_ca_file
9298# * attestation_port
9299# * attestation_auth_blob
9300# * attestation_auth_timeout
9301# * attestation_insecure_ssl
9302# (string value)
9303#attestation_api_url=/OpenAttestationWebServices/V1.0
9304
9305#
9306# Attestation servers require a specific blob that is used to authenticate. The
9307# content and format of the blob are determined by the particular attestation
9308# server being used. There is no default value; you must supply the value as
9309# specified by your attestation service. See the `attestation_server` help text
9310# for more information about host verification.
9311#
9312# This option is only used by the FilterScheduler and its subclasses; if you use
9313# a different scheduler, this option has no effect. Also note that this setting
9314# only affects scheduling if the 'TrustedFilter' filter is enabled.
9315#
9316# Possible values:
9317#
9318# * A string containing the specific blob required by the attestation server, or
9319# an empty string.
9320#
9321# Related options:
9322#
9323# * attestation_server
9324# * attestation_server_ca_file
9325# * attestation_port
9326# * attestation_api_url
9327# * attestation_auth_timeout
9328# * attestation_insecure_ssl
9329# (string value)
9330#attestation_auth_blob=<None>
9331
9332#
9333# This value controls how long a successful attestation is cached. Once this
9334# period has elapsed, a new attestation request will be made. See the
9335# `attestation_server` help text for more information about host verification.
9336#
9337# This option is only used by the FilterScheduler and its subclasses; if you use
9338# a different scheduler, this option has no effect. Also note that this setting
9339# only affects scheduling if the 'TrustedFilter' filter is enabled.
9340#
9341# Possible values:
9342#
9343# * A integer value, corresponding to the timeout interval for attestations in
9344# seconds. Any integer is valid, although setting this to zero or negative
9345# values can greatly impact performance when using an attestation service.
9346#
9347# Related options:
9348#
9349# * attestation_server
9350# * attestation_server_ca_file
9351# * attestation_port
9352# * attestation_api_url
9353# * attestation_auth_blob
9354# * attestation_insecure_ssl
9355# (integer value)
9356#attestation_auth_timeout=60
9357
9358#
9359# When set to True, the SSL certificate verification is skipped for the
9360# attestation service. See the `attestation_server` help text for more
9361# information about host verification.
9362#
9363# This option is only used by the FilterScheduler and its subclasses; if you use
9364# a different scheduler, this option has no effect. Also note that this setting
9365# only affects scheduling if the 'TrustedFilter' filter is enabled.
9366#
9367# Related options:
9368#
9369# * attestation_server
9370# * attestation_server_ca_file
9371# * attestation_port
9372# * attestation_api_url
9373# * attestation_auth_blob
9374# * attestation_auth_timeout
9375# (boolean value)
9376#attestation_insecure_ssl=false
9377
9378
9379[upgrade_levels]
9380#
9381# upgrade_levels options are used to set version cap for RPC
9382# messages sent between different nova services.
9383#
9384# By default all services send messages using the latest version
9385# they know about.
9386#
9387# The compute upgrade level is an important part of rolling upgrades
9388# where old and new nova-compute services run side by side.
9389#
9390# The other options can largely be ignored, and are only kept to
9391# help with a possible future backport issue.
9392
9393#
9394# From nova.conf
9395#
9396
9397#
9398# Compute RPC API version cap.
9399#
9400# By default, we always send messages using the most recent version
9401# the client knows about.
9402#
9403# Where you have old and new compute services running, you should set
9404# this to the lowest deployed version. This is to guarantee that all
9405# services never send messages that one of the compute nodes can't
9406# understand. Note that we only support upgrading from release N to
9407# release N+1.
9408#
9409# Set this option to "auto" if you want to let the compute RPC module
9410# automatically determine what version to use based on the service
9411# versions in the deployment.
9412#
9413# Possible values:
9414#
9415# * By default send the latest version the client knows about
9416# * 'auto': Automatically determines what version to use based on
9417# the service versions in the deployment.
9418# * A string representing a version number in the format 'N.N';
9419# for example, possible values might be '1.12' or '2.0'.
9420# * An OpenStack release name, in lower case, such as 'mitaka' or
9421# 'liberty'.
9422# (string value)
9423#compute=<None>
9424
9425# Cells RPC API version cap (string value)
9426#cells=<None>
9427
9428# Intercell RPC API version cap (string value)
9429#intercell=<None>
9430
9431# Cert RPC API version cap (string value)
9432#cert=<None>
9433
9434# Scheduler RPC API version cap (string value)
9435#scheduler=<None>
9436
9437# Conductor RPC API version cap (string value)
9438#conductor=<None>
9439
9440# Console RPC API version cap (string value)
9441#console=<None>
9442
9443# Consoleauth RPC API version cap (string value)
9444#consoleauth=<None>
9445
9446# Network RPC API version cap (string value)
9447#network=<None>
9448
9449# Base API RPC API version cap (string value)
9450#baseapi=<None>
9451
9452
9453[vendordata_dynamic_auth]
9454#
9455# Options within this group control the authentication of the vendordata
9456# subsystem of the metadata API server (and config drive) with external systems.
9457
9458#
9459# From nova.conf
9460#
9461
9462# PEM encoded Certificate Authority to use when verifying HTTPs connections.
9463# (string value)
9464#cafile=<None>
9465
9466# PEM encoded client certificate cert file (string value)
9467#certfile=<None>
9468
9469# PEM encoded client certificate key file (string value)
9470#keyfile=<None>
9471
9472# Verify HTTPS connections. (boolean value)
9473#insecure=false
9474
9475# Timeout value for http requests (integer value)
9476#timeout=<None>
9477
9478# Authentication type to load (string value)
9479# Deprecated group/name - [vendordata_dynamic_auth]/auth_plugin
9480#auth_type=<None>
9481
9482# Config Section from which to load plugin specific options (string value)
9483#auth_section=<None>
9484
9485# Authentication URL (string value)
9486#auth_url=<None>
9487
9488# Domain ID to scope to (string value)
9489#domain_id=<None>
9490
9491# Domain name to scope to (string value)
9492#domain_name=<None>
9493
9494# Project ID to scope to (string value)
9495#project_id=<None>
9496
9497# Project name to scope to (string value)
9498#project_name=<None>
9499
9500# Domain ID containing project (string value)
9501#project_domain_id=<None>
9502
9503# Domain name containing project (string value)
9504#project_domain_name=<None>
9505
9506# Trust ID (string value)
9507#trust_id=<None>
9508
9509# Optional domain ID to use with v3 and v2 parameters. It will be used for both
9510# the user and project domain in v3 and ignored in v2 authentication. (string
9511# value)
9512#default_domain_id=<None>
9513
9514# Optional domain name to use with v3 API and v2 parameters. It will be used for
9515# both the user and project domain in v3 and ignored in v2 authentication.
9516# (string value)
9517#default_domain_name=<None>
9518
9519# User ID (string value)
9520#user_id=<None>
9521
9522# Username (string value)
9523# Deprecated group/name - [vendordata_dynamic_auth]/user-name
9524#username=<None>
9525
9526# User's domain id (string value)
9527#user_domain_id=<None>
9528
9529# User's domain name (string value)
9530#user_domain_name=<None>
9531
9532# User's password (string value)
9533#password=<None>
9534
9535# Tenant ID (string value)
9536#tenant_id=<None>
9537
9538# Tenant Name (string value)
9539#tenant_name=<None>
9540
9541
9542[vmware]
9543#
9544# Related options:
9545# Following options must be set in order to launch VMware-based
9546# virtual machines.
9547#
9548# * compute_driver: Must use vmwareapi.VMwareVCDriver.
9549# * vmware.host_username
9550# * vmware.host_password
9551# * vmware.cluster_name
9552
9553#
9554# From nova.conf
9555#
9556
9557#
9558# This option specifies the physical ethernet adapter name for VLAN
9559# networking.
9560#
9561# Set the vlan_interface configuration option to match the ESX host
9562# interface that handles VLAN-tagged VM traffic.
9563#
9564# Possible values:
9565#
9566# * Any valid string representing VLAN interface name
9567# (string value)
9568#vlan_interface=vmnic0
9569
9570#
9571# This option should be configured only when using the NSX-MH Neutron
9572# plugin. This is the name of the integration bridge on the ESXi server
9573# or host. This should not be set for any other Neutron plugin. Hence
9574# the default value is not set.
9575#
9576# Possible values:
9577#
9578# * Any valid string representing the name of the integration bridge
9579# (string value)
9580#integration_bridge=<None>
9581
9582#
9583# Set this value if affected by an increased network latency causing
9584# repeated characters when typing in a remote console.
9585# (integer value)
9586# Minimum value: 0
9587#console_delay_seconds=<None>
9588
9589#
9590# Identifies the remote system where the serial port traffic will
9591# be sent.
9592#
9593# This option adds a virtual serial port which sends console output to
9594# a configurable service URI. At the service URI address there will be
9595# virtual serial port concentrator that will collect console logs.
9596# If this is not set, no serial ports will be added to the created VMs.
9597#
9598# Possible values:
9599#
9600# * Any valid URI
9601# (string value)
9602#serial_port_service_uri=<None>
9603
9604#
9605# Identifies a proxy service that provides network access to the
9606# serial_port_service_uri.
9607#
9608# Possible values:
9609#
9610# * Any valid URI
9611#
9612# Related options:
9613# This option is ignored if serial_port_service_uri is not specified.
9614# * serial_port_service_uri
9615# (string value)
9616#serial_port_proxy_uri=<None>
9617
9618#
9619# Hostname or IP address for connection to VMware vCenter host. (string value)
9620#host_ip=<None>
9621
9622# Port for connection to VMware vCenter host. (port value)
9623# Minimum value: 0
9624# Maximum value: 65535
9625#host_port=443
9626
9627# Username for connection to VMware vCenter host. (string value)
9628#host_username=<None>
9629
9630# Password for connection to VMware vCenter host. (string value)
9631#host_password=<None>
9632
9633#
9634# Specifies the CA bundle file to be used in verifying the vCenter
9635# server certificate.
9636# (string value)
9637#ca_file=<None>
9638
9639#
9640# If true, the vCenter server certificate is not verified. If false,
9641# then the default CA truststore is used for verification.
9642#
9643# Related options:
9644# * ca_file: This option is ignored if "ca_file" is set.
9645# (boolean value)
9646#insecure=false
9647
9648# Name of a VMware Cluster ComputeResource. (string value)
9649#cluster_name=<None>
9650
9651#
9652# Regular expression pattern to match the name of datastore.
9653#
9654# The datastore_regex setting specifies the datastores to use with
9655# Compute. For example, datastore_regex="nas.*" selects all the data
9656# stores that have a name starting with "nas".
9657#
9658# NOTE: If no regex is given, it just picks the datastore with the
9659# most freespace.
9660#
9661# Possible values:
9662#
9663# * Any matching regular expression to a datastore must be given
9664# (string value)
9665#datastore_regex=<None>
9666
9667#
9668# Time interval in seconds to poll remote tasks invoked on
9669# VMware VC server.
9670# (floating point value)
9671#task_poll_interval=0.5
9672
9673#
9674# Number of times VMware vCenter server API must be retried on connection
9675# failures, e.g. socket error, etc.
9676# (integer value)
9677# Minimum value: 0
9678#api_retry_count=10
9679
9680#
9681# This option specifies VNC starting port.
9682#
9683# Every VM created by ESX host has an option of enabling VNC client
9684# for remote connection. Above option 'vnc_port' helps you to set
9685# default starting port for the VNC client.
9686#
9687# Possible values:
9688#
9689# * Any valid port number within 5900 -(5900 + vnc_port_total)
9690#
9691# Related options:
9692# Below options should be set to enable VNC client.
9693# * vnc.enabled = True
9694# * vnc_port_total
9695# (port value)
9696# Minimum value: 0
9697# Maximum value: 65535
9698#vnc_port=5900
9699
9700#
9701# Total number of VNC ports.
9702# (integer value)
9703# Minimum value: 0
9704#vnc_port_total=10000
9705
9706#
9707# This option enables/disables the use of linked clone.
9708#
9709# The ESX hypervisor requires a copy of the VMDK file in order to boot
9710# up a virtual machine. The compute driver must download the VMDK via
9711# HTTP from the OpenStack Image service to a datastore that is visible
9712# to the hypervisor and cache it. Subsequent virtual machines that need
9713# the VMDK use the cached version and don't have to copy the file again
9714# from the OpenStack Image service.
9715#
9716# If set to false, even with a cached VMDK, there is still a copy
9717# operation from the cache location to the hypervisor file directory
9718# in the shared datastore. If set to true, the above copy operation
9719# is avoided as it creates copy of the virtual machine that shares
9720# virtual disks with its parent VM.
9721# (boolean value)
9722#use_linked_clone=true
9723
9724# DEPRECATED:
9725# This option specifies VIM Service WSDL Location
9726#
9727# If vSphere API versions 5.1 and later is being used, this section can
9728# be ignored. If version is less than 5.1, WSDL files must be hosted
9729# locally and their location must be specified in the above section.
9730#
9731# Optional over-ride to default location for bug work-arounds.
9732#
9733# Possible values:
9734#
9735# * http://<server>/vimService.wsdl
9736# * file:///opt/stack/vmware/SDK/wsdl/vim25/vimService.wsdl
9737# (string value)
9738# This option is deprecated for removal since 15.0.0.
9739# Its value may be silently ignored in the future.
9740# Reason: Only vCenter versions earlier than 5.1 require this option and the
9741# current minimum version is 5.1.
9742#wsdl_location=<None>
9743
9744#
9745# This option enables or disables storage policy based placement
9746# of instances.
9747#
9748# Related options:
9749#
9750# * pbm_default_policy
9751# (boolean value)
9752#pbm_enabled=false
9753
9754#
9755# This option specifies the PBM service WSDL file location URL.
9756#
9757# Setting this will disable storage policy based placement
9758# of instances.
9759#
9760# Possible values:
9761#
9762# * Any valid file path
9763# e.g file:///opt/SDK/spbm/wsdl/pbmService.wsdl
9764# (string value)
9765#pbm_wsdl_location=<None>
9766
9767#
9768# This option specifies the default policy to be used.
9769#
9770# If pbm_enabled is set and there is no defined storage policy for the
9771# specific request, then this policy will be used.
9772#
9773# Possible values:
9774#
9775# * Any valid storage policy such as VSAN default storage policy
9776#
9777# Related options:
9778#
9779# * pbm_enabled
9780# (string value)
9781#pbm_default_policy=<None>
9782
9783#
9784# This option specifies the limit on the maximum number of objects to
9785# return in a single result.
9786#
9787# A positive value will cause the operation to suspend the retrieval
9788# when the count of objects reaches the specified limit. The server may
9789# still limit the count to something less than the configured value.
9790# Any remaining objects may be retrieved with additional requests.
9791# (integer value)
9792# Minimum value: 0
9793#maximum_objects=100
9794
9795#
9796# This option adds a prefix to the folder where cached images are stored
9797#
9798# This is not the full path - just a folder prefix. This should only be
9799# used when a datastore cache is shared between compute nodes.
9800#
9801# Note: This should only be used when the compute nodes are running on same
9802# host or they have a shared file system.
9803#
9804# Possible values:
9805#
9806# * Any string representing the cache prefix to the folder
9807# (string value)
9808#cache_prefix=<None>
9809
9810
9811[vnc]
9812#
9813# Virtual Network Computer (VNC) can be used to provide remote desktop
9814# console access to instances for tenants and/or administrators.
9815
9816#
9817# From nova.conf
9818#
9819enabled = true
9820novncproxy_base_url={{ compute.vncproxy_url }}/vnc_auto.html
9821novncproxy_port={{ compute.bind.vnc_port }}
9822vncserver_listen=0.0.0.0
9823vncserver_proxyclient_address={{ compute.bind.vnc_address }}
9824keymap = {{ compute.get('vnc_keymap', 'en-us') }}
9825
9826#
9827# Enable VNC related features.
9828#
9829# Guests will get created with graphical devices to support this. Clients
9830# (for example Horizon) can then establish a VNC connection to the guest.
9831# (boolean value)
9832# Deprecated group/name - [DEFAULT]/vnc_enabled
9833#enabled=true
9834
9835#
9836# Keymap for VNC.
9837#
9838# The keyboard mapping (keymap) determines which keyboard layout a VNC
9839# session should use by default.
9840#
9841# Possible values:
9842#
9843# * A keyboard layout which is supported by the underlying hypervisor on
9844# this node. This is usually an 'IETF language tag' (for example
9845# 'en-us'). If you use QEMU as hypervisor, you should find the list
9846# of supported keyboard layouts at ``/usr/share/qemu/keymaps``.
9847# (string value)
9848# Deprecated group/name - [DEFAULT]/vnc_keymap
9849#keymap=en-us
9850
9851#
9852# The IP address or hostname on which an instance should listen to for
9853# incoming VNC connection requests on this node.
9854# (string value)
9855# Deprecated group/name - [DEFAULT]/vncserver_listen
9856#vncserver_listen=127.0.0.1
9857
9858#
9859# Private, internal IP address or hostname of VNC console proxy.
9860#
9861# The VNC proxy is an OpenStack component that enables compute service
9862# users to access their instances through VNC clients.
9863#
9864# This option sets the private address to which proxy clients, such as
9865# ``nova-xvpvncproxy``, should connect to.
9866# (string value)
9867# Deprecated group/name - [DEFAULT]/vncserver_proxyclient_address
9868#vncserver_proxyclient_address=127.0.0.1
9869
9870#
9871# Public address of noVNC VNC console proxy.
9872#
9873# The VNC proxy is an OpenStack component that enables compute service
9874# users to access their instances through VNC clients. noVNC provides
9875# VNC support through a websocket-based client.
9876#
9877# This option sets the public base URL to which client systems will
9878# connect. noVNC clients can use this address to connect to the noVNC
9879# instance and, by extension, the VNC sessions.
9880#
9881# Related options:
9882#
9883# * novncproxy_host
9884# * novncproxy_port
9885# (uri value)
9886# Deprecated group/name - [DEFAULT]/novncproxy_base_url
9887#novncproxy_base_url=http://127.0.0.1:6080/vnc_auto.html
9888
9889#
9890# IP address or hostname that the XVP VNC console proxy should bind to.
9891#
9892# The VNC proxy is an OpenStack component that enables compute service
9893# users to access their instances through VNC clients. Xen provides
9894# the Xenserver VNC Proxy, or XVP, as an alternative to the
9895# websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
9896# XVP clients are Java-based.
9897#
9898# This option sets the private address to which the XVP VNC console proxy
9899# service should bind to.
9900#
9901# Related options:
9902#
9903# * xvpvncproxy_port
9904# * xvpvncproxy_base_url
9905# (string value)
9906# Deprecated group/name - [DEFAULT]/xvpvncproxy_host
9907#xvpvncproxy_host=0.0.0.0
9908
9909#
9910# Port that the XVP VNC console proxy should bind to.
9911#
9912# The VNC proxy is an OpenStack component that enables compute service
9913# users to access their instances through VNC clients. Xen provides
9914# the Xenserver VNC Proxy, or XVP, as an alternative to the
9915# websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
9916# XVP clients are Java-based.
9917#
9918# This option sets the private port to which the XVP VNC console proxy
9919# service should bind to.
9920#
9921# Related options:
9922#
9923# * xvpvncproxy_host
9924# * xvpvncproxy_base_url
9925# (port value)
9926# Minimum value: 0
9927# Maximum value: 65535
9928# Deprecated group/name - [DEFAULT]/xvpvncproxy_port
9929#xvpvncproxy_port=6081
9930
9931#
9932# Public URL address of XVP VNC console proxy.
9933#
9934# The VNC proxy is an OpenStack component that enables compute service
9935# users to access their instances through VNC clients. Xen provides
9936# the Xenserver VNC Proxy, or XVP, as an alternative to the
9937# websocket-based noVNC proxy used by Libvirt. In contrast to noVNC,
9938# XVP clients are Java-based.
9939#
9940# This option sets the public base URL to which client systems will
9941# connect. XVP clients can use this address to connect to the XVP
9942# instance and, by extension, the VNC sessions.
9943#
9944# Related options:
9945#
9946# * xvpvncproxy_host
9947# * xvpvncproxy_port
9948# (uri value)
9949# Deprecated group/name - [DEFAULT]/xvpvncproxy_base_url
9950#xvpvncproxy_base_url=http://127.0.0.1:6081/console
9951
9952#
9953# IP address that the noVNC console proxy should bind to.
9954#
9955# The VNC proxy is an OpenStack component that enables compute service
9956# users to access their instances through VNC clients. noVNC provides
9957# VNC support through a websocket-based client.
9958#
9959# This option sets the private address to which the noVNC console proxy
9960# service should bind to.
9961#
9962# Related options:
9963#
9964# * novncproxy_port
9965# * novncproxy_base_url
9966# (string value)
9967# Deprecated group/name - [DEFAULT]/novncproxy_host
9968#novncproxy_host=0.0.0.0
9969
9970#
9971# Port that the noVNC console proxy should bind to.
9972#
9973# The VNC proxy is an OpenStack component that enables compute service
9974# users to access their instances through VNC clients. noVNC provides
9975# VNC support through a websocket-based client.
9976#
9977# This option sets the private port to which the noVNC console proxy
9978# service should bind to.
9979#
9980# Related options:
9981#
9982# * novncproxy_host
9983# * novncproxy_base_url
9984# (port value)
9985# Minimum value: 0
9986# Maximum value: 65535
9987# Deprecated group/name - [DEFAULT]/novncproxy_port
9988#novncproxy_port=6080
9989
9990
9991[workarounds]
9992#
9993# A collection of workarounds used to mitigate bugs or issues found in system
9994# tools (e.g. Libvirt or QEMU) or Nova itself under certain conditions. These
9995# should only be enabled in exceptional circumstances. All options are linked
9996# against bug IDs, where more information on the issue can be found.
9997
9998#
9999# From nova.conf
10000#
10001
10002#
10003# Use sudo instead of rootwrap.
10004#
10005# Allow fallback to sudo for performance reasons.
10006#
10007# For more information, refer to the bug report:
10008#
10009# https://bugs.launchpad.net/nova/+bug/1415106
10010#
10011# Possible values:
10012#
10013# * True: Use sudo instead of rootwrap
10014# * False: Use rootwrap as usual
10015#
10016# Interdependencies to other options:
10017#
10018# * Any options that affect 'rootwrap' will be ignored.
10019# (boolean value)
10020#disable_rootwrap=false
10021
10022#
10023# Disable live snapshots when using the libvirt driver.
10024#
10025# Live snapshots allow the snapshot of the disk to happen without an
10026# interruption to the guest, using coordination with a guest agent to
10027# quiesce the filesystem.
10028#
10029# When using libvirt 1.2.2 live snapshots fail intermittently under load
10030# (likely related to concurrent libvirt/qemu operations). This config
10031# option provides a mechanism to disable live snapshot, in favor of cold
10032# snapshot, while this is resolved. Cold snapshot causes an instance
10033# outage while the guest is going through the snapshotting process.
10034#
10035# For more information, refer to the bug report:
10036#
10037# https://bugs.launchpad.net/nova/+bug/1334398
10038#
10039# Possible values:
10040#
10041# * True: Live snapshot is disabled when using libvirt
10042# * False: Live snapshots are always used when snapshotting (as long as
10043# there is a new enough libvirt and the backend storage supports it)
10044# (boolean value)
10045#disable_libvirt_livesnapshot=true
10046
10047#
10048# Enable handling of events emitted from compute drivers.
10049#
10050# Many compute drivers emit lifecycle events, which are events that occur when,
10051# for example, an instance is starting or stopping. If the instance is going
10052# through task state changes due to an API operation, like resize, the events
10053# are ignored.
10054#
10055# This is an advanced feature which allows the hypervisor to signal to the
10056# compute service that an unexpected state change has occurred in an instance
10057# and that the instance can be shutdown automatically. Unfortunately, this can
10058# race in some conditions, for example in reboot operations or when the compute
10059# service or when host is rebooted (planned or due to an outage). If such races
10060# are common, then it is advisable to disable this feature.
10061#
10062# Care should be taken when this feature is disabled and
10063# 'sync_power_state_interval' is set to a negative value. In this case, any
10064# instances that get out of sync between the hypervisor and the Nova database
10065# will have to be synchronized manually.
10066#
10067# For more information, refer to the bug report:
10068#
10069# https://bugs.launchpad.net/bugs/1444630
10070#
10071# Interdependencies to other options:
10072#
10073# * If ``sync_power_state_interval`` is negative and this feature is disabled,
10074# then instances that get out of sync between the hypervisor and the Nova
10075# database will have to be synchronized manually.
10076# (boolean value)
10077#handle_virt_lifecycle_events=true
10078
10079
10080[wsgi]
10081#
10082# Options under this group are used to configure WSGI (Web Server Gateway
10083# Interface). WSGI is used to serve API requests.
10084
10085#
10086# From nova.conf
10087#
10088
10089#
10090# This option represents a file name for the paste.deploy config for nova-api.
10091#
10092# Possible values:
10093#
10094# * A string representing file name for the paste.deploy config.
10095# (string value)
10096# Deprecated group/name - [DEFAULT]/api_paste_config
10097api_paste_config=/etc/nova/api-paste.ini
10098
10099#
10100# It represents a python format string that is used as the template to generate
10101# log lines. The following values can be formatted into it: client_ip,
10102# date_time, request_line, status_code, body_length, wall_seconds.
10103#
10104# This option is used for building custom request loglines.
10105#
10106# Possible values:
10107#
10108# * '%(client_ip)s "%(request_line)s" status: %(status_code)s'
10109# 'len: %(body_length)s time: %(wall_seconds).7f' (default)
10110# * Any formatted string formed by specific values.
10111# (string value)
10112# Deprecated group/name - [DEFAULT]/wsgi_log_format
10113#wsgi_log_format=%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f
10114
10115#
10116# This option specifies the HTTP header used to determine the protocol scheme
10117# for the original request, even if it was removed by a SSL terminating proxy.
10118#
10119# Possible values:
10120#
10121# * None (default) - the request scheme is not influenced by any HTTP headers.
10122# * Valid HTTP header, like HTTP_X_FORWARDED_PROTO
10123# (string value)
10124# Deprecated group/name - [DEFAULT]/secure_proxy_ssl_header
10125#secure_proxy_ssl_header=<None>
10126
10127#
10128# This option allows setting path to the CA certificate file that should be used
10129# to verify connecting clients.
10130#
10131# Possible values:
10132#
10133# * String representing path to the CA certificate file.
10134#
10135# Related options:
10136#
10137# * enabled_ssl_apis
10138# (string value)
10139# Deprecated group/name - [DEFAULT]/ssl_ca_file
10140#ssl_ca_file=<None>
10141
10142#
10143# This option allows setting path to the SSL certificate of API server.
10144#
10145# Possible values:
10146#
10147# * String representing path to the SSL certificate.
10148#
10149# Related options:
10150#
10151# * enabled_ssl_apis
10152# (string value)
10153# Deprecated group/name - [DEFAULT]/ssl_cert_file
10154#ssl_cert_file=<None>
10155
10156#
10157# This option specifies the path to the file where SSL private key of API
10158# server is stored when SSL is in effect.
10159#
10160# Possible values:
10161#
10162# * String representing path to the SSL private key.
10163#
10164# Related options:
10165#
10166# * enabled_ssl_apis
10167# (string value)
10168# Deprecated group/name - [DEFAULT]/ssl_key_file
10169#ssl_key_file=<None>
10170
10171#
10172# This option sets the value of TCP_KEEPIDLE in seconds for each server socket.
10173# It specifies the duration of time to keep connection active. TCP generates a
10174# KEEPALIVE transmission for an application that requests to keep connection
10175# active. Not supported on OS X.
10176#
10177# Related options:
10178#
10179# * keep_alive
10180# (integer value)
10181# Minimum value: 0
10182# Deprecated group/name - [DEFAULT]/tcp_keepidle
10183#tcp_keepidle=600
10184
10185#
10186# This option specifies the size of the pool of greenthreads used by wsgi.
10187# It is possible to limit the number of concurrent connections using this
10188# option.
10189# (integer value)
10190# Minimum value: 0
10191# Deprecated group/name - [DEFAULT]/wsgi_default_pool_size
10192#default_pool_size=1000
10193
10194#
10195# This option specifies the maximum line size of message headers to be accepted.
10196# max_header_line may need to be increased when using large tokens (typically
10197# those generated by the Keystone v3 API with big service catalogs).
10198#
10199# Since TCP is a stream based protocol, in order to reuse a connection, the HTTP
10200# has to have a way to indicate the end of the previous response and beginning
10201# of the next. Hence, in a keep_alive case, all messages must have a
10202# self-defined message length.
10203# (integer value)
10204# Minimum value: 0
10205# Deprecated group/name - [DEFAULT]/max_header_line
10206#max_header_line=16384
10207
10208#
10209# This option allows using the same TCP connection to send and receive multiple
10210# HTTP requests/responses, as opposed to opening a new one for every single
10211# request/response pair. HTTP keep-alive indicates HTTP connection reuse.
10212#
10213# Possible values:
10214#
10215# * True : reuse HTTP connection.
10216# * False : closes the client socket connection explicitly.
10217#
10218# Related options:
10219#
10220# * tcp_keepidle
10221# (boolean value)
10222# Deprecated group/name - [DEFAULT]/wsgi_keep_alive
10223#keep_alive=true
10224
10225#
10226# This option specifies the timeout for client connections' socket operations.
10227# If an incoming connection is idle for this number of seconds it will be
10228# closed. It indicates timeout on individual read/writes on the socket
10229# connection. To wait forever set to 0.
10230# (integer value)
10231# Minimum value: 0
10232# Deprecated group/name - [DEFAULT]/client_socket_timeout
10233#client_socket_timeout=900
10234
10235
10236[xenserver]
10237#
10238# XenServer options are used when the compute_driver is set to use
10239# XenServer (compute_driver=xenapi.XenAPIDriver).
10240#
10241# Must specify connection_url, connection_password and ovs_integration_bridge to
10242# use compute_driver=xenapi.XenAPIDriver.
10243
10244#
10245# From nova.conf
10246#
10247
10248#
10249# Number of seconds to wait for agent's reply to a request.
10250#
10251# Nova configures/performs certain administrative actions on a server with the
10252# help of an agent that's installed on the server. The communication between
10253# Nova and the agent is achieved via sharing messages, called records, over
10254# xenstore, a shared storage across all the domains on a Xenserver host.
10255# Operations performed by the agent on behalf of nova are: 'version','
10256# key_init',
10257# 'password','resetnetwork','inject_file', and 'agentupdate'.
10258#
10259# To perform one of the above operations, the xapi 'agent' plugin writes the
10260# command and its associated parameters to a certain location known to the
10261# domain
10262# and awaits response. On being notified of the message, the agent performs
10263# appropriate actions on the server and writes the result back to xenstore. This
10264# result is then read by the xapi 'agent' plugin to determine the
10265# success/failure
10266# of the operation.
10267#
10268# This config option determines how long the xapi 'agent' plugin shall wait to
10269# read the response off of xenstore for a given request/command. If the agent on
10270# the instance fails to write the result in this time period, the operation is
10271# considered to have timed out.
10272#
10273# Related options:
10274#
10275# * ``agent_version_timeout``
10276# * ``agent_resetnetwork_timeout``
10277#
10278# (integer value)
10279# Minimum value: 0
10280#agent_timeout=30
10281
10282#
10283# Number of seconds to wait for agent't reply to version request.
10284#
10285# This indicates the amount of time xapi 'agent' plugin waits for the agent to
10286# respond to the 'version' request specifically. The generic timeout for agent
10287# communication ``agent_timeout`` is ignored in this case.
10288#
10289# During the build process the 'version' request is used to determine if the
10290# agent is available/operational to perform other requests such as
10291# 'resetnetwork', 'password', 'key_init' and 'inject_file'. If the 'version'
10292# call
10293# fails, the other configuration is skipped. So, this configuration option can
10294# also be interpreted as time in which agent is expected to be fully
10295# operational.
10296# (integer value)
10297# Minimum value: 0
10298#agent_version_timeout=300
10299
10300#
10301# Number of seconds to wait for agent's reply to resetnetwork
10302# request.
10303#
10304# This indicates the amount of time xapi 'agent' plugin waits for the agent to
10305# respond to the 'resetnetwork' request specifically. The generic timeout for
10306# agent communication ``agent_timeout`` is ignored in this case.
10307# (integer value)
10308# Minimum value: 0
10309#agent_resetnetwork_timeout=60
10310
10311#
10312# Path to locate guest agent on the server.
10313#
10314# Specifies the path in which the XenAPI guest agent should be located. If the
10315# agent is present, network configuration is not injected into the image.
10316#
10317# Related options:
10318#
10319# For this option to have an effect:
10320# * ``flat_injected`` should be set to ``True``
10321# * ``compute_driver`` should be set to ``xenapi.XenAPIDriver``
10322#
10323# (string value)
10324#agent_path=usr/sbin/xe-update-networking
10325
10326#
10327# Disables the use of XenAPI agent.
10328#
10329# This configuration option suggests whether the use of agent should be enabled
10330# or not regardless of what image properties are present. Image properties have
10331# an effect only when this is set to ``True``. Read description of config option
10332# ``use_agent_default`` for more information.
10333#
10334# Related options:
10335#
10336# * ``use_agent_default``
10337#
10338# (boolean value)
10339#disable_agent=false
10340
10341#
10342# Whether or not to use the agent by default when its usage is enabled but not
10343# indicated by the image.
10344#
10345# The use of XenAPI agent can be disabled altogether using the configuration
10346# option ``disable_agent``. However, if it is not disabled, the use of an agent
10347# can still be controlled by the image in use through one of its properties,
10348# ``xenapi_use_agent``. If this property is either not present or specified
10349# incorrectly on the image, the use of agent is determined by this configuration
10350# option.
10351#
10352# Note that if this configuration is set to ``True`` when the agent is not
10353# present, the boot times will increase significantly.
10354#
10355# Related options:
10356#
10357# * ``disable_agent``
10358#
10359# (boolean value)
10360#use_agent_default=false
10361
10362# Timeout in seconds for XenAPI login. (integer value)
10363# Minimum value: 0
10364#login_timeout=10
10365
10366#
10367# Maximum number of concurrent XenAPI connections.
10368#
10369# In nova, multiple XenAPI requests can happen at a time.
10370# Configuring this option will parallelize access to the XenAPI
10371# session, which allows you to make concurrent XenAPI connections.
10372# (integer value)
10373# Minimum value: 1
10374#connection_concurrent=5
10375
10376# DEPRECATED:
10377# Base URL for torrent files; must contain a slash character (see RFC 1808,
10378# step 6).
10379# (string value)
10380# This option is deprecated for removal since 15.0.0.
10381# Its value may be silently ignored in the future.
10382# Reason:
10383# The torrent feature has not been tested nor maintained, and as such is being
10384# removed.
10385#torrent_base_url=<None>
10386
10387# DEPRECATED: Probability that peer will become a seeder (1.0 = 100%) (floating
10388# point value)
10389# Minimum value: 0
10390# This option is deprecated for removal since 15.0.0.
10391# Its value may be silently ignored in the future.
10392# Reason:
10393# The torrent feature has not been tested nor maintained, and as such is being
10394# removed.
10395#torrent_seed_chance=1.0
10396
10397# DEPRECATED:
10398# Number of seconds after downloading an image via BitTorrent that it should
10399# be seeded for other peers.'
10400# (integer value)
10401# This option is deprecated for removal since 15.0.0.
10402# Its value may be silently ignored in the future.
10403# Reason:
10404# The torrent feature has not been tested nor maintained, and as such is being
10405# removed.
10406#torrent_seed_duration=3600
10407
10408# DEPRECATED:
10409# Cached torrent files not accessed within this number of seconds can be reaped.
10410# (integer value)
10411# Minimum value: 0
10412# This option is deprecated for removal since 15.0.0.
10413# Its value may be silently ignored in the future.
10414# Reason:
10415# The torrent feature has not been tested nor maintained, and as such is being
10416# removed.
10417#torrent_max_last_accessed=86400
10418
10419# DEPRECATED: Beginning of port range to listen on (port value)
10420# Minimum value: 0
10421# Maximum value: 65535
10422# This option is deprecated for removal since 15.0.0.
10423# Its value may be silently ignored in the future.
10424# Reason:
10425# The torrent feature has not been tested nor maintained, and as such is being
10426# removed.
10427#torrent_listen_port_start=6881
10428
10429# DEPRECATED: End of port range to listen on (port value)
10430# Minimum value: 0
10431# Maximum value: 65535
10432# This option is deprecated for removal since 15.0.0.
10433# Its value may be silently ignored in the future.
10434# Reason:
10435# The torrent feature has not been tested nor maintained, and as such is being
10436# removed.
10437#torrent_listen_port_end=6891
10438
10439# DEPRECATED:
10440# Number of seconds a download can remain at the same progress percentage w/o
10441# being considered a stall.
10442# (integer value)
10443# Minimum value: 0
10444# This option is deprecated for removal since 15.0.0.
10445# Its value may be silently ignored in the future.
10446# Reason:
10447# The torrent feature has not been tested nor maintained, and as such is being
10448# removed.
10449#torrent_download_stall_cutoff=600
10450
10451# DEPRECATED:
10452# Maximum number of seeder processes to run concurrently within a given dom0
10453# (-1 = no limit).
10454# (integer value)
10455# Minimum value: -1
10456# This option is deprecated for removal since 15.0.0.
10457# Its value may be silently ignored in the future.
10458# Reason:
10459# The torrent feature has not been tested nor maintained, and as such is being
10460# removed.
10461#torrent_max_seeder_processes_per_host=1
10462
10463#
10464# Cache glance images locally.
10465#
10466# The value for this option must be chosen from the choices listed
10467# here. Configuring a value other than these will default to 'all'.
10468#
10469# Note: There is nothing that deletes these images.
10470#
10471# Possible values:
10472#
10473# * `all`: will cache all images.
10474# * `some`: will only cache images that have the
10475# image_property `cache_in_nova=True`.
10476# * `none`: turns off caching entirely.
10477# (string value)
10478# Allowed values: all, some, none
10479#cache_images=all
10480
10481#
10482# Compression level for images.
10483#
10484# By setting this option we can configure the gzip compression level.
10485# This option sets GZIP environment variable before spawning tar -cz
10486# to force the compression level. It defaults to none, which means the
10487# GZIP environment variable is not set and the default (usually -6)
10488# is used.
10489#
10490# Possible values:
10491#
10492# * Range is 1-9, e.g., 9 for gzip -9, 9 being most
10493# compressed but most CPU intensive on dom0.
10494# * Any values out of this range will default to None.
10495# (integer value)
10496# Minimum value: 1
10497# Maximum value: 9
10498#image_compression_level=<None>
10499
10500# Default OS type used when uploading an image to glance (string value)
10501#default_os_type=linux
10502
10503# Time in secs to wait for a block device to be created (integer value)
10504# Minimum value: 1
10505#block_device_creation_timeout=10
10506
10507#
10508# Maximum size in bytes of kernel or ramdisk images.
10509#
10510# Specifying the maximum size of kernel or ramdisk will avoid copying
10511# large files to dom0 and fill up /boot/guest.
10512# (integer value)
10513#max_kernel_ramdisk_size=16777216
10514
10515#
10516# Filter for finding the SR to be used to install guest instances on.
10517#
10518# Possible values:
10519#
10520# * To use the Local Storage in default XenServer/XCP installations
10521# set this flag to other-config:i18n-key=local-storage.
10522# * To select an SR with a different matching criteria, you could
10523# set it to other-config:my_favorite_sr=true.
10524# * To fall back on the Default SR, as displayed by XenCenter,
10525# set this flag to: default-sr:true.
10526# (string value)
10527#sr_matching_filter=default-sr:true
10528
10529#
10530# Whether to use sparse_copy for copying data on a resize down.
10531# (False will use standard dd). This speeds up resizes down
10532# considerably since large runs of zeros won't have to be rsynced.
10533# (boolean value)
10534#sparse_copy=true
10535
10536#
10537# Maximum number of retries to unplug VBD.
10538# If set to 0, should try once, no retries.
10539# (integer value)
10540# Minimum value: 0
10541#num_vbd_unplug_retries=10
10542
10543#
10544# Whether or not to download images via Bit Torrent.
10545#
10546# The value for this option must be chosen from the choices listed
10547# here. Configuring a value other than these will default to 'none'.
10548#
10549# Possible values:
10550#
10551# * `all`: will download all images.
10552# * `some`: will only download images that have the image_property
10553# `bittorrent=true`.
10554# * `none`: will turnoff downloading images via Bit Torrent.
10555# (string value)
10556# Allowed values: all, some, none
10557#torrent_images=none
10558
10559#
10560# Name of network to use for booting iPXE ISOs.
10561#
10562# An iPXE ISO is a specially crafted ISO which supports iPXE booting.
10563# This feature gives a means to roll your own image.
10564#
10565# By default this option is not set. Enable this option to
10566# boot an iPXE ISO.
10567#
10568# Related Options:
10569#
10570# * `ipxe_boot_menu_url`
10571# * `ipxe_mkisofs_cmd`
10572# (string value)
10573#ipxe_network_name=<None>
10574
10575#
10576# URL to the iPXE boot menu.
10577#
10578# An iPXE ISO is a specially crafted ISO which supports iPXE booting.
10579# This feature gives a means to roll your own image.
10580#
10581# By default this option is not set. Enable this option to
10582# boot an iPXE ISO.
10583#
10584# Related Options:
10585#
10586# * `ipxe_network_name`
10587# * `ipxe_mkisofs_cmd`
10588# (string value)
10589#ipxe_boot_menu_url=<None>
10590
10591#
10592# Name and optionally path of the tool used for ISO image creation.
10593#
10594# An iPXE ISO is a specially crafted ISO which supports iPXE booting.
10595# This feature gives a means to roll your own image.
10596#
10597# Note: By default `mkisofs` is not present in the Dom0, so the
10598# package can either be manually added to Dom0 or include the
10599# `mkisofs` binary in the image itself.
10600#
10601# Related Options:
10602#
10603# * `ipxe_network_name`
10604# * `ipxe_boot_menu_url`
10605# (string value)
10606#ipxe_mkisofs_cmd=mkisofs
10607
10608#
10609# URL for connection to XenServer/Xen Cloud Platform. A special value
10610# of unix://local can be used to connect to the local unix socket.
10611#
10612# Possible values:
10613#
10614# * Any string that represents a URL. The connection_url is
10615# generally the management network IP address of the XenServer.
10616# * This option must be set if you chose the XenServer driver.
10617# (string value)
10618#connection_url=<None>
10619
10620# Username for connection to XenServer/Xen Cloud Platform (string value)
10621#connection_username=root
10622
10623# Password for connection to XenServer/Xen Cloud Platform (string value)
10624#connection_password=<None>
10625
10626#
10627# The interval used for polling of coalescing vhds.
10628#
10629# This is the interval after which the task of coalesce VHD is
10630# performed, until it reaches the max attempts that is set by
10631# vhd_coalesce_max_attempts.
10632#
10633# Related options:
10634#
10635# * `vhd_coalesce_max_attempts`
10636# (floating point value)
10637# Minimum value: 0
10638#vhd_coalesce_poll_interval=5.0
10639
10640#
10641# Ensure compute service is running on host XenAPI connects to.
10642# This option must be set to false if the 'independent_compute'
10643# option is set to true.
10644#
10645# Possible values:
10646#
10647# * Setting this option to true will make sure that compute service
10648# is running on the same host that is specified by connection_url.
10649# * Setting this option to false, doesn't perform the check.
10650#
10651# Related options:
10652#
10653# * `independent_compute`
10654# (boolean value)
10655#check_host=true
10656
10657#
10658# Max number of times to poll for VHD to coalesce.
10659#
10660# This option determines the maximum number of attempts that can be
10661# made for coalescing the VHD before giving up.
10662#
10663# Related opitons:
10664#
10665# * `vhd_coalesce_poll_interval`
10666# (integer value)
10667# Minimum value: 0
10668#vhd_coalesce_max_attempts=20
10669
10670# Base path to the storage repository on the XenServer host. (string value)
10671#sr_base_path=/var/run/sr-mount
10672
10673#
10674# The iSCSI Target Host.
10675#
10676# This option represents the hostname or ip of the iSCSI Target.
10677# If the target host is not present in the connection information from
10678# the volume provider then the value from this option is taken.
10679#
10680# Possible values:
10681#
10682# * Any string that represents hostname/ip of Target.
10683# (string value)
10684#target_host=<None>
10685
10686#
10687# The iSCSI Target Port.
10688#
10689# This option represents the port of the iSCSI Target. If the
10690# target port is not present in the connection information from the
10691# volume provider then the value from this option is taken.
10692# (port value)
10693# Minimum value: 0
10694# Maximum value: 65535
10695#target_port=3260
10696
10697# DEPRECATED:
10698# Used to enable the remapping of VBD dev.
10699# (Works around an issue in Ubuntu Maverick)
10700# (boolean value)
10701# This option is deprecated for removal since 15.0.0.
10702# Its value may be silently ignored in the future.
10703# Reason:
10704# This option provided a workaround for issues in Ubuntu Maverick, which
10705# was released in April 2010 and was dropped from support in April 2012.
10706# There's no reason to continue supporting this option.
10707#remap_vbd_dev=false
10708
10709#
10710# Specify prefix to remap VBD dev to (ex. /dev/xvdb -> /dev/sdb).
10711#
10712# Related options:
10713#
10714# * If `remap_vbd_dev` is set to False this option has no impact.
10715# (string value)
10716#remap_vbd_dev_prefix=sd
10717
10718#
10719# Used to prevent attempts to attach VBDs locally, so Nova can
10720# be run in a VM on a different host.
10721#
10722# Related options:
10723#
10724# * ``CONF.flat_injected`` (Must be False)
10725# * ``CONF.xenserver.check_host`` (Must be False)
10726# * ``CONF.default_ephemeral_format`` (Must be unset or 'ext3')
10727# * Joining host aggregates (will error if attempted)
10728# * Swap disks for Windows VMs (will error if attempted)
10729# * Nova-based auto_configure_disk (will error if attempted)
10730# (boolean value)
10731#independent_compute=false
10732
10733#
10734# Wait time for instances to go to running state.
10735#
10736# Provide an integer value representing time in seconds to set the
10737# wait time for an instance to go to running state.
10738#
10739# When a request to create an instance is received by nova-api and
10740# communicated to nova-compute, the creation of the instance occurs
10741# through interaction with Xen via XenAPI in the compute node. Once
10742# the node on which the instance(s) are to be launched is decided by
10743# nova-schedule and the launch is triggered, a certain amount of wait
10744# time is involved until the instance(s) can become available and
10745# 'running'. This wait time is defined by running_timeout. If the
10746# instances do not go to running state within this specified wait
10747# time, the launch expires and the instance(s) are set to 'error'
10748# state.
10749# (integer value)
10750# Minimum value: 0
10751#running_timeout=60
10752
10753# DEPRECATED:
10754# The XenAPI VIF driver using XenServer Network APIs.
10755#
10756# Provide a string value representing the VIF XenAPI vif driver to use for
10757# plugging virtual network interfaces.
10758#
10759# Xen configuration uses bridging within the backend domain to allow
10760# all VMs to appear on the network as individual hosts. Bridge
10761# interfaces are used to create a XenServer VLAN network in which
10762# the VIFs for the VM instances are plugged. If no VIF bridge driver
10763# is plugged, the bridge is not made available. This configuration
10764# option takes in a value for the VIF driver.
10765#
10766# Possible values:
10767#
10768# * nova.virt.xenapi.vif.XenAPIOpenVswitchDriver (default)
10769# * nova.virt.xenapi.vif.XenAPIBridgeDriver (deprecated)
10770#
10771# Related options:
10772#
10773# * ``vlan_interface``
10774# * ``ovs_integration_bridge``
10775# (string value)
10776# This option is deprecated for removal since 15.0.0.
10777# Its value may be silently ignored in the future.
10778# Reason:
10779# There are only two in-tree vif drivers for XenServer. XenAPIBridgeDriver is
10780# for
10781# nova-network which is deprecated and XenAPIOpenVswitchDriver is for Neutron
10782# which is the default configuration for Nova since the 15.0.0 Ocata release. In
10783# the future the "use_neutron" configuration option will be used to determine
10784# which vif driver to use.
10785#vif_driver=nova.virt.xenapi.vif.XenAPIOpenVswitchDriver
10786
10787#
10788# Dom0 plugin driver used to handle image uploads.
10789#
10790# Provide a string value representing a plugin driver required to
10791# handle the image uploading to GlanceStore.
10792#
10793# Images, and snapshots from XenServer need to be uploaded to the data
10794# store for use. image_upload_handler takes in a value for the Dom0
10795# plugin driver. This driver is then called to uplaod images to the
10796# GlanceStore.
10797# (string value)
10798#image_upload_handler=nova.virt.xenapi.image.glance.GlanceStore
10799
10800#
10801# Number of seconds to wait for SR to settle if the VDI
10802# does not exist when first introduced.
10803#
10804# Some SRs, particularly iSCSI connections are slow to see the VDIs
10805# right after they got introduced. Setting this option to a
10806# time interval will make the SR to wait for that time period
10807# before raising VDI not found exception.
10808# (integer value)
10809# Minimum value: 0
10810#introduce_vdi_retry_wait=20
10811
10812#
10813# The name of the integration Bridge that is used with xenapi
10814# when connecting with Open vSwitch.
10815#
10816# Note: The value of this config option is dependent on the
10817# environment, therefore this configuration value must be set
10818# accordingly if you are using XenAPI.
10819#
10820# Possible values:
10821#
10822# * Any string that represents a bridge name.
10823# (string value)
10824#ovs_integration_bridge=<None>
10825
10826#
10827# When adding new host to a pool, this will append a --force flag to the
10828# command, forcing hosts to join a pool, even if they have different CPUs.
10829#
10830# Since XenServer version 5.6 it is possible to create a pool of hosts that have
10831# different CPU capabilities. To accommodate CPU differences, XenServer limited
10832# features it uses to determine CPU compatibility to only the ones that are
10833# exposed by CPU and support for CPU masking was added.
10834# Despite this effort to level differences between CPUs, it is still possible
10835# that adding new host will fail, thus option to force join was introduced.
10836# (boolean value)
10837#use_join_force=true
10838
10839#
10840# Publicly visible name for this console host.
10841#
10842# Possible values:
10843#
10844# * A string representing a valid hostname
10845# (string value)
10846# Deprecated group/name - [DEFAULT]/console_public_hostname
10847#console_public_hostname=lcy01-22
10848
10849
10850[xvp]
10851#
10852# Configuration options for XVP.
10853#
10854# xvp (Xen VNC Proxy) is a proxy server providing password-protected VNC-based
10855# access to the consoles of virtual machines hosted on Citrix XenServer.
10856
10857#
10858# From nova.conf
10859#
10860
10861# XVP conf template (string value)
10862# Deprecated group/name - [DEFAULT]/console_xvp_conf_template
10863#console_xvp_conf_template=$pybasedir/nova/console/xvp.conf.template
10864
10865# Generated XVP conf file (string value)
10866# Deprecated group/name - [DEFAULT]/console_xvp_conf
10867#console_xvp_conf=/etc/xvp.conf
10868
10869# XVP master process pid file (string value)
10870# Deprecated group/name - [DEFAULT]/console_xvp_pid
10871#console_xvp_pid=/var/run/xvp.pid
10872
10873# XVP log file (string value)
10874# Deprecated group/name - [DEFAULT]/console_xvp_log
10875#console_xvp_log=/var/log/xvp.log
10876
10877# Port for XVP to multiplex VNC connections on (port value)
10878# Minimum value: 0
10879# Maximum value: 65535
10880# Deprecated group/name - [DEFAULT]/console_xvp_multiplex_port
10881#console_xvp_multiplex_port=5900