Get started with SCloud

SCloud is a command-line tool to make API calls to the Data Stream Processor. You can use scloud to interact with APIs such as the Ingest REST API.

Configuration

Configure your ~/.scloud file to point to your on-premises DSP instance:

1. Set DSP_HOST to the IP address or hostname of your master node.

   DSP_HOST=<IP_Address>

2. Run the following script by copy and pasting the following text in the command line.

   cat << EOF > ~/.scloud
   env = "prod"
   host-url = "https://$DSP_HOST:31000"
   auth-url = "https://$DSP_HOST:31000"
   tenant = "default"
   username = "dsp-admin"
   insecure = "true"
   EOF
   

Verify that the SCloud tool has been configured properly

1. From the command line, type

   ./scloud login

   When prompted, use the dsp-admin password printed during the DSP installation. If needed, you can get the username and password again by typing sudo ./print-login on one of your nodes.
2. From the DSP homepage, click on Build Pipeline and select the Splunk Firehose to Splunk Index template.
3. Click Start Preview.
4. Try ingesting an event.

   ./scloud ingest post-events -format raw <<<  'test'

Additional commands

The syntax for the SCloud CLI is as follows:
./scloud [-u <username>] [-p <password>] [-tenant <tenant>] [-no-prompt]<command> <subcommand> [params]

scloud has the following additional commands. For subcommands and more information, run ./scloud help or ./scloud <command> help.

Command	Description
Identity	The identity commands create and manage users and admins, manage tenant memberships, and manage the access to tenant resources granted by the definition of groups, roles, and their corresponding permissions.
Streams	The streams command creates and manages Splunk data stream pipelines.
Forwarders	The forwarders command interacts with the Splunk forwarder service APIs to create, delete, and view certificates that the forwarders use. It does not control forwarders.
Ingest	The ingest command posts event and metric data to the ingest service.