Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions docs/ADVANCED.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,17 +209,35 @@ Here's an overview of what this looks like if you want to persist *all* your ind
---
splunk:
smartstore:
- indexName: default
remoteName: remote_store
scheme: s3
remoteLocation: <bucket-name>
s3:
access_key: <access_key>
secret_key: <secret_key>
endpoint: http://s3-us-west-2.amazonaws.com
index:
- indexName: default
remoteName: remote_store
scheme: s3
remoteLocation: <bucket-name>
s3:
access_key: <access_key>
secret_key: <secret_key>
endpoint: http://s3-us-west-2.amazonaws.com
...
```

Some cache management options are also available. Options defined under the index stanza correspond to options in `indexes.conf` https://docs.splunk.com/Documentation/Splunk/latest/admin/Indexesconf. While options defined outside the index correspond to options in `server.conf` https://docs.splunk.com/Documentation/Splunk/latest/admin/Serverconf, note that currently only `[cachemanager]` stanza is supported. This is an example config that defines cache settings and retention policy:
```
smartstore:
cachemanager:
max_cache_size: 500
max_concurrent_uploads: 7
index:
- indexName: custom_index
remoteName: my_storage
scheme: http
remoteLocation: my_storage.net
maxGlobalDataSizeMB: 500
maxGlobalRawDataSizeMB: 200
hotlist_recency_secs: 30
hotlist_bloom_filter_recency_hours: 1
```

## Using deployment servers
Briefly, deployment servers can be used to manage otherwise unclustered/disjoint Splunk instances. A primary use-case would be to stand up a deployment server to manage app or configuration distribution to a fleet of 100 universal forwarders.

Expand Down
17 changes: 9 additions & 8 deletions tests/test_docker_splunk.py
Original file line number Diff line number Diff line change
Expand Up @@ -2170,14 +2170,15 @@ def test_compose_1cm_smartstore(self):
assert password
# Add a custom conf file
output = re.sub(r' smartstore: null', r''' smartstore:
- indexName: default
remoteName: remote_vol
scheme: s3
remoteLocation: smartstore-test
s3:
access_key: abcd
secret_key: 1234
endpoint: https://s3-region.amazonaws.com''', output)
index:
- indexName: default
remoteName: remote_vol
scheme: s3
remoteLocation: smartstore-test
s3:
access_key: abcd
secret_key: 1234
endpoint: https://s3-region.amazonaws.com''', output)
# Write the default.yml to a file
with open(os.path.join(FIXTURES_DIR, "default.yml"), "w") as f:
f.write(output)
Expand Down