{"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":"66fe0205-7c07-4616-b38f-12caf619140f"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"bce44bb6-333b-48b0-94ef-f20930246128"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"For more information about Swarm Gateway, its concepts, and operations, click ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443816622"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Prerequisites","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RHEL/CentOS 7 or RHEL/Rocky Linux 8 Setup","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Latest Swarm bundle package","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/public/pages/3041394691"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Setup Linux for Cloud Gateway","type":"text"}]},{"type":"paragraph","content":[{"text":"Below is the deployment example for the site.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"3b46c6f2-4329-4155-a0b2-53574fe1bf39"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"Minimal Server","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[255.0,300.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Host name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[255.0]},"content":[{"type":"paragraph","content":[{"text":"cg77-01.datacore.internal","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"cg77-02.datacore.internal","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"Application Network ","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[255.0,300.0]},"content":[{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"IP Address","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[255.0]},"content":[{"type":"paragraph","content":[{"text":"172.16.33.16/24 ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[300.0]},"content":[{"type":"paragraph","content":[{"text":"172.16.33.17/24 ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"Gateway","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[255.0,300.0]},"content":[{"type":"paragraph","content":[{"text":"172.16.33.1","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[205.0]},"content":[{"type":"paragraph","content":[{"text":"NTP","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[255.0,300.0]},"content":[{"type":"paragraph","content":[{"text":"172.16.33.10","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"To set up time synchronization for RHEL/CentOS 7 or RHEL/Rocky Linux 8, see ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://perifery.atlassian.net/wiki/spaces/public/pages/2956918809"}}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Install Swarm Gateway","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Info","type":"text"}]},{"type":"paragraph","content":[{"text":"Creating a user/user group/password applies when PAM authentication is used. Create a user group via standard Linux user administration commands.","type":"text"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a user group.","type":"text"}]},{"type":"codeBlock","content":[{"text":"groupadd clusteradmins","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a new user.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"adduser admin -g clusteradmins -p datacore\npasswd admin","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update Linux and install EPEL.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"yum -y update\nyum -y install epel-release","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install NTP server and verify NTP starts on system boot.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"yum -y install chrony\nsystemctl enable chronyd\nsystemctl start chronyd","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configure the firewall to allow Swarm Gateway.","type":"text"}]},{"type":"codeBlock","content":[{"text":"vi /etc/firewalld/services/swarm_gateway.xml","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\n SwarmGateway\n Gateway server, which is based on http traffic.\n \n \n \n \n \n","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the firewall service.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add Swarm Gateway firewall rule (permanent) ","type":"text"}]},{"type":"codeBlock","content":[{"text":"firewall-cmd --permanent --add-service swarm_gateway","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reload the firewall service.","type":"text"}]},{"type":"codeBlock","content":[{"text":"firewall-cmd --reload","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Unzip the Swarm bundle package.","type":"text"}]},{"type":"codeBlock","content":[{"text":"cd /root/datacore\nunzip Swarm-{bundle version here}.zip","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get the latest gateway and UI RPMs from the downloaded Swarm bundle.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"ll ~/datacore/Gateway/\n-rw-r--r--. 1 root root 58718208 Dec 16 22:37 caringo-gateway-{version here}.noarch.rpm \n-rw-r--r--. 1 root root 395 Dec 16 22:37 README.txt \n-rw-r--r--. 1 root root 1927 Oct 2 04:17 RPM-GPG-KEY\n\nll ~/datacore/UI/ \n-rw-r--r--. 1 root root 2835590 Oct 2 04:17 caringo-gateway-webui-{version here}.noarch.rpm \n-rw-r--r--. 1 root root 19286001 Dec 16 22:37 caringo-storage-webui-{version here}.noarch.rpm \n-rw-r--r--. 1 root root 359 Dec 16 22:37 README.txt \n-rw-r--r--. 1 root root 1927 Oct 2 04:17 RPM-GPG-KEY ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Swarm RPM public key included with the distribution bundle.","type":"text"}]},{"type":"codeBlock","content":[{"text":"rpm --import RPM-GPG-KEY","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Cloud Gateway components.","type":"text"}]},{"type":"codeBlock","content":[{"text":"yum -y install caringo-gateway-{version here}.noarch.rpm","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Complete the IDSYS document for PAM user authentication.","type":"text"}]},{"type":"codeBlock","content":[{"text":"vi /etc/caringo/cloudgateway/idsys.json","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\"pam\": { \n \"name\" : \"idsys-pam\", \n \"description\": \"PAM identity management configuration\", \n \"cookieName\": \"token\", \n \"tokenPath\": \"/.TOKEN/\", \n \"tokenAdmin\": \"admin@\"\n}} ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Complete policy document for access control.","type":"text"}]},{"type":"codeBlock","content":[{"text":"vi /etc/caringo/cloudgateway/policy.json","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"Id\": \"PAM policy example\",\n \"Statement\": [{\n \"Sid\": \"1\",\n \"Resource\": \"/*\",\n \"Action\": [\"*\"],\n \"Principal\": {\"user\": [\"admin\"], \"group\": [\"clusteradmins\"]},\n \"Effect\": \"Allow\"\n }],\n \"Version\": \"2008-10-17\"\n}","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install Gateway WebUI.","type":"text"}]},{"type":"codeBlock","content":[{"text":"yum -y install caringo-gateway-webui-{version here}.noarch.rpm","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit the configuration file.","type":"text"}]},{"type":"codeBlock","content":[{"text":"vi /etc/caringo/cloudgateway/gateway.cfg","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"adminDomain","type":"text","marks":[{"type":"em"}]},{"text":" for the administrative domain name to be created. It is recommended to always set a unique name for each Swarm cluster to prevent replication collision between the Source and Target Swarm Cluster when using replication feeds. Set a unique name for each Swarm cluster to prevent replication collision.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"hosts","type":"text","marks":[{"type":"em"}]},{"text":" for the storage cluster nodes (IP address of storage nodes).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set ","type":"text"},{"text":"indexerHosts","type":"text","marks":[{"type":"em"}]},{"text":" to Elasticsearch Servers (IP address of Elasticsearch nodes).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable ","type":"text"},{"text":"S3","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"Cluster Admin","type":"text","marks":[{"type":"em"}]},{"text":" on the gateway server to allow usage of the Swarm Storage UI.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set Management Port to 91. The admin user and password must be the same as configured in SCS.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set managementUser to the same value as admin.username","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set managementPassword to the same value as admin.password","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# Following are only needed when enabling cluster_admin\nmanagementPort = 91 \nmanagementUser = admin \nmanagementPassword = datacore ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enable ","type":"text"},{"text":"metering","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Below is a sample Gateway configuration file in its entirety.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"# \n# gateway.cfg -- configuration file for Caringo CloudScaler Gateway server \n# \n# Please read the CloudScaler Gateway Administration Guide for an explanation \n# of the parameters in this configuration file. \n# \n# Basic Configuration Steps: \n# ------------------------- \n# \n# 1. Set '[gateway]adminDomain' to administrative domain's name \n# \n# 2. Use the Swarm static locator for the backend cluster: \n# - Set '[storage_cluster]locatorType' to 'static' \n# - Set '[storage_cluster]hosts' for your Swarm nodes \n# \n# 3. Configure the Elasticsearch metadata backend: \n# - Set '[storage_cluster]indexerHosts' to the metadata search servers \n# \n# 4. If the S3 protocol is used: \n# - Ensure that bindAddress:bindPort does not conflict with SCSP \n# \n# \n# NOTE: For production use, you will need to adjust the thread counts, \n# connection limits, connection time outs, and the space/limits \n# for the HTTP multi-part spool. \n# \n\n# \n# Client communications and handling \n# \n[gateway]\n\nadminDomain = Lab1GatewayAdminDomain \nthreads = 100 * (Number of CPUs present in the Gateway) \n# multipartSpoolDir = /var/spool/cloudgateway \n# multipartUsageAllowed = 50 \n# sanitizeErrors = false \n# enablePasswordEncryption = false \n# legacyOnlyMode = false\n \n# \n# Storage cluster back-end configuration\n#\n[storage_cluster] \n\nlocatorType = static \nhosts = 192.168.9.143 192.168.9.144 192.168.9.145\n# port = 80\n# dataProtection = immediate\n# blockUndeletableWrites = true\n\nindexerHosts = 192.168.9.21 192.168.9.22 192.168.9.23\n# indexerPort = 9200\n# indexerSocketTimeout = 120\n\n# maxConnectionsPerRoute = threads / 2 \n# maxConnections = (threads / 2) * (number of nodes)\n# connectTimeout = 60\n# socketTimeout = 120\n# idleTimeout = 120\n# continueWaitTimeout = 30\n\n# Following are only needed when enabling cluster_admin \nmanagementPort = 91\nmanagementUser = admin\nmanagementPassword = datacore\n\n# \n# SCSP front-end protocol\n#\n[scsp] \n\nenabled = true \nbindAddress = 0.0.0.0 \nbindPort = 80\n\n# Set the following if this Gateway is the target of a push-style replication feed.\n# See 'Replication Feeds' in the Swarm documentation for details.\n# allowSwarmAdminIP = list,of,node,ips -or- all\nallowSwarmAdminIP = all\n\n# Set these to the external ports on your proxy, if using one \n#externalHTTPPort = 80 \n#externalHTTPSPort = 443 \n\n# \n# S3 front-end protocol\n# \n[s3]\n\nenabled = true \nbindAddress = 0.0.0.0 \nbindPort = 8090\n\n# Set these to the external ports on your proxy, if using one \n#externalHTTPPort = 80 \n#externalHTTPSPort = 443\n\n# \n# Cluster management protocol \n#\n[cluster_admin] \n\nenabled = true \nbindAddress = 0.0.0.0 \nbindPort = 91\n# secretKey = yoursecretkeyhere\n\n# Set these to the external ports on your proxy, if using one \n#externalHTTPPort = 91 \n#externalHTTPSPort = 1443 \n\n#\n# Internal \"folder listing service\" config\n# \n[folder_listings]\n\n# enhancedListingConsistency = true # force ES index flush before query \n# feedCheckInterval = 60000 # in milliseconds, how often to check for non-searchable domains (search feed filters) \n# suppressNonSearchableError = false # suppress 412 error when searching non-searchable domain \n\n# \n# Caching timers : 0 == disabled \n#\n[caching] \n\n# authRefresh = 300 \n# tokenRefresh = 300 \n# idsysRefresh = 300 \n# policyRefresh = 300 \n# xformRefresh = 300 \n# metadataRefresh = 300 \n# domainExistenceRefresh = 300\n\n# \n# Metering Support \n#\n[metering] \n\nenabled = true \n# flushIntervalSeconds = 300 \n# retentionDays = 100 \n# storageSampleIntervalSeconds = 3600 \n\n# \n# Quota Support \n#\n[quota]\n\nenabled = false \nsmtpHost = localhost \nmailFrom = donotreply@localhost \n\n# mailSubjectTemplate = Quota state change notification \n# mailTemplate = Metric %metric% changed to %state% state in %contextType% %contextName%.\n\n# smtpPort = 25 \n# smtpUser = \n# smtpPassword = \n\n# minRefreshDeadline = 60 \n# maxRefreshDeadline = 3600 \n# numRefreshThreads = 4 \n# maxRefreshRetries = 3 \n# maxQueueSize = 10000 \n# queryTTL = 3600 \n# refreshRetryDelay = 10 \n# refreshIdleSleep = 3\n\n# \n# Prometheus metrics capturing support \n# \n[metrics] \n\nmetricsEnabled = true # default enabled \n# metricsPort = 9100 # port where to scrape for metrics \n\n# \n# Remote synchronous write support (RSW) \n# \n[rsw]\n\n# enabled = true # default enabled\n# maxWaitTime = -1 # timeout in seconds to wait for RSW completion, -1 means no timeout\n# enableInfoLogging = true # default true, log RSW operations at INFO level\n\n# \n# Object Lock Support (Retention, LegalHold)\n#\n[object_locking] \n\n# scspDeleteUsesS3Logic = true # Allows delete of a locked current object version (via delete marker)\n# retentionMaxYears = 100 # Max retention duration ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Cluster Initialization","type":"text"}]},{"type":"paragraph","content":[{"text":"The gateway must be initialized once the configuration is complete to guarantee a proper runtime environment. This ensures the administrative domain exists within the storage cluster and secures all plaintext passwords entered into the configuration files.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Verify Gateway is not running.","type":"text"}]},{"type":"codeBlock","content":[{"text":"systemctl stop cloudgateway","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Perform the initialization of the environment.","type":"text"}]},{"type":"codeBlock","content":[{"text":"/opt/caringo/cloudgateway/bin/initgateway","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start CloudGateway and verify the gateway service is running on system boot once initialization is successfully completed.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"systemctl start cloudgateway\nsystemctl enable cloudgateway","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Info","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"If you encounter the error \"No module named PAM\", run ","type":"text"},{"text":"sudo dnf install -y python3-pam","type":"text","marks":[{"type":"code"}]},{"text":" command to install the required PAM module.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Next, ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2919137344"}},{"text":".","type":"text"}]}]}],"version":1}

Browser not supported