diff --git a/cmd/config-current.go b/cmd/config-current.go index b1be6960a..2c35ac432 100644 --- a/cmd/config-current.go +++ b/cmd/config-current.go @@ -84,22 +84,34 @@ func initHelp() { // Captures help for each sub-system helpSubSys := config.HelpKVS{ + config.HelpKV{ + Key: config.SubnetSubSys, + Type: "string", + Description: "register the cluster to MinIO SUBNET", + Optional: true, + }, + config.HelpKV{ + Key: config.CallhomeSubSys, + Type: "string", + Description: "enable callhome to MinIO SUBNET", + Optional: true, + }, config.HelpKV{ Key: config.SiteSubSys, Description: "label the server and its location", }, config.HelpKV{ - Key: config.CacheSubSys, - Description: "add caching storage tier", + Key: config.APISubSys, + Description: "manage global HTTP API call specific features, such as throttling, authentication types, etc.", + }, + config.HelpKV{ + Key: config.ScannerSubSys, + Description: "manage namespace scanning for usage calculation, lifecycle, healing and more", }, config.HelpKV{ Key: config.CompressionSubSys, Description: "enable server side compression of objects", }, - config.HelpKV{ - Key: config.EtcdSubSys, - Description: "federate multiple clusters for IAM and Bucket DNS", - }, config.HelpKV{ Key: config.IdentityOpenIDSubSys, Description: "enable OpenID SSO support", @@ -121,14 +133,6 @@ func initHelp() { Key: config.PolicyPluginSubSys, Description: "enable Access Management Plugin for policy enforcement", }, - config.HelpKV{ - Key: config.APISubSys, - Description: "manage global HTTP API call specific features, such as throttling, authentication types, etc.", - }, - config.HelpKV{ - Key: config.ScannerSubSys, - Description: "manage namespace scanning for usage calculation, lifecycle, healing and more", - }, config.HelpKV{ Key: config.LoggerWebhookSubSys, Description: "send server logs to webhook endpoints", @@ -195,16 +199,12 @@ func initHelp() { MultipleTargets: true, }, config.HelpKV{ - Key: config.SubnetSubSys, - Type: "string", - Description: "set subnet config for the cluster e.g. api key", - Optional: true, + Key: config.EtcdSubSys, + Description: "persist IAM assets externally to etcd", }, config.HelpKV{ - Key: config.CallhomeSubSys, - Type: "string", - Description: "enable callhome for the cluster", - Optional: true, + Key: config.CacheSubSys, + Description: "[DEPRECATED] add caching storage tier", }, } diff --git a/docs/config/README.md b/docs/config/README.md index d3370b3fc..491dd3f37 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -132,19 +132,35 @@ KEY: api manage global HTTP API call specific features, such as throttling, authentication types, etc. ARGS: -requests_max (number) set the maximum number of concurrent requests, e.g. "1600" -requests_deadline (duration) set the deadline for API requests waiting to be processed e.g. "1m" -cors_allow_origin (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com" -remote_transport_deadline (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h" +requests_max (number) set the maximum number of concurrent requests (default: '0') +requests_deadline (duration) set the deadline for API requests waiting to be processed (default: '10s') +cluster_deadline (duration) set the deadline for cluster readiness check (default: '10s') +cors_allow_origin (csv) set comma separated list of origins allowed for CORS requests (default: '*') +remote_transport_deadline (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h" (default: '2h') +list_quorum (string) set the acceptable quorum expected for list operations e.g. "optimal", "reduced", "disk", "strict" (default: 'strict') +replication_priority (string) set replication priority (default: 'auto') +transition_workers (number) set the number of transition workers (default: '100') +stale_uploads_expiry (duration) set to expire stale multipart uploads older than this values (default: '24h') +stale_uploads_cleanup_interval (duration) set to change intervals when stale multipart uploads are expired (default: '6h') +delete_cleanup_interval (duration) set to change intervals when deleted objects are permanently deleted from ".trash" folder (default: '5m') +disable_odirect (boolean) set to disable O_DIRECT for reads under special conditions. NOTE: it is not recommended to disable O_DIRECT without prior testing. (default: 'off') ``` or environment variables ``` -MINIO_API_REQUESTS_MAX (number) set the maximum number of concurrent requests, e.g. "1600" -MINIO_API_REQUESTS_DEADLINE (duration) set the deadline for API requests waiting to be processed e.g. "1m" -MINIO_API_CORS_ALLOW_ORIGIN (csv) set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com" -MINIO_API_REMOTE_TRANSPORT_DEADLINE (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h" +MINIO_API_REQUESTS_MAX (number) set the maximum number of concurrent requests (default: '0') +MINIO_API_REQUESTS_DEADLINE (duration) set the deadline for API requests waiting to be processed (default: '10s') +MINIO_API_CLUSTER_DEADLINE (duration) set the deadline for cluster readiness check (default: '10s') +MINIO_API_CORS_ALLOW_ORIGIN (csv) set comma separated list of origins allowed for CORS requests (default: '*') +MINIO_API_REMOTE_TRANSPORT_DEADLINE (duration) set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h" (default: '2h') +MINIO_API_LIST_QUORUM (string) set the acceptable quorum expected for list operations e.g. "optimal", "reduced", "disk", "strict" (default: 'strict') +MINIO_API_REPLICATION_PRIORITY (string) set replication priority (default: 'auto') +MINIO_API_TRANSITION_WORKERS (number) set the number of transition workers (default: '100') +MINIO_API_STALE_UPLOADS_EXPIRY (duration) set to expire stale multipart uploads older than this values (default: '24h') +MINIO_API_STALE_UPLOADS_CLEANUP_INTERVAL (duration) set to change intervals when stale multipart uploads are expired (default: '6h') +MINIO_API_DELETE_CLEANUP_INTERVAL (duration) set to change intervals when deleted objects are permanently deleted from ".trash" folder (default: '5m') +MINIO_API_DISABLE_ODIRECT (boolean) set to disable O_DIRECT for reads under special conditions. NOTE: it is not recommended to disable O_DIRECT without prior testing. (default: 'off') ``` #### Notifications