{"type":"doc","content":[{"type":"paragraph","content":[{"text":"You need all the enabling components to use the Swarm Storage UI with Swarm Metrics, such as a simplified Gateway (Service Proxy) to provide the needed access and an Elasticsearch service and curator. Your CSN download includes all of the RPMs and scripts needed to install and configure these components.","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Caution","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Do not use the CSN-embedded ES server as a Swarm Search Feed target.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Do not change the preconfigured defaults for Metrics, which are set in ","type":"text"},{"text":"/etc/caringo-elasticsearch-metrics/metrics.cfg","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"metrics.target","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"metrics.port","type":"text","marks":[{"type":"code"}]},{"text":" are preconfigured for the Service Proxy.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Metrics are checked every 15 minutes and are retained for 120 days.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you have any scaling concerns, consult Support about whether you need a dedicated Elasticsearch cluster.","type":"text"}]}]}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Install the CSN bundle as usual (the new RPMs will install for you).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a Swarm license and start up the Storage nodes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the integration script to configure the Service Gateway, adding arguments as appropriate:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"/usr/bin/configure_storage_webui_with_serviceproxy.py","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Optional arguments	Default	Purpose
-h, --help		Display help summary and then exit.
-v, --verbose	INFO	Add to generate more extensive logging output.
-d DIR, --directory DIR	/var/log/caringo	Specify a different working directory for logs and output.
-s, --start_services	yes	Disable automatic enabling and start up of services after configuration.
-n NUM_HOSTS, --num_hosts NUM_HOSTS	5	Specify a different number of hosts to add to the Gateway configuration.
--indexer_host INDEXER_HOST [INDEXER_HOST ...]		Specify remote Elasticsearch hostnames or IPs, disabling (and preventing creation of) a local ES instance. Important: If you have an existing ES cluster, be sure to specify it here to avoid creating an extra local instance.

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Optional arguments","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Default","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-h, --help","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Display help summary and then exit.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-v, --verbose","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"INFO","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Add to generate more extensive logging output.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-d DIR, --directory DIR","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"/var/log/caringo","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Specify a different working directory for logs and output.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-s, --start_services","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"yes","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Disable automatic enabling and start up of services after configuration.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"-n NUM_HOSTS, --num_hosts NUM_HOSTS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"5","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Specify a different number of hosts to add to the Gateway configuration.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"--indexer_host INDEXER_HOST [INDEXER_HOST ...]","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Specify remote Elasticsearch hostnames or IPs, disabling (and preventing creation of) a local ES instance.","type":"text"}]},{"type":"paragraph","content":[{"text":"Important","type":"text","marks":[{"type":"strong"}]},{"text":": If you have an existing ES cluster, be sure to specify it here to avoid creating an extra local instance.","type":"text"}]}]}]}]}],"version":1},"reason":"A table in list item can't be created or edited in the new editor."}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Each time the script prompts you for a configuration setting, press Enter to accept the suggested value, or enter your own.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On completion, the script will attempt to start all of the services with their new configurations, logging the output to the ","type":"text"},{"text":"integration.log","type":"text","marks":[{"type":"code"}]},{"text":" file (which defaults to ","type":"text"},{"text":"/var/log/caringo","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the script provides you with your URL and credentials, log into the Storage UI with a JavaScript-enabled browser (development and testing were conducted using the most recent versions of Firefox and Chrome).","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"Metrics data will not appear until new storage data is added and metrics collection cycles have occurred, which is a minimum of 30 minutes.","type":"text"}]}]},{"type":"orderedList","attrs":{"order":7},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The script creates a \"","type":"text"},{"text":"caringoadmin","type":"text","marks":[{"type":"code"}]},{"text":"\" user (password \"","type":"text"},{"text":"caringo","type":"text","marks":[{"type":"code"}]},{"text":"\"), which is a user that is local to the CSN. These user credentials are required to login to the Storage UI through the Service Gateway.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"This ","type":"text"},{"text":"caringoadmin","type":"text","marks":[{"type":"code"}]},{"text":" user is only used by the Service Gateway and not by the Swarm cluster.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To change the ","type":"text"},{"text":"caringoadmin","type":"text","marks":[{"type":"code"}]},{"text":" password on the local CSN, run the password command and follow the prompts:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"passwd caringoadmin","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user ","type":"text"},{"text":"caringoadmin","type":"text","marks":[{"type":"code"}]},{"text":" user is defined as the administrator for the Service Gateway in this file on the CSN: ","type":"text"},{"text":"/etc/caringo/cloudgateway/policy.json","type":"text","marks":[{"type":"code"}]},{"text":". The user can be changed according to your requirements, just as in the Content Gateway. ","type":"text"},{"type":"hardBreak"},{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://perifery.atlassian.net/wiki/spaces/public/pages/2443816967"}},{"text":". ","type":"text"}]}]}]},{"type":"orderedList","attrs":{"order":8},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"With CSN 8.3, all of these interfaces remain available and may be used concurrently:","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Legacy CSN Console	`http://{CSN·host}:8090`
Legacy Admin Console	`http://{CSN·host}:8090/services/storage`
Swarm Storage UI	`http://{CSN·host}/_admin/storage\n`

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"table","attrs":{"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"paragraph","content":[{"text":"Legacy CSN Console ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"http://{CSN·host}:8090","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"paragraph","content":[{"text":"Legacy Admin Console","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"http://{CSN·host}:8090/services/storage","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"paragraph","content":[{"text":"Swarm Storage UI","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[389.0]},"content":[{"type":"paragraph","content":[{"text":"http://{CSN·host}/_admin/storage\n","type":"text","marks":[{"type":"code"}]}]}]}]}]}],"version":1},"reason":"A table in list item can't be created or edited in the new editor."}}}]}]}]}],"version":1}

Browser not supported