Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

...

adminDomain

gatewayAdminDomain

Required. The administrative domain where meta information about tenants and storage domains is kept.

Info

Important

This parameter must be set to the same value for all Gateway servers.

Changing the adminDomain invalidates encrypted passwords in idsys.json and gateway.cfg and all tokens.

This is not recommended to match the Swarm default domain (cluster.name). Doing so leads to “Invalid token” errors if cluster.enforceTenancy=False, which is also not recommended.

threads

200

The number of threads allocated to handling client requests. Set for 100 times number of CPU cores. Minimum is 200.

For CPUs with hyperthreading enabled, this calculation is based on the number of virtual cores, not physical.

tokenTTLHours

24

The default number of hours an authentication token is valid if no time is defined when it is created.

multipartSpoolDir

/var/spool/cloudgateway

The location of the spool directory for HTTP multipart MIME upload temporary space.

Note

Uploads through the Content UI use SCSP multipart uploads rather than multipart MIME uploads. (Gateway v6.2)

multipartUsageAllowed

50

The percentage of the file system that can be used for multipart MIME upload temporary space.

recursiveDeleteMaxThreads

50

The maximum number of parallel delete operations to dispatch when processing recursive delete requests.

sanitizeErrors

false

Set to true to hide identity management configuration details from authentication errors.

cookieDomains


One or more base domains for the Set-Cookie response header to scope (instead of the FQDN from the request) if an authentication token is created within a child domain of one of these base domains. This can be useful when using the Content UI to access multiple storage domains that share a common base domain when wanting to use the same authentication token across domains. (v5.2.2)

Example:

cookieDomains = cloud.example.com cloud.example.net

veeamKbBlockSize

8192

Gateway implements the Veeam SOSAPI extension (v7.10.3). This config allows block size configuration. The default and recommended value is 8192. Set to 0 to disable SOSAPI handling.

The capacity and availability returned in a GET of pseudo-object .system-d26a9498-cb7c-4a87-a44a-8ae204f5ba6c/capacity.xml are estimated based on the bucket's evaluated EC setting which is cached for 5 minutes. The values are based on cluster capacity; bucket quotas are not currently used.

Note

Veeam uses S3 multipart uploads, which requires EC to be enabled.

recursiveDeleteMaxThreads

50

The size of threadpool for SCSP/S3 multidelete operations

.

recursiveDeleteMaxItems

10000

The max multidelete request items, SCSP only. S3 has a fixed limit of 1000 which is defined by AWS.

recursiveDeleteMaxSize

2560000

The max multidelete request body size (~2.5Mb).

recursiveDeleteMaxRetries

3

Number of retries when hitting 503 on delete.

recursiveDeleteRetryDelay

500

Number of milliseconds to wait before retrying.

recursiveDeleteSynchronousIndexing

true

Whether to request synchronous ES index update during each delete.

...

locatorType

"static"

Zeroconf is not supported.

hosts

server1 server2 server3

Space or comma delimited list of IP addresses or host names of the storage cluster nodes.

port

80

Integer socket port number for SCSP on the storage nodes.

clusterName


The name of the storage cluster.

indexerHosts

indexer1 indexer2 indexer3

Space or comma delimited list of the Elasticsearch metadata index servers used by the storage cluster. Must be from the same ES cluster: do not mix old and new clusters.

Required for the S3 protocol and for Content Metering

Info

Important

If the Primary Swarm Search feed changes, update this setting and restart the Gateway servers. indexerHosts must match Swarm's default Search Feed because Gateway receives the index alias name from the default. indexerHosts=ES5does not work when set if the default feed is still ES2.

indexerPort

9200

The socket port on which the Elasticsearch servers listen.

managementPort
managementUser managementPassword

91

Provide these credentials for the storage cluster to enable Gateway version and component information to be included in the cluster health report that provides proactive support from DataCore. (v6.0)

Required when using [cluster_admin].

clientBindAddress

0.0.0.0

Set to the IP address of the network interface connected to the storage cluster subnet when using a multi-homed Gateway. The value must be defined as a non-default value when using a multi-homed Gateway server such as one connected to a front-end client network and a back-end storage network.

maxConnectionsPerRoute

100

The maximum number of open connections to a specific storage node.

maxConnections

250

The maximum number of open connections to allow. This includes both active and idle connections.

connectTimeout

60

The time in seconds allowed to connect to a node.

socketTimeout

120

The time in seconds allowed for an active connection to deliver data.

idleTimeout

120

The time in seconds an idle socket is allowed to remain in the connection pool.

indexerSocketTimeout

120

The time in seconds an indexer socket is allowed to remain in the connection pool. This affects the ability to list larger buckets. (v7.1)

Info

Important

Increase the load balancer (such as HAProxy) "timeout server" and S3 client timeouts as needed to match this.

continueWaitTimeout

30

The time in seconds to wait for client response after a 100 continue reply.

dataProtection

"immediate"

Controls whether synchronous (immediate, using replicate on write) or asynchronous (delayed) data protection is requested when writing to the storage cluster.

Values:

  • "immediate" (for replicate on write) - requires storage cluster setting of scsp.replicateOnWrite=true

  • "delayed" (disables replicate on write) - requires storage cluster setting of scsp.replicateOnWrite=false 

See Configuring ROW Replicate On Write

blockUndeletableWrites

true

When enabled, the Gateway rejects any SCSP write (PUT, POST, COPY, APPEND) that includes a deletable=no/false lifepoint. This restriction applies to both named and unnamed (alias and immutable) objects. The request is refused with a 400 error message, "Unable to write undeletable object".

...

enabled

false

The protocol must be explicitly enabled. Values are: "true", "false".

bindAddress

0.0.0.0

The IP address of the network interface to which the listening socket binds. Defaults to all interfaces.

bindPort

80

Integer socket port number for protocol.

Info

Important

Must be unique from SCSP port if both are enabled.

externalHTTPPort
externalHTTPSPort

80
443

Optional, one or both. Allows Gateway to be used either behind a proxy or within a Docker environment, taking effect when X-Forwarded-Proto is found on the request. Gateway uses X-Forwarded-Proto to determine which port to use. (v5.4)

enhancedListingConsistency

true

Improves compatibility with S3 clients and software libraries that expect consistent listings (despite the documented nature of listings to be eventually consistent). Can be disabled to boost write throughput (especially for small objects), if listing consistency is not critical. (v5.2.1)

Exceptions to synchronous indexing:

  • Deletes of manifests for canceled multipart uploads are done asynchronously.

  • On a delete, when there is not enough space on the local node to write a delete marker for a named object, Swarm writes to another node and indexes asynchronously.

  • On a rename, Swarm indexes the new name synchronously, but the old name is deleted asynchronously.

  • On a parallel write complete, the init stream is deleted asynchronously.

region

The Amazon S3 GET Bucket Location request returns the AWS region in which the bucket is located.
By default, Gateway returns an empty value for the location, which S3 clients interpret as us-east-1. If another region is required, there are two options:

  • Supply the location in the bucket creation operation using LocationConstraint.

  • Set the region option in the Gateway configuration file to the preferred region. This applies to all buckets unless the location is specified during creation.

If you require the behavior prior to Content Gateway 7.10.2 of returning the cluster name, set region to that cluster name.

forcedDomain

Set forcedDomain to the name of an existing domain to force Content Gateway to use that domain for S3 requests regardless of the incoming Host or X-Forwarded-Host header. This allows S3 clients to use gateway hostnames or IP addresses as the endpoint instead of requiring the endpoint to be a domain name. The S3 clients must use the "bucket in path" style of access for all requests, not the “bucket in Host” style. This feature is supported since v7.10.7.

...