Configure SmartStore for an indexer cluster

Configure SmartStore remote storage for an Indexer Cluster deployment.

Configure SmartStore remote storage for an Indexer Cluster deployment using a ClusterManager Custom Resource specification.

  1. Configure remote store credentials using one of the following methods:
    • Configure IAM role-based credentials through a service account or annotations.
    • Create a Secret object with secret and access credentials as described in the SmartStore secrets topic.
  2. Confirm your S3-based storage volume path and URL.
  3. Confirm the name of the Splunk indexes to use with the SmartStore volume.
  4. Create or update the Cluster Manager custom resource specification with volume and index configuration.

    Example Clustermanager.yaml:

    CODE 
    apiVersion: enterprise.splunk.com/v4
kind: ClusterManager
metadata:
  name: <name>
  finalizers:
  - enterprise.splunk.com/delete-pvc
spec:
  smartstore:
    volumes:
      - name: <remote_volume_name>
        path: <remote_volume_path>
        endpoint: https://s3-<region>.amazonaws.com
        secretRef: <secret_store_obj>
    indexes:
      - name: <index_name_1>
        remotePath: $_index_name
        volumeName: <remote_volume_name>
      - name: <index_name_2>
        remotePath: $_index_name
        volumeName: <remote_volume_name>
      - name: <index_name_3>
        remotePath: $_index_name
        volumeName: <remote_volume_name>
  5. Apply the custom resource specification:
    CODE 
    kubectl apply -f Clustermanager.yaml
  6. Follow the remaining steps to create an Indexer Cluster.

The SmartStore parameters are placed into the required .conf files in an app named splunk-operator. For an Indexer Cluster deployment, the app is located on the Cluster Manager at /opt/splunk/etc/manager-apps/.

After the SmartStore configuration is populated to the Cluster Manager splunk-operator app, the Operator issues a bundle push command to the Cluster Manager so that the SmartStore configuration is distributed to all the peers in that Indexer Cluster.

Note: Custom apps with higher precedence can potentially overwrite the index and volume configuration in the splunk-operator app. Avoid conflicting SmartStore configuration in custom apps. See Configuration file precedence order.