From acb8ed5b3f5125b32569cc0a7a18c56da368c1fc Mon Sep 17 00:00:00 2001 From: Pranali Deore Date: Mon, 26 Aug 2024 05:24:22 +0000 Subject: [PATCH] Refresh Glance example configs for dalmatian m3 Change-Id: Ic839b415637128dbba0dc11bf0ffa51a692b7a28 --- etc/glance-api.conf | 173 ++++++++++++++++----------------------- etc/glance-cache.conf | 70 ++++++++++++---- etc/glance-manage.conf | 27 ++++-- etc/glance-scrubber.conf | 70 ++++++++++++---- 4 files changed, 205 insertions(+), 135 deletions(-) diff --git a/etc/glance-api.conf b/etc/glance-api.conf index acea487401..901cafe34a 100644 --- a/etc/glance-api.conf +++ b/etc/glance-api.conf @@ -200,8 +200,8 @@ # image location is shown under the image property ``direct_url``. # # When multiple image locations exist for an image, the best location -# is displayed based on the location strategy indicated by the -# configuration option ``location_strategy``. +# is displayed based on the store weightage assigned for each store +# indicated by the configuration option ``weight``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -218,7 +218,7 @@ # # Related options: # * show_multiple_locations -# * location_strategy +# * weight # # (boolean value) #show_image_direct_url = false @@ -229,9 +229,9 @@ # This configuration option indicates whether to show all the image # locations when returning image details to the user. When multiple # image locations exist for an image, the locations are ordered based -# on the location strategy indicated by the configuration opt -# ``location_strategy``. The image locations are shown under the -# image property ``locations``. +# on the store weightage assigned for each store indicated by the +# configuration option ``weight``. The image locations are shown +# under the image property ``locations``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -250,7 +250,7 @@ # # Related options: # * show_image_direct_url -# * location_strategy +# * weight # # (boolean value) # This option is deprecated for removal since Newton. @@ -265,6 +265,24 @@ # issue. #show_multiple_locations = false +# +# Calculate hash and checksum for the image. +# +# This configuration option indicates that /v2/images/{image_id}/locations +# POST API will calculate hash and checksum of the image on the fly. +# If False it will silently ignore the hash and checksum calculation. +# +# Possible values: +# * True +# * False +# (boolean value) +#do_secure_hash = true + +# +# The number of times to retry when any operation fails. +# (integer value) +#http_retries = 3 + # # Maximum size of image a user can upload in bytes. # @@ -371,7 +389,7 @@ # Maximum value: 65535 #pydev_worker_debug_port = 5678 -# +# DEPRECATED: # AES key for encrypting store location metadata. # # Provide a string value representing the AES cipher to use for @@ -387,6 +405,15 @@ # * None # # (string value) +# This option is deprecated for removal since Dalmatian. +# Its value may be silently ignored in the future. +# Reason: +# This option doesnt serves the purpose of encryption of location metadata, +# whereas it encrypts location url only for specific APIs. Also if enabled +# this during an upgrade may disrupt existing deployments, as it does not +# support/provide db upgrade script to encrypt existing location URLs. +# Moreover, its functionality for encrypting location URLs is inconsistent +# which is resulting in download failures. #metadata_encryption_key = # DEPRECATED: @@ -476,41 +503,6 @@ # (string value) #worker_self_reference_url = -# DEPRECATED: -# Strategy to determine the preference order of image locations. -# -# This configuration option indicates the strategy to determine -# the order in which an image's locations must be accessed to -# serve the image's data. Glance then retrieves the image data -# from the first responsive active location it finds in this list. -# -# This option takes one of two possible values ``location_order`` -# and ``store_type``. The default value is ``location_order``, -# which suggests that image data be served by using locations in -# the order they are stored in Glance. The ``store_type`` value -# sets the image location preference based on the order in which -# the storage backends are listed as a comma separated list for -# the configuration option ``store_type_preference``. -# -# Possible values: -# * location_order -# * store_type -# -# Related options: -# * store_type_preference -# -# (string value) -# 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 - # # The location of the property protection file. # @@ -1077,11 +1069,15 @@ # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# Uses logging handler designed to watch file system. When log file is moved or -# removed this handler will open a new log file with specified path +# DEPRECATED: Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path # instantaneously. It makes sense only if log_file option is specified and Linux # platform is used. This option is ignored if log_config_append is set. (boolean # value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: This function is known to have bene broken for long time, and depends +# on the unmaintained library #watch_log_file = false # Use syslog for logging. Existing syslog format is DEPRECATED and will be @@ -1113,6 +1109,11 @@ # Reason: Windows support is no longer maintained. #use_eventlog = false +# (Optional) Set the 'color' key according to log levels. This option takes +# effect only when logging to stderr or stdout is used. This option is ignored +# if log_config_append is set. (boolean value) +#log_color = false + # The amount of time before the log files are rotated. This option is ignored # unless log_rotation_type is set to "interval". (integer value) #log_rotate_interval = 1 @@ -1183,10 +1184,16 @@ # Maximum number of logged messages per rate_limit_interval. (integer value) #rate_limit_burst = 0 -# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or -# empty string. Logs with level greater or equal to rate_limit_except_level are -# not filtered. An empty string means that all levels are filtered. (string -# value) +# Log level name used by rate limiting. Logs with level greater or equal to +# rate_limit_except_level are not filtered. An empty string means that all +# levels are filtered. (string value) +# Possible values: +# CRITICAL - +# ERROR - +# INFO - +# WARNING - +# DEBUG - +# '' - #rate_limit_except_level = CRITICAL # Enables or disables fatal status of deprecations. (boolean value) @@ -1270,8 +1277,7 @@ # is False, this is ignored. (string value) #verify_ssl_path = -# Specifies the type of endpoint. Allowed values are: public, private, and -# admin (string value) +# Specifies the type of endpoint. (string value) # Possible values: # public - # internal - @@ -5792,17 +5798,22 @@ # Should we use consistant queue names or random ones (boolean value) #use_queue_manager = false -# Hostname used by queue manager (string value) -#hostname = pranali-new-devstack +# Hostname used by queue manager. Defaults to the value returned by +# socket.gethostname(). (string value) +# +# This option has a sample default set, which means that +# its actual default value may vary from the one documented +# below. +#hostname = node1.example.com # Process name used by queue manager (string value) #processname = oslo-config-generator -# Use stream queues in RabbitMQ (x-queue-type: stream). The stream queue is a -# modern queue type for RabbitMQ implementing a durable, replicated FIFO queue -# based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. -# If set this option will replace all fanout queues with only one stream queue. -# (boolean value) +# Use stream queues in RabbitMQ (x-queue-type: stream). Streams are a new +# persistent and replicated data structure ("queue type") in RabbitMQ which +# models an append-only log with non-destructive consumer semantics. It is +# available as of RabbitMQ 3.9.0. If set this option will replace all fanout +# queues with only one stream queue. (boolean value) #rabbit_stream_fanout = false @@ -6092,49 +6103,6 @@ #filter_error_trace = false -[store_type_location_strategy] - -# -# From glance.api -# - -# DEPRECATED: -# Preference order of storage backends. -# -# Provide a comma separated list of store names in the order in -# which images should be retrieved from storage backends. -# These store names must be registered with the ``stores`` -# configuration option. -# -# NOTE: The ``store_type_preference`` configuration option is applied -# only if ``store_type`` is chosen as a value for the -# ``location_strategy`` configuration option. An empty list will not -# change the location order. -# -# Possible values: -# * Empty list -# * Comma separated list of registered store names. Legal values are: -# * file -# * http -# * rbd -# * swift -# * cinder -# * vmware -# -# Related options: -# * location_strategy -# * 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 = - - [task] # @@ -6331,6 +6299,9 @@ # available only in Vault Enterprise (string value) #namespace = +# Timeout (in seconds) in each request to Vault (floating point value) +#timeout = 60 + [wsgi] diff --git a/etc/glance-cache.conf b/etc/glance-cache.conf index 1ddcf5f917..e1214c43a8 100644 --- a/etc/glance-cache.conf +++ b/etc/glance-cache.conf @@ -142,8 +142,8 @@ # image location is shown under the image property ``direct_url``. # # When multiple image locations exist for an image, the best location -# is displayed based on the location strategy indicated by the -# configuration option ``location_strategy``. +# is displayed based on the store weightage assigned for each store +# indicated by the configuration option ``weight``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -160,7 +160,7 @@ # # Related options: # * show_multiple_locations -# * location_strategy +# * weight # # (boolean value) #show_image_direct_url = false @@ -171,9 +171,9 @@ # This configuration option indicates whether to show all the image # locations when returning image details to the user. When multiple # image locations exist for an image, the locations are ordered based -# on the location strategy indicated by the configuration opt -# ``location_strategy``. The image locations are shown under the -# image property ``locations``. +# on the store weightage assigned for each store indicated by the +# configuration option ``weight``. The image locations are shown +# under the image property ``locations``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -192,7 +192,7 @@ # # Related options: # * show_image_direct_url -# * location_strategy +# * weight # # (boolean value) # This option is deprecated for removal since Newton. @@ -207,6 +207,24 @@ # issue. #show_multiple_locations = false +# +# Calculate hash and checksum for the image. +# +# This configuration option indicates that /v2/images/{image_id}/locations +# POST API will calculate hash and checksum of the image on the fly. +# If False it will silently ignore the hash and checksum calculation. +# +# Possible values: +# * True +# * False +# (boolean value) +#do_secure_hash = true + +# +# The number of times to retry when any operation fails. +# (integer value) +#http_retries = 3 + # # Maximum size of image a user can upload in bytes. # @@ -313,7 +331,7 @@ # Maximum value: 65535 #pydev_worker_debug_port = 5678 -# +# DEPRECATED: # AES key for encrypting store location metadata. # # Provide a string value representing the AES cipher to use for @@ -329,6 +347,15 @@ # * None # # (string value) +# This option is deprecated for removal since Dalmatian. +# Its value may be silently ignored in the future. +# Reason: +# This option doesnt serves the purpose of encryption of location metadata, +# whereas it encrypts location url only for specific APIs. Also if enabled +# this during an upgrade may disrupt existing deployments, as it does not +# support/provide db upgrade script to encrypt existing location URLs. +# Moreover, its functionality for encrypting location URLs is inconsistent +# which is resulting in download failures. #metadata_encryption_key = # DEPRECATED: @@ -608,11 +635,15 @@ # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# Uses logging handler designed to watch file system. When log file is moved or -# removed this handler will open a new log file with specified path +# DEPRECATED: Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path # instantaneously. It makes sense only if log_file option is specified and Linux # platform is used. This option is ignored if log_config_append is set. (boolean # value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: This function is known to have bene broken for long time, and depends +# on the unmaintained library #watch_log_file = false # Use syslog for logging. Existing syslog format is DEPRECATED and will be @@ -644,6 +675,11 @@ # Reason: Windows support is no longer maintained. #use_eventlog = false +# (Optional) Set the 'color' key according to log levels. This option takes +# effect only when logging to stderr or stdout is used. This option is ignored +# if log_config_append is set. (boolean value) +#log_color = false + # The amount of time before the log files are rotated. This option is ignored # unless log_rotation_type is set to "interval". (integer value) #log_rotate_interval = 1 @@ -714,10 +750,16 @@ # Maximum number of logged messages per rate_limit_interval. (integer value) #rate_limit_burst = 0 -# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or -# empty string. Logs with level greater or equal to rate_limit_except_level are -# not filtered. An empty string means that all levels are filtered. (string -# value) +# Log level name used by rate limiting. Logs with level greater or equal to +# rate_limit_except_level are not filtered. An empty string means that all +# levels are filtered. (string value) +# Possible values: +# CRITICAL - +# ERROR - +# INFO - +# WARNING - +# DEBUG - +# '' - #rate_limit_except_level = CRITICAL # Enables or disables fatal status of deprecations. (boolean value) diff --git a/etc/glance-manage.conf b/etc/glance-manage.conf index bf10215f75..a6ad5e2f03 100644 --- a/etc/glance-manage.conf +++ b/etc/glance-manage.conf @@ -35,11 +35,15 @@ # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# Uses logging handler designed to watch file system. When log file is moved or -# removed this handler will open a new log file with specified path +# DEPRECATED: Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path # instantaneously. It makes sense only if log_file option is specified and Linux # platform is used. This option is ignored if log_config_append is set. (boolean # value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: This function is known to have bene broken for long time, and depends +# on the unmaintained library #watch_log_file = false # Use syslog for logging. Existing syslog format is DEPRECATED and will be @@ -71,6 +75,11 @@ # Reason: Windows support is no longer maintained. #use_eventlog = false +# (Optional) Set the 'color' key according to log levels. This option takes +# effect only when logging to stderr or stdout is used. This option is ignored +# if log_config_append is set. (boolean value) +#log_color = false + # The amount of time before the log files are rotated. This option is ignored # unless log_rotation_type is set to "interval". (integer value) #log_rotate_interval = 1 @@ -141,10 +150,16 @@ # Maximum number of logged messages per rate_limit_interval. (integer value) #rate_limit_burst = 0 -# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or -# empty string. Logs with level greater or equal to rate_limit_except_level are -# not filtered. An empty string means that all levels are filtered. (string -# value) +# Log level name used by rate limiting. Logs with level greater or equal to +# rate_limit_except_level are not filtered. An empty string means that all +# levels are filtered. (string value) +# Possible values: +# CRITICAL - +# ERROR - +# INFO - +# WARNING - +# DEBUG - +# '' - #rate_limit_except_level = CRITICAL # Enables or disables fatal status of deprecations. (boolean value) diff --git a/etc/glance-scrubber.conf b/etc/glance-scrubber.conf index 61f9a086e1..37383d0cd8 100644 --- a/etc/glance-scrubber.conf +++ b/etc/glance-scrubber.conf @@ -142,8 +142,8 @@ # image location is shown under the image property ``direct_url``. # # When multiple image locations exist for an image, the best location -# is displayed based on the location strategy indicated by the -# configuration option ``location_strategy``. +# is displayed based on the store weightage assigned for each store +# indicated by the configuration option ``weight``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -160,7 +160,7 @@ # # Related options: # * show_multiple_locations -# * location_strategy +# * weight # # (boolean value) #show_image_direct_url = false @@ -171,9 +171,9 @@ # This configuration option indicates whether to show all the image # locations when returning image details to the user. When multiple # image locations exist for an image, the locations are ordered based -# on the location strategy indicated by the configuration opt -# ``location_strategy``. The image locations are shown under the -# image property ``locations``. +# on the store weightage assigned for each store indicated by the +# configuration option ``weight``. The image locations are shown +# under the image property ``locations``. # # NOTES: # * Revealing image locations can present a GRAVE SECURITY RISK as @@ -192,7 +192,7 @@ # # Related options: # * show_image_direct_url -# * location_strategy +# * weight # # (boolean value) # This option is deprecated for removal since Newton. @@ -207,6 +207,24 @@ # issue. #show_multiple_locations = false +# +# Calculate hash and checksum for the image. +# +# This configuration option indicates that /v2/images/{image_id}/locations +# POST API will calculate hash and checksum of the image on the fly. +# If False it will silently ignore the hash and checksum calculation. +# +# Possible values: +# * True +# * False +# (boolean value) +#do_secure_hash = true + +# +# The number of times to retry when any operation fails. +# (integer value) +#http_retries = 3 + # # Maximum size of image a user can upload in bytes. # @@ -313,7 +331,7 @@ # Maximum value: 65535 #pydev_worker_debug_port = 5678 -# +# DEPRECATED: # AES key for encrypting store location metadata. # # Provide a string value representing the AES cipher to use for @@ -329,6 +347,15 @@ # * None # # (string value) +# This option is deprecated for removal since Dalmatian. +# Its value may be silently ignored in the future. +# Reason: +# This option doesnt serves the purpose of encryption of location metadata, +# whereas it encrypts location url only for specific APIs. Also if enabled +# this during an upgrade may disrupt existing deployments, as it does not +# support/provide db upgrade script to encrypt existing location URLs. +# Moreover, its functionality for encrypting location URLs is inconsistent +# which is resulting in download failures. #metadata_encryption_key = # DEPRECATED: @@ -612,11 +639,15 @@ # Deprecated group/name - [DEFAULT]/logdir #log_dir = -# Uses logging handler designed to watch file system. When log file is moved or -# removed this handler will open a new log file with specified path +# DEPRECATED: Uses logging handler designed to watch file system. When log file +# is moved or removed this handler will open a new log file with specified path # instantaneously. It makes sense only if log_file option is specified and Linux # platform is used. This option is ignored if log_config_append is set. (boolean # value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +# Reason: This function is known to have bene broken for long time, and depends +# on the unmaintained library #watch_log_file = false # Use syslog for logging. Existing syslog format is DEPRECATED and will be @@ -648,6 +679,11 @@ # Reason: Windows support is no longer maintained. #use_eventlog = false +# (Optional) Set the 'color' key according to log levels. This option takes +# effect only when logging to stderr or stdout is used. This option is ignored +# if log_config_append is set. (boolean value) +#log_color = false + # The amount of time before the log files are rotated. This option is ignored # unless log_rotation_type is set to "interval". (integer value) #log_rotate_interval = 1 @@ -718,10 +754,16 @@ # Maximum number of logged messages per rate_limit_interval. (integer value) #rate_limit_burst = 0 -# Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or -# empty string. Logs with level greater or equal to rate_limit_except_level are -# not filtered. An empty string means that all levels are filtered. (string -# value) +# Log level name used by rate limiting. Logs with level greater or equal to +# rate_limit_except_level are not filtered. An empty string means that all +# levels are filtered. (string value) +# Possible values: +# CRITICAL - +# ERROR - +# INFO - +# WARNING - +# DEBUG - +# '' - #rate_limit_except_level = CRITICAL # Enables or disables fatal status of deprecations. (boolean value)