Scenarios for Swarm UI

The installation scenarios below describe how to add Swarm UI to different CSN architectures. These are the components involved:

Swarm UI is a web interface that connects via port 91 to Swarm nodes running Swarm 9.0+. Swarm UI must be installed on a server that has direct access to the Swarm cluster nodes.
Service Proxy is a light (proxy-only) version of the Content Gateway that allows access to the Swarm UI web interface when the Swarm nodes are not open to the rest of the network (such as when the nodes are located in a dual-network CSN or a Content Gateway environment). You cannot use Service Proxy for writing content to the Swarm cluster: it is not for S3 or SCSP calls.
Metrics Curator is a service that runs at set intervals to generate your Swarm historical metrics. The Swarm UI Dashboard and Reports sections display and graph these metrics.
Elasticsearch stores the metrics data (indexes) but is not for Swarm Search. This cluster installs via the integration script, but it can be co-located on an existing node in your search cluster. A single-node ES cluster is enough to run the Metrics Curator, but without redundancy.

The integration script (configure_storage_webui_with_serviceproxy.py) included with CSN 8.3 installs and configures all of these required services.

Important

Do not install the complete Content Gateway on a CSN. This configuration is unsupported.
Do not install the Service Proxy on CSN versions prior to CSN 8.3.
Only install the Service Proxy component of the Content Gateway using the included script, which also installs the Swarm UI.
Ensure that your CSN has at least 6 GB RAM before adding these services.
Ensure that you are running only one instance of the Metrics Curator across your entire Swarm implementation.

Network	Implemented	Unused	Installation Options
Dual	Storage cluster	Content Gateway Search cluster	Recommended: Run the integration script to install all of the required services for Swarm UI on your existing CSN.
Single	Storage cluster	Content Gateway Search cluster	Recommended: Run the integration script to install all of the required services for Swarm UI on your existing CSN.
Dual	Storage cluster Search cluster	Content Gateway	Recommended: Run the integration script to install all of the required services for Swarm UI on your existing CSN. Have the metrics use a new Elasticsearch instance on the CSN rather than the Swarm Search cluster you already have available. Alternative: Install Service Proxy, Swarm UI, and metrics curator on a new server and use the existing Search cluster for the Swarm UI's metrics collection.
Single	Storage cluster Search cluster	Content Gateway	Recommended: Run the integration script to install all of the required services for Swarm UI on your existing CSN. Have the metrics use a new Elasticsearch instance on the CSN rather than the Swarm Search cluster you already have available. Alternative: Install Service Proxy, Swarm UI, and metrics curator on a new server and use the existing Search cluster for the Swarm UI's metrics collection. Alternative: Install only the Swarm UI and the metrics curator on the CSN without installing the Service Proxy, pointing metrics collection to your existing Swarm Search cluster. Because all Swarm nodes have direct network access, the Service Proxy is not required. However, it is easier to install the entire package with the script provided and use the Service Proxy, which allows for flexible security (such as LDAP) to manage logins to the Swarm UI.
Dual	Storage cluster Content Gateway Search cluster		Recommended: Enable Service Proxy on one or more of the Content Gateways, as it is included in 5.1.2+. Then install Swarm UI on any webserver within the environment that has direct access to the nodes. Alternative: Install Swarm UI on one or more of the Content Gateways themselves. Metrics curator can also run on one of the Content Gateways or on the CSN (if available), but only one instance of the metrics curator can be running. In this environment, you can point the metrics at the existing Swarm Search cluster to avoid installing an additional Elasticsearch instance.