diff --git a/etc/glance-api.conf b/etc/glance-api.conf index 55b20b176b..e72bbc0064 100644 --- a/etc/glance-api.conf +++ b/etc/glance-api.conf @@ -508,7 +508,7 @@ # (string value) #worker_self_reference_url = -# +# DEPRECATED: # Strategy to determine the preference order of image locations. # # This configuration option indicates the strategy to determine @@ -535,6 +535,12 @@ # Possible values: # location_order - # store_type - +# This option is deprecated for removal since Caracal. +# Its value may be silently ignored in the future. +# Reason: +# In Bobcat, a new weighing mechanism has been introduced, which makes the +# location strategy obsolete. This option is scheduled to be removed during the +# Dalmatian development cycle. #location_strategy = location_order # @@ -778,7 +784,7 @@ # value) #pipe_handle = -# +# DEPRECATED: # The relative path to sqlite file database that will be used for image cache # management. # @@ -795,6 +801,12 @@ # * ``image_cache_dir`` # # (string value) +# This option is deprecated for removal since Caracal (2024.1). +# Its value may be silently ignored in the future. +# Reason: +# As centralized database will now be used for image cache management, the use +# of `sqlite` database and driver will be dropped from 'E' (2025.1) +# development cycle. #image_cache_sqlite_db = cache.db # @@ -813,13 +825,21 @@ # are ``sqlite`` and ``xattr``. These drivers primarily differ in the way they # store the information about cached images: # -# * The ``sqlite`` driver uses a sqlite database (which sits on every glance -# node locally) to track the usage of cached images. +# * The ``centralized_db`` driver uses a central database (which will be common +# for all glance nodes) to track the usage of cached images. +# * The ``sqlite`` (deprecated) driver uses a sqlite database (which sits on +# every glance node locally) to track the usage of cached images. # * The ``xattr`` driver uses the extended attributes of files to store this # information. It also requires a filesystem that sets ``atime`` on the files # when accessed. # +# Deprecation warning: +# * As centralized database will now be used for image cache management, the +# use of `sqlite` database and driver will be dropped from 'E' (2025.1) +# development cycle. +# # Possible values: +# * centralized_db # * sqlite # * xattr # @@ -828,9 +848,10 @@ # # (string value) # Possible values: +# centralized_db - # sqlite - # xattr - -#image_cache_driver = sqlite +#image_cache_driver = centralized_db # # The upper limit on cache size, in bytes, after which the cache-pruner cleans @@ -967,7 +988,7 @@ # (list value) #disabled_notifications = -# +# DEPRECATED: # The amount of time, in seconds, to delay image scrubbing. # # When delayed delete is turned on, an image is put into ``pending_delete`` @@ -989,9 +1010,13 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #scrub_time = 0 -# +# DEPRECATED: # The size of thread pool to be used for scrubbing images. # # When there are a large number of images to scrub, it is beneficial to scrub @@ -1009,9 +1034,13 @@ # # (integer value) # Minimum value: 1 +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #scrub_pool_size = 1 -# +# DEPRECATED: # Turn on/off delayed delete. # # Typically when an image is deleted, the ``glance-api`` service puts the image @@ -1039,6 +1068,10 @@ # * ``scrub_pool_size`` # # (boolean value) +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #delayed_delete = false # @@ -1106,7 +1139,10 @@ # set. (boolean value) #use_stderr = false -# Log output to Windows Event Log. (boolean value) +# DEPRECATED: Log output to Windows Event Log. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Windows support is no longer maintained. #use_eventlog = false # The amount of time before the log files are rotated. This option is ignored @@ -1763,14 +1799,6 @@ # value) #mysql_wsrep_sync_wait = -# DEPRECATED: If True, transparently enables support for handling MySQL Cluster -# (NDB). (boolean value) -# This option is deprecated for removal since 12.1.0. -# Its value may be silently ignored in the future. -# Reason: Support for the MySQL NDB Cluster storage engine has been deprecated -# and will be removed in a future release. -#mysql_enable_ndb = false - # Connections which have been present in the connection pool longer than this # number of seconds will be replaced with a new one the next time they are # checked out from the pool. (integer value) @@ -2151,15 +2179,15 @@ # (string value) #rbd_store_ceph_conf = -# DEPRECATED: +# # Timeout value for connecting to Ceph cluster. # # This configuration option takes in the timeout value in seconds used # when connecting to the Ceph cluster i.e. it sets the time to wait for # glance-api before closing the connection. This prevents glance-api # hangups during the connection to RBD. If the value for this option -# is set to less than or equal to 0, no timeout is set and the default -# librados value is used. +# is set to less than 0, no timeout is set and the default librados value +# is used. # # Possible Values: # * Any integer value @@ -2168,14 +2196,7 @@ # * None # # (integer value) -# This option is deprecated for removal since Zed. -# Its value may be silently ignored in the future. -# Reason: -# This option has not had any effect in years. Users willing to set a timeout -# for -# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's -# configuration file. -#rados_connect_timeout = 0 +#rados_connect_timeout = -1 # # Enable or not thin provisioning in this backend. @@ -3911,15 +3932,15 @@ # (string value) #rbd_store_ceph_conf = -# DEPRECATED: +# # Timeout value for connecting to Ceph cluster. # # This configuration option takes in the timeout value in seconds used # when connecting to the Ceph cluster i.e. it sets the time to wait for # glance-api before closing the connection. This prevents glance-api # hangups during the connection to RBD. If the value for this option -# is set to less than or equal to 0, no timeout is set and the default -# librados value is used. +# is set to less than 0, no timeout is set and the default librados value +# is used. # # Possible Values: # * Any integer value @@ -3928,14 +3949,7 @@ # * None # # (integer value) -# This option is deprecated for removal since Zed. -# Its value may be silently ignored in the future. -# Reason: -# This option has not had any effect in years. Users willing to set a timeout -# for -# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's -# configuration file. -#rados_connect_timeout = 0 +#rados_connect_timeout = -1 # # Enable or not thin provisioning in this backend. @@ -4899,6 +4913,14 @@ # back as part of a request. (list value) #backends = +# A list of network addresses to limit source ip allowed to access healthcheck +# information. Any request from ip outside of these network addresses are +# ignored. (list value) +#allowed_source_ranges = + +# Ignore requests with proxy headers. (boolean value) +#ignore_proxied_requests = false + # Check the presence of a file to determine if an application is running on a # port. Used by DisableByFileHealthcheck plugin. (string value) #disable_by_file_path = @@ -5340,6 +5362,10 @@ # used. (floating point value) #status_code_retry_delay = +# List of retriable HTTP status codes that should be retried. If not set default +# to [503] (list value) +#retriable_status_codes = + [oslo_messaging_amqp] @@ -5769,8 +5795,11 @@ # Positive integer representing duration in seconds for queue TTL (x-expires). # Queues which are unused for the duration of the TTL are automatically deleted. -# The parameter affects only reply and fanout queues. (integer value) -# Minimum value: 1 +# The parameter affects only reply and fanout queues. Setting 0 as value will +# disable the x-expires. If doing so, make sure you have a rabbitmq policy to +# delete the queues or you deployment will create an infinite number of queue +# over time. (integer value) +# Minimum value: 0 #rabbit_transient_queues_ttl = 1800 # Specifies the number of messages to prefetch. Setting to zero allows unlimited @@ -5783,7 +5812,7 @@ # How often times during the heartbeat_timeout_threshold we check the heartbeat. # (integer value) -#heartbeat_rate = 2 +#heartbeat_rate = 3 # DEPRECATED: (DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct # send. The direct send is used as reply, so the MessageUndeliverable exception @@ -6093,7 +6122,7 @@ # From glance.api # -# +# DEPRECATED: # Preference order of storage backends. # # Provide a comma separated list of store names in the order in @@ -6121,6 +6150,12 @@ # * stores # # (list value) +# This option is deprecated for removal since Caracal. +# Its value may be silently ignored in the future. +# Reason: +# In Bobcat, a new weighing mechanism has been introduced, which makes the +# location strategy obsolete. This option is scheduled to be removed during the +# Dalmatian development cycle. #store_type_preference = @@ -6300,6 +6335,9 @@ # Mountpoint of KV store in Vault to use, for example: secret (string value) #kv_mountpoint = secret +# Path relative to root of KV store in Vault to use. (string value) +#kv_path = + # Version of KV store in Vault to use, for example: 2 (integer value) #kv_version = 2 diff --git a/etc/glance-cache.conf b/etc/glance-cache.conf index 765efde7f3..93f53b6f43 100644 --- a/etc/glance-cache.conf +++ b/etc/glance-cache.conf @@ -450,7 +450,7 @@ # (string value) #worker_self_reference_url = -# +# DEPRECATED: # The relative path to sqlite file database that will be used for image cache # management. # @@ -467,6 +467,12 @@ # * ``image_cache_dir`` # # (string value) +# This option is deprecated for removal since Caracal (2024.1). +# Its value may be silently ignored in the future. +# Reason: +# As centralized database will now be used for image cache management, the use +# of `sqlite` database and driver will be dropped from 'E' (2025.1) +# development cycle. #image_cache_sqlite_db = cache.db # @@ -485,13 +491,21 @@ # are ``sqlite`` and ``xattr``. These drivers primarily differ in the way they # store the information about cached images: # -# * The ``sqlite`` driver uses a sqlite database (which sits on every glance -# node locally) to track the usage of cached images. +# * The ``centralized_db`` driver uses a central database (which will be common +# for all glance nodes) to track the usage of cached images. +# * The ``sqlite`` (deprecated) driver uses a sqlite database (which sits on +# every glance node locally) to track the usage of cached images. # * The ``xattr`` driver uses the extended attributes of files to store this # information. It also requires a filesystem that sets ``atime`` on the files # when accessed. # +# Deprecation warning: +# * As centralized database will now be used for image cache management, the +# use of `sqlite` database and driver will be dropped from 'E' (2025.1) +# development cycle. +# # Possible values: +# * centralized_db # * sqlite # * xattr # @@ -500,9 +514,10 @@ # # (string value) # Possible values: +# centralized_db - # sqlite - # xattr - -#image_cache_driver = sqlite +#image_cache_driver = centralized_db # # The upper limit on cache size, in bytes, after which the cache-pruner cleans @@ -655,7 +670,10 @@ # set. (boolean value) #use_stderr = false -# Log output to Windows Event Log. (boolean value) +# DEPRECATED: Log output to Windows Event Log. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Windows support is no longer maintained. #use_eventlog = false # The amount of time before the log files are rotated. This option is ignored @@ -1486,15 +1504,15 @@ # (string value) #rbd_store_ceph_conf = -# DEPRECATED: +# # Timeout value for connecting to Ceph cluster. # # This configuration option takes in the timeout value in seconds used # when connecting to the Ceph cluster i.e. it sets the time to wait for # glance-api before closing the connection. This prevents glance-api # hangups during the connection to RBD. If the value for this option -# is set to less than or equal to 0, no timeout is set and the default -# librados value is used. +# is set to less than 0, no timeout is set and the default librados value +# is used. # # Possible Values: # * Any integer value @@ -1503,14 +1521,7 @@ # * None # # (integer value) -# This option is deprecated for removal since Zed. -# Its value may be silently ignored in the future. -# Reason: -# This option has not had any effect in years. Users willing to set a timeout -# for -# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's -# configuration file. -#rados_connect_timeout = 0 +#rados_connect_timeout = -1 # # Enable or not thin provisioning in this backend. diff --git a/etc/glance-manage.conf b/etc/glance-manage.conf index 33fc33be50..8f6d02066f 100644 --- a/etc/glance-manage.conf +++ b/etc/glance-manage.conf @@ -65,7 +65,10 @@ # set. (boolean value) #use_stderr = false -# Log output to Windows Event Log. (boolean value) +# DEPRECATED: Log output to Windows Event Log. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Windows support is no longer maintained. #use_eventlog = false # The amount of time before the log files are rotated. This option is ignored @@ -183,14 +186,6 @@ # value) #mysql_wsrep_sync_wait = -# DEPRECATED: If True, transparently enables support for handling MySQL Cluster -# (NDB). (boolean value) -# This option is deprecated for removal since 12.1.0. -# Its value may be silently ignored in the future. -# Reason: Support for the MySQL NDB Cluster storage engine has been deprecated -# and will be removed in a future release. -#mysql_enable_ndb = false - # Connections which have been present in the connection pool longer than this # number of seconds will be replaced with a new one the next time they are # checked out from the pool. (integer value) diff --git a/etc/glance-scrubber.conf b/etc/glance-scrubber.conf index 9ea18511ca..f78cc99528 100644 --- a/etc/glance-scrubber.conf +++ b/etc/glance-scrubber.conf @@ -450,7 +450,7 @@ # (string value) #worker_self_reference_url = -# +# DEPRECATED: # The amount of time, in seconds, to delay image scrubbing. # # When delayed delete is turned on, an image is put into ``pending_delete`` @@ -472,9 +472,13 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #scrub_time = 0 -# +# DEPRECATED: # The size of thread pool to be used for scrubbing images. # # When there are a large number of images to scrub, it is beneficial to scrub @@ -492,9 +496,13 @@ # # (integer value) # Minimum value: 1 +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #scrub_pool_size = 1 -# +# DEPRECATED: # Turn on/off delayed delete. # # Typically when an image is deleted, the ``glance-api`` service puts the image @@ -522,9 +530,13 @@ # * ``scrub_pool_size`` # # (boolean value) +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #delayed_delete = false -# +# DEPRECATED: # Time interval, in seconds, between scrubber runs in daemon mode. # # Scrubber can be run either as a cron job or daemon. When run as a daemon, this @@ -545,9 +557,13 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #wakeup_time = 300 -# +# DEPRECATED: # Run scrubber as a daemon. # # This boolean configuration option indicates whether scrubber should @@ -568,9 +584,13 @@ # * ``wakeup_time`` # # (boolean value) +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #daemon = false -# +# DEPRECATED: # Restore the image status from 'pending_delete' to 'active'. # # This option is used by administrator to reset the image's status from @@ -583,6 +603,10 @@ # * image's uuid # # (string value) +# This option is deprecated for removal since 2024.1 (Caracal). +# Its value may be silently ignored in the future. +# Reason: The entire glance scrubber, including this option, is scheduled to be +# removed during the 2024.2 (Dalmatian) development cycle. #restore = # @@ -650,7 +674,10 @@ # set. (boolean value) #use_stderr = false -# Log output to Windows Event Log. (boolean value) +# DEPRECATED: Log output to Windows Event Log. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: Windows support is no longer maintained. #use_eventlog = false # The amount of time before the log files are rotated. This option is ignored @@ -768,14 +795,6 @@ # value) #mysql_wsrep_sync_wait = -# DEPRECATED: If True, transparently enables support for handling MySQL Cluster -# (NDB). (boolean value) -# This option is deprecated for removal since 12.1.0. -# Its value may be silently ignored in the future. -# Reason: Support for the MySQL NDB Cluster storage engine has been deprecated -# and will be removed in a future release. -#mysql_enable_ndb = false - # Connections which have been present in the connection pool longer than this # number of seconds will be replaced with a new one the next time they are # checked out from the pool. (integer value) @@ -1588,15 +1607,15 @@ # (string value) #rbd_store_ceph_conf = -# DEPRECATED: +# # Timeout value for connecting to Ceph cluster. # # This configuration option takes in the timeout value in seconds used # when connecting to the Ceph cluster i.e. it sets the time to wait for # glance-api before closing the connection. This prevents glance-api # hangups during the connection to RBD. If the value for this option -# is set to less than or equal to 0, no timeout is set and the default -# librados value is used. +# is set to less than 0, no timeout is set and the default librados value +# is used. # # Possible Values: # * Any integer value @@ -1605,14 +1624,7 @@ # * None # # (integer value) -# This option is deprecated for removal since Zed. -# Its value may be silently ignored in the future. -# Reason: -# This option has not had any effect in years. Users willing to set a timeout -# for -# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's -# configuration file. -#rados_connect_timeout = 0 +#rados_connect_timeout = -1 # # Enable or not thin provisioning in this backend.