Skip to content

Commit 752aab7

Browse files
committed
Refresh Glance example configs for caracal m3
Change-Id: I7490eeaa7352d38fba95c40bbb17bd970887be8b
1 parent 4bfd932 commit 752aab7

File tree

4 files changed

+150
-94
lines changed

4 files changed

+150
-94
lines changed

etc/glance-api.conf

Lines changed: 81 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@
508508
# (string value)
509509
#worker_self_reference_url = <None>
510510

511-
#
511+
# DEPRECATED:
512512
# Strategy to determine the preference order of image locations.
513513
#
514514
# This configuration option indicates the strategy to determine
@@ -535,6 +535,12 @@
535535
# Possible values:
536536
# location_order - <No description provided>
537537
# store_type - <No description provided>
538+
# This option is deprecated for removal since Caracal.
539+
# Its value may be silently ignored in the future.
540+
# Reason:
541+
# In Bobcat, a new weighing mechanism has been introduced, which makes the
542+
# location strategy obsolete. This option is scheduled to be removed during the
543+
# Dalmatian development cycle.
538544
#location_strategy = location_order
539545

540546
#
@@ -778,7 +784,7 @@
778784
# value)
779785
#pipe_handle = <None>
780786

781-
#
787+
# DEPRECATED:
782788
# The relative path to sqlite file database that will be used for image cache
783789
# management.
784790
#
@@ -795,6 +801,12 @@
795801
# * ``image_cache_dir``
796802
#
797803
# (string value)
804+
# This option is deprecated for removal since Caracal (2024.1).
805+
# Its value may be silently ignored in the future.
806+
# Reason:
807+
# As centralized database will now be used for image cache management, the use
808+
# of `sqlite` database and driver will be dropped from 'E' (2025.1)
809+
# development cycle.
798810
#image_cache_sqlite_db = cache.db
799811

800812
#
@@ -813,13 +825,21 @@
813825
# are ``sqlite`` and ``xattr``. These drivers primarily differ in the way they
814826
# store the information about cached images:
815827
#
816-
# * The ``sqlite`` driver uses a sqlite database (which sits on every glance
817-
# node locally) to track the usage of cached images.
828+
# * The ``centralized_db`` driver uses a central database (which will be common
829+
# for all glance nodes) to track the usage of cached images.
830+
# * The ``sqlite`` (deprecated) driver uses a sqlite database (which sits on
831+
# every glance node locally) to track the usage of cached images.
818832
# * The ``xattr`` driver uses the extended attributes of files to store this
819833
# information. It also requires a filesystem that sets ``atime`` on the files
820834
# when accessed.
821835
#
836+
# Deprecation warning:
837+
# * As centralized database will now be used for image cache management, the
838+
# use of `sqlite` database and driver will be dropped from 'E' (2025.1)
839+
# development cycle.
840+
#
822841
# Possible values:
842+
# * centralized_db
823843
# * sqlite
824844
# * xattr
825845
#
@@ -828,9 +848,10 @@
828848
#
829849
# (string value)
830850
# Possible values:
851+
# centralized_db - <No description provided>
831852
# sqlite - <No description provided>
832853
# xattr - <No description provided>
833-
#image_cache_driver = sqlite
854+
#image_cache_driver = centralized_db
834855

835856
#
836857
# The upper limit on cache size, in bytes, after which the cache-pruner cleans
@@ -967,7 +988,7 @@
967988
# (list value)
968989
#disabled_notifications =
969990

970-
#
991+
# DEPRECATED:
971992
# The amount of time, in seconds, to delay image scrubbing.
972993
#
973994
# When delayed delete is turned on, an image is put into ``pending_delete``
@@ -989,9 +1010,13 @@
9891010
#
9901011
# (integer value)
9911012
# Minimum value: 0
1013+
# This option is deprecated for removal since 2024.1 (Caracal).
1014+
# Its value may be silently ignored in the future.
1015+
# Reason: The entire glance scrubber, including this option, is scheduled to be
1016+
# removed during the 2024.2 (Dalmatian) development cycle.
9921017
#scrub_time = 0
9931018

994-
#
1019+
# DEPRECATED:
9951020
# The size of thread pool to be used for scrubbing images.
9961021
#
9971022
# When there are a large number of images to scrub, it is beneficial to scrub
@@ -1009,9 +1034,13 @@
10091034
#
10101035
# (integer value)
10111036
# Minimum value: 1
1037+
# This option is deprecated for removal since 2024.1 (Caracal).
1038+
# Its value may be silently ignored in the future.
1039+
# Reason: The entire glance scrubber, including this option, is scheduled to be
1040+
# removed during the 2024.2 (Dalmatian) development cycle.
10121041
#scrub_pool_size = 1
10131042

1014-
#
1043+
# DEPRECATED:
10151044
# Turn on/off delayed delete.
10161045
#
10171046
# Typically when an image is deleted, the ``glance-api`` service puts the image
@@ -1039,6 +1068,10 @@
10391068
# * ``scrub_pool_size``
10401069
#
10411070
# (boolean value)
1071+
# This option is deprecated for removal since 2024.1 (Caracal).
1072+
# Its value may be silently ignored in the future.
1073+
# Reason: The entire glance scrubber, including this option, is scheduled to be
1074+
# removed during the 2024.2 (Dalmatian) development cycle.
10421075
#delayed_delete = false
10431076

10441077
#
@@ -1106,7 +1139,10 @@
11061139
# set. (boolean value)
11071140
#use_stderr = false
11081141

1109-
# Log output to Windows Event Log. (boolean value)
1142+
# DEPRECATED: Log output to Windows Event Log. (boolean value)
1143+
# This option is deprecated for removal.
1144+
# Its value may be silently ignored in the future.
1145+
# Reason: Windows support is no longer maintained.
11101146
#use_eventlog = false
11111147

11121148
# The amount of time before the log files are rotated. This option is ignored
@@ -1763,14 +1799,6 @@
17631799
# value)
17641800
#mysql_wsrep_sync_wait = <None>
17651801

1766-
# DEPRECATED: If True, transparently enables support for handling MySQL Cluster
1767-
# (NDB). (boolean value)
1768-
# This option is deprecated for removal since 12.1.0.
1769-
# Its value may be silently ignored in the future.
1770-
# Reason: Support for the MySQL NDB Cluster storage engine has been deprecated
1771-
# and will be removed in a future release.
1772-
#mysql_enable_ndb = false
1773-
17741802
# Connections which have been present in the connection pool longer than this
17751803
# number of seconds will be replaced with a new one the next time they are
17761804
# checked out from the pool. (integer value)
@@ -2151,15 +2179,15 @@
21512179
# (string value)
21522180
#rbd_store_ceph_conf =
21532181

2154-
# DEPRECATED:
2182+
#
21552183
# Timeout value for connecting to Ceph cluster.
21562184
#
21572185
# This configuration option takes in the timeout value in seconds used
21582186
# when connecting to the Ceph cluster i.e. it sets the time to wait for
21592187
# glance-api before closing the connection. This prevents glance-api
21602188
# hangups during the connection to RBD. If the value for this option
2161-
# is set to less than or equal to 0, no timeout is set and the default
2162-
# librados value is used.
2189+
# is set to less than 0, no timeout is set and the default librados value
2190+
# is used.
21632191
#
21642192
# Possible Values:
21652193
# * Any integer value
@@ -2168,14 +2196,7 @@
21682196
# * None
21692197
#
21702198
# (integer value)
2171-
# This option is deprecated for removal since Zed.
2172-
# Its value may be silently ignored in the future.
2173-
# Reason:
2174-
# This option has not had any effect in years. Users willing to set a timeout
2175-
# for
2176-
# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's
2177-
# configuration file.
2178-
#rados_connect_timeout = 0
2199+
#rados_connect_timeout = -1
21792200

21802201
#
21812202
# Enable or not thin provisioning in this backend.
@@ -3911,15 +3932,15 @@
39113932
# (string value)
39123933
#rbd_store_ceph_conf =
39133934

3914-
# DEPRECATED:
3935+
#
39153936
# Timeout value for connecting to Ceph cluster.
39163937
#
39173938
# This configuration option takes in the timeout value in seconds used
39183939
# when connecting to the Ceph cluster i.e. it sets the time to wait for
39193940
# glance-api before closing the connection. This prevents glance-api
39203941
# hangups during the connection to RBD. If the value for this option
3921-
# is set to less than or equal to 0, no timeout is set and the default
3922-
# librados value is used.
3942+
# is set to less than 0, no timeout is set and the default librados value
3943+
# is used.
39233944
#
39243945
# Possible Values:
39253946
# * Any integer value
@@ -3928,14 +3949,7 @@
39283949
# * None
39293950
#
39303951
# (integer value)
3931-
# This option is deprecated for removal since Zed.
3932-
# Its value may be silently ignored in the future.
3933-
# Reason:
3934-
# This option has not had any effect in years. Users willing to set a timeout
3935-
# for
3936-
# connecting to the Ceph cluster should use 'client_mount_timeout' in Ceph's
3937-
# configuration file.
3938-
#rados_connect_timeout = 0
3952+
#rados_connect_timeout = -1
39393953

39403954
#
39413955
# Enable or not thin provisioning in this backend.
@@ -4899,6 +4913,14 @@
48994913
# back as part of a request. (list value)
49004914
#backends =
49014915

4916+
# A list of network addresses to limit source ip allowed to access healthcheck
4917+
# information. Any request from ip outside of these network addresses are
4918+
# ignored. (list value)
4919+
#allowed_source_ranges =
4920+
4921+
# Ignore requests with proxy headers. (boolean value)
4922+
#ignore_proxied_requests = false
4923+
49024924
# Check the presence of a file to determine if an application is running on a
49034925
# port. Used by DisableByFileHealthcheck plugin. (string value)
49044926
#disable_by_file_path = <None>
@@ -5340,6 +5362,10 @@
53405362
# used. (floating point value)
53415363
#status_code_retry_delay = <None>
53425364

5365+
# List of retriable HTTP status codes that should be retried. If not set default
5366+
# to [503] (list value)
5367+
#retriable_status_codes = <None>
5368+
53435369

53445370
[oslo_messaging_amqp]
53455371

@@ -5769,8 +5795,11 @@
57695795

57705796
# Positive integer representing duration in seconds for queue TTL (x-expires).
57715797
# Queues which are unused for the duration of the TTL are automatically deleted.
5772-
# The parameter affects only reply and fanout queues. (integer value)
5773-
# Minimum value: 1
5798+
# The parameter affects only reply and fanout queues. Setting 0 as value will
5799+
# disable the x-expires. If doing so, make sure you have a rabbitmq policy to
5800+
# delete the queues or you deployment will create an infinite number of queue
5801+
# over time. (integer value)
5802+
# Minimum value: 0
57745803
#rabbit_transient_queues_ttl = 1800
57755804

57765805
# Specifies the number of messages to prefetch. Setting to zero allows unlimited
@@ -5783,7 +5812,7 @@
57835812

57845813
# How often times during the heartbeat_timeout_threshold we check the heartbeat.
57855814
# (integer value)
5786-
#heartbeat_rate = 2
5815+
#heartbeat_rate = 3
57875816

57885817
# DEPRECATED: (DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct
57895818
# send. The direct send is used as reply, so the MessageUndeliverable exception
@@ -6093,7 +6122,7 @@
60936122
# From glance.api
60946123
#
60956124

6096-
#
6125+
# DEPRECATED:
60976126
# Preference order of storage backends.
60986127
#
60996128
# Provide a comma separated list of store names in the order in
@@ -6121,6 +6150,12 @@
61216150
# * stores
61226151
#
61236152
# (list value)
6153+
# This option is deprecated for removal since Caracal.
6154+
# Its value may be silently ignored in the future.
6155+
# Reason:
6156+
# In Bobcat, a new weighing mechanism has been introduced, which makes the
6157+
# location strategy obsolete. This option is scheduled to be removed during the
6158+
# Dalmatian development cycle.
61246159
#store_type_preference =
61256160

61266161

@@ -6300,6 +6335,9 @@
63006335
# Mountpoint of KV store in Vault to use, for example: secret (string value)
63016336
#kv_mountpoint = secret
63026337

6338+
# Path relative to root of KV store in Vault to use. (string value)
6339+
#kv_path = <None>
6340+
63036341
# Version of KV store in Vault to use, for example: 2 (integer value)
63046342
#kv_version = 2
63056343

0 commit comments

Comments
 (0)