Splunk Cloud Services SDK for Go

The Splunk Cloud Services software development kit (SDK) for Go contains library code and examples to enable you to build apps using the Splunk Cloud Services with the Go programming language.

Note: This SDK is not used for Splunk Enterprise or Splunk Cloud development. For information about developing apps and add-ons for those products, see the Splunk Developer Portal for Splunk Enterprise.

Splunk Cloud Services CLI

Splunk Cloud Services CLI, scloud, is a command-line tool for developers to make API calls to Splunk Cloud Services.

For more information about Splunk Cloud Services CLI, see the Splunk Developer Portal.

Terms of Service

Log in to Splunk Investigate and accept the Terms of Service when prompted.

Get started

Install Go and Go tools

1. Install Go 1.11 or later from the Getting Started page on the Go Programmming Language website.

2. Install recommended tools for Go by running the following commands:

   $ go get golang.org/x/lint/golint
   $ go get -u golang.org/x/tools/cmd/goimports

Initialize your project

Initialize your project using Go modules for dependency support. Your project can be located outside of the $GOPATH/src directory. For more about modules, see Go 1.11 Modules on the GitHub website.

1. If your project is within your $GOPATH, set GO111MODULE=on in your environment variables.

2. Initialize your project by running the following commands, but replace the <github.com/example/myproject> path with your Git host, organization, user name, and project name as appropriate:

   $ mkdir myproject && cd myproject
   $ go mod init <github.com/example/myproject>

3. Create a main.go file within your project directory containing the following code:

   package main
   
   import (
       "fmt"
       "os"
   
       "github.com/splunk/splunk-cloud-sdk-go/sdk"
       "github.com/splunk/splunk-cloud-sdk-go/services"
       "github.com/splunk/splunk-cloud-sdk-go/services/identity"
   )
   
   func main() {
       checkForTenantToken()
       // Initialize the client
       client, err := sdk.NewClient(&services.Config{
           Token:  os.Getenv("BEARER_TOKEN"),
           Tenant: os.Getenv("TENANT"),
       })
       exitOnErr(err)
       // Validate access to Splunk Cloud Services and tenant
       query := identity.ValidateTokenQueryParams{Include: identity.ValidateTokeninclude{"principal", "tenant"}}
       info, err := client.IdentityService.ValidateToken(&query)
       exitOnErr(err)
       fmt.Println("name: " + info.Name)
       fmt.Println("principal name: " + info.Principal.Name)
       fmt.Println("tenant name: " + info.Tenant.Name)
   }
   
   func exitOnErr(err error) {
       if err != nil {
           fmt.Println(err)
           os.Exit(1)
       }
   }
   
   func checkForTenantToken() {
       if os.Getenv("BEARER_TOKEN") == "" {
           exitOnErr(fmt.Errorf("$BEARER_TOKEN must be set"))
       }
       if os.Getenv("TENANT") == "" {
           exitOnErr(fmt.Errorf("$TENANT must be set"))
       }
   }

4. Set your access token and tenant.

   • Retrieve your access token from the Splunk Cloud Console.

     • Log in with your email address.
     • Enter/Choose your tenant.
     • Navigate to the Settings page from the top-right dropdown.
     • Under Authorization / Access Token click Copy to clipboard to copy your token.

   • Run the following command, replacing <accessToken> and <tenant> with your values:

     $ export BEARER_TOKEN=<accessToken>
     $ export TENANT=<tenant>

5. Build and run your project by running the following commands, where <project> is the name of your project, and <[email protected]> is your user name:

   $ go build
   $ ./<project>
   name: <[email protected]>
   principal name: <[email protected]>
   tenant name: <mytenant>

scloud login using device flow with access to environments: playground, staging, prod, playground-scs, staging-scs (gstage) and prod-scs (gprod1)

To gain access to the environments through scloud cli, set the following config variables:

• username associated with the environment you are intending to use, example:

  $ scloud config set --key username --value <your_username>

• tenant associated with the environment you are intending to use, example:

  $ scloud config set --key tenant --value <your_tenant>

• env (envrionment), example:

  $ scloud config set --key env --value <any of the five available environments: `playground`, `staging`, `prod`, `playground-scs`, `staging-scs` (gstage) or `prod-scs` (gprod1)>

Once the environment variables are set, you can login using the command below:

$ scloud login --use-device

If the environment variables - tenant, username and env are set correctly, you will see the message given below prompting you to follow the verification browser link and to use the given code in that browser page to complete the login process.

$ scloud login --use-device
Please validate user code in browser!
Verification URL: https://auth.staging.scs.splunk.com/verify?tenant=<your_set_tenant> 
User Code: <random_code>

An example command to access core services using scloud cli once the scloud login --use-device above has succeeded:

$ scloud appreg list-subscriptions

If the environment variables are not set correctly, you may see the following error:

$ scloud login --use-device
failed to get successful response from device endpoint: 401
 Try again using the --logtostderr flag to show details about the error.

Documentation

For general documentation, see the Splunk Developer Portal.

For reference documentation, see the Splunk Cloud Services SDK for Go API Reference.

Contributing

Do not directly edit any source file with _generated in the name because that file was generated from service specifications.

Contact

If you have questions, reach out to us on Slack in the #sdc channel or email us at [email protected].