Add GetSearchPeers() method

This will be used for creating ephemeral users for multi-node Splunk
deployments

Author: Amey Bhide

clients/splunk/deployment.go

@@ -0,0 +1,19 @@
+package splunk
+
+// DeploymentService encapsulates the Deployment portion of the Splunk API
+type DeploymentService struct {
+	client *Client
+}
+
+func newDeploymentService(client *Client) *DeploymentService {
+	return &DeploymentService{
+		client: client,
+	}
+}
+
+// GetSearchPeers returns information about all search peers
+func (d *DeploymentService) GetSearchPeers() ([]ServerInfoEntry, *Response, error) {
+	info := make([]ServerInfoEntry, 0)
+	resp, err := Receive(d.client.New().Get("search/distributed/peers"), &info)
+	return info, resp, err
+}

clients/splunk/properties.go

@@ -29,10 +29,10 @@ type Entry struct {
 // stringResponseDecoder decodes http response string
 // Properties API operates on particular key in the configuration file.
 // CRUD for properties API returns JSON/XML encoded response for error cases and returns a string response for success
-type stringResponseDecoder struct{
+type stringResponseDecoder struct {
 }
 
-func getPropertiesUri(file string, stanza string, key string) (string) {
+func getPropertiesUri(file string, stanza string, key string) string {
 	return fmt.Sprintf("properties/%s/%s/%s", url.PathEscape(file), url.PathEscape(stanza), url.PathEscape(key))
 }
 
@@ -74,4 +74,4 @@ func (p *PropertiesService) GetKey(file string, stanza string, key string) (*str
 		return nil, resp, relevantError(err, apiError)
 	}
 	return &output.Value, resp, relevantError(err, apiError)
-}
+}

clients/splunk/properties_test.go

@@ -12,7 +12,7 @@ func TestPropertiesService_GetKey(t *testing.T) {
 	_, response, err := propertiesSvc.GetKey("foo", "bar", "key")
 	assert.ErrorContains(t, err, "splunk: foo does not exist")
 	assert.Equal(t, response.StatusCode, 404)
-	_, response, err = propertiesSvc.GetKey("b/a/z","b-ar", "k-ey")
+	_, response, err = propertiesSvc.GetKey("b/a/z", "b-ar", "k-ey")
 	assert.ErrorContains(t, err, "ERROR splunk: Directory traversal risk in /nobody/system/b/a/z at segment \"b/a/z\"")
 	assert.Equal(t, response.StatusCode, 403)
 	_, response, err = propertiesSvc.GetKey("foo-bar", "b/a/z", "k-ey")
@@ -22,7 +22,6 @@ func TestPropertiesService_GetKey(t *testing.T) {
 	assert.ErrorContains(t, err, "splunk: bar does not exist")
 	assert.Equal(t, response.StatusCode, 404)
 
-
 	_, response, _ = propertiesSvc.GetKey("server", "general", "pass4SymmKey")
 	assert.Equal(t, response.StatusCode, 200)
 

clients/splunk/splunk.go

@@ -20,6 +20,7 @@ type API struct {
 	Introspection *IntrospectionService
 	AccessControl *AccessControlService
 	Properties    *PropertiesService
+	Deployment    *DeploymentService
 	// XXX ...
 }
 
@@ -39,6 +40,7 @@ func (params *APIParams) NewAPI(ctx context.Context) *API {
 		Introspection: newIntrospectionService(client.New()),
 		AccessControl: newAccessControlService(client.New()),
 		Properties:    newPropertiesService(client.New()),
+		Deployment:    newDeploymentService(client.New()),
 	}
 }
 

conn.go

@@ -30,6 +30,7 @@ type splunkConfig struct {
 	Username       string        `json:"username" structs:"username"`
 	Password       string        `json:"password" structs:"password"`
 	URL            string        `json:"url" structs:"url"`
+	IsStandalone   bool          `json:"is_standalone" structs:"is_standalone"`
 	AllowedRoles   []string      `json:"allowed_roles" structs:"allowed_roles"`
 	Verify         bool          `json:"verify" structs:"verify"`
 	InsecureTLS    bool          `json:"insecure_tls" structs:"insecure_tls"`

path_config_connection.go

@@ -33,6 +33,11 @@ func (b *backend) pathConfigConnection() *framework.Path {
 				Type:        framework.TypeString,
 				Description: "Splunk server URL.",
 			},
+			"is_standalone": &framework.FieldSchema{
+				Type:        framework.TypeBool,
+				Description: "Whether this is a standalone or multi-node deployment",
+				Default:     false,
+			},
 			"allowed_roles": &framework.FieldSchema{
 				Type: framework.TypeCommaStringSlice,
 				Description: trimIndent(`