Splunk® Data Stream Processor

Install and administer the Data Stream Processor

On April 3, 2023, Splunk Data Stream Processor reached its end of sale, and will reach its end of life on February 28, 2025. If you are an existing DSP customer, please reach out to your account team for more information.

All DSP releases prior to DSP 1.4.0 use Gravity, a Kubernetes orchestrator, which has been announced end-of-life. We have replaced Gravity with an alternative component in DSP 1.4.0. Therefore, we will no longer provide support for versions of DSP prior to DSP 1.4.0 after July 1, 2023. We advise all of our customers to upgrade to DSP 1.4.0 in order to continue to receive full product support from Splunk.

Get started with the Data Stream Processor CLI

The Splunk Data Stream Processor includes its own command-line tool starting in DSP 1.4.0, which lets you administer and configure your DSP deployment. This collection of commands replaces the scripts that previous versions of DSP included in the installer package. See Available commands for all commands.

You must run all DSP CLI commands from the working directory of a controller node. To access the DSP CLI, navigate to the bin subdirectory in the DSP working directory. From there, you can run any DSP CLI commands using the following syntax: dsp <command> [subcommand] [flag]. To get more information about a specific command, its usage, flags, and any applicable subcommands, run the command with the --help flag.

Available commands

Command Description
admin Perform administrative operations for the DSP cluster, such as managing credentials, pipelines, and connections.
backup Generate a backup TAR file of the DSP deployment.
bootstrap Specify whether you want to skip creating certain resources when installing DSP.
category View, start, stop, or restart resources in one or more specific categories. A category is a system service like auth, ingest, or pipelines.
completion Generate the autocompletion script for bash, fish, PowerShell, or zsh shells. See each subcommand's help for details on how to use the generated script.
config View or edit any DSP configurations that you added.
configure-ui Configure DSP to enable the UI on the provided DSP host. If you do not set the dsp-host parameter, the command determines the DSP host based on this precedence order:
  • DSP_HOST environment variable
  • Auto-discover the external IP
  • Localhost
  • create Create a predefined DSP resource.
    deploy Deploy new configurations or secrets. Whenever you create a new configuration or make changes to an existing configuration, you must deploy the configuration for the changes to take effect.
    help Get help about any command.
    install Install DSP on a Kubernetes k0s cluster.
    join Join a node to a k0s cluster.
    join-additional Join multiple nodes to an existing k0s cluster.
    leave Remove a node from a k0s cluster.
    logs View logs for a specific container or service.
    preflights Perform preflight checks for installation.
    print-join Print the command for joining additional nodes to the cluster.
    remove Remove node from a specified k0s cluster.
    report View logs for a specified pod. These logs are packaged into a TAR file.
    restore Restore a backup TAR file into the cluster.
    rolling-reactivate Deactivate and reactivate all pipelines.
    service List, start, stop, and restart any services installed on the cluster.
    smoketest Run smoke tests on DSP services. You can choose to test all services or test only one or more specified services.
    ssh Start up an SSH server.
    status View a summary of the statuses of your DSP applications and resources.
    version View version information for the DSP cluster, the CLI tool, and the DSP applications installed on the cluster.
    wait Run status checks on the DSP deployments to verify activity.
    Last modified on 11 January, 2023
    Get started with the Splunk Cloud Services CLI   Cluster configuration options

    This documentation applies to the following versions of Splunk® Data Stream Processor: 1.4.0, 1.4.1, 1.4.2, 1.4.3, 1.4.4

    Was this topic useful?

    You must be logged into splunk.com in order to post comments. Log in now.

    Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

    0 out of 1000 Characters