Skip to content

Commit aa22e46

Browse files
authored
Merge pull request #63 from lstewartsplunk/patch-2
Update README.md for sample_spl2_pii_masking app
2 parents fafa470 + 58af124 commit aa22e46

File tree

1 file changed

+11
-5
lines changed
  • spl2-sample-apps/sample_spl2_pii_masking

1 file changed

+11
-5
lines changed

spl2-sample-apps/sample_spl2_pii_masking/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In addition, this app shows how to:
1515

1616
* Organize your app modules for customization and reuse.
1717
* Use a separate module that contains views for specific user roles and capabilities. You can mask sensitive employee ID data in an index for most users, while keeping that data unmasked for privileged roles.
18-
* How to specify a custom command function to masking out sensitive data.
18+
* Specify a custom command function to masking out sensitive data.
1919
* Use a dataset literal to provide sample data for the app.
2020
* Import a view into your _default module.
2121
* Export views.
@@ -26,7 +26,13 @@ This app is compatible with Splunk Enterprise.
2626

2727
You need a pre-release version of Splunk Enterprise that supports SPL2-based applications. See [SPL2 Public Beta overview](https://dev.splunk.com/enterprise/docs/developapps/createspl2apps/spl2previewoverview) for information about the Beta.
2828

29-
## Installation
29+
## Accessing the sample app
30+
31+
The app is available in the [spl2-sample-apps](https://github.com/splunk/splunk-app-examples/tree/master/spl2-sample-apps/sample_spl2_pii_masking) folder on the Splunk GitHub Examples repository.
32+
33+
The app is uncompressed so that you can view the app folder structure, the modules, and other resources that are included with the app.
34+
35+
<!--## Installation
3036
3137
Complete the following steps to install a SPL2-based application:
3238
@@ -37,7 +43,7 @@ Complete the following steps to install a SPL2-based application:
3743
4. Locate the app file and select **Upload**. You might be prompted to restart the Splunk Enterprise instance.
3844
3945
2. Verify that the app appears in the **Apps** drop-down. You can also find the app on your pre-release instance in the `$SPLUNK_HOME/etc/apps/<app_name>`folder.
40-
46+
-->
4147
## App information
4248

4349
This app was developed by Splunk.
@@ -49,7 +55,7 @@ This app was developed by Splunk.
4955
| App file name | sample_spl2_pii_masking.spl | |
5056
| Namespace | apps.sample_spl2_pii_masking | |
5157
| Module | _default | This module contains all of the searches for this app. |
52-
| Module | functions | This module contains the custom command function `pii_mask`, which masks sensitive employee ID data in a dataset.
58+
| Module | functions | This module contains the custom command function `pii_mask`, which masks sensitive employee ID data in a dataset. |
5359
| Module | sample_data | This module contains a dataset literal of a sample set of events. |
5460
| View | $masked_view | This view returns all of the events with masked email addresses.
5561
This view is used to create the 'Failed logins (masked)' report. |
@@ -98,4 +104,4 @@ Alternatively, you can email us at `spl2@splunk.com`.
98104

99105
Splunk Developer Guide - [Create SPL2-based apps](https://dev.splunk.com/enterprise/docs/developapps/createspl2apps)
100106

101-
Happy Splunking!
107+
Happy Splunking!

0 commit comments

Comments
 (0)