Skip to content

Commit c0d5cea

Browse files
committed
DPDV-2605 - rename dataset splunk addon to Security DataLake Addon for splunk
1 parent 1d4378e commit c0d5cea

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# DataSet Add-on for Splunk
2-
The DataSet Add-on for Splunk provides integration with [DataSet](https://www.dataset.com) and [XDR](https://www.sentinelone.com/platform/xdr-ingestion) by [SentinelOne](https://sentinelone.com). The key functions allow two-way integration:
1+
# Security Data Lake Add-On for Splunk
2+
The Security Data Lake Add-On for Splunk provides integration with [DataSet](https://www.dataset.com) and [XDR](https://www.sentinelone.com/platform/xdr-ingestion) by [SentinelOne](https://sentinelone.com). The key functions allow two-way integration:
33
- SPL custom command to query directly from the Splunk UI.
44
- Inputs to index alerts as CIM-compliant, or any user-defined query results.
55
- Alert action to send events from Splunk.
@@ -60,7 +60,7 @@ The add-on uses Splunk encrypted secrets storage, so admins require `admin_all_o
6060

6161
3. Optionally, configure logging level and proxy information on the associated tabs.
6262
4. Click Save.
63-
5. The included DataSet by Example dashboard can be used to confirm connectivity and also shows example searches to get started.
63+
5. The included Security Data Lake by Example dashboard can be used to confirm connectivity and also shows example searches to get started.
6464

6565
## SPL Command
6666
The `| dataset` command allows queries against the [DataSet APIs](https://app.scalyr.com/help/api) directly from Splunk's search bar.
@@ -174,7 +174,7 @@ Error saving configuration "CSRF validation failed" - This is a Splunk browser i
174174

175175
Search errors `Account token error, review search log for details` or `Splunk configuration error, see search log for details.` - API token was unable to be retrieved. Common issues include user role missing list_storage_passwords permission, API token not set or incorrect account name given that has not been configured. Review job inspector search log for errors returned by Splunk. `Error retrieving account settings, error = UrlEncoded('broken')` indicates a likely misconfigured or incorrect account name; `splunklib.binding.HTTPError: HTTP 403 Forbidden -- You (user=username) do not have permission to perform this operation (requires capability: list_storage_passwords OR admin_all_objects)` indicates missing Splunk user permissions (list_storage_passwords).
176176

177-
To troubleshoot the custom command, check the Job Inspector search log, also available in the internal index: `index=_internal app="TA_dataset" sourcetype=splunk_search_messages`.
177+
To troubleshoot the custom command, check the Job Inspector search log, also available in the internal index: `index=_internal app="TA_security_data_lake" sourcetype=splunk_search_messages`.
178178

179179
For support, open a ticket with DataSet (or SentinelOne for XDR) support including any logged errors, or open a GitHub issue.
180180

@@ -208,8 +208,8 @@ In order to use use python 3.8 we use Python Virtual environment.
208208
* `pip install --upgrade-strategy only-if-needed splunk-packaging-toolkit`
209209

210210
## Build App
211-
- `ucc-gen build --source TA_dataset --ta-version 2.0.1`
212-
- `slim package output/TA_dataset -o release`
211+
- `ucc-gen build --source TA_security_data_lake --ta-version 2.0.1`
212+
- `slim package output/TA_security_data_lake -o release`
213213

214214
## Run Docker Splunk locally (Mac M1 machines)
215215
Since Splunk does not have [Docker image for Apple Sillicon](https://github.com/splunk/docker-splunk/issues/493) you may need to
@@ -219,23 +219,23 @@ Since Splunk does not have [Docker image for Apple Sillicon](https://github.com/
219219

220220
To clean up container run `docker container rm splunk` command
221221

222-
## Install DataSet Add-on for Splunk to running Docker container
222+
## Install Security Data Lake Add-On for Splunk to running Docker container
223223
Assuming application was previously built
224224

225225
### From existing release
226-
- `docker cp release/TA_dataset-2.0.0-Rxxx.tar.gz splunk:/opt/splunk/etc/apps/`
227-
- `docker exec splunk sudo tar -xvzf /opt/splunk/etc/apps/TA_dataset-2.0.0-Rxxx.tar.gz -C /opt/splunk/etc/apps/`
228-
- `docker exec splunk sudo chown -R splunk:splunk /opt/splunk/etc/apps/TA_dataset/`
226+
- `docker cp release/TA_security_data_lake-2.0.0-Rxxx.tar.gz splunk:/opt/splunk/etc/apps/`
227+
- `docker exec splunk sudo tar -xvzf /opt/splunk/etc/apps/TA_security_data_lake-2.0.0-Rxxx.tar.gz -C /opt/splunk/etc/apps/`
228+
- `docker exec splunk sudo chown -R splunk:splunk /opt/splunk/etc/apps/TA_security_data_lake/`
229229
- `docker exec splunk sudo -u splunk /opt/splunk/bin/splunk restart`
230230

231231
### Using mounted volume from built app
232-
- Mount folder with built app `docker run -it -v "$(pwd)/output/TA_dataset:/opt/splunk/etc/apps/TA_dataset/" -e SPLUNK_START_ARGS=--accept-license -e SPLUNK_PASSWORD=Test0101 --platform=linux/amd64 --name splunk -p 8000:8000 splunk/splunk:latest start`
232+
- Mount folder with built app `docker run -it -v "$(pwd)/output/TA_security_data_lake:/opt/splunk/etc/apps/TA_security_data_lake/" -e SPLUNK_START_ARGS=--accept-license -e SPLUNK_PASSWORD=Test0101 --platform=linux/amd64 --name splunk -p 8000:8000 splunk/splunk:latest start`
233233

234-
To apply changes build app again `ucc-gen build --source TA_dataset`
234+
To apply changes build app again `ucc-gen build --source TA_security_data_lake`
235235
- Changes in python scripts take effect immediately without any restart
236236
- Changes in static files like XML template take effect after restart `docker exec splunk sudo -u splunk /opt/splunk/bin/splunk restart`
237237

238238
Once application is installed create connection to DataSet environment under `Configuration` tab using `Add` button.
239239
Note that build cleans previously created configuration. To prevent removal of configuration while build
240-
- copy configured configuration to home folder `mkdir -p ~/splunk_dataset_app_configuration && cp -R ./output/TA_dataset/local/* ~/splunk_dataset_app_configuration/`
241-
- copy back to splunk `mkdir -p ./output/TA_dataset/local/ && cp -R ~/splunk_dataset_app_configuration/* ./output/TA_dataset/local/`
240+
- copy configured configuration to home folder `mkdir -p ~/splunk_dataset_app_configuration && cp -R ./output/TA_security_data_lake/local/* ~/splunk_dataset_app_configuration/`
241+
- copy back to splunk `mkdir -p ./output/TA_security_data_lake/local/ && cp -R ~/splunk_dataset_app_configuration/* ./output/TA_security_data_lake/local/`

Splunk Dashboards/dataset_by_example.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<form version="1.1">
2-
<label>DataSet by Example</label>
2+
<label>Security Data Lake by Example</label>
33
<init>
44
<set token="myMaxCount">maxcount=10</set>
55
<set token="baseQuery"></set>
@@ -260,4 +260,4 @@
260260
</chart>
261261
</panel>
262262
</row>
263-
</form>
263+
</form>

TA_dataset/app.manifest

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"schemaVersion": "2.0.0",
33
"info": {
4-
"title": "DataSet Add-on for Splunk",
4+
"title": "Security Data Lake Add-On for Splunk",
55
"id": {
66
"group": null,
77
"name": "TA_dataset",
@@ -15,7 +15,7 @@
1515
}
1616
],
1717
"releaseDate": null,
18-
"description": "The DataSet Add-on for Splunk provides integration with DataSet by SentinelOne.",
18+
"description": "The Security Data Lake Add-On for Splunk provides integration with DataSet by SentinelOne.",
1919
"classification": {
2020
"intendedAudience": "IT",
2121
"categories": ["Security, Fraud & Compliance", "IT Operations", "Business Analytics"],

TA_dataset/default/app.conf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ build = 1
77
[launcher]
88
author = DataSet by SentinelOne
99
version = 2.0.1
10-
description = The DataSet Add-on for Splunk integrates with DataSet by SentinelOne
10+
description = The Security Data Lake Add-On for Splunk integrates with DataSet by SentinelOne
1111

1212
[ui]
1313
is_visible = 1
14-
label = DataSet Add-on for Splunk
14+
label = Security Data Lake Add-On for Splunk
1515

1616
[package]
1717
id = TA_dataset

globalConfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"meta": {
33
"name": "TA_dataset",
4-
"displayName": "DataSet Add-on for Splunk",
4+
"displayName": "Security Data Lake Add-On for Splunk",
55
"version": "2.0.1",
66
"restRoot": "TA_dataset",
77
"schemaVersion": "0.0.3"

0 commit comments

Comments
 (0)