Install Splunk Cloud Gateway

Splunk Cloud Gateway is required for all Connected Experiences apps. Install Splunk Cloud Gateway to enable users to receive actionable alerts, generate QR codes and NFC URLS for AR workspaces and Splunk dashboards, and manage devices for app users.

If you run into issues with installation or connection, see Troubleshoot Splunk Cloud Gateway and Troubleshoot Splunk Cloud Gateway Connection Issues for more information.

Prerequisites

• Have admin role access.
• Make sure that KV store is running. See KV store troubleshooting tools and Back up and restore KV store to learn how to check the status of KV store and for KV store best practices.
• Open port 443 outbound to prod.spacebridge.spl.mobi.
• Use a compatible proxy server, operating system, and Splunk Enterprise version. See the following table for proxies, operating systems, and Splunk Enterprise versions that are compatible with Splunk Cloud Gateway:

Component	Requirements
Proxy server	Set up a proxy in server.conf If you're using a proxy server, it must be a HTTPS proxy and support HTTP CONNECT. To configure your proxy server, see Configure splunkd to use your HTTP Proxy Server in the Splunk Enterprise Admin Manual. Here's how to edit server.conf to configure splunkd to work with your server proxy: [proxyConfig] https_proxy = <string that identifies the server proxy. When set, splunkd sends all HTTPS requests through the proxy server defined here. If not set, splunkd uses the proxy defined in http_proxy. The default value is unset.> no_proxy = <string that identifies the no proxy rules. When set, splunkd uses the [no_proxy] rules to decide whether the proxy server needs to be bypassed for matching hosts and IP Addresses. Requests going to localhost/loopback address are not proxied. Default is "localhost, 127.0.0.1, ::1">
Operating System	Splunk Cloud Gateway is compatible with Mac, Windows, and Linux operating systems.
Hardware	Splunk Cloud Gateway requires a minimum processor size of 4 cores and 16GB of ram. The minimum AWS instance size is m5.xlarge.
Splunk Enterprise Version	The following Splunk Enterprise versions are the minimum requirements to support Splunk Cloud Gateway. Admin, power, and normal users can use Splunk Cloud Gateway if they have the cloudgateway role. 6.5.x 6.6.x 7.0.x 7.1.x 7.2.x

Splunk Gateway doesn't trust third party certificates.

Install Splunk Cloud Gateway from Splunkbase

Use Splunkbase to install Splunk Cloud Gateway.

1. Launch Splunk Enterprise.
2. Log in.
3. Download Splunk Cloud Gateway from Splunkbase.
4. Click the Apps gear icon in Splunk Enterprise.
5. Click Install app from file.
6. Click Choose File and select the downloaded Splunk Cloud Gateway file.
7. Click Upload.
8. Restart Splunk Enterprise.

Upgrade Splunk Cloud Gateway

Upgrade Splunk Cloud Gateway by installing the latest version from Splunkbase.

Upgrade Splunk Cloud Gateway on Mac or Linux

To upgrade Splunk Cloud Gateway on Mac or Linux, follow these steps:

1. Install the app from Splunk Cloud Gateway.
2. Check Upgrade app to overwrite the older version of Splunk Cloud Gateway.
3. Click Upload.

Upgrade Splunk Cloud Gateway on Windows

To upgrade Splunk Cloud Gateway, first stop splunk and delete the existing Splunk Cloud Gateway file. To stop Splunk, see Stop Splunk Enterprise in the Splunk Enterprise Admin Manual.

1. Stop Splunk.
2. Delete the existing Splunk Cloud Gateway file.
3. Install the app from Splunk Cloud Gateway.
4. Check Upgrade app to overwrite the older version of Splunk Cloud Gateway.
5. Click Upload.

Deploy Splunk Cloud Gateway in a distributed environment

If you're installing Splunk Cloud Gateway in a distributed environment, install it on the search head cluster. See App deployment overview in the Splunk Enterprise Admin Manual to deploy Splunk Cloud Gateway to search head clusters.

Install Splunk Cloud Gateway on Splunk Cloud

Installing Splunk Cloud Gateway on Splunk Cloud through SSAI requires Splunk Cloud v7.1.x or later.

To install Splunk Cloud Gateway on Splunk Cloud v7.0.x or earlier, submit a case to Splunk Support. See Contact Splunk Support for contact information and how to submit a case.

Download Splunk Cloud Gateway in your Splunk Cloud Deployment from Splunkbase.

See Install apps in your Splunk Cloud deployment in the Splunk Cloud Admin Manual for further instructions.