General settings

Use this information to get general settings for configuring Ceph Object Gateway.

Table 1. Ceph Object Gateway general configuration settings
Name	Description	Type	Default
`rgw_data`	Sets the location of the data files for Ceph Object Gateway.	String	`/var/lib/ceph/radosgw/$cluster-$id`
`rgw_enable_apis`	Enables the specified APIs.	String	`s3, s3website, swift, swift_auth, admin, sts, iam, notifications`
`rgw_cache_enabled`	Whether the Ceph Object Gateway cache is enabled.	Boolean	`true`
`rgw_cache_lru_size`	The number of entries in the Ceph Object Gateway cache.	Integer	`10000`
`rgw_socket_path`	The socket path for the domain socket. `FastCgiExternalServer` uses this socket. If you do not specify a socket path, Ceph Object Gateway will not run as an external server. The path you specify here must be the same as the path specified in the `rgw.conf` file.	String	N/A
`rgw_host`	The host for the Ceph Object Gateway instance. Can be an IP address or a hostname.	String	`0.0.0.0`
`rgw_port`	Port the instance listens for requests. If not specified, Ceph Object Gateway runs external FastCGI.	String	None
`rgw_dns_name`	The DNS name of the served domain. See also the `hostnames` setting within zone groups.	String	None
`rgw_script_uri`	The alternative value for the `SCRIPT_URI` if not set in the request.	String	None
`rgw_request_uri`	The alternative value for the `REQUEST_URI` if not set in the request.	String	None
`rgw_print_continue`	Enable `100-continue` if it is operational.	Boolean	`true`
`rgw_remote_addr_param`	The remote address parameter. For example, the HTTP field containing the remote address, or the `X-Forwarded-For` address if a reverse proxy is operational.	String	`REMOTE_ADDR`
`rgw_op_thread_timeout`	The timeout in seconds for open threads.	Integer	600
`rgw_op_thread_suicide_timeout`	The `timeout` in seconds before a Ceph Object Gateway process dies. Disabled if set to `0`.	Integer	`0`
`rgw_thread_pool_size`	The size of the thread pool.	Integer	512 threads.
`rgw_num_control_oids`	The number of notification objects used for cache synchronization between different `rgw` instances.	Integer	`8`
`rgw_init_timeout`	The number of seconds before Ceph Object Gateway gives up on initialization.	Integer	`30`
`rgw_mime_types_file`	The path and location of the MIME types. Used for Swift auto-detection of object types.	String	`/etc/mime.types`
`rgw_gc_max_objs`	The maximum number of objects that may be handled by garbage collection in one garbage collection processing cycle.	Integer	`32`
`rgw_gc_obj_min_wait`	The minimum wait time before the object may be removed and handled by garbage collection processing.	Integer	`2 * 3600`
`rgw_gc_processor_max_time`	The maximum time between the beginning of two consecutive garbage collection processing cycles.	Integer	`3600`
`rgw_gc_processor_period`	The cycle time for garbage collection processing.	Integer	`3600`
`rgw_s3 success_create_obj_status`	The alternate success status response for `create-obj`.	Integer	`0`
`rgw_resolve_cname`	Whether `rgw` should use the DNS CNAME record of the request hostname field (if hostname is not equal to `rgw_dns name`).	Boolean	`false`
`rgw_object_stripe_size`	The size of an object stripe for Ceph Object Gateway objects.	Integer	`4 << 20`
`rgw_extended_http_attrs`	Add a new set of attributes that could be set on an object. These extra attributes can be set through HTTP header fields when putting the objects. If set, these attributes will return as HTTP fields when doing GET/HEAD on the object.	String	None. For example: "content_foo, content_bar"
`rgw_exit_timeout_secs`	Number of seconds to wait for a process before exiting unconditionally.	Integer	`120`
`rgw_get_obj_window_size`	The window size in bytes for a single object request.	Integer	`16 << 20`
`rgw_get_obj_max_req_size`	The maximum request size of a single get operation sent to the Ceph Storage Cluster.	Integer	`4 << 20`
`rgw_relaxed_s3_bucket_names`	Enables relaxed S3 bucket names rules for zone group buckets.	Boolean	`false`
`rgw_list buckets_max_chunk`	The maximum number of buckets to retrieve in a single operation when listing user buckets.	Integer	`1000`
`rgw_override_bucket_index_max_shards`	The number of shards for the bucket index object. A value of `0` indicates there is no sharding. IBM does not recommend setting a value too large (for example, `1000`) as it increases the cost for bucket listing. This variable should be set in the `[client]` or the `[global]` section so it is automatically applied to `radosgw-admin` commands.	Integer	`0`
`rgw_curl_wait_timeout_ms`	The timeout in milliseconds for certain `curl` calls.	Integer	`1000`
`rgw_copy_obj_progress`	Enables output of object progress during long copy operations.	Boolean	`true`
`rgw_copy_obj_progress_every_bytes`	The minimum bytes between copy progress output.	Integer	`1024 * 1024`
`rgw_admin_entry`	The entry point for an admin request URL.	String	`admin`
`rgw_content_length_compat`	Enable compatibility handling of FCGI requests with both CONTENT_LENGTH AND HTTP_CONTENT_LENGTH set.	Boolean	`false`
`rgw_bucket_default_quota_max_objects`	The default maximum number of objects per bucket. This value is set on new users if no other quota is specified. It has no effect on existing users. This variable should be set in the `[client]` or the `[global]` section so it is automatically applied to `radosgw-admin` commands.	Integer	`-1`
`rgw_bucket_quota_ttl`	The amount of time in seconds cached quota information is trusted. After this timeout, the quota information will be re-fetched from the cluster.	Integer	600
`rgw_user_quota_bucket_sync_interval`	The amount of time in seconds bucket quota information is accumulated before syncing to the cluster. During this time, other RGW instances will not see the changes in bucket quota stats from operations on this instance.	Integer	180
`rgw_user_quota_sync_interval`	The amount of time in seconds user quota information is accumulated before syncing to the cluster. During this time, other RGW instances will not see the changes in user quota stats from operations on this instance.	Integer	3600 * 24
`log_meta`	A zone parameter to determine whether or not the gateway logs the metadata operations.	Boolean	`false`
`log_data`	A zone parameter to determine whether or not the gateway logs the data operations.	Boolean	`false`
`sync_from_all`	A `radosgw-admin` command to set or unset whether zone syncs from all zonegroup peers.	Boolean	`false`
`rgw_curl_tcp_keepalive`	Enables TCP keepalive on the HTTP client sockets managed by libcurl. This does not apply to connections received by the HTTP frontend, but only to HTTP requests sent by radosgw. Examples include requests to Keystone for authentication, sync requests from multisite, and requests to key management servers for SSE.	Boolean	`false`