ceph/src/common/options/rgw.yaml.in

   1 # -*- mode: YAML -*-
   2 ---
   3
   4 options:
   5 # According to AWS S3(http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html),
   6 # An ACL can have up to 100 grants.
   7 - name: rgw_acl_grants_max_num
   8   type: int
   9   level: advanced
  10   desc: Max number of ACL grants in a single request
  11   default: 100
  12   services:
  13   - rgw
  14   with_legacy: true
  15 # According to AWS S3(http://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html),
  16 # An cors can have up to 100 rules.
  17 - name: rgw_cors_rules_max_num
  18   type: int
  19   level: advanced
  20   desc: Max number of cors rules in a single request
  21   default: 100
  22   services:
  23   - rgw
  24   with_legacy: true
  25 # According to AWS S3(https://docs.aws.amazon.com/AmazonS3/latest/dev/DeletingObjects.html),
  26 # Amazon S3 also provides the Multi-Object Delete API that you can use to delete up to 1000
  27 # objects in a single HTTP request.
  28 - name: rgw_delete_multi_obj_max_num
  29   type: int
  30   level: advanced
  31   desc: Max number of objects in a single multi-object delete request
  32   default: 1000
  33   services:
  34   - rgw
  35   with_legacy: true
  36 # According to AWS S3, An website routing config can have up to 50 rules.
  37 - name: rgw_website_routing_rules_max_num
  38   type: int
  39   level: advanced
  40   desc: Max number of website routing rules in a single request
  41   default: 50
  42   services:
  43   - rgw
  44   with_legacy: true
  45 - name: rgw_rados_tracing
  46   type: bool
  47   level: advanced
  48   desc: true if LTTng-UST tracepoints should be enabled
  49   default: false
  50   services:
  51   - rgw
  52 - name: rgw_op_tracing
  53   type: bool
  54   level: advanced
  55   desc: true if LTTng-UST tracepoints should be enabled
  56   default: false
  57   services:
  58   - rgw
  59 - name: rgw_max_chunk_size
  60   type: size
  61   level: advanced
  62   desc: Set RGW max chunk size
  63   long_desc: The chunk size is the size of RADOS I/O requests that RGW sends when
  64     accessing data objects. RGW read and write operations will never request more than
  65     this amount in a single request. This also defines the RGW head object size, as
  66     head operations need to be atomic, and anything larger than this would require
  67     more than a single operation. When RGW objects are written to the default
  68     storage class, up to this amount of payload data will be stored alongside
  69     metadata in the head object.
  70   default: 4_M
  71   services:
  72   - rgw
  73   with_legacy: true
  74 - name: rgw_put_obj_min_window_size
  75   type: size
  76   level: advanced
  77   desc: The minimum RADOS write window size (in bytes).
  78   long_desc: The window size determines the total concurrent RADOS writes of a single
  79     RGW object. When writing an object RGW will send multiple chunks to RADOS. The
  80     total size of the writes does not exceed the window size. The window size may
  81     be adjusted dynamically in order to better utilize the pipe.
  82   default: 16_M
  83   services:
  84   - rgw
  85   see_also:
  86   - rgw_put_obj_max_window_size
  87   - rgw_max_chunk_size
  88   with_legacy: true
  89 - name: rgw_put_obj_max_window_size
  90   type: size
  91   level: advanced
  92   desc: The maximum RADOS write window size (in bytes).
  93   long_desc: The window size may be dynamically adjusted, but will not surpass this
  94     value.
  95   default: 64_M
  96   services:
  97   - rgw
  98   see_also:
  99   - rgw_put_obj_min_window_size
 100   - rgw_max_chunk_size
 101   with_legacy: true
 102 - name: rgw_max_put_size
 103   type: size
 104   level: advanced
 105   desc: Max size (in bytes) of regular (non multi-part) object upload.
 106   long_desc: Plain object upload is capped at this amount of data. In order to upload
 107     larger objects, a special upload mechanism is required. The S3 API provides the
 108     multi-part upload, and Swift provides DLO and SLO.
 109   default: 5_G
 110   services:
 111   - rgw
 112   with_legacy: true
 113 - name: rgw_max_put_param_size
 114   type: size
 115   level: advanced
 116   desc: The maximum size (in bytes) of data input of certain RESTful requests.
 117   default: 1_M
 118   services:
 119   - rgw
 120   with_legacy: true
 121 - name: rgw_max_attr_size
 122   type: size
 123   level: advanced
 124   desc: The maximum length of metadata value. 0 skips the check
 125   default: 0
 126   services:
 127   - rgw
 128   with_legacy: true
 129 - name: rgw_max_attr_name_len
 130   type: size
 131   level: advanced
 132   desc: The maximum length of metadata name. 0 skips the check
 133   default: 0
 134   services:
 135   - rgw
 136   with_legacy: true
 137 - name: rgw_max_attrs_num_in_req
 138   type: uint
 139   level: advanced
 140   desc: The maximum number of metadata items that can be put via single request
 141   default: 0
 142   services:
 143   - rgw
 144   with_legacy: true
 145 # override max bucket index shards in zone configuration (if not zero)
 146 #
 147 # Represents the number of shards for the bucket index object, a value of zero
 148 # indicates there is no sharding. By default (no sharding, the name of the object
 149 # is '.dir.{marker}', with sharding, the name is '.dir.{markder}.{sharding_id}',
 150 # sharding_id is zero-based value. It is not recommended to set a too large value
 151 # (e.g. thousand) as it increases the cost for bucket listing.
 152 - name: rgw_override_bucket_index_max_shards
 153   type: uint
 154   level: dev
 155   desc: The default number of bucket index shards for newly-created buckets. This
 156     value overrides bucket_index_max_shards stored in the zone. Setting this value
 157     in the zone is preferred, because it applies globally to all radosgw daemons running
 158     in the zone.
 159   fmt_desc: Represents the number of shards for the bucket index object,
 160     a value of zero indicates there is no sharding. It is not
 161     recommended to set a value too large (e.g. thousand) as it
 162     increases the cost for bucket listing.
 163     This variable should be set in the client or global sections
 164     so that it is automatically applied to radosgw-admin commands.
 165   default: 0
 166   services:
 167   - rgw
 168   with_legacy: true
 169 # Represents the maximum AIO pending requests for the bucket index object shards.
 170 - name: rgw_bucket_index_max_aio
 171   type: uint
 172   level: advanced
 173   desc: Max number of concurrent RADOS requests when handling bucket shards.
 174   default: 128
 175   services:
 176   - rgw
 177   with_legacy: true
 178 # whether or not the quota/gc threads should be started
 179 - name: rgw_enable_quota_threads
 180   type: bool
 181   level: advanced
 182   desc: Enables the quota maintenance thread.
 183   long_desc: The quota maintenance thread is responsible for quota related maintenance
 184     work. The thread itself can be disabled, but in order for quota to work correctly,
 185     at least one RGW in each zone needs to have this thread running. Having the thread
 186     enabled on multiple RGW processes within the same zone can spread some of the
 187     maintenance work between them.
 188   default: true
 189   services:
 190   - rgw
 191   see_also:
 192   - rgw_enable_gc_threads
 193   - rgw_enable_lc_threads
 194   with_legacy: true
 195 - name: rgw_enable_gc_threads
 196   type: bool
 197   level: advanced
 198   desc: Enables the garbage collection maintenance thread.
 199   long_desc: The garbage collection maintenance thread is responsible for garbage
 200     collector maintenance work. The thread itself can be disabled, but in order for
 201     garbage collection to work correctly, at least one RGW in each zone needs to have
 202     this thread running.  Having the thread enabled on multiple RGW processes within
 203     the same zone can spread some of the maintenance work between them.
 204   default: true
 205   services:
 206   - rgw
 207   see_also:
 208   - rgw_enable_quota_threads
 209   - rgw_enable_lc_threads
 210   with_legacy: true
 211 - name: rgw_enable_lc_threads
 212   type: bool
 213   level: advanced
 214   desc: Enables the lifecycle maintenance thread. This is required on at least one
 215     rgw for each zone.
 216   long_desc: The lifecycle maintenance thread is responsible for lifecycle related
 217     maintenance work. The thread itself can be disabled, but in order for lifecycle
 218     to work correctly, at least one RGW in each zone needs to have this thread running.
 219     Havingthe thread enabled on multiple RGW processes within the same zone can spread
 220     some of the maintenance work between them.
 221   default: true
 222   services:
 223   - rgw
 224   see_also:
 225   - rgw_enable_gc_threads
 226   - rgw_enable_quota_threads
 227   with_legacy: true
 228 - name: rgw_data
 229   type: str
 230   level: advanced
 231   desc: Alternative location for RGW configuration.
 232   long_desc: If this is set, the different Ceph system configurables (such as the keyring file will be located in the path that is specified here.
 233   fmt_desc: Sets the location of the data files for Ceph RADOS Gateway.
 234   default: /var/lib/ceph/radosgw/$cluster-$id
 235   services:
 236   - rgw
 237   flags:
 238   - no_mon_update
 239   with_legacy: true
 240 - name: rgw_enable_apis
 241   type: str
 242   level: advanced
 243   desc: A list of set of RESTful APIs that rgw handles.
 244   fmt_desc: |
 245     Enables the specified APIs.
 246
 247       .. note:: Enabling the ``s3`` API is a requirement for
 248                 any ``radosgw`` instance that is meant to
 249                 participate in a `multi-site <../multisite>`_
 250                 configuration.
 251   default: s3, s3website, swift, swift_auth, admin, sts, iam, notifications
 252   services:
 253   - rgw
 254   with_legacy: true
 255 - name: rgw_cache_enabled
 256   type: bool
 257   level: advanced
 258   desc: Enable RGW metadata cache.
 259   long_desc: The metadata cache holds metadata entries that RGW requires for processing
 260     requests. Metadata entries can be user info, bucket info, and bucket instance
 261     info. If not found in the cache, entries will be fetched from the backing RADOS
 262     store.
 263   fmt_desc: Whether the Ceph Object Gateway cache is enabled.
 264   default: true
 265   services:
 266   - rgw
 267   see_also:
 268   - rgw_cache_lru_size
 269   with_legacy: true
 270 - name: rgw_cache_lru_size
 271   type: int
 272   level: advanced
 273   desc: Max number of items in RGW metadata cache.
 274   long_desc: When full, the RGW metadata cache evicts least recently used entries.
 275   fmt_desc: The number of entries in the Ceph Object Gateway cache.
 276   default: 10000
 277   services:
 278   - rgw
 279   see_also:
 280   - rgw_cache_enabled
 281   with_legacy: true
 282 - name: rgw_dns_name
 283   type: str
 284   level: advanced
 285   desc: The host name that RGW uses.
 286   long_desc: This is Needed for virtual hosting of buckets to work properly, unless
 287     configured via zonegroup configuration.
 288   fmt_desc: The DNS name of the served domain. See also the ``hostnames`` setting within regions.
 289   services:
 290   - rgw
 291   with_legacy: true
 292 - name: rgw_dns_s3website_name
 293   type: str
 294   level: advanced
 295   desc: The host name that RGW uses for static websites (S3)
 296   long_desc: This is needed for virtual hosting of buckets, unless configured via
 297     zonegroup configuration.
 298   services:
 299   - rgw
 300   with_legacy: true
 301 - name: rgw_numa_node
 302   type: int
 303   level: advanced
 304   desc: set rgw's cpu affinity to a numa node (-1 for none)
 305   default: -1
 306   services:
 307   - rgw
 308   flags:
 309   - startup
 310 - name: rgw_service_provider_name
 311   type: str
 312   level: advanced
 313   desc: Service provider name which is contained in http response headers
 314   long_desc: As S3 or other cloud storage providers do, http response headers should
 315     contain the name of the provider. This name will be placed in http header 'Server'.
 316   services:
 317   - rgw
 318   with_legacy: true
 319 - name: rgw_content_length_compat
 320   type: bool
 321   level: advanced
 322   desc: Multiple content length headers compatibility
 323   long_desc: Try to handle requests with abiguous multiple content length headers
 324     (Content-Length, Http-Content-Length).
 325   fmt_desc: Enable compatibility handling of FCGI requests with both ``CONTENT_LENGTH``
 326     and ``HTTP_CONTENT_LENGTH`` set.
 327   default: false
 328   services:
 329   - rgw
 330   with_legacy: true
 331 - name: rgw_relaxed_region_enforcement
 332   type: bool
 333   level: advanced
 334   desc: Disable region constraint enforcement
 335   long_desc: Enable requests such as bucket creation to succeed irrespective of region
 336     restrictions (Jewel compat).
 337   default: false
 338   services:
 339   - rgw
 340 - name: rgw_lifecycle_work_time
 341   type: str
 342   level: advanced
 343   desc: Lifecycle allowed work time
 344   long_desc: Local time window in which the lifecycle maintenance thread can work.
 345   default: 00:00-06:00
 346   services:
 347   - rgw
 348   with_legacy: true
 349 - name: rgw_lc_lock_max_time
 350   type: int
 351   level: dev
 352   default: 90
 353   services:
 354   - rgw
 355   with_legacy: true
 356 - name: rgw_lc_thread_delay
 357   type: int
 358   level: advanced
 359   desc: Delay after processing of bucket listing chunks (i.e., per 1000 entries) in
 360     milliseconds
 361   default: 0
 362   services:
 363   - rgw
 364 - name: rgw_lc_max_worker
 365   type: int
 366   level: advanced
 367   desc: Number of LCWorker tasks that will be run in parallel
 368   long_desc: Number of LCWorker tasks that will run in parallel--used to permit >1
 369     bucket/index shards to be processed simultaneously
 370   fmt_desc: This option specifies the number of lifecycle worker threads
 371     to run in parallel, thereby processing bucket and index
 372     shards simultaneously.
 373   default: 3
 374   services:
 375   - rgw
 376   with_legacy: true
 377 - name: rgw_lc_max_wp_worker
 378   type: int
 379   level: advanced
 380   desc: Number of workpool threads per LCWorker
 381   long_desc: Number of threads in per-LCWorker workpools--used to accelerate per-bucket
 382     processing
 383   fmt_desc: This option specifies the number of threads in each lifecycle
 384     workers work pool. This option can help accelerate processing each bucket.
 385   default: 3
 386   services:
 387   - rgw
 388   with_legacy: true
 389 - name: rgw_lc_max_objs
 390   type: int
 391   level: advanced
 392   desc: Number of lifecycle data shards
 393   long_desc: Number of RADOS objects to use for storing lifecycle index. This affects
 394     concurrency of lifecycle maintenance, as shards can be processed in parallel.
 395   default: 32
 396   services:
 397   - rgw
 398   with_legacy: true
 399 - name: rgw_lc_max_rules
 400   type: uint
 401   level: advanced
 402   desc: Max number of lifecycle rules set on one bucket
 403   long_desc: Number of lifecycle rules set on one bucket should be limited.
 404   default: 1000
 405   services:
 406   - rgw
 407   with_legacy: true
 408 - name: rgw_lc_debug_interval
 409   type: int
 410   level: dev
 411   desc: The number of seconds that simulate one "day" in order to debug RGW LifeCycle.
 412     Do *not* modify for a production cluster.
 413   long_desc: For debugging RGW LifeCycle, the number of seconds that are equivalent to
 414     one simulated "day". Values less than 1 are ignored and do not change LifeCycle behavior.
 415     For example, during debugging if one wanted every 10 minutes to be equivalent to one day,
 416     then this would be set to 600, the number of seconds in 10 minutes.
 417   default: -1
 418   services:
 419   - rgw
 420   with_legacy: true
 421 - name: rgw_mp_lock_max_time
 422   type: int
 423   level: advanced
 424   desc: Multipart upload max completion time
 425   long_desc: Time length to allow completion of a multipart upload operation. This
 426     is done to prevent concurrent completions on the same object with the same upload
 427     id.
 428   default: 10_min
 429   services:
 430   - rgw
 431 - name: rgw_script_uri
 432   type: str
 433   level: dev
 434   fmt_desc: The alternative value for the ``SCRIPT_URI`` if not set
 435     in the request.
 436   services:
 437   - rgw
 438   with_legacy: true
 439 - name: rgw_request_uri
 440   type: str
 441   level: dev
 442   fmt_desc: The alternative value for the ``REQUEST_URI`` if not set
 443     in the request.
 444   services:
 445   - rgw
 446   with_legacy: true
 447 - name: rgw_ignore_get_invalid_range
 448   type: bool
 449   level: advanced
 450   desc: Treat invalid (e.g., negative) range request as full
 451   long_desc: Treat invalid (e.g., negative) range request as request for the full
 452     object (AWS compatibility)
 453   default: false
 454   services:
 455   - rgw
 456   with_legacy: true
 457 - name: rgw_swift_url
 458   type: str
 459   level: advanced
 460   desc: Swift-auth storage URL
 461   long_desc: Used in conjunction with rgw internal swift authentication. This affects
 462     the X-Storage-Url response header value.
 463   fmt_desc: The URL for the Ceph Object Gateway Swift API.
 464   services:
 465   - rgw
 466   see_also:
 467   - rgw_swift_auth_entry
 468   with_legacy: true
 469 - name: rgw_swift_url_prefix
 470   type: str
 471   level: advanced
 472   desc: Swift URL prefix
 473   long_desc: The URL path prefix for swift requests.
 474   fmt_desc: |
 475     The URL prefix for the Swift API, to distinguish it from
 476     the S3 API endpoint. The default is ``swift``, which
 477     makes the Swift API available at the URL
 478     ``http://host:port/swift/v1`` (or
 479     ``http://host:port/swift/v1/AUTH_%(tenant_id)s`` if
 480     ``rgw swift account in url`` is enabled).
 481
 482     For compatibility, setting this configuration variable
 483     to the empty string causes the default ``swift`` to be
 484     used; if you do want an empty prefix, set this option to
 485     ``/``.
 486
 487     .. warning:: If you set this option to ``/``, you must
 488                  disable the S3 API by modifying ``rgw
 489                  enable apis`` to exclude ``s3``. It is not
 490                  possible to operate radosgw with ``rgw
 491                  swift url prefix = /`` and simultaneously
 492                  support both the S3 and Swift APIs. If you
 493                  do need to support both APIs without
 494                  prefixes, deploy multiple radosgw instances
 495                  to listen on different hosts (or ports)
 496                  instead, enabling some for S3 and some for
 497                  Swift.
 498   example: /swift-testing
 499   default: swift
 500   services:
 501   - rgw
 502   with_legacy: true
 503 - name: rgw_swift_auth_url
 504   type: str
 505   level: advanced
 506   desc: Swift auth URL
 507   long_desc: Default url to which RGW connects and verifies tokens for v1 auth (if
 508     not using internal swift auth).
 509   services:
 510   - rgw
 511   with_legacy: true
 512 - name: rgw_swift_auth_entry
 513   type: str
 514   level: advanced
 515   desc: Swift auth URL prefix
 516   long_desc: URL path prefix for internal swift auth requests.
 517   fmt_desc: The entry point for a Swift auth URL.
 518   default: auth
 519   services:
 520   - rgw
 521   see_also:
 522   - rgw_swift_url
 523   with_legacy: true
 524 - name: rgw_swift_tenant_name
 525   type: str
 526   level: advanced
 527   desc: Swift tenant name
 528   long_desc: Tenant name that is used when constructing the swift path.
 529   services:
 530   - rgw
 531   see_also:
 532   - rgw_swift_account_in_url
 533   with_legacy: true
 534 - name: rgw_swift_account_in_url
 535   type: bool
 536   level: advanced
 537   desc: Swift account encoded in URL
 538   long_desc: Whether the swift account is encoded in the uri path (AUTH_<account>).
 539   fmt_desc: |
 540     Whether or not the Swift account name should be included
 541     in the Swift API URL.
 542     If set to ``false`` (the default), then the Swift API
 543     will listen on a URL formed like
 544     ``http://host:port/<rgw_swift_url_prefix>/v1``, and the
 545     account name (commonly a Keystone project UUID if
 546     radosgw is configured with `Keystone integration
 547     <../keystone>`_) will be inferred from request
 548     headers.
 549     If set to ``true``, the Swift API URL will be
 550     ``http://host:port/<rgw_swift_url_prefix>/v1/AUTH_<account_name>``
 551     (or
 552     ``http://host:port/<rgw_swift_url_prefix>/v1/AUTH_<keystone_project_id>``)
 553     instead, and the Keystone ``object-store`` endpoint must
 554     accordingly be configured to include the
 555     ``AUTH_%(tenant_id)s`` suffix.
 556     You **must** set this option to ``true`` (and update the
 557     Keystone service catalog) if you want radosgw to support
 558     publicly-readable containers and `temporary URLs
 559     <../swift/tempurl>`_.
 560   default: false
 561   services:
 562   - rgw
 563   see_also:
 564   - rgw_swift_tenant_name
 565   with_legacy: true
 566 - name: rgw_swift_enforce_content_length
 567   type: bool
 568   level: advanced
 569   desc: Send content length when listing containers (Swift)
 570   long_desc: Whether content length header is needed when listing containers. When
 571     this is set to false, RGW will send extra info for each entry in the response.
 572   default: false
 573   services:
 574   - rgw
 575   with_legacy: true
 576 - name: rgw_keystone_url
 577   type: str
 578   level: basic
 579   desc: The URL to the Keystone server.
 580   services:
 581   - rgw
 582   with_legacy: true
 583 - name: rgw_keystone_admin_token
 584   type: str
 585   level: advanced
 586   desc: 'DEPRECATED: The admin token (shared secret) that is used for the Keystone
 587     requests.'
 588   fmt_desc: The Keystone admin token (shared secret). In Ceph RGW
 589     authentication with the admin token has priority over
 590     authentication with the admin credentials
 591     (``rgw_keystone_admin_user``, ``rgw_keystone_admin_password``,
 592     ``rgw_keystone_admin_tenant``, ``rgw_keystone_admin_project``,
 593     ``rgw_keystone_admin_domain``). The Keystone admin token
 594     has been deprecated, but can be used to integrate with
 595     older environments.  It is preferred to instead configure
 596     ``rgw_keystone_admin_token_path`` to avoid exposing the token.
 597   services:
 598   - rgw
 599   with_legacy: true
 600 - name: rgw_keystone_admin_token_path
 601   type: str
 602   level: advanced
 603   desc: Path to a file containing the admin token (shared secret) that is used for
 604     the Keystone requests.
 605   fmt_desc: Path to a file containing the Keystone admin token
 606     (shared secret).  In Ceph RadosGW authentication with
 607     the admin token has priority over authentication with
 608     the admin credentials
 609     (``rgw_keystone_admin_user``, ``rgw_keystone_admin_password``,
 610     ``rgw_keystone_admin_tenant``, ``rgw_keystone_admin_project``,
 611     ``rgw_keystone_admin_domain``).
 612     The Keystone admin token has been deprecated, but can be
 613     used to integrate with older environments.
 614   services:
 615   - rgw
 616   with_legacy: true
 617 - name: rgw_keystone_admin_user
 618   type: str
 619   level: advanced
 620   desc: Keystone admin user.
 621   fmt_desc: The name of OpenStack user with admin privilege for Keystone
 622     authentication (Service User) when using OpenStack Identity API v2
 623   services:
 624   - rgw
 625   with_legacy: true
 626 - name: rgw_keystone_admin_password
 627   type: str
 628   level: advanced
 629   desc: 'DEPRECATED: Keystone admin password.'
 630   fmt_desc: The password for OpenStack admin user when using OpenStack
 631     Identity API v2.  It is preferred to instead configure
 632     ``rgw_keystone_admin_password_path`` to avoid exposing the token.
 633   services:
 634   - rgw
 635   with_legacy: true
 636 - name: rgw_keystone_admin_password_path
 637   type: str
 638   level: advanced
 639   desc: Path to a file containing the Keystone admin password.
 640   fmt_desc: Path to a file containing the password for OpenStack
 641     admin user when using OpenStack Identity API v2.
 642   services:
 643   - rgw
 644   with_legacy: true
 645 - name: rgw_keystone_admin_tenant
 646   type: str
 647   level: advanced
 648   desc: Keystone admin user tenant.
 649   fmt_desc: The name of OpenStack tenant with admin privilege (Service Tenant) when
 650     using OpenStack Identity API v2
 651   services:
 652   - rgw
 653   with_legacy: true
 654 - name: rgw_keystone_admin_project
 655   type: str
 656   level: advanced
 657   desc: Keystone admin user project (for Keystone v3).
 658   fmt_desc: The name of OpenStack project with admin privilege when using
 659     OpenStack Identity API v3. If left unspecified, value of
 660     ``rgw keystone admin tenant`` will be used instead.
 661   services:
 662   - rgw
 663   with_legacy: true
 664 - name: rgw_keystone_admin_domain
 665   type: str
 666   level: advanced
 667   desc: Keystone admin user domain (for Keystone v3).
 668   fmt_desc: The name of OpenStack domain with admin privilege when using
 669     OpenStack Identity API v3.
 670   services:
 671   - rgw
 672   with_legacy: true
 673 - name: rgw_keystone_barbican_user
 674   type: str
 675   level: advanced
 676   desc: Keystone user to access barbican secrets.
 677   fmt_desc: The name of the OpenStack user with access to the `Barbican`_
 678     secrets used for `Encryption`_.
 679   services:
 680   - rgw
 681   with_legacy: true
 682 - name: rgw_keystone_barbican_password
 683   type: str
 684   level: advanced
 685   desc: Keystone password for barbican user.
 686   fmt_desc: The password associated with the `Barbican`_ user.
 687   services:
 688   - rgw
 689   with_legacy: true
 690 - name: rgw_keystone_barbican_tenant
 691   type: str
 692   level: advanced
 693   desc: Keystone barbican user tenant (Keystone v2.0).
 694   fmt_desc: The name of the OpenStack tenant associated with the `Barbican`_
 695     user when using OpenStack Identity API v2.
 696   services:
 697   - rgw
 698   with_legacy: true
 699 - name: rgw_keystone_barbican_project
 700   type: str
 701   level: advanced
 702   desc: Keystone barbican user project (Keystone v3).
 703   fmt_desc: The name of the OpenStack project associated with the `Barbican`_
 704     user when using OpenStack Identity API v3.
 705   services:
 706   - rgw
 707   with_legacy: true
 708 - name: rgw_keystone_barbican_domain
 709   type: str
 710   level: advanced
 711   desc: Keystone barbican user domain.
 712   fmt_desc: The name of the OpenStack domain associated with the `Barbican`_
 713     user when using OpenStack Identity API v3.
 714   services:
 715   - rgw
 716   with_legacy: true
 717 - name: rgw_keystone_api_version
 718   type: int
 719   level: advanced
 720   desc: Version of Keystone API to use (2 or 3).
 721   fmt_desc: The version (2 or 3) of OpenStack Identity API that should be
 722     used for communication with the Keystone server.
 723   default: 2
 724   services:
 725   - rgw
 726   with_legacy: true
 727 - name: rgw_keystone_accepted_roles
 728   type: str
 729   level: advanced
 730   desc: Only users with one of these roles will be served when doing Keystone authentication.
 731   fmt_desc: The roles required to serve requests.
 732   default: Member, admin
 733   services:
 734   - rgw
 735   with_legacy: true
 736 - name: rgw_keystone_accepted_admin_roles
 737   type: str
 738   level: advanced
 739   desc: List of roles allowing user to gain admin privileges (Keystone).
 740   services:
 741   - rgw
 742   with_legacy: true
 743 - name: rgw_keystone_token_cache_size
 744   type: int
 745   level: advanced
 746   desc: Keystone token cache size
 747   long_desc: Max number of Keystone tokens that will be cached. Token that is not
 748     cached requires RGW to access the Keystone server when authenticating.
 749   fmt_desc: The maximum number of entries in each Keystone token cache.
 750   default: 10000
 751   services:
 752   - rgw
 753   with_legacy: true
 754 - name: rgw_keystone_verify_ssl
 755   type: bool
 756   level: advanced
 757   desc: Should RGW verify the Keystone server SSL certificate.
 758   fmt_desc: Verify SSL certificates while making token requests to keystone.
 759   default: true
 760   services:
 761   - rgw
 762   with_legacy: true
 763 - name: rgw_keystone_implicit_tenants
 764   type: str
 765   level: advanced
 766   desc: RGW Keystone implicit tenants creation
 767   long_desc: Implicitly create new users in their own tenant with the same name when
 768     authenticating via Keystone.  Can be limited to s3 or swift only.
 769   default: 'false'
 770   services:
 771   - rgw
 772   enum_values:
 773   - 'false'
 774   - 'true'
 775   - swift
 776   - s3
 777   - both
 778   - '0'
 779   - '1'
 780   - none
 781   with_legacy: true
 782 - name: rgw_cross_domain_policy
 783   type: str
 784   level: advanced
 785   desc: RGW handle cross domain policy
 786   long_desc: Returned cross domain policy when accessing the crossdomain.xml resource
 787     (Swift compatiility).
 788   default: <allow-access-from domain="*" secure="false" />
 789   services:
 790   - rgw
 791   with_legacy: true
 792 - name: rgw_healthcheck_disabling_path
 793   type: str
 794   level: dev
 795   desc: Swift health check api can be disabled if a file can be accessed in this path.
 796   services:
 797   - rgw
 798   with_legacy: true
 799 - name: rgw_s3_auth_use_rados
 800   type: bool
 801   level: advanced
 802   desc: Should S3 authentication use credentials stored in RADOS backend.
 803   default: true
 804   services:
 805   - rgw
 806   with_legacy: true
 807 - name: rgw_s3_auth_use_keystone
 808   type: bool
 809   level: advanced
 810   desc: Should S3 authentication use Keystone.
 811   default: false
 812   services:
 813   - rgw
 814   with_legacy: true
 815 - name: rgw_s3_auth_order
 816   type: str
 817   level: advanced
 818   desc: Authentication strategy order to use for s3 authentication
 819   long_desc: Order of authentication strategies to try for s3 authentication, the
 820     allowed options are a comma separated list of engines external, local. The default
 821     order is to try all the externally configured engines before attempting local
 822     rados based authentication
 823   default: sts, external, local
 824   services:
 825   - rgw
 826   with_legacy: true
 827 - name: rgw_barbican_url
 828   type: str
 829   level: advanced
 830   desc: URL to barbican server.
 831   fmt_desc: The URL for the Barbican server.
 832   services:
 833   - rgw
 834   with_legacy: true
 835 # OpenLDAP-style LDAP parameter strings
 836 - name: rgw_ldap_uri
 837   type: str
 838   level: advanced
 839   desc: Space-separated list of LDAP servers in URI format.
 840   default: ldaps://<ldap.your.domain>
 841   services:
 842   - rgw
 843   with_legacy: true
 844 - name: rgw_ldap_binddn
 845   type: str
 846   level: advanced
 847   desc: LDAP entry RGW will bind with (user match).
 848   default: uid=admin,cn=users,dc=example,dc=com
 849   services:
 850   - rgw
 851   with_legacy: true
 852 - name: rgw_ldap_searchdn
 853   type: str
 854   level: advanced
 855   desc: LDAP search base (basedn).
 856   default: cn=users,cn=accounts,dc=example,dc=com
 857   services:
 858   - rgw
 859   with_legacy: true
 860 - name: rgw_ldap_dnattr
 861   type: str
 862   level: advanced
 863   desc: LDAP attribute containing RGW user names (to form binddns).
 864   default: uid
 865   services:
 866   - rgw
 867   with_legacy: true
 868 - name: rgw_ldap_secret
 869   type: str
 870   level: advanced
 871   desc: Path to file containing credentials for rgw_ldap_binddn.
 872   default: /etc/openldap/secret
 873   services:
 874   - rgw
 875   with_legacy: true
 876 - name: rgw_s3_auth_use_ldap
 877   type: bool
 878   level: advanced
 879   desc: Should S3 authentication use LDAP.
 880   default: false
 881   services:
 882   - rgw
 883   with_legacy: true
 884 - name: rgw_ldap_searchfilter
 885   type: str
 886   level: advanced
 887   desc: LDAP search filter.
 888   services:
 889   - rgw
 890   with_legacy: true
 891 - name: rgw_opa_url
 892   type: str
 893   level: advanced
 894   desc: URL to OPA server.
 895   services:
 896   - rgw
 897   with_legacy: true
 898 - name: rgw_opa_token
 899   type: str
 900   level: advanced
 901   desc: The Bearer token OPA uses to authenticate client requests.
 902   services:
 903   - rgw
 904   with_legacy: true
 905 - name: rgw_opa_verify_ssl
 906   type: bool
 907   level: advanced
 908   desc: Should RGW verify the OPA server SSL certificate.
 909   default: true
 910   services:
 911   - rgw
 912   with_legacy: true
 913 - name: rgw_use_opa_authz
 914   type: bool
 915   level: advanced
 916   desc: Should OPA be used to authorize client requests.
 917   default: false
 918   services:
 919   - rgw
 920   with_legacy: true
 921 - name: rgw_admin_entry
 922   type: str
 923   level: advanced
 924   desc: Path prefix to be used for accessing RGW RESTful admin API.
 925   fmt_desc: The entry point for an admin request URL.
 926   default: admin
 927   services:
 928   - rgw
 929   with_legacy: true
 930 - name: rgw_enforce_swift_acls
 931   type: bool
 932   level: advanced
 933   desc: RGW enforce swift acls
 934   long_desc: Should RGW enforce special Swift-only ACLs. Swift has a special ACL that
 935     gives permission to access all objects in a container.
 936   fmt_desc: Enforces the Swift Access Control List (ACL) settings.
 937   default: true
 938   services:
 939   - rgw
 940   with_legacy: true
 941 - name: rgw_swift_token_expiration
 942   type: int
 943   level: advanced
 944   desc: Expiration time (in seconds) for token generated through RGW Swift auth.
 945   fmt_desc: The time in seconds for expiring a Swift token.
 946   default: 1_day
 947   services:
 948   - rgw
 949   with_legacy: true
 950 - name: rgw_print_continue
 951   type: bool
 952   level: advanced
 953   desc: RGW support of 100-continue
 954   long_desc: Should RGW explicitly send 100 (continue) responses. This is mainly relevant
 955     when using FastCGI, as some FastCGI modules do not fully support this feature.
 956   fmt_desc: Enable ``100-continue`` if it is operational.
 957   default: true
 958   services:
 959   - rgw
 960   with_legacy: true
 961 - name: rgw_print_prohibited_content_length
 962   type: bool
 963   level: advanced
 964   desc: RGW RFC-7230 compatibility
 965   long_desc: Specifies whether RGW violates RFC 7230 and sends Content-Length with
 966     204 or 304 statuses.
 967   default: false
 968   services:
 969   - rgw
 970   with_legacy: true
 971 - name: rgw_remote_addr_param
 972   type: str
 973   level: advanced
 974   desc: HTTP header that holds the remote address in incoming requests.
 975   long_desc: RGW will use this header to extract requests origin. When RGW runs behind
 976     a reverse proxy, the remote address header will point at the proxy's address and
 977     not at the originator's address. Therefore it is sometimes possible to have the
 978     proxy add the originator's address in a separate HTTP header, which will allow
 979     RGW to log it correctly.
 980   fmt_desc: The remote address parameter. For example, the HTTP field
 981     containing the remote address, or the ``X-Forwarded-For``
 982     address if a reverse proxy is operational.
 983   default: REMOTE_ADDR
 984   services:
 985   - rgw
 986   see_also:
 987   - rgw_enable_ops_log
 988   with_legacy: true
 989 - name: rgw_op_thread_timeout
 990   type: int
 991   level: dev
 992   desc: Timeout for async rados coroutine operations.
 993   fmt_desc: The timeout in seconds for open threads.
 994   default: 10_min
 995   services:
 996   - rgw
 997   with_legacy: true
 998 - name: rgw_op_thread_suicide_timeout
 999   type: int
1000   level: dev
1001   default: 0
1002   fmt_desc: The time ``timeout`` in seconds before a Ceph Object Gateway
1003     process dies. Disabled if set to ``0``.
1004   services:
1005   - rgw
1006   with_legacy: true
1007 - name: rgw_thread_pool_size
1008   type: int
1009   level: basic
1010   desc: RGW requests handling thread pool size.
1011   long_desc: This parameter determines the number of concurrent requests RGW can process
1012     when using either the civetweb, or the fastcgi frontends. The higher this number
1013     is, RGW will be able to deal with more concurrent requests at the cost of more
1014     resource utilization.
1015   fmt_desc: The size of the thread pool.
1016   default: 512
1017   services:
1018   - rgw
1019   with_legacy: true
1020 - name: rgw_num_control_oids
1021   type: int
1022   level: advanced
1023   desc: Number of control objects used for cross-RGW communication.
1024   long_desc: RGW uses certain control objects to send messages between different RGW
1025     processes running on the same zone. These messages include metadata cache invalidation
1026     info that is being sent when metadata is modified (such as user or bucket information).
1027     A higher number of control objects allows better concurrency of these messages,
1028     at the cost of more resource utilization.
1029   fmt_desc: The number of notification objects used for cache synchronization
1030     between different ``rgw`` instances.
1031   default: 8
1032   services:
1033   - rgw
1034   with_legacy: true
1035 - name: rgw_verify_ssl
1036   type: bool
1037   level: advanced
1038   desc: Should RGW verify SSL when connecing to a remote HTTP server
1039   long_desc: RGW can send requests to other RGW servers (e.g., in multi-site sync
1040     work). This configurable selects whether RGW should verify the certificate for
1041     the remote peer and host.
1042   fmt_desc: Verify SSL certificates while making requests.
1043   default: true
1044   services:
1045   - rgw
1046   see_also:
1047   - rgw_keystone_verify_ssl
1048   with_legacy: true
1049 # The following are tunables for caches of RGW NFS (and other file
1050 # client) objects.
1051 #
1052 # The file handle cache is a partitioned hash table
1053 # (fhcache_partitions), each with a closed hash part and backing
1054 # b-tree mapping.  The number of partions is expected to be a small
1055 # prime, the cache size something larger but less than 5K, the total
1056 # size of the cache is n_part *  cache_size.
1057 - name: rgw_nfs_lru_lanes
1058   type: int
1059   level: advanced
1060   default: 5
1061   services:
1062   - rgw
1063   with_legacy: true
1064 - name: rgw_nfs_lru_lane_hiwat
1065   type: int
1066   level: advanced
1067   default: 911
1068   services:
1069   - rgw
1070   with_legacy: true
1071 - name: rgw_nfs_fhcache_partitions
1072   type: int
1073   level: advanced
1074   default: 3
1075   services:
1076   - rgw
1077   with_legacy: true
1078 - name: rgw_nfs_fhcache_size
1079   type: int
1080   level: advanced
1081   default: 2017
1082   services:
1083   - rgw
1084   with_legacy: true
1085 - name: rgw_nfs_namespace_expire_secs
1086   type: int
1087   level: advanced
1088   default: 5_min
1089   services:
1090   - rgw
1091   min: 1
1092   with_legacy: true
1093 - name: rgw_nfs_max_gc
1094   type: int
1095   level: advanced
1096   default: 5_min
1097   services:
1098   - rgw
1099   min: 1
1100   with_legacy: true
1101 - name: rgw_nfs_write_completion_interval_s
1102   type: int
1103   level: advanced
1104   default: 10
1105   services:
1106   - rgw
1107   with_legacy: true
1108 # use fast S3 attrs from bucket index--currently assumes NFS mounts are immutable
1109 - name: rgw_nfs_s3_fast_attrs
1110   type: bool
1111   level: advanced
1112   desc: use fast S3 attrs from bucket index (immutable only)
1113   long_desc: use fast S3 attrs from bucket index (assumes NFS mounts are immutable)
1114   default: false
1115   services:
1116   - rgw
1117   with_legacy: true
1118 # overrides for librgw/nfs
1119 - name: rgw_nfs_run_gc_threads
1120   type: bool
1121   level: advanced
1122   desc: run GC threads in librgw (default off)
1123   default: false
1124   services:
1125   - rgw
1126   with_legacy: true
1127 - name: rgw_nfs_run_lc_threads
1128   type: bool
1129   level: advanced
1130   desc: run lifecycle threads in librgw (default off)
1131   default: false
1132   services:
1133   - rgw
1134   with_legacy: true
1135 - name: rgw_nfs_run_quota_threads
1136   type: bool
1137   level: advanced
1138   desc: run quota threads in librgw (default off)
1139   default: false
1140   services:
1141   - rgw
1142   with_legacy: true
1143 - name: rgw_nfs_run_sync_thread
1144   type: bool
1145   level: advanced
1146   desc: run sync thread in librgw (default off)
1147   default: false
1148   services:
1149   - rgw
1150   with_legacy: true
1151 - name: rgw_rados_pool_autoscale_bias
1152   type: float
1153   level: advanced
1154   desc: pg_autoscale_bias value for RGW metadata (omap-heavy) pools
1155   default: 4
1156   services:
1157   - rgw
1158   min: 0.01
1159   max: 100000
1160 - name: rgw_rados_pool_pg_num_min
1161   type: uint
1162   level: advanced
1163   desc: pg_num_min value for RGW metadata (omap-heavy) pools
1164   default: 8
1165   services:
1166   - rgw
1167   min: 1
1168   max: 1_K
1169 - name: rgw_rados_pool_recovery_priority
1170   type: uint
1171   level: advanced
1172   desc: recovery_priority value for RGW metadata (omap-heavy) pools
1173   default: 5
1174   services:
1175   - rgw
1176   min: -10
1177   max: 10
1178 - name: rgw_zone
1179   type: str
1180   level: advanced
1181   desc: Zone name
1182   fmt_desc: The name of the zone for the gateway instance. If no zone is
1183     set, a cluster-wide default can be configured with the command
1184     ``radosgw-admin zone default``.
1185   services:
1186   - rgw
1187   see_also:
1188   - rgw_zonegroup
1189   - rgw_realm
1190   with_legacy: true
1191 - name: rgw_zone_id
1192   type: str
1193   level: advanced
1194   desc: Zone ID
1195   services:
1196   - rgw
1197   see_also:
1198   - rgw_zone
1199   - rgw_zonegroup
1200   - rgw_realm
1201 - name: rgw_zone_root_pool
1202   type: str
1203   level: advanced
1204   desc: Zone root pool name
1205   long_desc: The zone root pool, is the pool where the RGW zone configuration located.
1206   default: .rgw.root
1207   services:
1208   - rgw
1209   see_also:
1210   - rgw_zonegroup_root_pool
1211   - rgw_realm_root_pool
1212   - rgw_period_root_pool
1213   with_legacy: true
1214 - name: rgw_default_zone_info_oid
1215   type: str
1216   level: advanced
1217   desc: Default zone info object id
1218   long_desc: Name of the RADOS object that holds the default zone information.
1219   default: default.zone
1220   services:
1221   - rgw
1222   with_legacy: true
1223 - name: rgw_region
1224   type: str
1225   level: advanced
1226   desc: Region name
1227   long_desc: Obsolete config option. The rgw_zonegroup option should be used instead.
1228   services:
1229   - rgw
1230   see_also:
1231   - rgw_zonegroup
1232   with_legacy: true
1233 - name: rgw_region_root_pool
1234   type: str
1235   level: advanced
1236   desc: Region root pool
1237   long_desc: Obsolete config option. The rgw_zonegroup_root_pool should be used instead.
1238   default: .rgw.root
1239   services:
1240   - rgw
1241   see_also:
1242   - rgw_zonegroup_root_pool
1243   with_legacy: true
1244 - name: rgw_default_region_info_oid
1245   type: str
1246   level: advanced
1247   desc: Default region info object id
1248   long_desc: Obsolete config option. The rgw_default_zonegroup_info_oid should be
1249     used instead.
1250   default: default.region
1251   services:
1252   - rgw
1253   see_also:
1254   - rgw_default_zonegroup_info_oid
1255   with_legacy: true
1256 - name: rgw_zonegroup
1257   type: str
1258   level: advanced
1259   desc: Zonegroup name
1260   fmt_desc: The name of the zonegroup for the gateway instance. If no
1261     zonegroup is set, a cluster-wide default can be configured with
1262     the command ``radosgw-admin zonegroup default``.
1263   services:
1264   - rgw
1265   see_also:
1266   - rgw_zone
1267   - rgw_realm
1268   with_legacy: true
1269 - name: rgw_zonegroup_id
1270   type: str
1271   level: advanced
1272   desc: Zonegroup ID
1273   services:
1274   - rgw
1275   see_also:
1276   - rgw_zone
1277   - rgw_zonegroup
1278   - rgw_realm
1279 - name: rgw_zonegroup_root_pool
1280   type: str
1281   level: advanced
1282   desc: Zonegroup root pool
1283   long_desc: The zonegroup root pool, is the pool where the RGW zonegroup configuration
1284     located.
1285   default: .rgw.root
1286   services:
1287   - rgw
1288   see_also:
1289   - rgw_zone_root_pool
1290   - rgw_realm_root_pool
1291   - rgw_period_root_pool
1292   with_legacy: true
1293 - name: rgw_default_zonegroup_info_oid
1294   type: str
1295   level: advanced
1296   default: default.zonegroup
1297   services:
1298   - rgw
1299   with_legacy: true
1300 - name: rgw_realm
1301   type: str
1302   level: advanced
1303   fmt_desc: The name of the realm for the gateway instance. If no realm is
1304     set, a cluster-wide default can be configured with the command
1305     ``radosgw-admin realm default``.
1306   services:
1307   - rgw
1308   with_legacy: true
1309 - name: rgw_realm_id
1310   type: str
1311   level: advanced
1312   services:
1313   - rgw
1314 - name: rgw_realm_root_pool
1315   type: str
1316   level: advanced
1317   desc: Realm root pool
1318   long_desc: The realm root pool, is the pool where the RGW realm configuration located.
1319   default: .rgw.root
1320   services:
1321   - rgw
1322   see_also:
1323   - rgw_zonegroup_root_pool
1324   - rgw_zone_root_pool
1325   - rgw_period_root_pool
1326   with_legacy: true
1327 - name: rgw_default_realm_info_oid
1328   type: str
1329   level: advanced
1330   default: default.realm
1331   services:
1332   - rgw
1333   with_legacy: true
1334 - name: rgw_period_root_pool
1335   type: str
1336   level: advanced
1337   desc: Period root pool
1338   long_desc: The period root pool, is the pool where the RGW period configuration
1339     located.
1340   default: .rgw.root
1341   services:
1342   - rgw
1343   see_also:
1344   - rgw_zonegroup_root_pool
1345   - rgw_zone_root_pool
1346   - rgw_realm_root_pool
1347   with_legacy: true
1348 - name: rgw_period_latest_epoch_info_oid
1349   type: str
1350   level: dev
1351   default: .latest_epoch
1352   services:
1353   - rgw
1354   with_legacy: true
1355 - name: rgw_log_nonexistent_bucket
1356   type: bool
1357   level: advanced
1358   desc: Should RGW log operations on bucket that does not exist
1359   long_desc: This config option applies to the ops log. When this option is set, the
1360     ops log will log operations that are sent to non existing buckets. These operations
1361     inherently fail, and do not correspond to a specific user.
1362   fmt_desc: Enables Ceph Object Gateway to log a request for a non-existent
1363     bucket.
1364   default: false
1365   services:
1366   - rgw
1367   see_also:
1368   - rgw_enable_ops_log
1369   with_legacy: true
1370 # man date to see codes (a subset are supported)
1371 - name: rgw_log_object_name
1372   type: str
1373   level: advanced
1374   desc: Ops log object name format
1375   long_desc: Defines the format of the RADOS objects names that ops log uses to store
1376     ops log data
1377   fmt_desc: The logging format for an object name. See ma npage
1378     :manpage:`date` for details about format specifiers.
1379   default: '%Y-%m-%d-%H-%i-%n'
1380   services:
1381   - rgw
1382   see_also:
1383   - rgw_enable_ops_log
1384   with_legacy: true
1385 - name: rgw_log_object_name_utc
1386   type: bool
1387   level: advanced
1388   desc: Should ops log object name based on UTC
1389   long_desc: If set, the names of the RADOS objects that hold the ops log data will
1390     be based on UTC time zone. If not set, it will use the local time zone.
1391   fmt_desc: Whether a logged object name includes a UTC time.
1392     If ``false``, it uses the local time.
1393   default: false
1394   services:
1395   - rgw
1396   see_also:
1397   - rgw_enable_ops_log
1398   - rgw_log_object_name
1399   with_legacy: true
1400 - name: rgw_usage_max_shards
1401   type: int
1402   level: advanced
1403   desc: Number of shards for usage log.
1404   long_desc: The number of RADOS objects that RGW will use in order to store the usage
1405     log data.
1406   fmt_desc: The maximum number of shards for usage logging.
1407   default: 32
1408   services:
1409   - rgw
1410   see_also:
1411   - rgw_enable_usage_log
1412   with_legacy: true
1413 - name: rgw_usage_max_user_shards
1414   type: int
1415   level: advanced
1416   desc: Number of shards for single user in usage log
1417   long_desc: The number of shards that a single user will span over in the usage log.
1418   fmt_desc: The maximum number of shards used for a single user's
1419     usage logging.
1420   default: 1
1421   services:
1422   - rgw
1423   see_also:
1424   - rgw_enable_usage_log
1425   min: 1
1426   with_legacy: true
1427 # enable logging every rgw operation
1428 - name: rgw_enable_ops_log
1429   type: bool
1430   level: advanced
1431   desc: Enable ops log
1432   fmt_desc: Enable logging for each successful Ceph Object Gateway operation.
1433   default: false
1434   services:
1435   - rgw
1436   see_also:
1437   - rgw_log_nonexistent_bucket
1438   - rgw_log_object_name
1439   - rgw_ops_log_rados
1440   - rgw_ops_log_socket_path
1441   - rgw_ops_log_file_path
1442   with_legacy: true
1443 # enable logging bandwidth usage
1444 - name: rgw_enable_usage_log
1445   type: bool
1446   level: advanced
1447   desc: Enable the usage log
1448   default: false
1449   services:
1450   - rgw
1451   see_also:
1452   - rgw_usage_max_shards
1453   with_legacy: true
1454 # whether ops log should go to rados
1455 - name: rgw_ops_log_rados
1456   type: bool
1457   level: advanced
1458   desc: Use RADOS for ops log
1459   long_desc: If set, RGW will store ops log information in RADOS.
1460   fmt_desc: Whether the operations log should be written to the
1461     Ceph Storage Cluster backend.
1462   default: true
1463   services:
1464   - rgw
1465   see_also:
1466   - rgw_enable_ops_log
1467   with_legacy: true
1468 # path to unix domain socket where ops log can go
1469 - name: rgw_ops_log_socket_path
1470   type: str
1471   level: advanced
1472   desc: Unix domain socket path for ops log.
1473   long_desc: Path to unix domain socket that RGW will listen for connection on. When
1474     connected, RGW will send ops log data through it.
1475   fmt_desc: The Unix domain socket for writing operations logs.
1476   services:
1477   - rgw
1478   see_also:
1479   - rgw_enable_ops_log
1480   - rgw_ops_log_data_backlog
1481   with_legacy: true
1482 # path to file where ops log can go
1483 - name: rgw_ops_log_file_path
1484   type: str
1485   level: advanced
1486   desc: File-system path for ops log.
1487   long_desc: Path to file that RGW will log ops logs to.
1488   fmt_desc: The file-system path for writing operations logs.
1489   services:
1490   - rgw
1491   see_also:
1492   - rgw_enable_ops_log
1493   with_legacy: true
1494 # max data backlog for ops log
1495 - name: rgw_ops_log_data_backlog
1496   type: size
1497   level: advanced
1498   desc: Ops log socket backlog
1499   long_desc: Maximum amount of data backlog that RGW can keep when ops log is configured
1500     to send info through unix domain socket. When data backlog is higher than this,
1501     ops log entries will be lost. In order to avoid ops log information loss, the
1502     listener needs to clear data (by reading it) quickly enough.
1503   fmt_desc: The maximum data backlog data size for operations logs written
1504     to a Unix domain socket.
1505   default: 5_M
1506   services:
1507   - rgw
1508   see_also:
1509   - rgw_enable_ops_log
1510   - rgw_ops_log_socket_path
1511   with_legacy: true
1512 - name: rgw_usage_log_flush_threshold
1513   type: int
1514   level: advanced
1515   desc: Number of entries in usage log before flushing
1516   long_desc: This is the max number of entries that will be held in the usage log,
1517     before it will be flushed to the backend. Note that the usage log is periodically
1518     flushed, even if number of entries does not reach this threshold. A usage log
1519     entry corresponds to one or more operations on a single bucket.i
1520   fmt_desc: The number of dirty merged entries in the usage log before
1521     flushing synchronously.
1522   default: 1024
1523   services:
1524   - rgw
1525   see_also:
1526   - rgw_enable_usage_log
1527   - rgw_usage_log_tick_interval
1528   with_legacy: true
1529 - name: rgw_usage_log_tick_interval
1530   type: int
1531   level: advanced
1532   desc: Number of seconds between usage log flush cycles
1533   long_desc: The number of seconds between consecutive usage log flushes. The usage
1534     log will also flush itself to the backend if the number of pending entries reaches
1535     a certain threshold.
1536   fmt_desc: Flush pending usage log data every ``n`` seconds.
1537   default: 30
1538   services:
1539   - rgw
1540   see_also:
1541   - rgw_enable_usage_log
1542   - rgw_usage_log_flush_threshold
1543   with_legacy: true
1544 - name: rgw_init_timeout
1545   type: int
1546   level: basic
1547   desc: Initialization timeout
1548   long_desc: The time length (in seconds) that RGW will allow for its initialization.
1549     RGW process will give up and quit if initialization is not complete after this
1550     amount of time.
1551   fmt_desc: The number of seconds before Ceph Object Gateway gives up on
1552     initialization.
1553   default: 5_min
1554   services:
1555   - rgw
1556   with_legacy: true
1557 - name: rgw_mime_types_file
1558   type: str
1559   level: basic
1560   desc: Path to local mime types file
1561   long_desc: The mime types file is needed in Swift when uploading an object. If object's
1562     content type is not specified, RGW will use data from this file to assign a content
1563     type to the object.
1564   fmt_desc: The path and location of the MIME-types file. Used for Swift
1565     auto-detection of object types.
1566   default: /etc/mime.types
1567   services:
1568   - rgw
1569   with_legacy: true
1570 - name: rgw_gc_max_objs
1571   type: int
1572   level: advanced
1573   desc: Number of shards for garbage collector data
1574   long_desc: The number of garbage collector data shards, is the number of RADOS objects
1575     that RGW will use to store the garbage collection information on.
1576   fmt_desc: The maximum number of objects that may be handled by
1577     garbage collection in one garbage collection processing cycle.
1578     Please do not change this value after the first deployment.
1579   default: 32
1580   services:
1581   - rgw
1582   see_also:
1583   - rgw_gc_obj_min_wait
1584   - rgw_gc_processor_max_time
1585   - rgw_gc_processor_period
1586   - rgw_gc_max_concurrent_io
1587   with_legacy: true
1588 # wait time before object may be handled by gc, recommended lower limit is 30 mins
1589 - name: rgw_gc_obj_min_wait
1590   type: int
1591   level: advanced
1592   desc: Garbage collection object expiration time
1593   long_desc: The length of time (in seconds) that the RGW collector will wait before
1594     purging a deleted object's data. RGW will not remove object immediately, as object
1595     could still have readers. A mechanism exists to increase the object's expiration
1596     time when it's being read. The recommended value of its lower limit is 30 minutes
1597   fmt_desc: The minimum wait time before a deleted object may be removed
1598     and handled by garbage collection processing.
1599   default: 2_hr
1600   services:
1601   - rgw
1602   see_also:
1603   - rgw_gc_max_objs
1604   - rgw_gc_processor_max_time
1605   - rgw_gc_processor_period
1606   - rgw_gc_max_concurrent_io
1607   with_legacy: true
1608 - name: rgw_gc_processor_max_time
1609   type: int
1610   level: advanced
1611   desc: Length of time GC processor can lease shard
1612   long_desc: Garbage collection thread in RGW process holds a lease on its data shards.
1613     These objects contain the information about the objects that need to be removed.
1614     RGW takes a lease in order to prevent multiple RGW processes from handling the
1615     same objects concurrently. This time signifies that maximum amount of time (in
1616     seconds) that RGW is allowed to hold that lease. In the case where RGW goes down
1617     uncleanly, this is the amount of time where processing of that data shard will
1618     be blocked.
1619   fmt_desc: The maximum time between the beginning of two consecutive garbage
1620     collection processing cycles.
1621   default: 1_hr
1622   services:
1623   - rgw
1624   see_also:
1625   - rgw_gc_max_objs
1626   - rgw_gc_obj_min_wait
1627   - rgw_gc_processor_period
1628   - rgw_gc_max_concurrent_io
1629   with_legacy: true
1630 - name: rgw_gc_processor_period
1631   type: int
1632   level: advanced
1633   desc: Garbage collector cycle run time
1634   long_desc: The amount of time between the start of consecutive runs of the garbage
1635     collector threads. If garbage collector runs takes more than this period, it will
1636     not wait before running again.
1637   fmt_desc: The cycle time for garbage collection processing.
1638   default: 1_hr
1639   services:
1640   - rgw
1641   see_also:
1642   - rgw_gc_max_objs
1643   - rgw_gc_obj_min_wait
1644   - rgw_gc_processor_max_time
1645   - rgw_gc_max_concurrent_io
1646   - rgw_gc_max_trim_chunk
1647   with_legacy: true
1648 - name: rgw_gc_max_concurrent_io
1649   type: int
1650   level: advanced
1651   desc: Max concurrent RADOS IO operations for garbage collection
1652   long_desc: The maximum number of concurrent IO operations that the RGW garbage collection
1653     thread will use when purging old data.
1654   default: 10
1655   services:
1656   - rgw
1657   see_also:
1658   - rgw_gc_max_objs
1659   - rgw_gc_obj_min_wait
1660   - rgw_gc_processor_max_time
1661   - rgw_gc_max_trim_chunk
1662   with_legacy: true
1663 - name: rgw_gc_max_trim_chunk
1664   type: int
1665   level: advanced
1666   desc: Max number of keys to remove from garbage collector log in a single operation
1667   default: 16
1668   services:
1669   - rgw
1670   see_also:
1671   - rgw_gc_max_objs
1672   - rgw_gc_obj_min_wait
1673   - rgw_gc_processor_max_time
1674   - rgw_gc_max_concurrent_io
1675   with_legacy: true
1676 - name: rgw_gc_max_deferred_entries_size
1677   type: uint
1678   level: advanced
1679   desc: maximum allowed size of deferred entries in queue head for gc
1680   default: 3_K
1681   services:
1682   - rgw
1683   with_legacy: true
1684 - name: rgw_gc_max_queue_size
1685   type: uint
1686   level: advanced
1687   desc: Maximum allowed queue size for gc
1688   long_desc: The maximum allowed size of each gc queue, and its value should not be
1689     greater than (osd_max_object_size - rgw_gc_max_deferred_entries_size - 1K).
1690   default: 131068_K
1691   services:
1692   - rgw
1693   see_also:
1694   - osd_max_object_size
1695   - rgw_gc_max_deferred_entries_size
1696   with_legacy: true
1697 - name: rgw_gc_max_deferred
1698   type: uint
1699   level: advanced
1700   desc: Number of maximum deferred data entries to be stored in queue for gc
1701   default: 50
1702   services:
1703   - rgw
1704   with_legacy: true
1705 - name: rgw_s3_success_create_obj_status
1706   type: int
1707   level: advanced
1708   desc: HTTP return code override for object creation
1709   long_desc: If not zero, this is the HTTP return code that will be returned on a
1710     successful S3 object creation.
1711   fmt_desc: The alternate success status response for ``create-obj``.
1712   default: 0
1713   services:
1714   - rgw
1715   with_legacy: true
1716 - name: rgw_s3_client_max_sig_ver
1717   type: int
1718   level: advanced
1719   desc: Max S3 authentication signature version
1720   long_desc: If greater than zero, would force max signature version to use
1721   default: -1
1722   services:
1723   - rgw
1724 - name: rgw_resolve_cname
1725   type: bool
1726   level: advanced
1727   desc: Support vanity domain names via CNAME
1728   long_desc: If true, RGW will query DNS when detecting that it's serving a request
1729     that was sent to a host in another domain. If a CNAME record is configured for
1730     that domain it will use it instead. This gives user to have the ability of creating
1731     a unique domain of their own to point at data in their bucket.
1732   fmt_desc: Whether ``rgw`` should use DNS CNAME record of the request
1733     hostname field (if hostname is not equal to ``rgw dns name``).
1734   default: false
1735   services:
1736   - rgw
1737   with_legacy: true
1738 - name: rgw_obj_stripe_size
1739   type: size
1740   level: advanced
1741   desc: RGW object stripe size
1742   long_desc: The size of an object stripe for RGW objects. This is the maximum size
1743     a backing RADOS object will have. RGW objects that are larger than this will span
1744     over multiple objects.
1745   fmt_desc: The size of an object stripe for Ceph Object Gateway objects.
1746     See `Architecture`_ for details on striping.
1747   default: 4_M
1748   services:
1749   - rgw
1750   with_legacy: true
1751 # list of extended attrs that can be set on objects (beyond the default)
1752 - name: rgw_extended_http_attrs
1753   type: str
1754   level: advanced
1755   desc: RGW support extended HTTP attrs
1756   long_desc: Add new set of attributes that could be set on an object. These extra
1757     attributes can be set through HTTP header fields when putting the objects. If
1758     set, these attributes will return as HTTP fields when doing GET/HEAD on the object.
1759   fmt_desc: Add new set of attributes that could be set on an entity
1760     (user, bucket or object). These extra attributes can be set
1761     through HTTP header fields when putting the entity or modifying
1762     it using POST method. If set, these attributes will return as
1763     HTTP  fields when doing GET/HEAD on the entity.
1764   services:
1765   - rgw
1766   example: content_foo, content_bar, x-foo-bar
1767   with_legacy: true
1768 - name: rgw_exit_timeout_secs
1769   type: int
1770   level: advanced
1771   desc: RGW shutdown timeout
1772   long_desc: Number of seconds to wait for a process before exiting unconditionally.
1773   default: 2_min
1774   services:
1775   - rgw
1776   with_legacy: true
1777 - name: rgw_get_obj_window_size
1778   type: size
1779   level: advanced
1780   desc: RGW object read window size
1781   long_desc: The window size in bytes for a single object read request
1782   default: 16_M
1783   services:
1784   - rgw
1785   with_legacy: true
1786 - name: rgw_get_obj_max_req_size
1787   type: size
1788   level: advanced
1789   desc: RGW object read chunk size
1790   long_desc: The maximum request size of a single object read operation sent to RADOS
1791   fmt_desc: The maximum request size of a single get operation sent to the
1792     Ceph Storage Cluster.
1793   default: 4_M
1794   services:
1795   - rgw
1796   with_legacy: true
1797 - name: rgw_relaxed_s3_bucket_names
1798   type: bool
1799   level: advanced
1800   desc: RGW enable relaxed S3 bucket names
1801   long_desc: RGW enable relaxed S3 bucket name rules for US region buckets.
1802   fmt_desc: Enables relaxed S3 bucket names rules for US region buckets.
1803   default: false
1804   services:
1805   - rgw
1806   with_legacy: true
1807 - name: rgw_defer_to_bucket_acls
1808   type: str
1809   level: advanced
1810   desc: Bucket ACLs override object ACLs
1811   long_desc: If not empty, a string that selects that mode of operation. 'recurse'
1812     will use bucket's ACL for the authorizaton. 'full-control' will allow users that
1813     users that have full control permission on the bucket have access to the object.
1814   services:
1815   - rgw
1816   with_legacy: true
1817 - name: rgw_list_buckets_max_chunk
1818   type: int
1819   level: advanced
1820   desc: Max number of buckets to retrieve in a single listing operation
1821   long_desc: When RGW fetches lists of user's buckets from the backend, this is the
1822     max number of entries it will try to retrieve in a single operation. Note that
1823     the backend may choose to return a smaller number of entries.
1824   fmt_desc: The maximum number of buckets to retrieve in a single operation
1825     when listing user buckets.
1826   default: 1000
1827   services:
1828   - rgw
1829   with_legacy: true
1830 - name: rgw_md_log_max_shards
1831   type: int
1832   level: advanced
1833   desc: RGW number of metadata log shards
1834   long_desc: The number of shards the RGW metadata log entries will reside in. This
1835     affects the metadata sync parallelism as a shard can only be processed by a single
1836     RGW at a time
1837   fmt_desc: The maximum number of shards for the metadata log.
1838   default: 64
1839   services:
1840   - rgw
1841   with_legacy: true
1842 - name: rgw_curl_buffersize
1843   type: int
1844   level: dev
1845   long_desc: 'Pass a long specifying your preferred size (in bytes) for the receivebuffer
1846     in libcurl. See: https://curl.se/libcurl/c/CURLOPT_BUFFERSIZE.html'
1847   default: 524288
1848   services:
1849   - rgw
1850   min: 1024
1851   max: 524288
1852   with_legacy: true
1853 - name: rgw_curl_wait_timeout_ms
1854   type: int
1855   level: dev
1856   default: 1000
1857   fmt_desc: The timeout in milliseconds for certain ``curl`` calls.
1858   services:
1859   - rgw
1860   with_legacy: true
1861 - name: rgw_curl_low_speed_limit
1862   type: int
1863   level: advanced
1864   long_desc: It contains the average transfer speed in bytes per second that the transfer
1865     should be below during rgw_curl_low_speed_time seconds for libcurl to consider
1866     it to be too slow and abort. Set it zero to disable this.
1867   default: 1024
1868   services:
1869   - rgw
1870   with_legacy: true
1871 - name: rgw_curl_low_speed_time
1872   type: int
1873   level: advanced
1874   long_desc: It contains the time in number seconds that the transfer speed should
1875     be below the rgw_curl_low_speed_limit for the library to consider it too slow
1876     and abort. Set it zero to disable this.
1877   default: 5_min
1878   services:
1879   - rgw
1880   with_legacy: true
1881 - name: rgw_copy_obj_progress
1882   type: bool
1883   level: advanced
1884   desc: Send progress report through copy operation
1885   long_desc: If true, RGW will send progress information when copy operation is executed.
1886   fmt_desc: Enables output of object progress during long copy operations.
1887   default: true
1888   services:
1889   - rgw
1890   with_legacy: true
1891 - name: rgw_copy_obj_progress_every_bytes
1892   type: size
1893   level: advanced
1894   desc: Send copy-object progress info after these many bytes
1895   fmt_desc: The minimum bytes between copy progress output.
1896   default: 1_M
1897   services:
1898   - rgw
1899   with_legacy: true
1900 - name: rgw_sync_obj_etag_verify
1901   type: bool
1902   level: advanced
1903   desc: Verify if the object copied from remote is identical to its source
1904   long_desc: If true, this option computes the MD5 checksum of the data which is written
1905     at the destination and checks if it is identical to the ETAG stored in the source.
1906     It ensures integrity of the objects fetched from a remote server over HTTP including
1907     multisite sync.
1908   default: false
1909   services:
1910   - rgw
1911   with_legacy: true
1912 - name: rgw_obj_tombstone_cache_size
1913   type: int
1914   level: advanced
1915   desc: Max number of entries to keep in tombstone cache
1916   long_desc: The tombstone cache is used when doing a multi-zone data sync. RGW keeps
1917     there information about removed objects which is needed in order to prevent re-syncing
1918     of objects that were already removed.
1919   default: 1000
1920   services:
1921   - rgw
1922   with_legacy: true
1923 - name: rgw_data_log_window
1924   type: int
1925   level: advanced
1926   desc: Data log time window
1927   long_desc: The data log keeps information about buckets that have objectst that
1928     were modified within a specific timeframe. The sync process then knows which buckets
1929     are needed to be scanned for data sync.
1930   fmt_desc: The data log entries window in seconds.
1931   default: 30
1932   services:
1933   - rgw
1934   with_legacy: true
1935 - name: rgw_data_log_changes_size
1936   type: int
1937   level: dev
1938   desc: Max size of pending changes in data log
1939   long_desc: RGW will trigger update to the data log if the number of pending entries
1940     reached this number.
1941   fmt_dsec: The number of in-memory entries to hold for the data changes log.
1942   default: 1000
1943   services:
1944   - rgw
1945   with_legacy: true
1946 - name: rgw_data_log_num_shards
1947   type: int
1948   level: advanced
1949   desc: Number of data log shards
1950   long_desc: The number of shards the RGW data log entries will reside in. This affects
1951     the data sync parallelism as a shard can only be processed by a single RGW at
1952     a time.
1953   fmt_desc: The number of shards (objects) on which to keep the
1954     data changes log.
1955   default: 128
1956   services:
1957   - rgw
1958   with_legacy: true
1959 - name: rgw_data_log_obj_prefix
1960   type: str
1961   level: dev
1962   default: data_log
1963   fmt_desc: The object name prefix for the data log.
1964   services:
1965   - rgw
1966   with_legacy: true
1967 - name: rgw_bucket_quota_ttl
1968   type: int
1969   level: advanced
1970   desc: Bucket quota stats cache TTL
1971   long_desc: Length of time for bucket stats to be cached within RGW instance.
1972   fmt_desc: The amount of time in seconds cached quota information is
1973     trusted.  After this timeout, the quota information will be
1974     re-fetched from the cluster.
1975   default: 10_min
1976   services:
1977   - rgw
1978   with_legacy: true
1979 - name: rgw_bucket_quota_cache_size
1980   type: int
1981   level: advanced
1982   desc: RGW quota stats cache size
1983   long_desc: Maximum number of entries in the quota stats cache.
1984   default: 10000
1985   services:
1986   - rgw
1987   with_legacy: true
1988 - name: rgw_bucket_default_quota_max_objects
1989   type: int
1990   level: basic
1991   desc: Default quota for max objects in a bucket
1992   long_desc: The default quota configuration for max number of objects in a bucket.
1993     A negative number means 'unlimited'.
1994   fmt_desc: Default max number of objects per bucket. Set on new users,
1995     if no other quota is specified. Has no effect on existing users.
1996     This variable should be set in the client or global sections
1997     so that it is automatically applied to radosgw-admin commands.
1998   default: -1
1999   services:
2000   - rgw
2001   with_legacy: true
2002 - name: rgw_bucket_default_quota_max_size
2003   type: int
2004   level: advanced
2005   desc: Default quota for total size in a bucket
2006   long_desc: The default quota configuration for total size of objects in a bucket.
2007     A negative number means 'unlimited'.
2008   fmt_desc: Default max capacity per bucket, in bytes. Set on new users,
2009     if no other quota is specified. Has no effect on existing users.
2010   default: -1
2011   services:
2012   - rgw
2013   with_legacy: true
2014 - name: rgw_expose_bucket
2015   type: bool
2016   level: advanced
2017   desc: Send Bucket HTTP header with the response
2018   long_desc: If true, RGW will send a Bucket HTTP header with the responses. The header
2019     will contain the name of the bucket the operation happened on.
2020   default: false
2021   services:
2022   - rgw
2023   with_legacy: true
2024 - name: rgw_frontends
2025   type: str
2026   level: basic
2027   desc: RGW frontends configuration
2028   long_desc: A comma delimited list of frontends configuration. Each configuration
2029     contains the type of the frontend followed by an optional space delimited set
2030     of key=value config parameters.
2031   fmt_desc: Configures the HTTP frontend(s). The configuration for multiple
2032     frontends can be provided in a comma-delimited list. Each frontend
2033     configuration may include a list of options separated by spaces,
2034     where each option is in the form "key=value" or "key". See
2035     `HTTP Frontends`_ for more on supported options.
2036   default: beast port=7480
2037   services:
2038   - rgw
2039   with_legacy: true
2040 - name: rgw_frontend_defaults
2041   type: str
2042   level: advanced
2043   desc: RGW frontends default configuration
2044   long_desc: A comma delimited list of default frontends configuration.
2045   default: beast ssl_certificate=config://rgw/cert/$realm/$zone.crt ssl_private_key=config://rgw/cert/$realm/$zone.key
2046   services:
2047   - rgw
2048 - name: rgw_beast_enable_async
2049   type: bool
2050   level: dev
2051   desc: Enable async request processing under beast using coroutines
2052   long_desc: When enabled, the beast frontend will process requests using
2053     coroutines, allowing the concurrent processing of several requests on the
2054     same thread. When disabled, the number of concurrent requests will be
2055     limited by the thread count, but debugging and tracing the synchronous
2056     calls can be easier.
2057   default: true
2058   services:
2059   - rgw
2060   with_legacy: true
2061 - name: rgw_user_quota_bucket_sync_interval
2062   type: int
2063   level: advanced
2064   desc: User quota bucket sync interval
2065   long_desc: Time period for accumulating modified buckets before syncing these stats.
2066   fmt_desc: The amount of time in seconds bucket quota information is
2067     accumulated before syncing to the cluster.  During this time,
2068     other RGW instances will not see the changes in bucket quota
2069     stats from operations on this instance.
2070   default: 3_min
2071   services:
2072   - rgw
2073   with_legacy: true
2074 - name: rgw_user_quota_sync_interval
2075   type: int
2076   level: advanced
2077   desc: User quota sync interval
2078   long_desc: Time period for accumulating modified buckets before syncing entire user
2079     stats.
2080   fmt_desc: The amount of time in seconds user quota information is
2081     accumulated before syncing to the cluster.  During this time,
2082     other RGW instances will not see the changes in user quota stats
2083     from operations on this instance.
2084   default: 1_day
2085   services:
2086   - rgw
2087   with_legacy: true
2088 - name: rgw_user_quota_sync_idle_users
2089   type: bool
2090   level: advanced
2091   desc: Should sync idle users quota
2092   long_desc: Whether stats for idle users be fully synced.
2093   default: false
2094   services:
2095   - rgw
2096   with_legacy: true
2097 - name: rgw_user_quota_sync_wait_time
2098   type: int
2099   level: advanced
2100   desc: User quota full-sync wait time
2101   long_desc: Minimum time between two full stats sync for non-idle users.
2102   default: 1_day
2103   services:
2104   - rgw
2105   with_legacy: true
2106 - name: rgw_user_default_quota_max_objects
2107   type: int
2108   level: basic
2109   desc: User quota max objects
2110   long_desc: The default quota configuration for total number of objects for a single
2111     user. A negative number means 'unlimited'.
2112   fmt_desc: Default max number of objects for a user. This includes all
2113     objects in all buckets owned by the user. Set on new users,
2114     if no other quota is specified. Has no effect on existing users.
2115   default: -1
2116   services:
2117   - rgw
2118   with_legacy: true
2119 - name: rgw_user_default_quota_max_size
2120   type: int
2121   level: basic
2122   desc: User quota max size
2123   long_desc: The default quota configuration for total size of objects for a single
2124     user. A negative number means 'unlimited'.
2125   fmt_desc: The value for user max size quota in bytes set on new users,
2126     if no other quota is specified.  Has no effect on existing users.
2127   default: -1
2128   services:
2129   - rgw
2130   with_legacy: true
2131 - name: rgw_multipart_min_part_size
2132   type: size
2133   level: advanced
2134   desc: Minimum S3 multipart-upload part size
2135   long_desc: When doing a multipart upload, each part (other than the last part) must
2136     be at least this size.
2137   default: 5_M
2138   services:
2139   - rgw
2140   with_legacy: true
2141 - name: rgw_multipart_part_upload_limit
2142   type: int
2143   level: advanced
2144   desc: Max number of parts in multipart upload
2145   default: 10000
2146   services:
2147   - rgw
2148   with_legacy: true
2149 - name: rgw_max_slo_entries
2150   type: int
2151   level: advanced
2152   desc: Max number of entries in Swift Static Large Object manifest
2153   default: 1000
2154   services:
2155   - rgw
2156   with_legacy: true
2157 - name: rgw_olh_pending_timeout_sec
2158   type: int
2159   level: dev
2160   desc: Max time for pending OLH change to complete
2161   long_desc: OLH is a versioned object's logical head. Operations on it are journaled
2162     and as pending before completion. If an operation doesn't complete with this amount
2163     of seconds, we remove the operation from the journal.
2164   default: 1_hr
2165   services:
2166   - rgw
2167   with_legacy: true
2168 - name: rgw_user_max_buckets
2169   type: int
2170   level: basic
2171   desc: Max number of buckets per user
2172   long_desc: A user can create at most this number of buckets. Zero means no limit;
2173     a negative value means users cannot create any new buckets, although users will
2174     retain buckets already created.
2175   default: 1000
2176   services:
2177   - rgw
2178   with_legacy: true
2179 - name: rgw_objexp_gc_interval
2180   type: uint
2181   level: advanced
2182   desc: Swift objects expirer garbage collector interval
2183   default: 600
2184   services:
2185   - rgw
2186   with_legacy: true
2187 - name: rgw_objexp_hints_num_shards
2188   type: uint
2189   level: advanced
2190   desc: Number of object expirer data shards
2191   long_desc: The number of shards the (Swift) object expirer will store its data on.
2192   default: 127
2193   services:
2194   - rgw
2195   with_legacy: true
2196 # maximum number of entries in a single operation when processing objexp data
2197 - name: rgw_objexp_chunk_size
2198   type: uint
2199   level: dev
2200   default: 100
2201   services:
2202   - rgw
2203   with_legacy: true
2204 - name: rgw_enable_static_website
2205   type: bool
2206   level: basic
2207   desc: Enable static website APIs
2208   long_desc: This configurable controls whether RGW handles the website control APIs.
2209     RGW can server static websites if s3website hostnames are configured, and unrelated
2210     to this configurable.
2211   default: false
2212   services:
2213   - rgw
2214   with_legacy: true
2215 - name: rgw_user_unique_email
2216   type: bool
2217   level: basic
2218   desc: Require local RGW users to have unique email addresses
2219   long_desc: Enforce builtin user accounts to have unique email addresses.  This setting
2220     is historical.  In future, non-enforcement of email address uniqueness is likely
2221     to become the default.
2222   default: true
2223   services:
2224   - rgw
2225 - name: rgw_log_http_headers
2226   type: str
2227   level: basic
2228   desc: List of HTTP headers to log
2229   long_desc: A comma delimited list of HTTP headers to log when seen, ignores case
2230     (e.g., http_x_forwarded_for).
2231   fmt_desc: Comma-delimited list of HTTP headers to include with ops
2232     log entries.  Header names are case insensitive, and use
2233     the full header name with words separated by underscores.
2234   example: http_x_forwarded_for, http_x_special_k
2235   services:
2236   - rgw
2237   with_legacy: true
2238 - name: rgw_num_async_rados_threads
2239   type: int
2240   level: advanced
2241   desc: Number of concurrent RADOS operations in multisite sync
2242   long_desc: The number of concurrent RADOS IO operations that will be triggered for
2243     handling multisite sync operations. This includes control related work, and not
2244     the actual sync operations.
2245   default: 32
2246   services:
2247   - rgw
2248   with_legacy: true
2249 - name: rgw_md_notify_interval_msec
2250   type: int
2251   level: advanced
2252   desc: Length of time to aggregate metadata changes
2253   long_desc: Length of time (in milliseconds) in which the master zone aggregates
2254     all the metadata changes that occurred, before sending notifications to all the
2255     other zones.
2256   default: 200
2257   services:
2258   - rgw
2259   with_legacy: true
2260 - name: rgw_run_sync_thread
2261   type: bool
2262   level: advanced
2263   desc: Should run sync thread
2264   fmt_desc: If there are other zones in the realm to sync from, spawn threads
2265     to handle the sync of data and metadata.
2266   default: true
2267   services:
2268   - rgw
2269   with_legacy: true
2270 - name: rgw_sync_lease_period
2271   type: int
2272   level: dev
2273   default: 2_min
2274   services:
2275   - rgw
2276   with_legacy: true
2277 - name: rgw_sync_log_trim_interval
2278   type: int
2279   level: advanced
2280   desc: Sync log trim interval
2281   long_desc: Time in seconds between attempts to trim sync logs.
2282   default: 20_min
2283   services:
2284   - rgw
2285   with_legacy: true
2286 - name: rgw_sync_log_trim_max_buckets
2287   type: int
2288   level: advanced
2289   desc: Maximum number of buckets to trim per interval
2290   long_desc: The maximum number of buckets to consider for bucket index log trimming
2291     each trim interval, regardless of the number of bucket index shards. Priority
2292     is given to buckets with the most sync activity over the last trim interval.
2293   default: 16
2294   services:
2295   - rgw
2296   see_also:
2297   - rgw_sync_log_trim_interval
2298   - rgw_sync_log_trim_min_cold_buckets
2299   - rgw_sync_log_trim_concurrent_buckets
2300 - name: rgw_sync_log_trim_min_cold_buckets
2301   type: int
2302   level: advanced
2303   desc: Minimum number of cold buckets to trim per interval
2304   long_desc: Of the `rgw_sync_log_trim_max_buckets` selected for bucket index log
2305     trimming each trim interval, at least this many of them must be 'cold' buckets.
2306     These buckets are selected in order from the list of all bucket instances, to
2307     guarantee that all buckets will be visited eventually.
2308   default: 4
2309   services:
2310   - rgw
2311   see_also:
2312   - rgw_sync_log_trim_interval
2313   - rgw_sync_log_trim_max_buckets
2314   - rgw_sync_log_trim_concurrent_buckets
2315 - name: rgw_sync_log_trim_concurrent_buckets
2316   type: int
2317   level: advanced
2318   desc: Maximum number of buckets to trim in parallel
2319   default: 4
2320   services:
2321   - rgw
2322   see_also:
2323   - rgw_sync_log_trim_interval
2324   - rgw_sync_log_trim_max_buckets
2325   - rgw_sync_log_trim_min_cold_buckets
2326 - name: rgw_sync_data_inject_err_probability
2327   type: float
2328   level: dev
2329   default: 0
2330   services:
2331   - rgw
2332   with_legacy: true
2333 - name: rgw_sync_meta_inject_err_probability
2334   type: float
2335   level: dev
2336   default: 0
2337   services:
2338   - rgw
2339   with_legacy: true
2340 - name: rgw_sync_trace_history_size
2341   type: size
2342   level: advanced
2343   desc: Sync trace history size
2344   long_desc: Maximum number of complete sync trace entries to keep.
2345   default: 4_K
2346   services:
2347   - rgw
2348   with_legacy: true
2349 - name: rgw_sync_trace_per_node_log_size
2350   type: int
2351   level: advanced
2352   desc: Sync trace per-node log size
2353   long_desc: The number of log entries to keep per sync-trace node.
2354   default: 32
2355   services:
2356   - rgw
2357   with_legacy: true
2358 - name: rgw_sync_trace_servicemap_update_interval
2359   type: int
2360   level: advanced
2361   desc: Sync-trace service-map update interval
2362   long_desc: Number of seconds between service-map updates of sync-trace events.
2363   default: 10
2364   services:
2365   - rgw
2366   with_legacy: true
2367 - name: rgw_period_push_interval
2368   type: float
2369   level: advanced
2370   desc: Period push interval
2371   long_desc: Number of seconds to wait before retrying 'period push' operation.
2372   default: 2
2373   services:
2374   - rgw
2375   with_legacy: true
2376 - name: rgw_period_push_interval_max
2377   type: float
2378   level: advanced
2379   desc: Period push maximum interval
2380   long_desc: The max number of seconds to wait before retrying 'period push' after
2381     exponential backoff.
2382   default: 30
2383   services:
2384   - rgw
2385   with_legacy: true
2386 - name: rgw_safe_max_objects_per_shard
2387   type: int
2388   level: advanced
2389   desc: Safe number of objects per shard
2390   long_desc: This is the max number of objects per bucket index shard that RGW considers
2391     safe. RGW will warn if it identifies a bucket where its per-shard count is higher
2392     than a percentage of this number.
2393   default: 102400
2394   services:
2395   - rgw
2396   see_also:
2397   - rgw_shard_warning_threshold
2398   with_legacy: true
2399 # pct of safe max at which to warn
2400 - name: rgw_shard_warning_threshold
2401   type: float
2402   level: advanced
2403   desc: Warn about max objects per shard
2404   long_desc: Warn if number of objects per shard in a specific bucket passed this
2405     percentage of the safe number.
2406   default: 90
2407   services:
2408   - rgw
2409   see_also:
2410   - rgw_safe_max_objects_per_shard
2411   with_legacy: true
2412 - name: rgw_swift_versioning_enabled
2413   type: bool
2414   level: advanced
2415   desc: Enable Swift versioning
2416   fmt_desc: |
2417     Enables the Object Versioning of OpenStack Object Storage API.
2418     This allows clients to put the ``X-Versions-Location`` attribute
2419     on containers that should be versioned. The attribute specifies
2420     the name of container storing archived versions. It must be owned
2421     by the same user that the versioned container due to access
2422     control verification - ACLs are NOT taken into consideration.
2423     Those containers cannot be versioned by the S3 object versioning
2424     mechanism.
2425
2426     A slightly different attribute, ``X-History-Location``, which is also understood by
2427     `OpenStack Swift <https://docs.openstack.org/swift/latest/api/object_versioning.html>`_
2428     for handling ``DELETE`` operations, is currently not supported.
2429   default: false
2430   services:
2431   - rgw
2432   with_legacy: true
2433 - name: rgw_swift_custom_header
2434   type: str
2435   level: advanced
2436   desc: Enable swift custom header
2437   long_desc: If not empty, specifies a name of HTTP header that can include custom
2438     data. When uploading an object, if this header is passed RGW will store this header
2439     info and it will be available when listing the bucket.
2440   services:
2441   - rgw
2442   with_legacy: true
2443 - name: rgw_swift_need_stats
2444   type: bool
2445   level: advanced
2446   desc: Enable stats on bucket listing in Swift
2447   default: true
2448   services:
2449   - rgw
2450   with_legacy: true
2451 - name: rgw_reshard_num_logs
2452   type: uint
2453   level: advanced
2454   default: 16
2455   services:
2456   - rgw
2457   - rgw
2458   min: 1
2459 - name: rgw_reshard_bucket_lock_duration
2460   type: uint
2461   level: advanced
2462   desc: Number of seconds the timeout on the reshard locks (bucket reshard lock and
2463     reshard log lock) are set to. As a reshard proceeds these locks can be renewed/extended.
2464     If too short, reshards cannot complete and will fail, causing a future reshard
2465     attempt. If too long a hung or crashed reshard attempt will keep the bucket locked
2466     for an extended period, not allowing RGW to detect the failed reshard attempt
2467     and recover.
2468   default: 360
2469   tags:
2470   - performance
2471   services:
2472   - rgw
2473   - rgw
2474   min: 30
2475 - name: rgw_reshard_batch_size
2476   type: uint
2477   level: advanced
2478   desc: Number of reshard entries to batch together before sending the operations
2479     to the CLS back-end
2480   default: 64
2481   tags:
2482   - performance
2483   services:
2484   - rgw
2485   - rgw
2486   min: 8
2487 - name: rgw_reshard_max_aio
2488   type: uint
2489   level: advanced
2490   desc: Maximum number of outstanding asynchronous I/O operations to allow at a time
2491     during resharding
2492   default: 128
2493   tags:
2494   - performance
2495   services:
2496   - rgw
2497   - rgw
2498   min: 16
2499 - name: rgw_trust_forwarded_https
2500   type: bool
2501   level: advanced
2502   desc: Trust Forwarded and X-Forwarded-Proto headers
2503   long_desc: When a proxy in front of radosgw is used for ssl termination, radosgw
2504     does not know whether incoming http connections are secure. Enable this option
2505     to trust the Forwarded and X-Forwarded-Proto headers sent by the proxy when determining
2506     whether the connection is secure. This is required for some features, such as
2507     server side encryption. (Never enable this setting if you do not have a trusted
2508     proxy in front of radosgw, or else malicious users will be able to set these headers
2509     in any request.)
2510   fmt_desc: When a proxy in front of radosgw is used for ssl termination, radosgw
2511     does not know whether incoming http connections are secure. Enable
2512     this option to trust the ``Forwarded`` and ``X-Forwarded-Proto`` headers
2513     sent by the proxy when determining whether the connection is secure.
2514     This is required for some features, such as server side encryption.
2515     (Never enable this setting if you do not have a trusted proxy in front of
2516     radosgw, or else malicious users will be able to set these headers in
2517     any request.)
2518   default: false
2519   services:
2520   - rgw
2521   see_also:
2522   - rgw_crypt_require_ssl
2523   with_legacy: true
2524 - name: rgw_crypt_require_ssl
2525   type: bool
2526   level: advanced
2527   desc: Requests including encryption key headers must be sent over ssl
2528   default: true
2529   services:
2530   - rgw
2531   with_legacy: true
2532 # base64 encoded key for encryption of rgw objects
2533 - name: rgw_crypt_default_encryption_key
2534   type: str
2535   level: dev
2536   services:
2537   - rgw
2538   with_legacy: true
2539 - name: rgw_crypt_s3_kms_backend
2540   type: str
2541   level: advanced
2542   desc: Where the SSE-KMS encryption keys are stored. Supported KMS systems are OpenStack
2543     Barbican ('barbican', the default) and HashiCorp Vault ('vault').
2544   fmt_desc: Where the SSE-KMS encryption keys are stored. Supported KMS
2545     systems are OpenStack Barbican (``barbican``, the default) and
2546     HashiCorp Vault (``vault``).
2547   default: barbican
2548   services:
2549   - rgw
2550   enum_values:
2551   - barbican
2552   - vault
2553   - testing
2554   - kmip
2555   with_legacy: true
2556 # extra keys that may be used for aws:kms
2557 # defined as map "key1=YmluCmJvb3N0CmJvb3N0LQ== key2=b3V0CnNyYwpUZXN0aW5nCg=="
2558 - name: rgw_crypt_s3_kms_encryption_keys
2559   type: str
2560   level: dev
2561   services:
2562   - rgw
2563   with_legacy: true
2564 - name: rgw_crypt_vault_auth
2565   type: str
2566   level: advanced
2567   desc: Type of authentication method to be used with Vault.
2568   fmt_desc: Type of authentication method to be used. The only method
2569     currently supported is ``token``.
2570   default: token
2571   services:
2572   - rgw
2573   see_also:
2574   - rgw_crypt_s3_kms_backend
2575   - rgw_crypt_vault_addr
2576   - rgw_crypt_vault_token_file
2577   enum_values:
2578   - token
2579   - agent
2580   with_legacy: true
2581 - name: rgw_crypt_vault_token_file
2582   type: str
2583   level: advanced
2584   desc: If authentication method is 'token', provide a path to the token file, which
2585     for security reasons should readable only by Rados Gateway.
2586   services:
2587   - rgw
2588   see_also:
2589   - rgw_crypt_s3_kms_backend
2590   - rgw_crypt_vault_auth
2591   - rgw_crypt_vault_addr
2592   with_legacy: true
2593 - name: rgw_crypt_vault_addr
2594   type: str
2595   level: advanced
2596   desc: Vault server base address.
2597   fmt_desc: Vault server base address, e.g. ``http://vaultserver:8200``.
2598   services:
2599   - rgw
2600   see_also:
2601   - rgw_crypt_s3_kms_backend
2602   - rgw_crypt_vault_auth
2603   - rgw_crypt_vault_prefix
2604   with_legacy: true
2605 # Optional URL prefix to Vault secret path
2606 - name: rgw_crypt_vault_prefix
2607   type: str
2608   level: advanced
2609   desc: Vault secret URL prefix, which can be used to restrict access to a particular
2610     subset of the Vault secret space.
2611   fmt_desc: The Vault secret URL prefix, which can be used to restrict access
2612     to a particular subset of the secret space, e.g. ``/v1/secret/data``.
2613   services:
2614   - rgw
2615   see_also:
2616   - rgw_crypt_s3_kms_backend
2617   - rgw_crypt_vault_addr
2618   - rgw_crypt_vault_auth
2619   with_legacy: true
2620 # kv, transit or other supported secret engines
2621 - name: rgw_crypt_vault_secret_engine
2622   type: str
2623   level: advanced
2624   desc: Vault Secret Engine to be used to retrieve encryption keys.
2625   fmt_desc: |
2626     Vault Secret Engine to be used to retrieve encryption keys: choose
2627     between kv-v2, transit.
2628   default: transit
2629   services:
2630   - rgw
2631   see_also:
2632   - rgw_crypt_s3_kms_backend
2633   - rgw_crypt_vault_auth
2634   - rgw_crypt_vault_addr
2635   with_legacy: true
2636 #  Vault Namespace (only availabe in Vault Enterprise Version)
2637 - name: rgw_crypt_vault_namespace
2638   type: str
2639   level: advanced
2640   desc: Vault Namespace to be used to select your tenant
2641   fmt_desc: If set, Vault Namespace provides tenant isolation for teams and individuals
2642     on the same Vault Enterprise instance, e.g. ``acme/tenant1``
2643   services:
2644   - rgw
2645   see_also:
2646   - rgw_crypt_s3_kms_backend
2647   - rgw_crypt_vault_auth
2648   - rgw_crypt_vault_addr
2649   with_legacy: true
2650 # Enable TLS authentication rgw and vault
2651 - name: rgw_crypt_vault_verify_ssl
2652   type: bool
2653   level: advanced
2654   desc: Should RGW verify the vault server SSL certificate.
2655   default: true
2656   services:
2657   - rgw
2658   with_legacy: true
2659 # TLS certs options
2660 - name: rgw_crypt_vault_ssl_cacert
2661   type: str
2662   level: advanced
2663   desc: Path for custom ca certificate for accessing vault server
2664   services:
2665   - rgw
2666   with_legacy: true
2667 - name: rgw_crypt_vault_ssl_clientcert
2668   type: str
2669   level: advanced
2670   desc: Path for custom client certificate for accessing vault server
2671   services:
2672   - rgw
2673   with_legacy: true
2674 - name: rgw_crypt_vault_ssl_clientkey
2675   type: str
2676   level: advanced
2677   desc: Path for private key required for client cert
2678   services:
2679   - rgw
2680   with_legacy: true
2681 - name: rgw_crypt_kmip_addr
2682   type: str
2683   level: advanced
2684   desc: kmip server address
2685   services:
2686   - rgw
2687   with_legacy: true
2688 - name: rgw_crypt_kmip_ca_path
2689   type: str
2690   level: advanced
2691   desc: ca for kmip servers
2692   services:
2693   - rgw
2694   with_legacy: true
2695 - name: rgw_crypt_kmip_username
2696   type: str
2697   level: advanced
2698   desc: when authenticating via username
2699   services:
2700   - rgw
2701   with_legacy: true
2702 - name: rgw_crypt_kmip_password
2703   type: str
2704   level: advanced
2705   desc: optional w/ username
2706   services:
2707   - rgw
2708   with_legacy: true
2709 - name: rgw_crypt_kmip_client_cert
2710   type: str
2711   level: advanced
2712   desc: connect using client certificate
2713   services:
2714   - rgw
2715   with_legacy: true
2716 - name: rgw_crypt_kmip_client_key
2717   type: str
2718   level: advanced
2719   desc: connect using client certificate
2720   services:
2721   - rgw
2722   with_legacy: true
2723 - name: rgw_crypt_kmip_kms_key_template
2724   type: str
2725   level: advanced
2726   desc: sse-kms; kmip key names
2727   services:
2728   - rgw
2729   with_legacy: true
2730 - name: rgw_crypt_kmip_s3_key_template
2731   type: str
2732   level: advanced
2733   desc: sse-s3; kmip key template
2734   default: $keyid
2735   services:
2736   - rgw
2737   with_legacy: true
2738 - name: rgw_crypt_suppress_logs
2739   type: bool
2740   level: advanced
2741   desc: Suppress logs that might print client key
2742   default: true
2743   services:
2744   - rgw
2745   with_legacy: true
2746 - name: rgw_list_bucket_min_readahead
2747   type: int
2748   level: advanced
2749   desc: Minimum number of entries to request from rados for bucket listing
2750   default: 1000
2751   services:
2752   - rgw
2753   with_legacy: true
2754 - name: rgw_rest_getusage_op_compat
2755   type: bool
2756   level: advanced
2757   desc: REST GetUsage request backward compatibility
2758   default: false
2759   services:
2760   - rgw
2761   with_legacy: true
2762 # The following are tunables for torrent data
2763 - name: rgw_torrent_flag
2764   type: bool
2765   level: advanced
2766   desc: When true, uploaded objects will calculate and store a SHA256 hash of object
2767     data so the object can be retrieved as a torrent file
2768   default: false
2769   services:
2770   - rgw
2771   with_legacy: true
2772 - name: rgw_torrent_tracker
2773   type: str
2774   level: advanced
2775   desc: Torrent field announce and announce list
2776   services:
2777   - rgw
2778   with_legacy: true
2779 - name: rgw_torrent_createby
2780   type: str
2781   level: advanced
2782   desc: torrent field created by
2783   services:
2784   - rgw
2785   with_legacy: true
2786 - name: rgw_torrent_comment
2787   type: str
2788   level: advanced
2789   desc: Torrent field comment
2790   services:
2791   - rgw
2792   with_legacy: true
2793 - name: rgw_torrent_encoding
2794   type: str
2795   level: advanced
2796   desc: torrent field encoding
2797   services:
2798   - rgw
2799   with_legacy: true
2800 - name: rgw_data_notify_interval_msec
2801   type: int
2802   level: advanced
2803   desc: data changes notification interval to followers
2804   long_desc: In multisite, radosgw will occasionally broadcast new entries in its
2805     data changes log to peer zones, so they can prioritize sync of some
2806     of the most recent changes. Can be disabled with 0.
2807   default: 200
2808   services:
2809   - rgw
2810   with_legacy: true
2811 - name: rgw_torrent_origin
2812   type: str
2813   level: advanced
2814   desc: Torrent origin
2815   services:
2816   - rgw
2817   with_legacy: true
2818 - name: rgw_torrent_sha_unit
2819   type: size
2820   level: advanced
2821   default: 512_K
2822   services:
2823   - rgw
2824   with_legacy: true
2825 - name: rgw_dynamic_resharding
2826   type: bool
2827   level: basic
2828   desc: Enable dynamic resharding
2829   long_desc: If true, RGW will dynamically increase the number of shards in buckets
2830     that have a high number of objects per shard.
2831   default: true
2832   services:
2833   - rgw
2834   see_also:
2835   - rgw_max_objs_per_shard
2836   - rgw_max_dynamic_shards
2837 - name: rgw_max_objs_per_shard
2838   type: uint
2839   level: basic
2840   desc: Max objects per shard for dynamic resharding
2841   long_desc: This is the max number of objects per bucket index shard that RGW will
2842     allow with dynamic resharding. RGW will trigger an automatic reshard operation
2843     on the bucket if it exceeds this number.
2844   default: 100000
2845   services:
2846   - rgw
2847   see_also:
2848   - rgw_dynamic_resharding
2849   - rgw_max_dynamic_shards
2850 - name: rgw_max_dynamic_shards
2851   type: uint
2852   level: advanced
2853   desc: Max shards that dynamic resharding can create
2854   long_desc: This is the maximum number of bucket index shards that dynamic sharding
2855     is able to create on its own. This does not limit user requested resharding. Ideally
2856     this value is a prime number.
2857   default: 1999
2858   services:
2859   - rgw
2860   see_also:
2861   - rgw_dynamic_resharding
2862   - rgw_max_objs_per_shard
2863   min: 1
2864 - name: rgw_reshard_thread_interval
2865   type: uint
2866   level: advanced
2867   desc: Number of seconds between processing of reshard log entries
2868   default: 600
2869   services:
2870   - rgw
2871   min: 10
2872 - name: rgw_cache_expiry_interval
2873   type: uint
2874   level: advanced
2875   desc: Number of seconds before entries in the cache are assumed stale and re-fetched.
2876     Zero is never.
2877   long_desc: The Rados Gateway stores metadata and objects in an internal cache. This
2878     should be kept consistent by the OSD's relaying notify events between multiple
2879     watching RGW processes. In the event that this notification protocol fails, bounding
2880     the length of time that any data in the cache will be assumed valid will ensure
2881     that any RGW instance that falls out of sync will eventually recover. This seems
2882     to be an issue mostly for large numbers of RGW instances under heavy use. If you
2883     would like to turn off cache expiry, set this value to zero.
2884   default: 900
2885   tags:
2886   - performance
2887   services:
2888   - rgw
2889   - rgw
2890 - name: rgw_inject_notify_timeout_probability
2891   type: float
2892   level: dev
2893   desc: Likelihood of ignoring a notify
2894   long_desc: This is the probability that the RGW cache will ignore a cache notify
2895     message. It exists to help with the development and testing of cache consistency
2896     and recovery improvements. Please do not set it in a production cluster, as it
2897     actively causes failures. Set this to a floating point value between 0 and 1.
2898   default: 0
2899   tags:
2900   - fault injection
2901   - testing
2902   services:
2903   - rgw
2904   - rgw
2905   min: 0
2906   max: 1
2907 - name: rgw_max_notify_retries
2908   type: uint
2909   level: advanced
2910   desc: Number of attempts to notify peers before giving up.
2911   long_desc: The number of times we will attempt to update a peer's cache in the event
2912     of error before giving up. This is unlikely to be an issue unless your cluster
2913     is very heavily loaded. Beware that increasing this value may cause some operations
2914     to take longer in exceptional cases and thus may, rarely, cause clients to time
2915     out.
2916   default: 3
2917   tags:
2918   - error recovery
2919   services:
2920   - rgw
2921   - rgw
2922 - name: rgw_sts_entry
2923   type: str
2924   level: advanced
2925   desc: STS URL prefix
2926   long_desc: URL path prefix for internal STS requests.
2927   default: sts
2928   services:
2929   - rgw
2930   with_legacy: true
2931 - name: rgw_sts_key
2932   type: str
2933   level: advanced
2934   desc: STS Key
2935   long_desc: Key used for encrypting/ decrypting session token.
2936   default: sts
2937   services:
2938   - rgw
2939   with_legacy: true
2940 # should we try to use sts for s3?
2941 - name: rgw_s3_auth_use_sts
2942   type: bool
2943   level: advanced
2944   desc: Should S3 authentication use STS.
2945   default: false
2946   services:
2947   - rgw
2948   with_legacy: true
2949 - name: rgw_sts_max_session_duration
2950   type: uint
2951   level: advanced
2952   desc: Session token max duration
2953   long_desc: Max duration in seconds for which the session token is valid.
2954   default: 43200
2955   services:
2956   - rgw
2957   with_legacy: true
2958 - name: rgw_sts_min_session_duration
2959   type: uint
2960   level: advanced
2961   desc: Minimum allowed duration of a session
2962   default: 900
2963   services:
2964   - rgw
2965   with_legacy: true
2966 - name: rgw_max_listing_results
2967   type: uint
2968   level: advanced
2969   desc: Upper bound on results in listing operations, ListBucket max-keys
2970   long_desc: This caps the maximum permitted value for listing-like operations in
2971     RGW S3. Affects ListBucket(max-keys), ListBucketVersions(max-keys), ListBucketMultipartUploads(max-uploads),
2972     ListMultipartUploadParts(max-parts)
2973   default: 1000
2974   services:
2975   - rgw
2976   - rgw
2977   min: 1
2978   max: 100000
2979 - name: rgw_sts_token_introspection_url
2980   type: str
2981   level: advanced
2982   desc: STS Web Token introspection URL
2983   long_desc: URL for introspecting an STS Web Token.
2984   services:
2985   - rgw
2986   with_legacy: true
2987 - name: rgw_sts_client_id
2988   type: str
2989   level: advanced
2990   desc: Client Id
2991   long_desc: Client Id needed for introspecting a Web Token.
2992   services:
2993   - rgw
2994   with_legacy: true
2995 - name: rgw_sts_client_secret
2996   type: str
2997   level: advanced
2998   desc: Client Secret
2999   long_desc: Client Secret needed for introspecting a Web Token.
3000   services:
3001   - rgw
3002   with_legacy: true
3003 - name: rgw_max_concurrent_requests
3004   type: int
3005   level: basic
3006   desc: Maximum number of concurrent HTTP requests.
3007   long_desc: Maximum number of concurrent HTTP requests that the beast frontend will
3008     process. Tuning this can help to limit memory usage under heavy load.
3009   default: 1024
3010   tags:
3011   - performance
3012   services:
3013   - rgw
3014   see_also:
3015   - rgw_frontends
3016 - name: rgw_scheduler_type
3017   type: str
3018   level: advanced
3019   desc: Set the type of dmclock scheduler, defaults to throttler Other valid values
3020     are dmclock which is experimental
3021   fmt_desc: |
3022     The RGW scheduler to use. Valid values are ``throttler` and
3023     ``dmclock``. Currently defaults to ``throttler`` which throttles Beast
3024     frontend requests. ``dmclock` is *experimental* and requires the
3025     ``dmclock`` to be included in the ``experimental_feature_enabled``
3026     configuration option.
3027
3028     The options below tune the experimental dmclock scheduler. For
3029     additional reading on dmclock, see :ref:`dmclock-qos`. `op_class` for the flags below is
3030     one of ``admin``, ``auth``, ``metadata``, or ``data``.
3031   default: throttler
3032   services:
3033   - rgw
3034 - name: rgw_dmclock_admin_res
3035   type: float
3036   level: advanced
3037   desc: mclock reservation for admin requests
3038   default: 100
3039   services:
3040   - rgw
3041   see_also:
3042   - rgw_dmclock_admin_wgt
3043   - rgw_dmclock_admin_lim
3044 - name: rgw_dmclock_admin_wgt
3045   type: float
3046   level: advanced
3047   desc: mclock weight for admin requests
3048   default: 100
3049   services:
3050   - rgw
3051   see_also:
3052   - rgw_dmclock_admin_res
3053   - rgw_dmclock_admin_lim
3054 - name: rgw_dmclock_admin_lim
3055   type: float
3056   level: advanced
3057   desc: mclock limit for admin requests
3058   default: 0
3059   services:
3060   - rgw
3061   see_also:
3062   - rgw_dmclock_admin_res
3063   - rgw_dmclock_admin_wgt
3064 - name: rgw_dmclock_auth_res
3065   type: float
3066   level: advanced
3067   desc: mclock reservation for object data requests
3068   default: 200
3069   services:
3070   - rgw
3071   see_also:
3072   - rgw_dmclock_auth_wgt
3073   - rgw_dmclock_auth_lim
3074 - name: rgw_dmclock_auth_wgt
3075   type: float
3076   level: advanced
3077   desc: mclock weight for object data requests
3078   default: 100
3079   services:
3080   - rgw
3081   see_also:
3082   - rgw_dmclock_auth_res
3083   - rgw_dmclock_auth_lim
3084 - name: rgw_dmclock_auth_lim
3085   type: float
3086   level: advanced
3087   desc: mclock limit for object data requests
3088   default: 0
3089   services:
3090   - rgw
3091   see_also:
3092   - rgw_dmclock_auth_res
3093   - rgw_dmclock_auth_wgt
3094 - name: rgw_dmclock_data_res
3095   type: float
3096   level: advanced
3097   desc: mclock reservation for object data requests
3098   default: 500
3099   services:
3100   - rgw
3101   see_also:
3102   - rgw_dmclock_data_wgt
3103   - rgw_dmclock_data_lim
3104 - name: rgw_dmclock_data_wgt
3105   type: float
3106   level: advanced
3107   desc: mclock weight for object data requests
3108   default: 500
3109   services:
3110   - rgw
3111   see_also:
3112   - rgw_dmclock_data_res
3113   - rgw_dmclock_data_lim
3114 - name: rgw_dmclock_data_lim
3115   type: float
3116   level: advanced
3117   desc: mclock limit for object data requests
3118   default: 0
3119   services:
3120   - rgw
3121   see_also:
3122   - rgw_dmclock_data_res
3123   - rgw_dmclock_data_wgt
3124 - name: rgw_dmclock_metadata_res
3125   type: float
3126   level: advanced
3127   desc: mclock reservation for metadata requests
3128   default: 500
3129   services:
3130   - rgw
3131   see_also:
3132   - rgw_dmclock_metadata_wgt
3133   - rgw_dmclock_metadata_lim
3134 - name: rgw_dmclock_metadata_wgt
3135   type: float
3136   level: advanced
3137   desc: mclock weight for metadata requests
3138   default: 500
3139   services:
3140   - rgw
3141   see_also:
3142   - rgw_dmclock_metadata_res
3143   - rgw_dmclock_metadata_lim
3144 - name: rgw_dmclock_metadata_lim
3145   type: float
3146   level: advanced
3147   desc: mclock limit for metadata requests
3148   default: 0
3149   services:
3150   - rgw
3151   see_also:
3152   - rgw_dmclock_metadata_res
3153   - rgw_dmclock_metadata_wgt
3154 - name: rgw_default_data_log_backing
3155   type: str
3156   level: advanced
3157   desc: Default backing store for the RGW data sync log
3158   long_desc: Whether to use the older OMAP backing store or the high performance FIFO
3159     based backing store by default. This only covers the creation of the log on startup
3160     if none exists.
3161   default: fifo
3162   services:
3163   - rgw
3164   enum_values:
3165   - fifo
3166   - omap
3167 - name: rgw_d3n_l1_local_datacache_enabled
3168   type: bool
3169   level: advanced
3170   desc: Enable datacenter-scale dataset delivery local cache
3171   default: false
3172   services:
3173   - rgw
3174   with_legacy: true
3175 - name: rgw_d3n_l1_datacache_persistent_path
3176   type: str
3177   level: advanced
3178   desc: path for the directory for storing the local cache objects data
3179   default: /tmp/rgw_datacache/
3180   services:
3181   - rgw
3182   with_legacy: true
3183 - name: rgw_d3n_l1_datacache_size
3184   type: size
3185   level: advanced
3186   desc: datacache maximum size on disk in bytes
3187   default: 1_G
3188   services:
3189   - rgw
3190   with_legacy: true
3191 - name: rgw_d3n_l1_evict_cache_on_start
3192   type: bool
3193   level: advanced
3194   desc: clear the content of the persistent data cache directory on start
3195   default: true
3196   services:
3197   - rgw
3198   with_legacy: true
3199 - name: rgw_d3n_l1_fadvise
3200   type: int
3201   level: advanced
3202   desc: posix_fadvise() flag for access pattern of cache files
3203   long_desc: for example to bypass the page-cache -
3204     POSIX_FADV_DONTNEED=4
3205   default: 4
3206   services:
3207   - rgw
3208   with_legacy: true
3209 - name: rgw_d3n_l1_eviction_policy
3210   type: str
3211   level: advanced
3212   desc: select the d3n cache eviction policy
3213   default: lru
3214   services:
3215   - rgw
3216   enum_values:
3217   - lru
3218   - random
3219   with_legacy: true
3220 - name: rgw_d3n_libaio_aio_threads
3221   type: int
3222   level: advanced
3223   desc: specifies the maximum number of worker threads that may be used by libaio
3224   default: 20
3225   services:
3226   - rgw
3227   see_also:
3228   - rgw_thread_pool_size
3229   with_legacy: true
3230 - name: rgw_d3n_libaio_aio_num
3231   type: int
3232   level: advanced
3233   desc: specifies the maximum number of simultaneous I/O requests that libaio expects to enqueue
3234   default: 64
3235   services:
3236   - rgw
3237   see_also:
3238   - rgw_thread_pool_size
3239   with_legacy: true
3240 - name: rgw_backend_store
3241   type: str
3242   level: advanced
3243   desc: experimental Option to set backend store type
3244   long_desc: defaults to rados. Other valid values are dbstore(experimental).
3245   default: rados
3246   services:
3247   - rgw
3248   enum_values:
3249   - rados
3250   - dbstore
3251 - name: rgw_luarocks_location
3252   type: str
3253   level: advanced
3254   desc: Directory where luarocks install packages from allowlist
3255   default: @rgw_luarocks_location@
3256   services:
3257   - rgw
3258   flags:
3259   - startup