{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"ba67d467-5530-4508-9673-921e730e34ab"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"f575b49a-1152-4c76-87d1-0cf0015a4af3"}},{"type":"paragraph","content":[{"text":"These configuration files reside on the system after installing the Content Gateway service:","type":"text"}]},{"type":"codeBlock","content":[{"text":"/etc/caringo/cloudgateway/gateway.cfg \n/etc/caringo/cloudgateway/logging.yaml","type":"text"}]},{"type":"paragraph","content":[{"text":"Logging:","type":"text","marks":[{"type":"strong"}]},{"text":" See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443810251"}},{"text":" after completing the Gateway configuration. The configuration file for logging changed from ","type":"text"},{"text":"logging.cfg","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"logging.yaml","type":"text","marks":[{"type":"code"}]},{"text":" as of Gateway 6.0 to support newer versions of Elasticsearch and to add customizations to the YAML file. See the ","type":"text"},{"text":"Apache documentation for logging","type":"text","marks":[{"type":"link","attrs":{"href":"https://logging.apache.org/log4j/2.x/manual/configuration.html#YAML"}}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Password Security","type":"text"}]},{"type":"paragraph","content":[{"text":"Plain-text passwords in both Gateway Configuration and ","type":"text"},{"text":"IDSYS","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443816826"}}]},{"text":" are replaced by encrypted versions on startup. Enter new passwords and restart Gateway when management passwords need to be changed, which replaces those strings with encrypted versions as part of startup. (v7.1)","type":"text"}]},{"type":"paragraph","content":[{"text":"These config items must be changed back to plain text so they can be encrypted with the new key if the adminDomain is deleted or changed.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Info","type":"text"}]},{"type":"paragraph","content":[{"text":"Upgrading does not replace your ","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" with the latest version in the rpm. It instead creates a ","type":"text"},{"text":"gateway.cfg.rpmnew","type":"text","marks":[{"type":"code"}]},{"text":" file. If needed, you can reapply your customizations and replace ","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" to see the latest configuration variables. Always back up the ","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" before making changes.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Configuring the Content Gateway","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Minimum Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"While cluster administrators must understand the details of configuring Content Gateway, this section summarizes the minimum steps required to configure and run Gateway. To deploy Gateway into production, additional customization is needed.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Check either that ","type":"text"},{"text":"IPTABLES","type":"text","marks":[{"type":"code"}]},{"text":" are off or that inbound access for the front-end protocols is allowed. These commands turn off and disable the firewall daemon.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"systemctl disable firewalld\nsystemctl stop firewalld","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit the ","type":"text"},{"text":"/etc/caringo/cloudgateway/gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" file:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"adminDomain","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"to the name of an administrative domain that is created.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"hosts","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"for the storage cluster nodes. Including 4 to 5 nodes is sufficient for most deployments.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"indexerHosts","type":"text","marks":[{"type":"code"}]},{"text":" to the Elasticsearch servers (required for S3 and Content Metering).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable at least one of the front-end protocols: ","type":"text"},{"text":"SCSP","type":"text","marks":[{"type":"strong"}]},{"text":" or ","type":"text"},{"text":"S3","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"Alternatively, for Service Proxy use (to host the Swarm UI), set ","type":"text"},{"text":"both","type":"text","marks":[{"type":"em"}]},{"text":" to disabled and complete the ","type":"text"},{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]},{"text":" section.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create the administrative domain by running the following on the first Gateway server:","type":"text"}]},{"type":"codeBlock","content":[{"text":"/opt/caringo/cloudgateway/bin/initgateway","type":"text"}]},{"type":"paragraph","content":[{"text":"Password Security: ","type":"text","marks":[{"type":"strong"}]},{"text":"This one-time step initializes password encryption for the Gateway configuration and IDSYS files. If upgrading from a version prior to 7.1, this initialization must be run again on one Gateway server to enable the feature. (v7.1)","type":"text"},{"type":"hardBreak"},{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443810269"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start the Gateway service:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"systemctl start cloudgateway","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable automatic startup of the Gateway service.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"systemctl enable cloudgateway","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Production deployments require customizations of the configuration parameters, below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration Sections of gateway.cfg","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" file controls the core operations of the Content Gateway. It is a plain text, INI-formatted file read when the Gateway is first started. The parameters within the file are organized into the following sections, and colored rows are generally essential entries.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"4"},"maxLevel":{"value":"4"},"outline":{"value":"false"},"type":{"value":"list"},"printable":{"value":"false"}},"macroMetadata":{"macroId":{"value":"997efe39-c1fe-43c1-a8bd-087632818d29"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c9f79efb-ac6f-46a4-8ba8-e5576e1a40de"}},{"type":"heading","attrs":{"level":4},"content":[{"text":"[gateway]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures client communications.","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"344df405-ba30-4f8b-8371-62ce4666cc74"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"adminDomain","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"undefined","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"Required. The administrative domain where meta information about tenants and storage domains is kept. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"This parameter must be set to the same value for all Gateway servers.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Changing the adminDomain invalidates encrypted passwords in idsys.json and gateway.cfg and all tokens.","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"The default value has been removed in Gateway 8.2.1.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"threads","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"100 * (number of CPUs present in the Gateway)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The number of threads allocated to handling client requests. Set for 100 times the number of CPU cores. The minimum is 200.","type":"text"}]},{"type":"paragraph","content":[{"text":"For CPUs with hyperthreading-enabled, this calculation is based on the number of virtual cores, not physical.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"tokenTTLHours","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"24","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The default number of hours an authentication token is valid if no time is defined when it is created.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"multipartSpoolDir","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"/var/spool/cloudgateway","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The location of the spool directory for HTTP multipart MIME upload temporary space.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"Uploads through the Content UI use SCSP multipart uploads rather than multipart MIME uploads. (Gateway v6.2)","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"multipartUsageAllowed","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"50","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The percentage of the file system that can be used for multipart MIME upload temporary space.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteMaxThreads","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"50","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The maximum number of parallel delete operations to dispatch when processing recursive delete requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"sanitizeErrors","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"Set to true to hide identity management configuration details from authentication errors.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"cookieDomains","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"One or more base domains for the ","type":"text"},{"text":"Set-Cookie","type":"text","marks":[{"type":"code"}]},{"text":" 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)","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"paragraph","content":[{"text":"cookieDomains = cloud.example.com cloud.example.net","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"veeamKbBlockSize","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"8192","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"The capacity and availability returned in a GET of ","type":"text"},{"text":"pseudo-object .system-d26a9498-cb7c-4a87-a44a-8ae204f5ba6c/capacity.xml","type":"text","marks":[{"type":"code"}]},{"text":" 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.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note ","type":"text"}]},{"type":"paragraph","content":[{"text":"Veeam uses S3 multipart uploads, which requires EC to be enabled.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteMaxItems","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"10000","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The max multidelete request items, SCSP only. S3 has a fixed limit of 1000 which is defined by AWS.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteMaxSize","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"2560000","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"The max multidelete request body size (~2.5Mb).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteMaxRetries","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"Number of retries when hitting 503 on delete.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteRetryDelay","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"500","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"Number of milliseconds to wait before retrying.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[192.0]},"content":[{"type":"paragraph","content":[{"text":"recursiveDeleteSynchronousIndexing ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[227.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[771.0]},"content":[{"type":"paragraph","content":[{"text":"Whether to request synchronous ES index update during each delete.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[storage_cluster] ","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures the back-end storage cluster.","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":1204.0,"localId":"7eadfa23-eff9-49a6-a58b-fab46af161f4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"locatorType","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"\"static\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Zeroconf ","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.zeroconf.org/"}}]},{"text":"is not supported.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"hosts","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"server1 server2 server3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Space or comma delimited list of IP addresses or host names of the storage cluster nodes.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"80","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Integer socket port number for SCSP on the storage nodes.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"clusterName","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The name of the storage cluster.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"indexerHosts","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"indexer1 indexer2 indexer3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Space or comma delimited list of the Elasticsearch metadata index servers used by the storage cluster. ","type":"text"},{"text":"Must be from the same ES cluster: do not mix old and new clusters.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Required for the S3 protocol and for ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443817185"}}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"Primary","type":"text","marks":[{"type":"em"}]},{"text":" Swarm Search feed changes, update this setting and restart the Gateway servers. ","type":"text"},{"text":"indexerHosts","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"must","type":"text","marks":[{"type":"em"}]},{"text":" match Swarm's default Search Feed because Gateway receives the index alias name from the default. ","type":"text"},{"text":"indexerHosts=ES5","type":"text","marks":[{"type":"code"}]},{"text":"does not work when set if the default feed is still ","type":"text"},{"text":"ES2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"indexerPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"9200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The socket port on which the Elasticsearch servers listen.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"managementPort","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"managementUser managementPassword","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"91","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Provide these credentials for the storage cluster to enable Gateway version and component information to be included in the ","type":"text"},{"text":"cluster health report","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443815867"}}]},{"text":" that provides proactive support from DataCore. (v6.0)","type":"text"}]},{"type":"paragraph","content":[{"text":"Required ","type":"text","marks":[{"type":"strong"}]},{"text":"when using [cluster_admin].","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"clientBindAddress","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"0.0.0.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"maxConnectionsPerRoute","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"threads / 2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The maximum number of open connections to a specific storage node.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"maxConnections","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"(threads / 2) * (number of nodes)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The maximum number of open connections to allow. This includes both active and idle connections.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"connectTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"60","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The time in seconds allowed to connect to a node.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"socketTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"10","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The time in seconds allowed for an active connection to deliver data.","type":"text"},{"type":"hardBreak"},{"text":"10 (seconds), default starting 8.1.0. Set to -1 to disable.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"idleTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"120","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The time in seconds an idle socket is allowed to remain in the connection pool.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"indexerSocketTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"120","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"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)","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Increase the load balancer (such as HAProxy) \"timeout server\" and S3 client timeouts as needed to match this.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"continueWaitTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"30","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"The time in seconds to wait for client response after a 100 continue reply.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"dataProtection","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"\"immediate\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"Controls whether synchronous (","type":"text"},{"text":"immediate","type":"text","marks":[{"type":"em"}]},{"text":", using replicate on write) or asynchronous (","type":"text"},{"text":"delayed","type":"text","marks":[{"type":"em"}]},{"text":") data protection is requested when writing to the storage cluster.","type":"text"}]},{"type":"paragraph","content":[{"text":"Values:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"immediate\" (for replicate on write) - requires storage cluster setting of ","type":"text"},{"text":"scsp.replicateOnWrite=true","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"\"delayed\" (disables replicate on write) - requires storage cluster setting of ","type":"text"},{"text":"scsp.replicateOnWrite=false","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443811678"}}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"blockUndeletableWrites","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[256.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[740.0]},"content":[{"type":"paragraph","content":[{"text":"When enabled, the Gateway rejects any SCSP write (PUT, POST, COPY, APPEND) that includes a ","type":"text"},{"text":"deletable=no/false","type":"text","marks":[{"type":"code"}]},{"text":" 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\".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[scsp]","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This section configures the front-end SCSP protocol. This protocol must be enabled for any Gateway that services Content UI requests.","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"70f6418b-b90f-4dee-a2c3-f2def8dc0dcd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"enabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[940.0]},"content":[{"type":"paragraph","content":[{"text":"Activates this protocol: Values are: \"true\", \"false\".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"bindAddress","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"0.0.0.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[940.0]},"content":[{"type":"paragraph","content":[{"text":"The IP address of the network interface to which the listening socket binds. Defaults to all interfaces.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"bindPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"80","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[940.0]},"content":[{"type":"paragraph","content":[{"text":"Integer socket port number for protocol.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Must be unique from S3 port if both are enabled.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"externalHTTPPort","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"externalHTTPSPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"80","type":"text"}]},{"type":"paragraph","content":[{"text":"443","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[940.0]},"content":[{"type":"paragraph","content":[{"text":"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)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"allowSwarmAdminIP","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[142.0]},"content":[{"type":"paragraph","content":[{"text":"undefined","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[940.0]},"content":[{"type":"paragraph","content":[{"text":"Allows the use of internal Swarm requests for content replication to pass through the Gateway. This is useful if using replication feeds between clusters that use Gateway as the front-end.","type":"text"}]},{"type":"paragraph","content":[{"text":"Values are \"all\", full IP addresses, IP address prefixes, a list of IPs/prefixes, or CIDR format such as 172.30.15.0/24. ","type":"text"},{"type":"hardBreak"},{"text":"When undefined, no clients are allowed to send Swarm admin requests through the Gateway.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"This provides an additional layer of security. Any admin requests sent to Swarm require Swarm admin user and password correctly supplied.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[s3] ","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures the front-end S3 protocol, which is optional.","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"9d0d7986-3134-4642-a12a-af9c9faf4746"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"enabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"The protocol must be explicitly enabled. Values are: \"true\", \"false\".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"bindAddress","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"0.0.0.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"The IP address of the network interface to which the listening socket binds. Defaults to all interfaces.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"bindPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"80","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#ffffdd","rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"Integer socket port number for protocol.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Must be unique from SCSP port if both are enabled.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"externalHTTPPort","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"externalHTTPSPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"80","type":"text"},{"type":"hardBreak"},{"text":"443","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"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)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"enhancedListingConsistency","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"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)","type":"text"}]},{"type":"paragraph","content":[{"text":"Exceptions to synchronous indexing:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes of manifests for canceled multipart uploads are done asynchronously.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On a rename, Swarm indexes the new name synchronously, but the old name is deleted asynchronously.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On a parallel write complete, the init stream is deleted asynchronously.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"region","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"The Amazon S3 ","type":"text"},{"text":"GET Bucket Location","type":"text","marks":[{"type":"em"}]},{"text":" request returns the AWS region in which the bucket is located. ","type":"text"},{"type":"hardBreak"},{"text":"By default, Gateway returns an empty value for the location, which S3 clients interpret as ","type":"text"},{"text":"us-east-1","type":"text","marks":[{"type":"strong"}]},{"text":". If another region is required, there are two options:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Supply the location in the bucket creation operation using LocationConstraint.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" option in the Gateway configuration file to the preferred region. This applies to all buckets unless the location is specified during creation.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"If you require the behavior prior to Content Gateway 7.10.2 of returning the cluster name, set ","type":"text"},{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" to that cluster name.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"forcedDomain","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[765.0]},"content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"forcedDomain","type":"text","marks":[{"type":"code"}]},{"text":" 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.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[metering] ","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures usage metering, which is optional. See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443817185"}}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Tip","type":"text"}]},{"type":"paragraph","content":[{"text":"Do not confuse Gateway ","type":"text"},{"text":"metering","type":"text","marks":[{"type":"em"}]},{"text":", which manages quotas and graphs storage and bandwidth usage in Content UI, with ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/DOCS/pages/2443813497"}},{"text":",","type":"text","marks":[{"type":"em"}]},{"text":" which provide graphs of cluster metrics in the Storage UI.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Elasticsearch indices are distinguished by prefix:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"csmeter-* ","type":"text","marks":[{"type":"strong"}]},{"text":"- Gateway metering","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"metrics-*","type":"text","marks":[{"type":"strong"}]},{"text":" - Swarm historical metrics ","type":"text"}]}]}]}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"35076e4c-59ea-49ef-83b7-616c0af68128"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[307.0]},"content":[{"type":"paragraph","content":[{"text":"enabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[719.0]},"content":[{"type":"paragraph","content":[{"text":"The feature must be explicitly enabled.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[307.0]},"content":[{"type":"paragraph","content":[{"text":"flushIntervalSeconds","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"300 (5 minutes)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[719.0]},"content":[{"type":"paragraph","content":[{"text":"How frequently to send usage reports to Elasticsearch. Minimum is 10 seconds. The default value is optimized for the resolution of the queries.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[307.0]},"content":[{"type":"paragraph","content":[{"text":"retentionDays","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"100 (days)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[719.0]},"content":[{"type":"paragraph","content":[{"text":"How long to retain usage records. Minimum is 2 days. Allow for additional storage space if significantly increasing the retention period.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[307.0]},"content":[{"type":"paragraph","content":[{"text":"storageSampleIntervalSeconds","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[166.0]},"content":[{"type":"paragraph","content":[{"text":"3600 (1 hour)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[719.0]},"content":[{"type":"paragraph","content":[{"text":"How frequently to sample the disk usage. Minimum is 900 (15 minutes). Larger values reduce the query workload on Elasticsearch.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[caching]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures cache expiration. Times are in seconds. To disable, set it to 0.","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"56f0ddd8-8ecb-4dbb-856a-521e30baf0fd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"authRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time before authorization is revalidated with a request to the identity management system.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"tokenRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time before an authentication token is revalidated with a request to the administration domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"idsysRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time an IDSYS document, or its nonexistence, is cached in memory.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"policyRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time a tenant, domain, or bucket Policy document, or its nonexistence, is cached in memory.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"xformRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time an XFORM document, or its nonexistence, is cached in memory.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"metadataRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time that metadata for a tenant, domain, or bucket, or its nonexistence, is cached in memory. ","type":"text"},{"type":"hardBreak"},{"text":"This includes the owner for a tenant/domain/bucket and whether a bucket exists.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"domainExistenceRefresh","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"300","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Time that the knowledge of a domain's existence or nonexistence is cached.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[218.0]},"content":[{"type":"paragraph","content":[{"text":"socketTimeout","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[129.0]},"content":[{"type":"paragraph","content":[{"text":"10 (seconds)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[978.0]},"content":[{"type":"paragraph","content":[{"text":"Default timeout starting from v8.1.0. Set to -1 to disable this configuration.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[quota]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures storage and network usage quotas. See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443818631"}}]},{"type":"paragraph","content":[{"text":"The Gateway regularly refreshes the cache of quota information using an Elasticsearch query against usage metrics when enabled; it changes the quota state and performs the action specified by policy if any quota limit is reached. ","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"f4db7eb6-6bd9-4110-a150-97d73f569b8d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"enabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"The feature must be explicitly enabled.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"minRefreshDeadline","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"60","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"The global limits on the speed of quota data refreshing. To increase the precision of the usage data, lower these values. To reduce the load on Elasticsearch, increase these values.","type":"text"}]},{"type":"paragraph","content":[{"text":"To optimize the load on Elasticsearch, Gateway refreshes with a dynamic algorithm: slower when metrics are still far from the limit and faster when the limit approaches, slower when approaching a limit and faster as the overage nears an end. The minimum and maximum deadlines refer to the caps to apply to this refresh rate (no faster and no slower than these values).","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"maxRefreshDeadline","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"3600","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"numRefreshThreads","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"4","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"The number of threads in the pool that continuously look at the most urgent deadlines in the queue and perform the refreshes (Elasticsearch queries) as needed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"maxRefreshRetries","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"The number of times a refresh can fail due to a failing Elasticsearch query before an error is logged and the refresh is dropped.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"maxQueueSize","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"10000","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Maximum queue size for scope quota evaluations. The internal implementation uses a deadline queue and, If the queue is overflowed, the least urgent items are pushed out of the queue.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"queryTTL","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"maxRefreshDeadline","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"This avoids unnecessary load on Elasticsearch by allowing the results of a quota check performed when a scope (tenant, domain, bucket) is accessed to be cached for this period of time. If the time since last access is less that this value, the scope is not scanned in the background. Setting this parameter to 0 disables the access caching function.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"refreshRetryDelay","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"10","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Number of seconds to wait before retrying a refresh after the previous failed due to a failing Elasticsearch query.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"refreshIdleSleep","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Seconds to wait after finishing the work in a queue and before starting again.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"smtpHost","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"localhost","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Required. The hostname or IP address of the SMTP server that sends the email notifications.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"smtpPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"25","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Optional. The port where the SMTP server listens.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"smtpUser","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"smtpPassword","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Optional. The user and password to authenticate with SMTP server.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"mailFrom","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"donotreply@localhost","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Email address for the sender of the notification.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"mailSubjectTemplate","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"Quota state change notification","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[778.0]},"content":[{"type":"paragraph","content":[{"text":"Email templates for subject line and body. These variables can be used in both the subject line and message body templates.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"%metric%","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"%state%","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"%contextType%","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"%contextName%","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The %xxx% strings render current values when the message is generated.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[233.0]},"content":[{"type":"paragraph","content":[{"text":"mailTemplate","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"Metric %metric% changed to %state% state in %contextType% %contextName%.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[dynamic_features]","type":"text"}]},{"type":"paragraph","content":[{"text":"Any configuration settings appear in this ","type":"text"},{"text":"Dynamic Features","type":"text","marks":[{"type":"strong"}]},{"text":" section if optional, dynamic features such as ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2990833665"}},{"text":" are installed. (v11.0)","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"9f53ccb4-e8d3-4d7e-8933-3ac8d24931e4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.0]},"content":[{"type":"paragraph","content":[{"text":"resultObjectLifetime","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[116.0]},"content":[{"type":"paragraph","content":[{"text":"5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[926.0]},"content":[{"type":"paragraph","content":[{"text":"In days. Sets a lifepoint to trigger clean up of any JSON result objects for video clips are created asynchronously.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[folder_listings]","type":"text"}]},{"type":"paragraph","content":[{"text":"The section configures options related to object listings.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"d8d6bb18-122e-4129-9ff9-a8440aff765e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[161.0]},"content":[{"type":"paragraph","content":[{"text":"usePaths","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[874.0]},"content":[{"type":"paragraph","content":[{"text":"A setting introduced in Gateway v7.10.0 to improve S3 delimiter listing performance. The default is true as of Gateway v8.0.3. Also see ","type":"text"},{"text":"usePathsMaxDirs","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"It requires Swarm 14.1 or later with ","type":"text"},{"text":"search.enableDelimiterPaths","type":"text","marks":[{"type":"code"}]},{"text":" set to ","type":"text"},{"text":"True","type":"text","marks":[{"type":"code"}]},{"text":". This is the default for new Swarm 15.0+ clusters, see ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443811510"}},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"Set this setting explicitly if upgrading from Swarm 14.1.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"swarmctl -C search.enableDelimiterPaths -V True","type":"text","marks":[{"type":"code"}]},{"text":" and create a new search feed. See also, ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2919006276"}},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"The new feed can use the same Elasticsearch cluster if it has at least half of its disk space free.","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make the new search feed the default after completion. Then restart gateways with gateway.cfg containing ","type":"text"},{"text":"[folder_listings] usePaths=true","type":"text","marks":[{"type":"code"}]},{"text":", or with ","type":"text"},{"text":"usePaths","type":"text","marks":[{"type":"code"}]},{"text":" commented out as it is now enabled by default. ","type":"text"},{"type":"hardBreak"},{"text":"Now, this makes the top-level delimiter listings (used by Veeam and S3 Browser) faster.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[161.0]},"content":[{"type":"paragraph","content":[{"text":"usePathsMaxDirs","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[874.0]},"content":[{"type":"paragraph","content":[{"text":"A setting introduced in Gateway v8.0.3 that determines which delimiter listings are affected by ","type":"text"},{"text":"usePaths=true","type":"text","marks":[{"type":"code"}]},{"text":". It defaults to 5, which means that it affects delimiter listings without a prefix or with the prefix having up to five subdirectories.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[cluster_admin]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures options related to the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/3374579713"}},{"text":".","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"d1ce2e95-1cb4-47a6-a6cd-870c4f3ad679"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"enabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"Enables the Service Proxy functionality.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"bindAddress","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the IP address or host name where Service Proxy listens for incoming storage cluster management API and Metering Query requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"bindPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"91","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the port where Service Proxy listens. By convention, this is port 91.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"externalHTTPPort","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"externalHTTPSPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"},{"type":"hardBreak"},{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"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)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"platformHost","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"Required for Platform Server if running Service Proxy/Swarm UI on a standalone Gateway.","type":"text"},{"type":"hardBreak"},{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443827916"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"testMode","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[127.0]},"content":[{"type":"paragraph","content":[{"text":"true | false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[500.0]},"content":[{"type":"paragraph","content":[{"text":"Enables testMode when troubleshooting, which stops obfuscation of the backend Swarm Storage and Elasticsearch node IPs.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[metrics]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section configures the metrics server that gateway exposes for Prometheus. Prometheus is configured to poll ","type":"text"},{"text":"/metrics","type":"text","marks":[{"type":"code"}]},{"text":" on this address and port. Metrics are prefixed with ","type":"text"},{"text":"caringo_gateway","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"304e0bd1-7788-4d74-b47f-cbf331f16a37"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"metricsEnabled","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[527.0]},"content":[{"type":"paragraph","content":[{"text":"Metrics is enabled by default","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"metricsPort","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"9100","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[527.0]},"content":[{"type":"paragraph","content":[{"text":"Port for Prometheus to poll","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"metricsHost","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"0.0.0.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[527.0]},"content":[{"type":"paragraph","content":[{"text":"Address the metrics server bind to. 0.0.0.0, by default, refers to all IP addresses. This can be configured to a private address if Prometheus can connect to it. (v7.10.6)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"[debug]","type":"text"}]},{"type":"paragraph","content":[{"text":"This section contains configuration that Support might ask to be temporarily enabled for diagnosis:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"6d9c13a3-8986-4ddb-9bf4-8150b825b642"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"debugConnLeaks","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[95.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[527.0]},"content":[{"type":"paragraph","content":[{"text":"Set this to true as directed by DataCore Support to diagnose connection pool or ","type":"text"},{"text":"stuck thread","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/KB/pages/2202632256"}}]},{"text":" issues.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Setting Ports for Docker or Proxies","type":"text"}]},{"type":"paragraph","content":[{"text":"Gateway manages communications through assigned ports. Gateway is configured to run either within a Docker environment or behind a proxy as of release 5.4. The configuration has two settings (","type":"text"},{"text":"externalHTTPPort","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"externalHTTPSPort","type":"text","marks":[{"type":"code"}]},{"text":") per protocol: ","type":"text"},{"text":"[scsp]","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]},{"text":", the ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/3374579713"}},{"text":". These settings take effect when ","type":"text"},{"text":"X-Forwarded-Proto","type":"text","marks":[{"type":"code"}]},{"text":" appears on the request.","type":"text"}]},{"type":"paragraph","content":[{"text":"SCSP, S3, and Service Proxy request each route to the correct port. Browser requests must use the correct port:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"f79bb18d-3222-4510-be64-9ae1f6a38acc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Content UI","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.0]},"content":[{"type":"paragraph","content":[{"text":"/_admin/portal","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"SCSP port","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.0]},"content":[{"type":"paragraph","content":[{"text":"[scsp]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[137.0]},"content":[{"type":"paragraph","content":[{"text":"Swarm UI","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.0]},"content":[{"type":"paragraph","content":[{"text":"/_admin/storage","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[225.0]},"content":[{"type":"paragraph","content":[{"text":"Service Proxy port","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.0]},"content":[{"type":"paragraph","content":[{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Gateway can redirect users if they attempt to access a UI on the wrong port; to accomplish this,","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The load balancer must set ","type":"text"},{"text":"X-Forwarded-","type":"text","marks":[{"type":"code"}]},{"text":" headers, which Gateway uses to determine which port to use","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configure ","type":"text"},{"text":"externalHTTP[S]Port","type":"text","marks":[{"type":"code"}]},{"text":" correctly in ","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"4dd206aa-85c5-421c-82d3-05fbd3ee0a83"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[353.0]},"content":[{"type":"paragraph","content":[{"text":"Example Load Balancer Setup","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.0]},"content":[{"type":"paragraph","content":[{"text":"Example Settings in gateway.cfg","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[353.0]},"content":[{"type":"paragraph","content":[{"text":"If an HAProxy load balancer at ","type":"text"},{"text":"haproxy.example.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://haproxy.example.com"}}]},{"text":" is proxying requests for SCSP and S3 (on a shared port) and for Service Proxy:","type":"text"}]},{"type":"codeBlock","content":[{"text":"frontend www-http\n bind 0.0.0.0:80\n reqadd X-Forwarded-Proto:\\ http\n # Use for [scsp] externalHTTPPort\n reqadd X-Forwarded-Port:\\ 80\n default_backend www-backend-scsp\n ...\n use_backend www-backend-s3 if iss3\n ...\nfrontend www-http-svc\n bind 0.0.0.0:91\n reqadd X-Forwarded-Proto:\\ http\n # Use for [cluster_admin] externalHTTPPort\n reqadd X-Forwarded-Port:\\ 91\n default_backend www-backend-svc\n ...\nfrontend www-https\n bind 0.0.0.0:443 ssl crt /var/certs/server.pem\n reqadd X-Forwarded-Proto:\\ https\n # Use for [scsp] externalHTTPSPort\n reqadd X-Forwarded-Port:\\ 443\n default_backend www-backend-scsp\n ...\n use_backend www-backend-s3 if iss3\n ...\nfrontend www-https-svc\n bind 0.0.0.0:1443 ssl crt /var/certs/server.pem\n reqadd X-Forwarded-Proto:\\ https\n # Use for [cluster_admin] externalHTTPSPort\n reqadd X-Forwarded-Port:\\ 1443\n default_backend www-backend-svc","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.0]},"content":[{"type":"paragraph","content":[{"text":"...then expose both HTTP and HTTPS ","type":"text"},{"type":"hardBreak"},{"text":"in these sections:","type":"text"}]},{"type":"codeBlock","content":[{"text":"[scsp]\nbindPort = 80\nexternalHTTPSPort = 443\nexternalHTTPPort = 80\n\n[cluster_admin]\nbindPort = 91\nexternalHTTPSPort = 1443\nexternalHTTPPort = 91","type":"text"}]},{"type":"paragraph"}]}]}]},{"type":"paragraph","content":[{"text":"Redirection:","type":"text","marks":[{"type":"strong"}]},{"text":" This is how redirection is achieved given the example above. A user incorrectly attempts to access ","type":"text"},{"text":"/_admin/storage","type":"text","marks":[{"type":"code"}]},{"text":" on the SCSP/S3 port exposed by HAProxy.","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://haproxy.example.com/_admin/storage # default port 443","type":"text"}]},{"type":"paragraph","content":[{"text":"HAProxy proxies this request to Gateway's SCSP port as:","type":"text"}]},{"type":"codeBlock","content":[{"text":"GET /_admin/storage\nHost: gateway:80\nX-Forwarded-Host: haproxy.example.com\nX-Forwarded-Protocol: https\nX-Forwarded-Port: 443","type":"text"}]},{"type":"paragraph","content":[{"text":"Gateway SCSP knows that it does not handle ","type":"text"},{"text":"/_admin/storage","type":"text","marks":[{"type":"code"}]},{"text":" requests and that ","type":"text"},{"text":"/_admin/storage","type":"text","marks":[{"type":"code"}]},{"text":" is handled by the ","type":"text"},{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]},{"text":" port, so it responds with a redirect to the ","type":"text"},{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"externalHTTPSPort","type":"text","marks":[{"type":"code"}]},{"text":" (because ","type":"text"},{"text":"X-Forwarded-Protocol","type":"text","marks":[{"type":"code"}]},{"text":" specifies HTTPS; otherwise, it uses ","type":"text"},{"text":"externalHTTPPort","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"codeBlock","content":[{"text":"HTTP/1.1 308 Permanent Redirect\nGateway-Protocol: scsp\nLocation: https://haproxy.example.com:1443/_admin/storage","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Enabling the Service Proxy","type":"text"}]},{"type":"paragraph","content":[{"text":"For most implementations, one Gateway is dedicated to running as ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/3374579713"}},{"text":" to support cluster administration (using Swarm UI and Management API), and a pool of additional Gateways handles all content management at scale. For test or lightly used clusters, enable both cluster administration and content management on a single Gateway instance.","type":"text"}]},{"type":"paragraph","content":[{"text":"On the Gateway instance that runs as Service Proxy, make the following changes to the configuration (","type":"text"},{"text":"gateway.cfg","type":"text","marks":[{"type":"code"}]},{"text":" file):","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"All these settings are required. Add the ","type":"text"},{"text":"[cluster_admin]","type":"text","marks":[{"type":"code"}]},{"text":" section if the existing configuration file does not include it.","type":"text"}]}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"251be122-07ea-4587-96af-d5b4df0629c5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":6,"colwidth":[222.0]},"content":[{"type":"paragraph","content":[{"text":"[cluster_admin]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"enabled=true","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Enables the Service Proxy functionality.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"bindAddress=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the IP address or host name where Service Proxy listens for incoming storage cluster management API and Metering Query requests.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"bindPort=91","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the port where Service Proxy listens. By convention, this is port 91.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"externalHTTPPort=","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"externalHTTPSPort=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Optional, one or both. Allows Gateway to be used either behind a proxy or within a Docker environment, taking effect when ","type":"text"},{"text":"X-Forwarded-Proto","type":"text","marks":[{"type":"code"}]},{"text":" is found on the request. Gateway uses ","type":"text"},{"text":"X-Forwarded-Proto","type":"text","marks":[{"type":"code"}]},{"text":" to determine which port to use. (v5.4)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"platformHost=","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"platformPort=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Required for Platform Server if running ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/3374579713"}},{"text":"/Swarm UI on a standalone Gateway. ","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443827916"}}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"testMode=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Enables testMode when troubleshooting, which stops obfuscation of the backend Swarm Storage and Elasticsearch node IPs.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":3,"colwidth":[222.0]},"content":[{"type":"paragraph","content":[{"text":"[storage_cluster]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"managementPort=91","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the port where Swarm listens for storage cluster management API requests. By convention, this is port 91.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"managementUser=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the user known to Swarm allowed to perform management API requests against the storage cluster.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"managementPassword=","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[568.0]},"content":[{"type":"paragraph","content":[{"text":"Specifies the password of the ","type":"text"},{"text":"managementUser","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[222.0]},"content":[{"type":"paragraph","content":[{"text":"[s3]","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"enabled=false","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[568.0]},"content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Important","type":"text"}]},{"type":"paragraph","content":[{"text":"Retain the [s3] and [scsp] sections and explicitly set ‘","type":"text"},{"text":"enabled=","type":"text","marks":[{"type":"code"}]},{"text":"’, rather than delete them.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Tip","type":"text"}]},{"type":"paragraph","content":[{"text":"Enable one or both protocols on a single Gateway instance configured as the Service Proxy for test or lightly used clusters.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[222.0]},"content":[{"type":"paragraph","content":[{"text":"[scsp] ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[405.0]},"content":[{"type":"paragraph","content":[{"text":"enabled=false","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Authentication and authorization","type":"text","marks":[{"type":"strong"}]},{"text":" for the Service Proxy use Content Gateway's root IDSYS and root Policy. The root Policy ","type":"text"},{"text":"must","type":"text","marks":[{"type":"em"}]},{"text":" grant all actions to the storage administrator users and/or groups:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"Version\": \"2008-10-17\",\n \"Statement\": [{\n \"Action\": [\"*\"],\n \"Resource\": \"*\",\n \"Effect\": \"Allow\",\n \"Principal\": {\"user\": [\"admin\", \"admin2\"]},\n \"Sid\": \"storage-admins\"\n }],\n \"Id\": \"id-170428899\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443816826"}},{"text":" and ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443816981"}}]}],"version":1}

Browser not supported