Skip to content

Commit fbb867c

Browse files
committed
removed .splunkrc support
- Updated README.md file - removed scripts and makefile commands use for creating .splunkrc file - removed .splunkrc create steps from GitHub action for test
1 parent 09551a8 commit fbb867c

File tree

5 files changed

+4
-183
lines changed

5 files changed

+4
-183
lines changed

.github/workflows/test.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,6 @@ jobs:
3636
uses: actions/setup-python@v2
3737
with:
3838
python-version: ${{ matrix.python }}
39-
- name: Create .splunkrc file
40-
run: |
41-
cd ~
42-
echo host=localhost > .splunkrc
43-
echo port=8089 >> .splunkrc
44-
echo username=admin >> .splunkrc
45-
echo password=changed! >> .splunkrc
46-
echo scheme=https >> .splunkrc
47-
echo version=${{ matrix.splunk }} >> .splunkrc
4839
- name: Install tox
4940
run: pip install tox
5041
- name: Test Execution

Makefile

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,6 @@ test_smoke_no_app:
5656
@echo "$(ATTN_COLOR)==> test_smoke_no_app $(NO_COLOR)"
5757
@tox -e py27,py37 -- -m "smoke and not app"
5858

59-
.PHONY: splunkrc
60-
splunkrc:
61-
@echo "$(ATTN_COLOR)==> splunkrc $(NO_COLOR)"
62-
@echo "To make a .splunkrc:"
63-
@echo " [SPLUNK_INSTANCE_JSON] | python scripts/build-splunkrc.py ~/.splunkrc"
64-
65-
.PHONY: splunkrc_default
66-
splunkrc_default:
67-
@echo "$(ATTN_COLOR)==> splunkrc_default $(NO_COLOR)"
68-
@python scripts/build-splunkrc.py ~/.splunkrc
69-
7059
.PHONY: up
7160
up:
7261
@echo "$(ATTN_COLOR)==> up $(NO_COLOR)"

README.md

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ You'll need `docker` and `docker-compose` to get up and running using this metho
6060
```
6161
make up SPLUNK_VERSION=8.0
6262
make wait_up
63-
make splunkrc_default
6463
make test
6564
make down
6665
```
@@ -91,42 +90,12 @@ service = client.connect(host=<host_url>, token=<session_key>, autologin=True)
9190
```
9291

9392
###
94-
#### Create a .splunkrc convenience file
93+
#### Update a .env file
9594

96-
To connect to Splunk Enterprise, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a text file named **.splunkrc**. Then, the SDK examples and unit tests use the values from the **.splunkrc** file when you don't specify them.
95+
To connect to Splunk Enterprise, many of the SDK examples and unit tests take command-line arguments that specify values for the host, port, and login credentials for Splunk Enterprise. For convenience during development, you can store these arguments as key-value pairs in a **.env** file. Then, the SDK examples and unit tests use the values from the **.env** file when you don't specify them.
9796

98-
>**Note**: Storing login credentials in the **.splunkrc** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file.
97+
>**Note**: Storing login credentials in the **.env** file is only for convenience during development. This file isn't part of the Splunk platform and shouldn't be used for storing user credentials for production. And, if you're at all concerned about the security of your credentials, enter them at the command line rather than saving them in this file.
9998
100-
To use this convenience file, create a text file with the following format:
101-
102-
# Splunk Enterprise host (default: localhost)
103-
host=localhost
104-
# Splunk Enterprise admin port (default: 8089)
105-
port=8089
106-
# Splunk Enterprise username
107-
username=admin
108-
# Splunk Enterprise password
109-
password=changeme
110-
# Access scheme (default: https)
111-
scheme=https
112-
# Your version of Splunk Enterprise
113-
version=8.0
114-
115-
Save the file as **.splunkrc** in the current user's home directory.
116-
117-
* For example on OS X, save the file as:
118-
119-
~/.splunkrc
120-
121-
* On Windows, save the file as:
122-
123-
C:\Users\currentusername\.splunkrc
124-
125-
You might get errors in Windows when you try to name the file because ".splunkrc" appears to be a nameless file with an extension. You can use the command line to create this file by going to the **C:\Users\\&lt;currentusername&gt;** directory and entering the following command:
126-
127-
Notepad.exe .splunkrc
128-
129-
Click **Yes**, then continue creating the file.
13099

131100
#### Run the examples
132101

@@ -144,7 +113,7 @@ Using Session key
144113

145114
python examplename.py --sessionKey="<value>"
146115

147-
If you saved your login credentials in the **.splunkrc** file, you can omit those arguments:
116+
If you saved your login credentials in the **.env** file, you can omit those arguments:
148117

149118
python examplename.py
150119

scripts/build-splunkrc.py

Lines changed: 0 additions & 112 deletions
This file was deleted.

scripts/templates/splunkrc.template

Lines changed: 0 additions & 16 deletions
This file was deleted.

0 commit comments

Comments
 (0)