Browse Source

Merge "Sync Rocky example configs"

Zuul 8 months ago
parent
commit
8b1527e465
5 changed files with 314 additions and 311 deletions
  1. 100
    90
      etc/glance-api.conf
  2. 75
    69
      etc/glance-cache.conf
  3. 4
    1
      etc/glance-image-import.conf.sample
  4. 60
    82
      etc/glance-registry.conf
  5. 75
    69
      etc/glance-scrubber.conf

+ 100
- 90
etc/glance-api.conf View File

@@ -132,6 +132,40 @@
132 132
 #  (boolean value)
133 133
 #allow_additional_image_properties = true
134 134
 
135
+# "
136
+# Secure hashing algorithm used for computing the 'os_hash_value' property.
137
+#
138
+# This option configures the Glance "multihash", which consists of two
139
+# image properties: the 'os_hash_algo' and the 'os_hash_value'.  The
140
+# 'os_hash_algo' will be populated by the value of this configuration
141
+# option, and the 'os_hash_value' will be populated by the hexdigest computed
142
+# when the algorithm is applied to the uploaded or imported image data.
143
+#
144
+# The value must be a valid secure hash algorithm name recognized by the
145
+# python 'hashlib' library.  You can determine what these are by examining
146
+# the 'hashlib.algorithms_available' data member of the version of the
147
+# library being used in your Glance installation.  For interoperability
148
+# purposes, however, we recommend that you use the set of secure hash
149
+# names supplied by the 'hashlib.algorithms_guaranteed' data member because
150
+# those algorithms are guaranteed to be supported by the 'hashlib' library
151
+# on all platforms.  Thus, any image consumer using 'hashlib' locally should
152
+# be able to verify the 'os_hash_value' of the image.
153
+#
154
+# The default value of 'sha512' is a performant secure hash algorithm.
155
+#
156
+# If this option is misconfigured, any attempts to store image data will fail.
157
+# For that reason, we recommend using the default value.
158
+#
159
+# Possible values:
160
+#     * Any secure hash algorithm name recognized by the Python 'hashlib'
161
+#       library
162
+#
163
+# Related options:
164
+#     * None
165
+#
166
+#  (string value)
167
+#hashing_algorithm = sha512
168
+
135 169
 #
136 170
 # Maximum number of image members per image.
137 171
 #
@@ -393,40 +427,6 @@
393 427
 #  (string value)
394 428
 #user_storage_quota = 0
395 429
 
396
-#
397
-# Deploy the v1 OpenStack Images API.
398
-#
399
-# When this option is set to ``True``, Glance service will respond to
400
-# requests on registered endpoints conforming to the v1 OpenStack
401
-# Images API.
402
-#
403
-# NOTES:
404
-#     * If this option is enabled, then ``enable_v1_registry`` must
405
-#       also be set to ``True`` to enable mandatory usage of Registry
406
-#       service with v1 API.
407
-#
408
-#     * If this option is disabled, then the ``enable_v1_registry``
409
-#       option, which is enabled by default, is also recommended
410
-#       to be disabled.
411
-#
412
-#     * This option is separate from ``enable_v2_api``, both v1 and v2
413
-#       OpenStack Images API can be deployed independent of each
414
-#       other.
415
-#
416
-#     * If deploying only the v2 Images API, this option, which is
417
-#       enabled by default, should be disabled.
418
-#
419
-# Possible values:
420
-#     * True
421
-#     * False
422
-#
423
-# Related options:
424
-#     * enable_v1_registry
425
-#     * enable_v2_api
426
-#
427
-#  (boolean value)
428
-#enable_v1_api = true
429
-
430 430
 #
431 431
 # Deploy the v2 OpenStack Images API.
432 432
 #
@@ -439,44 +439,18 @@
439 439
 #       option, which is enabled by default, is also recommended
440 440
 #       to be disabled.
441 441
 #
442
-#     * This option is separate from ``enable_v1_api``, both v1 and v2
443
-#       OpenStack Images API can be deployed independent of each
444
-#       other.
445
-#
446
-#     * If deploying only the v1 Images API, this option, which is
447
-#       enabled by default, should be disabled.
448
-#
449 442
 # Possible values:
450 443
 #     * True
451 444
 #     * False
452 445
 #
453 446
 # Related options:
454 447
 #     * enable_v2_registry
455
-#     * enable_v1_api
456 448
 #
457 449
 #  (boolean value)
458 450
 #enable_v2_api = true
459 451
 
460 452
 #
461
-# Deploy the v1 API Registry service.
462
-#
463
-# When this option is set to ``True``, the Registry service
464
-# will be enabled in Glance for v1 API requests.
465
-#
466
-# NOTES:
467
-#     * Use of Registry is mandatory in v1 API, so this option must
468
-#       be set to ``True`` if the ``enable_v1_api`` option is enabled.
469
-#
470
-#     * If deploying only the v2 OpenStack Images API, this option,
471
-#       which is enabled by default, should be disabled.
472
-#
473
-# Possible values:
474
-#     * True
475
-#     * False
476
-#
477
-# Related options:
478
-#     * enable_v1_api
479
-#
453
+#                     DEPRECATED FOR REMOVAL
480 454
 #  (boolean value)
481 455
 #enable_v1_registry = true
482 456
 
@@ -2035,7 +2009,7 @@
2035 2009
 # From glance.store
2036 2010
 #
2037 2011
 
2038
-#
2012
+# DEPRECATED:
2039 2013
 # List of enabled Glance stores.
2040 2014
 #
2041 2015
 # Register the storage backends to use for storing disk images
@@ -2056,9 +2030,18 @@
2056 2030
 #     * default_store
2057 2031
 #
2058 2032
 #  (list value)
2033
+# This option is deprecated for removal since Rocky.
2034
+# Its value may be silently ignored in the future.
2035
+# Reason:
2036
+# This option is deprecated against new config option
2037
+# ``enabled_backends`` which helps to configure multiple backend stores
2038
+# of different schemes.
2039
+#
2040
+# This option is scheduled for removal in the Stein development
2041
+# cycle.
2059 2042
 #stores = file,http
2060 2043
 
2061
-#
2044
+# DEPRECATED:
2062 2045
 # The default scheme to use for storing images.
2063 2046
 #
2064 2047
 # Provide a string value representing the default scheme to use for
@@ -2100,9 +2083,18 @@
2100 2083
 # sheepdog - <No description provided>
2101 2084
 # cinder - <No description provided>
2102 2085
 # vsphere - <No description provided>
2086
+# This option is deprecated for removal since Rocky.
2087
+# Its value may be silently ignored in the future.
2088
+# Reason:
2089
+# This option is deprecated against new config option
2090
+# ``default_backend`` which acts similar to ``default_store`` config
2091
+# option.
2092
+#
2093
+# This option is scheduled for removal in the Stein development
2094
+# cycle.
2103 2095
 #default_store = file
2104 2096
 
2105
-#
2097
+# DEPRECATED:
2106 2098
 # Minimum interval in seconds to execute updating dynamic storage
2107 2099
 # capabilities based on current backend status.
2108 2100
 #
@@ -2117,14 +2109,19 @@
2117 2109
 # By default, this option is set to zero and is disabled. Provide an
2118 2110
 # integer value greater than zero to enable this option.
2119 2111
 #
2120
-# NOTE: For more information on store capabilities and their updates,
2112
+# NOTE 1: For more information on store capabilities and their updates,
2121 2113
 # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo
2122 2114
 # /store-capabilities.html
2123 2115
 #
2124 2116
 # For more information on setting up a particular store in your
2125 2117
 # deployment and help with the usage of this feature, please contact
2126 2118
 # the storage driver maintainers listed here:
2127
-# http://docs.openstack.org/developer/glance_store/drivers/index.html
2119
+# https://docs.openstack.org/glance_store/latest/user/drivers.html
2120
+#
2121
+# NOTE 2: The dynamic store update capability described above is not
2122
+# implemented by any current store drivers.  Thus, this option DOES
2123
+# NOT DO ANYTHING (and it never has).  It is DEPRECATED and scheduled
2124
+# for removal early in the Stein development cycle.
2128 2125
 #
2129 2126
 # Possible values:
2130 2127
 #     * Zero
@@ -2135,6 +2132,15 @@
2135 2132
 #
2136 2133
 #  (integer value)
2137 2134
 # Minimum value: 0
2135
+# This option is deprecated for removal since Rocky.
2136
+# Its value may be silently ignored in the future.
2137
+# Reason:
2138
+# This option configures a stub method that has not been implemented
2139
+# for any existing store drivers.  Hence it is non-operational, and
2140
+# giving it a value does absolutely nothing.
2141
+#
2142
+# This option is scheduled for removal early in the Stein development
2143
+# cycle.
2138 2144
 #store_capabilities_update_min_interval = 0
2139 2145
 
2140 2146
 #
@@ -2438,7 +2444,7 @@
2438 2444
 #
2439 2445
 # More information on configuring filesystem store with multiple store
2440 2446
 # directories can be found at
2441
-# http://docs.openstack.org/developer/glance/configuring.html
2447
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
2442 2448
 #
2443 2449
 # NOTE: This directory is used only when filesystem store is used as a
2444 2450
 # storage backend. Either ``filesystem_store_datadir`` or
@@ -2489,7 +2495,7 @@
2489 2495
 # digit.
2490 2496
 #
2491 2497
 # For more information, please refer the documentation at
2492
-# http://docs.openstack.org/developer/glance/configuring.html
2498
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
2493 2499
 #
2494 2500
 # Possible values:
2495 2501
 #     * A valid file access permission
@@ -2909,7 +2915,7 @@
2909 2915
 # this is 5GB. To upload objects bigger than this limit, objects are segmented
2910 2916
 # into multiple smaller objects that are tied together with a manifest file.
2911 2917
 # For more detail, refer to
2912
-# http://docs.openstack.org/developer/swift/overview_large_objects.html
2918
+# https://docs.openstack.org/swift/latest/overview_large_objects.html
2913 2919
 #
2914 2920
 # This configuration option specifies the size threshold over which the Swift
2915 2921
 # driver will start segmenting image data into multiple smaller files.
@@ -4170,9 +4176,6 @@
4170 4176
 # (integer value)
4171 4177
 #heartbeat_rate = 2
4172 4178
 
4173
-# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
4174
-#fake_rabbit = false
4175
-
4176 4179
 
4177 4180
 [oslo_messaging_zmq]
4178 4181
 
@@ -4449,37 +4452,38 @@
4449 4452
 #
4450 4453
 
4451 4454
 #
4452
-# Enables the profiling for all services on this node. Default value is False
4453
-# (fully disable the profiling feature).
4455
+# Enable the profiling for all services on this node.
4456
+#
4457
+# Default value is False (fully disable the profiling feature).
4454 4458
 #
4455 4459
 # Possible values:
4456 4460
 #
4457 4461
 # * True: Enables the feature
4458 4462
 # * False: Disables the feature. The profiling cannot be started via this
4459 4463
 # project
4460
-# operations. If the profiling is triggered by another project, this project
4461
-# part
4462
-# will be empty.
4464
+#   operations. If the profiling is triggered by another project, this project
4465
+#   part will be empty.
4463 4466
 #  (boolean value)
4464 4467
 # Deprecated group/name - [profiler]/profiler_enabled
4465 4468
 #enabled = false
4466 4469
 
4467 4470
 #
4468
-# Enables SQL requests profiling in services. Default value is False (SQL
4469
-# requests won't be traced).
4471
+# Enable SQL requests profiling in services.
4472
+#
4473
+# Default value is False (SQL requests won't be traced).
4470 4474
 #
4471 4475
 # Possible values:
4472 4476
 #
4473 4477
 # * True: Enables SQL requests profiling. Each SQL query will be part of the
4474
-# trace and can the be analyzed by how much time was spent for that.
4478
+#   trace and can the be analyzed by how much time was spent for that.
4475 4479
 # * False: Disables SQL requests profiling. The spent time is only shown on a
4476
-# higher level of operations. Single SQL queries cannot be analyzed this
4477
-# way.
4480
+#   higher level of operations. Single SQL queries cannot be analyzed this way.
4478 4481
 #  (boolean value)
4479 4482
 #trace_sqlalchemy = false
4480 4483
 
4481 4484
 #
4482 4485
 # Secret key(s) to use for encrypting context data for performance profiling.
4486
+#
4483 4487
 # This string value should have the following format: <key1>[,<key2>,...<keyn>],
4484 4488
 # where each key is some random string. A user who triggers the profiling via
4485 4489
 # the REST API has to set one of these keys in the headers of the REST API call
@@ -4489,19 +4493,24 @@
4489 4493
 # profiling. Also, to generate correct profiling information across all services
4490 4494
 # at least one key needs to be consistent between OpenStack projects. This
4491 4495
 # ensures it can be used from client side to generate the trace, containing
4492
-# information from all possible resources. (string value)
4496
+# information from all possible resources.
4497
+#  (string value)
4493 4498
 #hmac_keys = SECRET_KEY
4494 4499
 
4495 4500
 #
4496
-# Connection string for a notifier backend. Default value is messaging:// which
4497
-# sets the notifier to oslo_messaging.
4501
+# Connection string for a notifier backend.
4502
+#
4503
+# Default value is ``messaging://`` which sets the notifier to oslo_messaging.
4498 4504
 #
4499 4505
 # Examples of possible values:
4500 4506
 #
4501
-# * messaging://: use oslo_messaging driver for sending notifications.
4502
-# * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
4503
-# * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending
4504
-# notifications.
4507
+# * ``messaging://`` - use oslo_messaging driver for sending spans.
4508
+# * ``redis://127.0.0.1:6379`` - use redis driver for sending spans.
4509
+# * ``mongodb://127.0.0.1:27017`` - use mongodb driver for sending spans.
4510
+# * ``elasticsearch://127.0.0.1:9200`` - use elasticsearch driver for sending
4511
+#   spans.
4512
+# * ``jaeger://127.0.0.1:6831`` - use jaeger tracing as driver for sending
4513
+# spans.
4505 4514
 #  (string value)
4506 4515
 #connection_string = messaging://
4507 4516
 
@@ -4532,12 +4541,13 @@
4532 4541
 #
4533 4542
 # Redissentinel uses a service name to identify a master redis service.
4534 4543
 # This parameter defines the name (for example:
4535
-# sentinal_service_name=mymaster).
4544
+# ``sentinal_service_name=mymaster``).
4536 4545
 #  (string value)
4537 4546
 #sentinel_service_name = mymaster
4538 4547
 
4539 4548
 #
4540 4549
 # Enable filter traces that contain error/exception to a separated place.
4550
+#
4541 4551
 # Default value is set to False.
4542 4552
 #
4543 4553
 # Possible values:

+ 75
- 69
etc/glance-cache.conf View File

@@ -28,6 +28,40 @@
28 28
 #  (boolean value)
29 29
 #allow_additional_image_properties = true
30 30
 
31
+# "
32
+# Secure hashing algorithm used for computing the 'os_hash_value' property.
33
+#
34
+# This option configures the Glance "multihash", which consists of two
35
+# image properties: the 'os_hash_algo' and the 'os_hash_value'.  The
36
+# 'os_hash_algo' will be populated by the value of this configuration
37
+# option, and the 'os_hash_value' will be populated by the hexdigest computed
38
+# when the algorithm is applied to the uploaded or imported image data.
39
+#
40
+# The value must be a valid secure hash algorithm name recognized by the
41
+# python 'hashlib' library.  You can determine what these are by examining
42
+# the 'hashlib.algorithms_available' data member of the version of the
43
+# library being used in your Glance installation.  For interoperability
44
+# purposes, however, we recommend that you use the set of secure hash
45
+# names supplied by the 'hashlib.algorithms_guaranteed' data member because
46
+# those algorithms are guaranteed to be supported by the 'hashlib' library
47
+# on all platforms.  Thus, any image consumer using 'hashlib' locally should
48
+# be able to verify the 'os_hash_value' of the image.
49
+#
50
+# The default value of 'sha512' is a performant secure hash algorithm.
51
+#
52
+# If this option is misconfigured, any attempts to store image data will fail.
53
+# For that reason, we recommend using the default value.
54
+#
55
+# Possible values:
56
+#     * Any secure hash algorithm name recognized by the Python 'hashlib'
57
+#       library
58
+#
59
+# Related options:
60
+#     * None
61
+#
62
+#  (string value)
63
+#hashing_algorithm = sha512
64
+
31 65
 #
32 66
 # Maximum number of image members per image.
33 67
 #
@@ -289,40 +323,6 @@
289 323
 #  (string value)
290 324
 #user_storage_quota = 0
291 325
 
292
-#
293
-# Deploy the v1 OpenStack Images API.
294
-#
295
-# When this option is set to ``True``, Glance service will respond to
296
-# requests on registered endpoints conforming to the v1 OpenStack
297
-# Images API.
298
-#
299
-# NOTES:
300
-#     * If this option is enabled, then ``enable_v1_registry`` must
301
-#       also be set to ``True`` to enable mandatory usage of Registry
302
-#       service with v1 API.
303
-#
304
-#     * If this option is disabled, then the ``enable_v1_registry``
305
-#       option, which is enabled by default, is also recommended
306
-#       to be disabled.
307
-#
308
-#     * This option is separate from ``enable_v2_api``, both v1 and v2
309
-#       OpenStack Images API can be deployed independent of each
310
-#       other.
311
-#
312
-#     * If deploying only the v2 Images API, this option, which is
313
-#       enabled by default, should be disabled.
314
-#
315
-# Possible values:
316
-#     * True
317
-#     * False
318
-#
319
-# Related options:
320
-#     * enable_v1_registry
321
-#     * enable_v2_api
322
-#
323
-#  (boolean value)
324
-#enable_v1_api = true
325
-
326 326
 #
327 327
 # Deploy the v2 OpenStack Images API.
328 328
 #
@@ -335,44 +335,18 @@
335 335
 #       option, which is enabled by default, is also recommended
336 336
 #       to be disabled.
337 337
 #
338
-#     * This option is separate from ``enable_v1_api``, both v1 and v2
339
-#       OpenStack Images API can be deployed independent of each
340
-#       other.
341
-#
342
-#     * If deploying only the v1 Images API, this option, which is
343
-#       enabled by default, should be disabled.
344
-#
345 338
 # Possible values:
346 339
 #     * True
347 340
 #     * False
348 341
 #
349 342
 # Related options:
350 343
 #     * enable_v2_registry
351
-#     * enable_v1_api
352 344
 #
353 345
 #  (boolean value)
354 346
 #enable_v2_api = true
355 347
 
356 348
 #
357
-# Deploy the v1 API Registry service.
358
-#
359
-# When this option is set to ``True``, the Registry service
360
-# will be enabled in Glance for v1 API requests.
361
-#
362
-# NOTES:
363
-#     * Use of Registry is mandatory in v1 API, so this option must
364
-#       be set to ``True`` if the ``enable_v1_api`` option is enabled.
365
-#
366
-#     * If deploying only the v2 OpenStack Images API, this option,
367
-#       which is enabled by default, should be disabled.
368
-#
369
-# Possible values:
370
-#     * True
371
-#     * False
372
-#
373
-# Related options:
374
-#     * enable_v1_api
375
-#
349
+#                     DEPRECATED FOR REMOVAL
376 350
 #  (boolean value)
377 351
 #enable_v1_registry = true
378 352
 
@@ -1088,7 +1062,7 @@
1088 1062
 # From glance.store
1089 1063
 #
1090 1064
 
1091
-#
1065
+# DEPRECATED:
1092 1066
 # List of enabled Glance stores.
1093 1067
 #
1094 1068
 # Register the storage backends to use for storing disk images
@@ -1109,9 +1083,18 @@
1109 1083
 #     * default_store
1110 1084
 #
1111 1085
 #  (list value)
1086
+# This option is deprecated for removal since Rocky.
1087
+# Its value may be silently ignored in the future.
1088
+# Reason:
1089
+# This option is deprecated against new config option
1090
+# ``enabled_backends`` which helps to configure multiple backend stores
1091
+# of different schemes.
1092
+#
1093
+# This option is scheduled for removal in the Stein development
1094
+# cycle.
1112 1095
 #stores = file,http
1113 1096
 
1114
-#
1097
+# DEPRECATED:
1115 1098
 # The default scheme to use for storing images.
1116 1099
 #
1117 1100
 # Provide a string value representing the default scheme to use for
@@ -1153,9 +1136,18 @@
1153 1136
 # sheepdog - <No description provided>
1154 1137
 # cinder - <No description provided>
1155 1138
 # vsphere - <No description provided>
1139
+# This option is deprecated for removal since Rocky.
1140
+# Its value may be silently ignored in the future.
1141
+# Reason:
1142
+# This option is deprecated against new config option
1143
+# ``default_backend`` which acts similar to ``default_store`` config
1144
+# option.
1145
+#
1146
+# This option is scheduled for removal in the Stein development
1147
+# cycle.
1156 1148
 #default_store = file
1157 1149
 
1158
-#
1150
+# DEPRECATED:
1159 1151
 # Minimum interval in seconds to execute updating dynamic storage
1160 1152
 # capabilities based on current backend status.
1161 1153
 #
@@ -1170,14 +1162,19 @@
1170 1162
 # By default, this option is set to zero and is disabled. Provide an
1171 1163
 # integer value greater than zero to enable this option.
1172 1164
 #
1173
-# NOTE: For more information on store capabilities and their updates,
1165
+# NOTE 1: For more information on store capabilities and their updates,
1174 1166
 # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo
1175 1167
 # /store-capabilities.html
1176 1168
 #
1177 1169
 # For more information on setting up a particular store in your
1178 1170
 # deployment and help with the usage of this feature, please contact
1179 1171
 # the storage driver maintainers listed here:
1180
-# http://docs.openstack.org/developer/glance_store/drivers/index.html
1172
+# https://docs.openstack.org/glance_store/latest/user/drivers.html
1173
+#
1174
+# NOTE 2: The dynamic store update capability described above is not
1175
+# implemented by any current store drivers.  Thus, this option DOES
1176
+# NOT DO ANYTHING (and it never has).  It is DEPRECATED and scheduled
1177
+# for removal early in the Stein development cycle.
1181 1178
 #
1182 1179
 # Possible values:
1183 1180
 #     * Zero
@@ -1188,6 +1185,15 @@
1188 1185
 #
1189 1186
 #  (integer value)
1190 1187
 # Minimum value: 0
1188
+# This option is deprecated for removal since Rocky.
1189
+# Its value may be silently ignored in the future.
1190
+# Reason:
1191
+# This option configures a stub method that has not been implemented
1192
+# for any existing store drivers.  Hence it is non-operational, and
1193
+# giving it a value does absolutely nothing.
1194
+#
1195
+# This option is scheduled for removal early in the Stein development
1196
+# cycle.
1191 1197
 #store_capabilities_update_min_interval = 0
1192 1198
 
1193 1199
 #
@@ -1491,7 +1497,7 @@
1491 1497
 #
1492 1498
 # More information on configuring filesystem store with multiple store
1493 1499
 # directories can be found at
1494
-# http://docs.openstack.org/developer/glance/configuring.html
1500
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
1495 1501
 #
1496 1502
 # NOTE: This directory is used only when filesystem store is used as a
1497 1503
 # storage backend. Either ``filesystem_store_datadir`` or
@@ -1542,7 +1548,7 @@
1542 1548
 # digit.
1543 1549
 #
1544 1550
 # For more information, please refer the documentation at
1545
-# http://docs.openstack.org/developer/glance/configuring.html
1551
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
1546 1552
 #
1547 1553
 # Possible values:
1548 1554
 #     * A valid file access permission
@@ -1962,7 +1968,7 @@
1962 1968
 # this is 5GB. To upload objects bigger than this limit, objects are segmented
1963 1969
 # into multiple smaller objects that are tied together with a manifest file.
1964 1970
 # For more detail, refer to
1965
-# http://docs.openstack.org/developer/swift/overview_large_objects.html
1971
+# https://docs.openstack.org/swift/latest/overview_large_objects.html
1966 1972
 #
1967 1973
 # This configuration option specifies the size threshold over which the Swift
1968 1974
 # driver will start segmenting image data into multiple smaller files.

+ 4
- 1
etc/glance-image-import.conf.sample View File

@@ -25,7 +25,10 @@
25 25
 # Related Options:
26 26
 #     * disk_formats
27 27
 #  (string value)
28
-# Allowed values: qcow2, raw, vdmk
28
+# Possible values:
29
+# qcow2 - <No description provided>
30
+# raw - <No description provided>
31
+# vdmk - <No description provided>
29 32
 #output_format = raw
30 33
 
31 34
 

+ 60
- 82
etc/glance-registry.conf View File

@@ -111,6 +111,40 @@
111 111
 #  (boolean value)
112 112
 #allow_additional_image_properties = true
113 113
 
114
+# "
115
+# Secure hashing algorithm used for computing the 'os_hash_value' property.
116
+#
117
+# This option configures the Glance "multihash", which consists of two
118
+# image properties: the 'os_hash_algo' and the 'os_hash_value'.  The
119
+# 'os_hash_algo' will be populated by the value of this configuration
120
+# option, and the 'os_hash_value' will be populated by the hexdigest computed
121
+# when the algorithm is applied to the uploaded or imported image data.
122
+#
123
+# The value must be a valid secure hash algorithm name recognized by the
124
+# python 'hashlib' library.  You can determine what these are by examining
125
+# the 'hashlib.algorithms_available' data member of the version of the
126
+# library being used in your Glance installation.  For interoperability
127
+# purposes, however, we recommend that you use the set of secure hash
128
+# names supplied by the 'hashlib.algorithms_guaranteed' data member because
129
+# those algorithms are guaranteed to be supported by the 'hashlib' library
130
+# on all platforms.  Thus, any image consumer using 'hashlib' locally should
131
+# be able to verify the 'os_hash_value' of the image.
132
+#
133
+# The default value of 'sha512' is a performant secure hash algorithm.
134
+#
135
+# If this option is misconfigured, any attempts to store image data will fail.
136
+# For that reason, we recommend using the default value.
137
+#
138
+# Possible values:
139
+#     * Any secure hash algorithm name recognized by the Python 'hashlib'
140
+#       library
141
+#
142
+# Related options:
143
+#     * None
144
+#
145
+#  (string value)
146
+#hashing_algorithm = sha512
147
+
114 148
 #
115 149
 # Maximum number of image members per image.
116 150
 #
@@ -372,40 +406,6 @@
372 406
 #  (string value)
373 407
 #user_storage_quota = 0
374 408
 
375
-#
376
-# Deploy the v1 OpenStack Images API.
377
-#
378
-# When this option is set to ``True``, Glance service will respond to
379
-# requests on registered endpoints conforming to the v1 OpenStack
380
-# Images API.
381
-#
382
-# NOTES:
383
-#     * If this option is enabled, then ``enable_v1_registry`` must
384
-#       also be set to ``True`` to enable mandatory usage of Registry
385
-#       service with v1 API.
386
-#
387
-#     * If this option is disabled, then the ``enable_v1_registry``
388
-#       option, which is enabled by default, is also recommended
389
-#       to be disabled.
390
-#
391
-#     * This option is separate from ``enable_v2_api``, both v1 and v2
392
-#       OpenStack Images API can be deployed independent of each
393
-#       other.
394
-#
395
-#     * If deploying only the v2 Images API, this option, which is
396
-#       enabled by default, should be disabled.
397
-#
398
-# Possible values:
399
-#     * True
400
-#     * False
401
-#
402
-# Related options:
403
-#     * enable_v1_registry
404
-#     * enable_v2_api
405
-#
406
-#  (boolean value)
407
-#enable_v1_api = true
408
-
409 409
 #
410 410
 # Deploy the v2 OpenStack Images API.
411 411
 #
@@ -418,44 +418,18 @@
418 418
 #       option, which is enabled by default, is also recommended
419 419
 #       to be disabled.
420 420
 #
421
-#     * This option is separate from ``enable_v1_api``, both v1 and v2
422
-#       OpenStack Images API can be deployed independent of each
423
-#       other.
424
-#
425
-#     * If deploying only the v1 Images API, this option, which is
426
-#       enabled by default, should be disabled.
427
-#
428 421
 # Possible values:
429 422
 #     * True
430 423
 #     * False
431 424
 #
432 425
 # Related options:
433 426
 #     * enable_v2_registry
434
-#     * enable_v1_api
435 427
 #
436 428
 #  (boolean value)
437 429
 #enable_v2_api = true
438 430
 
439 431
 #
440
-# Deploy the v1 API Registry service.
441
-#
442
-# When this option is set to ``True``, the Registry service
443
-# will be enabled in Glance for v1 API requests.
444
-#
445
-# NOTES:
446
-#     * Use of Registry is mandatory in v1 API, so this option must
447
-#       be set to ``True`` if the ``enable_v1_api`` option is enabled.
448
-#
449
-#     * If deploying only the v2 OpenStack Images API, this option,
450
-#       which is enabled by default, should be disabled.
451
-#
452
-# Possible values:
453
-#     * True
454
-#     * False
455
-#
456
-# Related options:
457
-#     * enable_v1_api
458
-#
432
+#                     DEPRECATED FOR REMOVAL
459 433
 #  (boolean value)
460 434
 #enable_v1_registry = true
461 435
 
@@ -1967,9 +1941,6 @@
1967 1941
 # (integer value)
1968 1942
 #heartbeat_rate = 2
1969 1943
 
1970
-# Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
1971
-#fake_rabbit = false
1972
-
1973 1944
 
1974 1945
 [oslo_messaging_zmq]
1975 1946
 
@@ -2235,37 +2206,38 @@
2235 2206
 #
2236 2207
 
2237 2208
 #
2238
-# Enables the profiling for all services on this node. Default value is False
2239
-# (fully disable the profiling feature).
2209
+# Enable the profiling for all services on this node.
2210
+#
2211
+# Default value is False (fully disable the profiling feature).
2240 2212
 #
2241 2213
 # Possible values:
2242 2214
 #
2243 2215
 # * True: Enables the feature
2244 2216
 # * False: Disables the feature. The profiling cannot be started via this
2245 2217
 # project
2246
-# operations. If the profiling is triggered by another project, this project
2247
-# part
2248
-# will be empty.
2218
+#   operations. If the profiling is triggered by another project, this project
2219
+#   part will be empty.
2249 2220
 #  (boolean value)
2250 2221
 # Deprecated group/name - [profiler]/profiler_enabled
2251 2222
 #enabled = false
2252 2223
 
2253 2224
 #
2254
-# Enables SQL requests profiling in services. Default value is False (SQL
2255
-# requests won't be traced).
2225
+# Enable SQL requests profiling in services.
2226
+#
2227
+# Default value is False (SQL requests won't be traced).
2256 2228
 #
2257 2229
 # Possible values:
2258 2230
 #
2259 2231
 # * True: Enables SQL requests profiling. Each SQL query will be part of the
2260
-# trace and can the be analyzed by how much time was spent for that.
2232
+#   trace and can the be analyzed by how much time was spent for that.
2261 2233
 # * False: Disables SQL requests profiling. The spent time is only shown on a
2262
-# higher level of operations. Single SQL queries cannot be analyzed this
2263
-# way.
2234
+#   higher level of operations. Single SQL queries cannot be analyzed this way.
2264 2235
 #  (boolean value)
2265 2236
 #trace_sqlalchemy = false
2266 2237
 
2267 2238
 #
2268 2239
 # Secret key(s) to use for encrypting context data for performance profiling.
2240
+#
2269 2241
 # This string value should have the following format: <key1>[,<key2>,...<keyn>],
2270 2242
 # where each key is some random string. A user who triggers the profiling via
2271 2243
 # the REST API has to set one of these keys in the headers of the REST API call
@@ -2275,19 +2247,24 @@
2275 2247
 # profiling. Also, to generate correct profiling information across all services
2276 2248
 # at least one key needs to be consistent between OpenStack projects. This
2277 2249
 # ensures it can be used from client side to generate the trace, containing
2278
-# information from all possible resources. (string value)
2250
+# information from all possible resources.
2251
+#  (string value)
2279 2252
 #hmac_keys = SECRET_KEY
2280 2253
 
2281 2254
 #
2282
-# Connection string for a notifier backend. Default value is messaging:// which
2283
-# sets the notifier to oslo_messaging.
2255
+# Connection string for a notifier backend.
2256
+#
2257
+# Default value is ``messaging://`` which sets the notifier to oslo_messaging.
2284 2258
 #
2285 2259
 # Examples of possible values:
2286 2260
 #
2287
-# * messaging://: use oslo_messaging driver for sending notifications.
2288
-# * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
2289
-# * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending
2290
-# notifications.
2261
+# * ``messaging://`` - use oslo_messaging driver for sending spans.
2262
+# * ``redis://127.0.0.1:6379`` - use redis driver for sending spans.
2263
+# * ``mongodb://127.0.0.1:27017`` - use mongodb driver for sending spans.
2264
+# * ``elasticsearch://127.0.0.1:9200`` - use elasticsearch driver for sending
2265
+#   spans.
2266
+# * ``jaeger://127.0.0.1:6831`` - use jaeger tracing as driver for sending
2267
+# spans.
2291 2268
 #  (string value)
2292 2269
 #connection_string = messaging://
2293 2270
 
@@ -2318,12 +2295,13 @@
2318 2295
 #
2319 2296
 # Redissentinel uses a service name to identify a master redis service.
2320 2297
 # This parameter defines the name (for example:
2321
-# sentinal_service_name=mymaster).
2298
+# ``sentinal_service_name=mymaster``).
2322 2299
 #  (string value)
2323 2300
 #sentinel_service_name = mymaster
2324 2301
 
2325 2302
 #
2326 2303
 # Enable filter traces that contain error/exception to a separated place.
2304
+#
2327 2305
 # Default value is set to False.
2328 2306
 #
2329 2307
 # Possible values:

+ 75
- 69
etc/glance-scrubber.conf View File

@@ -28,6 +28,40 @@
28 28
 #  (boolean value)
29 29
 #allow_additional_image_properties = true
30 30
 
31
+# "
32
+# Secure hashing algorithm used for computing the 'os_hash_value' property.
33
+#
34
+# This option configures the Glance "multihash", which consists of two
35
+# image properties: the 'os_hash_algo' and the 'os_hash_value'.  The
36
+# 'os_hash_algo' will be populated by the value of this configuration
37
+# option, and the 'os_hash_value' will be populated by the hexdigest computed
38
+# when the algorithm is applied to the uploaded or imported image data.
39
+#
40
+# The value must be a valid secure hash algorithm name recognized by the
41
+# python 'hashlib' library.  You can determine what these are by examining
42
+# the 'hashlib.algorithms_available' data member of the version of the
43
+# library being used in your Glance installation.  For interoperability
44
+# purposes, however, we recommend that you use the set of secure hash
45
+# names supplied by the 'hashlib.algorithms_guaranteed' data member because
46
+# those algorithms are guaranteed to be supported by the 'hashlib' library
47
+# on all platforms.  Thus, any image consumer using 'hashlib' locally should
48
+# be able to verify the 'os_hash_value' of the image.
49
+#
50
+# The default value of 'sha512' is a performant secure hash algorithm.
51
+#
52
+# If this option is misconfigured, any attempts to store image data will fail.
53
+# For that reason, we recommend using the default value.
54
+#
55
+# Possible values:
56
+#     * Any secure hash algorithm name recognized by the Python 'hashlib'
57
+#       library
58
+#
59
+# Related options:
60
+#     * None
61
+#
62
+#  (string value)
63
+#hashing_algorithm = sha512
64
+
31 65
 #
32 66
 # Maximum number of image members per image.
33 67
 #
@@ -289,40 +323,6 @@
289 323
 #  (string value)
290 324
 #user_storage_quota = 0
291 325
 
292
-#
293
-# Deploy the v1 OpenStack Images API.
294
-#
295
-# When this option is set to ``True``, Glance service will respond to
296
-# requests on registered endpoints conforming to the v1 OpenStack
297
-# Images API.
298
-#
299
-# NOTES:
300
-#     * If this option is enabled, then ``enable_v1_registry`` must
301
-#       also be set to ``True`` to enable mandatory usage of Registry
302
-#       service with v1 API.
303
-#
304
-#     * If this option is disabled, then the ``enable_v1_registry``
305
-#       option, which is enabled by default, is also recommended
306
-#       to be disabled.
307
-#
308
-#     * This option is separate from ``enable_v2_api``, both v1 and v2
309
-#       OpenStack Images API can be deployed independent of each
310
-#       other.
311
-#
312
-#     * If deploying only the v2 Images API, this option, which is
313
-#       enabled by default, should be disabled.
314
-#
315
-# Possible values:
316
-#     * True
317
-#     * False
318
-#
319
-# Related options:
320
-#     * enable_v1_registry
321
-#     * enable_v2_api
322
-#
323
-#  (boolean value)
324
-#enable_v1_api = true
325
-
326 326
 #
327 327
 # Deploy the v2 OpenStack Images API.
328 328
 #
@@ -335,44 +335,18 @@
335 335
 #       option, which is enabled by default, is also recommended
336 336
 #       to be disabled.
337 337
 #
338
-#     * This option is separate from ``enable_v1_api``, both v1 and v2
339
-#       OpenStack Images API can be deployed independent of each
340
-#       other.
341
-#
342
-#     * If deploying only the v1 Images API, this option, which is
343
-#       enabled by default, should be disabled.
344
-#
345 338
 # Possible values:
346 339
 #     * True
347 340
 #     * False
348 341
 #
349 342
 # Related options:
350 343
 #     * enable_v2_registry
351
-#     * enable_v1_api
352 344
 #
353 345
 #  (boolean value)
354 346
 #enable_v2_api = true
355 347
 
356 348
 #
357
-# Deploy the v1 API Registry service.
358
-#
359
-# When this option is set to ``True``, the Registry service
360
-# will be enabled in Glance for v1 API requests.
361
-#
362
-# NOTES:
363
-#     * Use of Registry is mandatory in v1 API, so this option must
364
-#       be set to ``True`` if the ``enable_v1_api`` option is enabled.
365
-#
366
-#     * If deploying only the v2 OpenStack Images API, this option,
367
-#       which is enabled by default, should be disabled.
368
-#
369
-# Possible values:
370
-#     * True
371
-#     * False
372
-#
373
-# Related options:
374
-#     * enable_v1_api
375
-#
349
+#                     DEPRECATED FOR REMOVAL
376 350
 #  (boolean value)
377 351
 #enable_v1_registry = true
378 352
 
@@ -903,7 +877,7 @@
903 877
 # From glance.store
904 878
 #
905 879
 
906
-#
880
+# DEPRECATED:
907 881
 # List of enabled Glance stores.
908 882
 #
909 883
 # Register the storage backends to use for storing disk images
@@ -924,9 +898,18 @@
924 898
 #     * default_store
925 899
 #
926 900
 #  (list value)
901
+# This option is deprecated for removal since Rocky.
902
+# Its value may be silently ignored in the future.
903
+# Reason:
904
+# This option is deprecated against new config option
905
+# ``enabled_backends`` which helps to configure multiple backend stores
906
+# of different schemes.
907
+#
908
+# This option is scheduled for removal in the Stein development
909
+# cycle.
927 910
 #stores = file,http
928 911
 
929
-#
912
+# DEPRECATED:
930 913
 # The default scheme to use for storing images.
931 914
 #
932 915
 # Provide a string value representing the default scheme to use for
@@ -968,9 +951,18 @@
968 951
 # sheepdog - <No description provided>
969 952
 # cinder - <No description provided>
970 953
 # vsphere - <No description provided>
954
+# This option is deprecated for removal since Rocky.
955
+# Its value may be silently ignored in the future.
956
+# Reason:
957
+# This option is deprecated against new config option
958
+# ``default_backend`` which acts similar to ``default_store`` config
959
+# option.
960
+#
961
+# This option is scheduled for removal in the Stein development
962
+# cycle.
971 963
 #default_store = file
972 964
 
973
-#
965
+# DEPRECATED:
974 966
 # Minimum interval in seconds to execute updating dynamic storage
975 967
 # capabilities based on current backend status.
976 968
 #
@@ -985,14 +977,19 @@
985 977
 # By default, this option is set to zero and is disabled. Provide an
986 978
 # integer value greater than zero to enable this option.
987 979
 #
988
-# NOTE: For more information on store capabilities and their updates,
980
+# NOTE 1: For more information on store capabilities and their updates,
989 981
 # please visit: https://specs.openstack.org/openstack/glance-specs/specs/kilo
990 982
 # /store-capabilities.html
991 983
 #
992 984
 # For more information on setting up a particular store in your
993 985
 # deployment and help with the usage of this feature, please contact
994 986
 # the storage driver maintainers listed here:
995
-# http://docs.openstack.org/developer/glance_store/drivers/index.html
987
+# https://docs.openstack.org/glance_store/latest/user/drivers.html
988
+#
989
+# NOTE 2: The dynamic store update capability described above is not
990
+# implemented by any current store drivers.  Thus, this option DOES
991
+# NOT DO ANYTHING (and it never has).  It is DEPRECATED and scheduled
992
+# for removal early in the Stein development cycle.
996 993
 #
997 994
 # Possible values:
998 995
 #     * Zero
@@ -1003,6 +1000,15 @@
1003 1000
 #
1004 1001
 #  (integer value)
1005 1002
 # Minimum value: 0
1003
+# This option is deprecated for removal since Rocky.
1004
+# Its value may be silently ignored in the future.
1005
+# Reason:
1006
+# This option configures a stub method that has not been implemented
1007
+# for any existing store drivers.  Hence it is non-operational, and
1008
+# giving it a value does absolutely nothing.
1009
+#
1010
+# This option is scheduled for removal early in the Stein development
1011
+# cycle.
1006 1012
 #store_capabilities_update_min_interval = 0
1007 1013
 
1008 1014
 #
@@ -1306,7 +1312,7 @@
1306 1312
 #
1307 1313
 # More information on configuring filesystem store with multiple store
1308 1314
 # directories can be found at
1309
-# http://docs.openstack.org/developer/glance/configuring.html
1315
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
1310 1316
 #
1311 1317
 # NOTE: This directory is used only when filesystem store is used as a
1312 1318
 # storage backend. Either ``filesystem_store_datadir`` or
@@ -1357,7 +1363,7 @@
1357 1363
 # digit.
1358 1364
 #
1359 1365
 # For more information, please refer the documentation at
1360
-# http://docs.openstack.org/developer/glance/configuring.html
1366
+# https://docs.openstack.org/glance/latest/configuration/configuring.html
1361 1367
 #
1362 1368
 # Possible values:
1363 1369
 #     * A valid file access permission
@@ -1777,7 +1783,7 @@
1777 1783
 # this is 5GB. To upload objects bigger than this limit, objects are segmented
1778 1784
 # into multiple smaller objects that are tied together with a manifest file.
1779 1785
 # For more detail, refer to
1780
-# http://docs.openstack.org/developer/swift/overview_large_objects.html
1786
+# https://docs.openstack.org/swift/latest/overview_large_objects.html
1781 1787
 #
1782 1788
 # This configuration option specifies the size threshold over which the Swift
1783 1789
 # driver will start segmenting image data into multiple smaller files.

Loading…
Cancel
Save