From 87a59ae52bf411bc5380aacd14c439a1787db955 Mon Sep 17 00:00:00 2001 From: Erno Kuvaja Date: Tue, 7 Aug 2018 13:53:32 +0100 Subject: [PATCH] Sync Rocky example configs Change-Id: Ied1902018ded20b35bfa69200a1faee34fb3a4d6 --- etc/glance-api.conf | 190 +++++++++++++++------------- etc/glance-cache.conf | 144 +++++++++++---------- etc/glance-image-import.conf.sample | 5 +- etc/glance-registry.conf | 142 +++++++++------------ etc/glance-scrubber.conf | 144 +++++++++++---------- 5 files changed, 314 insertions(+), 311 deletions(-) diff --git a/etc/glance-api.conf b/etc/glance-api.conf index 578c20b908..5628e9843b 100644 --- a/etc/glance-api.conf +++ b/etc/glance-api.conf @@ -132,6 +132,40 @@ # (boolean value) #allow_additional_image_properties = true +# " +# Secure hashing algorithm used for computing the 'os_hash_value' property. +# +# This option configures the Glance "multihash", which consists of two +# image properties: the 'os_hash_algo' and the 'os_hash_value'. The +# 'os_hash_algo' will be populated by the value of this configuration +# option, and the 'os_hash_value' will be populated by the hexdigest computed +# when the algorithm is applied to the uploaded or imported image data. +# +# The value must be a valid secure hash algorithm name recognized by the +# python 'hashlib' library. You can determine what these are by examining +# the 'hashlib.algorithms_available' data member of the version of the +# library being used in your Glance installation. For interoperability +# purposes, however, we recommend that you use the set of secure hash +# names supplied by the 'hashlib.algorithms_guaranteed' data member because +# those algorithms are guaranteed to be supported by the 'hashlib' library +# on all platforms. Thus, any image consumer using 'hashlib' locally should +# be able to verify the 'os_hash_value' of the image. +# +# The default value of 'sha512' is a performant secure hash algorithm. +# +# If this option is misconfigured, any attempts to store image data will fail. +# For that reason, we recommend using the default value. +# +# Possible values: +# * Any secure hash algorithm name recognized by the Python 'hashlib' +# library +# +# Related options: +# * None +# +# (string value) +#hashing_algorithm = sha512 + # # Maximum number of image members per image. # @@ -393,40 +427,6 @@ # (string value) #user_storage_quota = 0 -# -# Deploy the v1 OpenStack Images API. -# -# When this option is set to ``True``, Glance service will respond to -# requests on registered endpoints conforming to the v1 OpenStack -# Images API. -# -# NOTES: -# * If this option is enabled, then ``enable_v1_registry`` must -# also be set to ``True`` to enable mandatory usage of Registry -# service with v1 API. -# -# * If this option is disabled, then the ``enable_v1_registry`` -# option, which is enabled by default, is also recommended -# to be disabled. -# -# * This option is separate from ``enable_v2_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v2 Images API, this option, which is -# enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_registry -# * enable_v2_api -# -# (boolean value) -#enable_v1_api = true - # # Deploy the v2 OpenStack Images API. # @@ -439,44 +439,18 @@ # option, which is enabled by default, is also recommended # to be disabled. # -# * This option is separate from ``enable_v1_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v1 Images API, this option, which is -# enabled by default, should be disabled. -# # Possible values: # * True # * False # # Related options: # * enable_v2_registry -# * enable_v1_api # # (boolean value) #enable_v2_api = true # -# Deploy the v1 API Registry service. -# -# When this option is set to ``True``, the Registry service -# will be enabled in Glance for v1 API requests. -# -# NOTES: -# * Use of Registry is mandatory in v1 API, so this option must -# be set to ``True`` if the ``enable_v1_api`` option is enabled. -# -# * If deploying only the v2 OpenStack Images API, this option, -# which is enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_api -# +# DEPRECATED FOR REMOVAL # (boolean value) #enable_v1_registry = true @@ -2035,7 +2009,7 @@ # From glance.store # -# +# DEPRECATED: # List of enabled Glance stores. # # Register the storage backends to use for storing disk images @@ -2056,9 +2030,18 @@ # * default_store # # (list value) +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``enabled_backends`` which helps to configure multiple backend stores +# of different schemes. +# +# This option is scheduled for removal in the Stein development +# cycle. #stores = file,http -# +# DEPRECATED: # The default scheme to use for storing images. # # Provide a string value representing the default scheme to use for @@ -2100,9 +2083,18 @@ # sheepdog - # cinder - # vsphere - +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``default_backend`` which acts similar to ``default_store`` config +# option. +# +# This option is scheduled for removal in the Stein development +# cycle. #default_store = file -# +# DEPRECATED: # Minimum interval in seconds to execute updating dynamic storage # capabilities based on current backend status. # @@ -2117,14 +2109,19 @@ # By default, this option is set to zero and is disabled. Provide an # integer value greater than zero to enable this option. # -# NOTE: For more information on store capabilities and their updates, +# NOTE 1: For more information on store capabilities and their updates, # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo # /store-capabilities.html # # For more information on setting up a particular store in your # deployment and help with the usage of this feature, please contact # the storage driver maintainers listed here: -# http://docs.openstack.org/developer/glance_store/drivers/index.html +# https://docs.openstack.org/glance_store/latest/user/drivers.html +# +# NOTE 2: The dynamic store update capability described above is not +# implemented by any current store drivers. Thus, this option DOES +# NOT DO ANYTHING (and it never has). It is DEPRECATED and scheduled +# for removal early in the Stein development cycle. # # Possible values: # * Zero @@ -2135,6 +2132,15 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option configures a stub method that has not been implemented +# for any existing store drivers. Hence it is non-operational, and +# giving it a value does absolutely nothing. +# +# This option is scheduled for removal early in the Stein development +# cycle. #store_capabilities_update_min_interval = 0 # @@ -2438,7 +2444,7 @@ # # More information on configuring filesystem store with multiple store # directories can be found at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # NOTE: This directory is used only when filesystem store is used as a # storage backend. Either ``filesystem_store_datadir`` or @@ -2489,7 +2495,7 @@ # digit. # # For more information, please refer the documentation at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # Possible values: # * A valid file access permission @@ -2909,7 +2915,7 @@ # this is 5GB. To upload objects bigger than this limit, objects are segmented # into multiple smaller objects that are tied together with a manifest file. # For more detail, refer to -# http://docs.openstack.org/developer/swift/overview_large_objects.html +# https://docs.openstack.org/swift/latest/overview_large_objects.html # # This configuration option specifies the size threshold over which the Swift # driver will start segmenting image data into multiple smaller files. @@ -4170,9 +4176,6 @@ # (integer value) #heartbeat_rate = 2 -# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value) -#fake_rabbit = false - [oslo_messaging_zmq] @@ -4449,37 +4452,38 @@ # # -# Enables the profiling for all services on this node. Default value is False -# (fully disable the profiling feature). +# Enable the profiling for all services on this node. +# +# Default value is False (fully disable the profiling feature). # # Possible values: # # * True: Enables the feature # * False: Disables the feature. The profiling cannot be started via this # project -# operations. If the profiling is triggered by another project, this project -# part -# will be empty. +# operations. If the profiling is triggered by another project, this project +# part will be empty. # (boolean value) # Deprecated group/name - [profiler]/profiler_enabled #enabled = false # -# Enables SQL requests profiling in services. Default value is False (SQL -# requests won't be traced). +# Enable SQL requests profiling in services. +# +# Default value is False (SQL requests won't be traced). # # Possible values: # # * True: Enables SQL requests profiling. Each SQL query will be part of the -# trace and can the be analyzed by how much time was spent for that. +# trace and can the be analyzed by how much time was spent for that. # * False: Disables SQL requests profiling. The spent time is only shown on a -# higher level of operations. Single SQL queries cannot be analyzed this -# way. +# higher level of operations. Single SQL queries cannot be analyzed this way. # (boolean value) #trace_sqlalchemy = false # # Secret key(s) to use for encrypting context data for performance profiling. +# # This string value should have the following format: [,,...], # where each key is some random string. A user who triggers the profiling via # the REST API has to set one of these keys in the headers of the REST API call @@ -4489,19 +4493,24 @@ # profiling. Also, to generate correct profiling information across all services # at least one key needs to be consistent between OpenStack projects. This # ensures it can be used from client side to generate the trace, containing -# information from all possible resources. (string value) +# information from all possible resources. +# (string value) #hmac_keys = SECRET_KEY # -# Connection string for a notifier backend. Default value is messaging:// which -# sets the notifier to oslo_messaging. +# Connection string for a notifier backend. +# +# Default value is ``messaging://`` which sets the notifier to oslo_messaging. # # Examples of possible values: # -# * messaging://: use oslo_messaging driver for sending notifications. -# * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications. -# * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending -# notifications. +# * ``messaging://`` - use oslo_messaging driver for sending spans. +# * ``redis://127.0.0.1:6379`` - use redis driver for sending spans. +# * ``mongodb://127.0.0.1:27017`` - use mongodb driver for sending spans. +# * ``elasticsearch://127.0.0.1:9200`` - use elasticsearch driver for sending +# spans. +# * ``jaeger://127.0.0.1:6831`` - use jaeger tracing as driver for sending +# spans. # (string value) #connection_string = messaging:// @@ -4532,12 +4541,13 @@ # # Redissentinel uses a service name to identify a master redis service. # This parameter defines the name (for example: -# sentinal_service_name=mymaster). +# ``sentinal_service_name=mymaster``). # (string value) #sentinel_service_name = mymaster # # Enable filter traces that contain error/exception to a separated place. +# # Default value is set to False. # # Possible values: diff --git a/etc/glance-cache.conf b/etc/glance-cache.conf index 07af0c002a..a823c0bcc7 100644 --- a/etc/glance-cache.conf +++ b/etc/glance-cache.conf @@ -28,6 +28,40 @@ # (boolean value) #allow_additional_image_properties = true +# " +# Secure hashing algorithm used for computing the 'os_hash_value' property. +# +# This option configures the Glance "multihash", which consists of two +# image properties: the 'os_hash_algo' and the 'os_hash_value'. The +# 'os_hash_algo' will be populated by the value of this configuration +# option, and the 'os_hash_value' will be populated by the hexdigest computed +# when the algorithm is applied to the uploaded or imported image data. +# +# The value must be a valid secure hash algorithm name recognized by the +# python 'hashlib' library. You can determine what these are by examining +# the 'hashlib.algorithms_available' data member of the version of the +# library being used in your Glance installation. For interoperability +# purposes, however, we recommend that you use the set of secure hash +# names supplied by the 'hashlib.algorithms_guaranteed' data member because +# those algorithms are guaranteed to be supported by the 'hashlib' library +# on all platforms. Thus, any image consumer using 'hashlib' locally should +# be able to verify the 'os_hash_value' of the image. +# +# The default value of 'sha512' is a performant secure hash algorithm. +# +# If this option is misconfigured, any attempts to store image data will fail. +# For that reason, we recommend using the default value. +# +# Possible values: +# * Any secure hash algorithm name recognized by the Python 'hashlib' +# library +# +# Related options: +# * None +# +# (string value) +#hashing_algorithm = sha512 + # # Maximum number of image members per image. # @@ -289,40 +323,6 @@ # (string value) #user_storage_quota = 0 -# -# Deploy the v1 OpenStack Images API. -# -# When this option is set to ``True``, Glance service will respond to -# requests on registered endpoints conforming to the v1 OpenStack -# Images API. -# -# NOTES: -# * If this option is enabled, then ``enable_v1_registry`` must -# also be set to ``True`` to enable mandatory usage of Registry -# service with v1 API. -# -# * If this option is disabled, then the ``enable_v1_registry`` -# option, which is enabled by default, is also recommended -# to be disabled. -# -# * This option is separate from ``enable_v2_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v2 Images API, this option, which is -# enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_registry -# * enable_v2_api -# -# (boolean value) -#enable_v1_api = true - # # Deploy the v2 OpenStack Images API. # @@ -335,44 +335,18 @@ # option, which is enabled by default, is also recommended # to be disabled. # -# * This option is separate from ``enable_v1_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v1 Images API, this option, which is -# enabled by default, should be disabled. -# # Possible values: # * True # * False # # Related options: # * enable_v2_registry -# * enable_v1_api # # (boolean value) #enable_v2_api = true # -# Deploy the v1 API Registry service. -# -# When this option is set to ``True``, the Registry service -# will be enabled in Glance for v1 API requests. -# -# NOTES: -# * Use of Registry is mandatory in v1 API, so this option must -# be set to ``True`` if the ``enable_v1_api`` option is enabled. -# -# * If deploying only the v2 OpenStack Images API, this option, -# which is enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_api -# +# DEPRECATED FOR REMOVAL # (boolean value) #enable_v1_registry = true @@ -1088,7 +1062,7 @@ # From glance.store # -# +# DEPRECATED: # List of enabled Glance stores. # # Register the storage backends to use for storing disk images @@ -1109,9 +1083,18 @@ # * default_store # # (list value) +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``enabled_backends`` which helps to configure multiple backend stores +# of different schemes. +# +# This option is scheduled for removal in the Stein development +# cycle. #stores = file,http -# +# DEPRECATED: # The default scheme to use for storing images. # # Provide a string value representing the default scheme to use for @@ -1153,9 +1136,18 @@ # sheepdog - # cinder - # vsphere - +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``default_backend`` which acts similar to ``default_store`` config +# option. +# +# This option is scheduled for removal in the Stein development +# cycle. #default_store = file -# +# DEPRECATED: # Minimum interval in seconds to execute updating dynamic storage # capabilities based on current backend status. # @@ -1170,14 +1162,19 @@ # By default, this option is set to zero and is disabled. Provide an # integer value greater than zero to enable this option. # -# NOTE: For more information on store capabilities and their updates, +# NOTE 1: For more information on store capabilities and their updates, # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo # /store-capabilities.html # # For more information on setting up a particular store in your # deployment and help with the usage of this feature, please contact # the storage driver maintainers listed here: -# http://docs.openstack.org/developer/glance_store/drivers/index.html +# https://docs.openstack.org/glance_store/latest/user/drivers.html +# +# NOTE 2: The dynamic store update capability described above is not +# implemented by any current store drivers. Thus, this option DOES +# NOT DO ANYTHING (and it never has). It is DEPRECATED and scheduled +# for removal early in the Stein development cycle. # # Possible values: # * Zero @@ -1188,6 +1185,15 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option configures a stub method that has not been implemented +# for any existing store drivers. Hence it is non-operational, and +# giving it a value does absolutely nothing. +# +# This option is scheduled for removal early in the Stein development +# cycle. #store_capabilities_update_min_interval = 0 # @@ -1491,7 +1497,7 @@ # # More information on configuring filesystem store with multiple store # directories can be found at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # NOTE: This directory is used only when filesystem store is used as a # storage backend. Either ``filesystem_store_datadir`` or @@ -1542,7 +1548,7 @@ # digit. # # For more information, please refer the documentation at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # Possible values: # * A valid file access permission @@ -1962,7 +1968,7 @@ # this is 5GB. To upload objects bigger than this limit, objects are segmented # into multiple smaller objects that are tied together with a manifest file. # For more detail, refer to -# http://docs.openstack.org/developer/swift/overview_large_objects.html +# https://docs.openstack.org/swift/latest/overview_large_objects.html # # This configuration option specifies the size threshold over which the Swift # driver will start segmenting image data into multiple smaller files. diff --git a/etc/glance-image-import.conf.sample b/etc/glance-image-import.conf.sample index 239840191e..fd27ad0303 100644 --- a/etc/glance-image-import.conf.sample +++ b/etc/glance-image-import.conf.sample @@ -25,7 +25,10 @@ # Related Options: # * disk_formats # (string value) -# Allowed values: qcow2, raw, vdmk +# Possible values: +# qcow2 - +# raw - +# vdmk - #output_format = raw diff --git a/etc/glance-registry.conf b/etc/glance-registry.conf index 465716b84f..32e80b2008 100644 --- a/etc/glance-registry.conf +++ b/etc/glance-registry.conf @@ -111,6 +111,40 @@ # (boolean value) #allow_additional_image_properties = true +# " +# Secure hashing algorithm used for computing the 'os_hash_value' property. +# +# This option configures the Glance "multihash", which consists of two +# image properties: the 'os_hash_algo' and the 'os_hash_value'. The +# 'os_hash_algo' will be populated by the value of this configuration +# option, and the 'os_hash_value' will be populated by the hexdigest computed +# when the algorithm is applied to the uploaded or imported image data. +# +# The value must be a valid secure hash algorithm name recognized by the +# python 'hashlib' library. You can determine what these are by examining +# the 'hashlib.algorithms_available' data member of the version of the +# library being used in your Glance installation. For interoperability +# purposes, however, we recommend that you use the set of secure hash +# names supplied by the 'hashlib.algorithms_guaranteed' data member because +# those algorithms are guaranteed to be supported by the 'hashlib' library +# on all platforms. Thus, any image consumer using 'hashlib' locally should +# be able to verify the 'os_hash_value' of the image. +# +# The default value of 'sha512' is a performant secure hash algorithm. +# +# If this option is misconfigured, any attempts to store image data will fail. +# For that reason, we recommend using the default value. +# +# Possible values: +# * Any secure hash algorithm name recognized by the Python 'hashlib' +# library +# +# Related options: +# * None +# +# (string value) +#hashing_algorithm = sha512 + # # Maximum number of image members per image. # @@ -372,40 +406,6 @@ # (string value) #user_storage_quota = 0 -# -# Deploy the v1 OpenStack Images API. -# -# When this option is set to ``True``, Glance service will respond to -# requests on registered endpoints conforming to the v1 OpenStack -# Images API. -# -# NOTES: -# * If this option is enabled, then ``enable_v1_registry`` must -# also be set to ``True`` to enable mandatory usage of Registry -# service with v1 API. -# -# * If this option is disabled, then the ``enable_v1_registry`` -# option, which is enabled by default, is also recommended -# to be disabled. -# -# * This option is separate from ``enable_v2_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v2 Images API, this option, which is -# enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_registry -# * enable_v2_api -# -# (boolean value) -#enable_v1_api = true - # # Deploy the v2 OpenStack Images API. # @@ -418,44 +418,18 @@ # option, which is enabled by default, is also recommended # to be disabled. # -# * This option is separate from ``enable_v1_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v1 Images API, this option, which is -# enabled by default, should be disabled. -# # Possible values: # * True # * False # # Related options: # * enable_v2_registry -# * enable_v1_api # # (boolean value) #enable_v2_api = true # -# Deploy the v1 API Registry service. -# -# When this option is set to ``True``, the Registry service -# will be enabled in Glance for v1 API requests. -# -# NOTES: -# * Use of Registry is mandatory in v1 API, so this option must -# be set to ``True`` if the ``enable_v1_api`` option is enabled. -# -# * If deploying only the v2 OpenStack Images API, this option, -# which is enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_api -# +# DEPRECATED FOR REMOVAL # (boolean value) #enable_v1_registry = true @@ -1967,9 +1941,6 @@ # (integer value) #heartbeat_rate = 2 -# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value) -#fake_rabbit = false - [oslo_messaging_zmq] @@ -2235,37 +2206,38 @@ # # -# Enables the profiling for all services on this node. Default value is False -# (fully disable the profiling feature). +# Enable the profiling for all services on this node. +# +# Default value is False (fully disable the profiling feature). # # Possible values: # # * True: Enables the feature # * False: Disables the feature. The profiling cannot be started via this # project -# operations. If the profiling is triggered by another project, this project -# part -# will be empty. +# operations. If the profiling is triggered by another project, this project +# part will be empty. # (boolean value) # Deprecated group/name - [profiler]/profiler_enabled #enabled = false # -# Enables SQL requests profiling in services. Default value is False (SQL -# requests won't be traced). +# Enable SQL requests profiling in services. +# +# Default value is False (SQL requests won't be traced). # # Possible values: # # * True: Enables SQL requests profiling. Each SQL query will be part of the -# trace and can the be analyzed by how much time was spent for that. +# trace and can the be analyzed by how much time was spent for that. # * False: Disables SQL requests profiling. The spent time is only shown on a -# higher level of operations. Single SQL queries cannot be analyzed this -# way. +# higher level of operations. Single SQL queries cannot be analyzed this way. # (boolean value) #trace_sqlalchemy = false # # Secret key(s) to use for encrypting context data for performance profiling. +# # This string value should have the following format: [,,...], # where each key is some random string. A user who triggers the profiling via # the REST API has to set one of these keys in the headers of the REST API call @@ -2275,19 +2247,24 @@ # profiling. Also, to generate correct profiling information across all services # at least one key needs to be consistent between OpenStack projects. This # ensures it can be used from client side to generate the trace, containing -# information from all possible resources. (string value) +# information from all possible resources. +# (string value) #hmac_keys = SECRET_KEY # -# Connection string for a notifier backend. Default value is messaging:// which -# sets the notifier to oslo_messaging. +# Connection string for a notifier backend. +# +# Default value is ``messaging://`` which sets the notifier to oslo_messaging. # # Examples of possible values: # -# * messaging://: use oslo_messaging driver for sending notifications. -# * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications. -# * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending -# notifications. +# * ``messaging://`` - use oslo_messaging driver for sending spans. +# * ``redis://127.0.0.1:6379`` - use redis driver for sending spans. +# * ``mongodb://127.0.0.1:27017`` - use mongodb driver for sending spans. +# * ``elasticsearch://127.0.0.1:9200`` - use elasticsearch driver for sending +# spans. +# * ``jaeger://127.0.0.1:6831`` - use jaeger tracing as driver for sending +# spans. # (string value) #connection_string = messaging:// @@ -2318,12 +2295,13 @@ # # Redissentinel uses a service name to identify a master redis service. # This parameter defines the name (for example: -# sentinal_service_name=mymaster). +# ``sentinal_service_name=mymaster``). # (string value) #sentinel_service_name = mymaster # # Enable filter traces that contain error/exception to a separated place. +# # Default value is set to False. # # Possible values: diff --git a/etc/glance-scrubber.conf b/etc/glance-scrubber.conf index 423bd92d23..c818f07572 100644 --- a/etc/glance-scrubber.conf +++ b/etc/glance-scrubber.conf @@ -28,6 +28,40 @@ # (boolean value) #allow_additional_image_properties = true +# " +# Secure hashing algorithm used for computing the 'os_hash_value' property. +# +# This option configures the Glance "multihash", which consists of two +# image properties: the 'os_hash_algo' and the 'os_hash_value'. The +# 'os_hash_algo' will be populated by the value of this configuration +# option, and the 'os_hash_value' will be populated by the hexdigest computed +# when the algorithm is applied to the uploaded or imported image data. +# +# The value must be a valid secure hash algorithm name recognized by the +# python 'hashlib' library. You can determine what these are by examining +# the 'hashlib.algorithms_available' data member of the version of the +# library being used in your Glance installation. For interoperability +# purposes, however, we recommend that you use the set of secure hash +# names supplied by the 'hashlib.algorithms_guaranteed' data member because +# those algorithms are guaranteed to be supported by the 'hashlib' library +# on all platforms. Thus, any image consumer using 'hashlib' locally should +# be able to verify the 'os_hash_value' of the image. +# +# The default value of 'sha512' is a performant secure hash algorithm. +# +# If this option is misconfigured, any attempts to store image data will fail. +# For that reason, we recommend using the default value. +# +# Possible values: +# * Any secure hash algorithm name recognized by the Python 'hashlib' +# library +# +# Related options: +# * None +# +# (string value) +#hashing_algorithm = sha512 + # # Maximum number of image members per image. # @@ -289,40 +323,6 @@ # (string value) #user_storage_quota = 0 -# -# Deploy the v1 OpenStack Images API. -# -# When this option is set to ``True``, Glance service will respond to -# requests on registered endpoints conforming to the v1 OpenStack -# Images API. -# -# NOTES: -# * If this option is enabled, then ``enable_v1_registry`` must -# also be set to ``True`` to enable mandatory usage of Registry -# service with v1 API. -# -# * If this option is disabled, then the ``enable_v1_registry`` -# option, which is enabled by default, is also recommended -# to be disabled. -# -# * This option is separate from ``enable_v2_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v2 Images API, this option, which is -# enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_registry -# * enable_v2_api -# -# (boolean value) -#enable_v1_api = true - # # Deploy the v2 OpenStack Images API. # @@ -335,44 +335,18 @@ # option, which is enabled by default, is also recommended # to be disabled. # -# * This option is separate from ``enable_v1_api``, both v1 and v2 -# OpenStack Images API can be deployed independent of each -# other. -# -# * If deploying only the v1 Images API, this option, which is -# enabled by default, should be disabled. -# # Possible values: # * True # * False # # Related options: # * enable_v2_registry -# * enable_v1_api # # (boolean value) #enable_v2_api = true # -# Deploy the v1 API Registry service. -# -# When this option is set to ``True``, the Registry service -# will be enabled in Glance for v1 API requests. -# -# NOTES: -# * Use of Registry is mandatory in v1 API, so this option must -# be set to ``True`` if the ``enable_v1_api`` option is enabled. -# -# * If deploying only the v2 OpenStack Images API, this option, -# which is enabled by default, should be disabled. -# -# Possible values: -# * True -# * False -# -# Related options: -# * enable_v1_api -# +# DEPRECATED FOR REMOVAL # (boolean value) #enable_v1_registry = true @@ -903,7 +877,7 @@ # From glance.store # -# +# DEPRECATED: # List of enabled Glance stores. # # Register the storage backends to use for storing disk images @@ -924,9 +898,18 @@ # * default_store # # (list value) +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``enabled_backends`` which helps to configure multiple backend stores +# of different schemes. +# +# This option is scheduled for removal in the Stein development +# cycle. #stores = file,http -# +# DEPRECATED: # The default scheme to use for storing images. # # Provide a string value representing the default scheme to use for @@ -968,9 +951,18 @@ # sheepdog - # cinder - # vsphere - +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option is deprecated against new config option +# ``default_backend`` which acts similar to ``default_store`` config +# option. +# +# This option is scheduled for removal in the Stein development +# cycle. #default_store = file -# +# DEPRECATED: # Minimum interval in seconds to execute updating dynamic storage # capabilities based on current backend status. # @@ -985,14 +977,19 @@ # By default, this option is set to zero and is disabled. Provide an # integer value greater than zero to enable this option. # -# NOTE: For more information on store capabilities and their updates, +# NOTE 1: For more information on store capabilities and their updates, # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo # /store-capabilities.html # # For more information on setting up a particular store in your # deployment and help with the usage of this feature, please contact # the storage driver maintainers listed here: -# http://docs.openstack.org/developer/glance_store/drivers/index.html +# https://docs.openstack.org/glance_store/latest/user/drivers.html +# +# NOTE 2: The dynamic store update capability described above is not +# implemented by any current store drivers. Thus, this option DOES +# NOT DO ANYTHING (and it never has). It is DEPRECATED and scheduled +# for removal early in the Stein development cycle. # # Possible values: # * Zero @@ -1003,6 +1000,15 @@ # # (integer value) # Minimum value: 0 +# This option is deprecated for removal since Rocky. +# Its value may be silently ignored in the future. +# Reason: +# This option configures a stub method that has not been implemented +# for any existing store drivers. Hence it is non-operational, and +# giving it a value does absolutely nothing. +# +# This option is scheduled for removal early in the Stein development +# cycle. #store_capabilities_update_min_interval = 0 # @@ -1306,7 +1312,7 @@ # # More information on configuring filesystem store with multiple store # directories can be found at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # NOTE: This directory is used only when filesystem store is used as a # storage backend. Either ``filesystem_store_datadir`` or @@ -1357,7 +1363,7 @@ # digit. # # For more information, please refer the documentation at -# http://docs.openstack.org/developer/glance/configuring.html +# https://docs.openstack.org/glance/latest/configuration/configuring.html # # Possible values: # * A valid file access permission @@ -1777,7 +1783,7 @@ # this is 5GB. To upload objects bigger than this limit, objects are segmented # into multiple smaller objects that are tied together with a manifest file. # For more detail, refer to -# http://docs.openstack.org/developer/swift/overview_large_objects.html +# https://docs.openstack.org/swift/latest/overview_large_objects.html # # This configuration option specifies the size threshold over which the Swift # driver will start segmenting image data into multiple smaller files.