Skip to content

Commit e3a7bc2

Browse files
author
Tony Lee
authored
Merge branch 'master' into develop
2 parents b03689a + 088c9c9 commit e3a7bc2

File tree

3 files changed

+57
-44
lines changed

3 files changed

+57
-44
lines changed

‎_config.yml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
theme: jekyll-theme-modernist
1+
theme: jekyll-theme-modernist
2+
relative_links:
3+
enabled: true
4+
collections: true
5+
markdown: kramdown
6+
kramdown:
7+
parse_block_html: true

‎base/debian-10/install.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ln -sf /usr/share/zoneinfo/UTC /etc/localtime
3131
apt update
3232

3333
# put back tools for customer support
34-
apt-get install -y --no-install-recommends curl sudo libgssapi-krb5-2 busybox procps acl
34+
apt-get install -y --no-install-recommends curl sudo libgssapi-krb5-2 busybox procps acl gcc libssl-dev libffi-dev python2-dev
3535
apt-get install -y --no-install-recommends python-pip python-setuptools python-requests python-yaml
3636
pip --no-cache-dir install ansible
3737

‎docs/EXAMPLES.md‎

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ $ docker run --name so1 --hostname so1 -p 8000:8000 -e "SPLUNK_PASSWORD=<passwor
3030
```
3131

3232
## Create standalone from compose
33-
<details><summary>docker-compose.yml</summary><p>
3433

35-
```
34+
<details><summary markdown="span">docker-compose.yml</summary>
35+
36+
```yaml
3637
version: "3.6"
3738

3839
services:
@@ -45,7 +46,7 @@ services:
4546
ports:
4647
- 8000
4748
```
48-
</p></details>
49+
</details>
4950
5051
Execute the following to bring up your deployment:
5152
```
@@ -55,9 +56,9 @@ $ SPLUNK_PASSWORD=<password> docker-compose up -d
5556
## Create standalone with license
5657
Adding a Splunk Enterprise license can be done in multiple ways. Please review the following compose files below to see how it can be achieved, either with a license hosted on a webserver or with a license file as a direct mount.
5758

58-
<details><summary>docker-compose.yml - license from URL</summary><p>
59+
<details><summary>docker-compose.yml - license from URL</summary>
5960

60-
```
61+
```yaml
6162
version: "3.6"
6263

6364
services:
@@ -71,11 +72,11 @@ services:
7172
ports:
7273
- 8000
7374
```
74-
</p></details>
75+
</details>
7576
76-
<details><summary>docker-compose.yml - license from file</summary><p>
77+
<details><summary>docker-compose.yml - license from file</summary>
7778
78-
```
79+
```yaml
7980
version: "3.6"
8081

8182
services:
@@ -91,7 +92,7 @@ services:
9192
volumes:
9293
- ./splunk.lic:/tmp/license/splunk.lic
9394
```
94-
</p></details>
95+
</details>
9596
9697
9798
Execute the following to bring up your deployment:
@@ -102,9 +103,9 @@ $ SPLUNK_PASSWORD=<password> docker-compose up -d
102103
## Create standalone with HEC
103104
To learn more about what the HTTP event collector (HEC) is and how to use it, please review the documentation [here](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector).
104105

105-
<details><summary>docker-compose.yml</summary><p>
106+
<details><summary>docker-compose.yml</summary>
106107

107-
```
108+
```yaml
108109
version: "3.6"
109110

110111
services:
@@ -118,7 +119,7 @@ services:
118119
ports:
119120
- 8000
120121
```
121-
</p></details>
122+
</details>
122123
123124
Execute the following to bring up your deployment:
124125
```
@@ -132,9 +133,11 @@ $ curl -k https://localhost:8088/services/collector/event -H "Authorization: Spl
132133
```
133134

134135
## Create standalone with app
135-
<details><summary>docker-compose.yml</summary><p>
136+
Splunk apps can also be installed using this Docker image.
136137

137-
```
138+
<details><summary>docker-compose.yml</summary>
139+
140+
```yaml
138141
version: "3.6"
139142

140143
services:
@@ -148,17 +151,19 @@ services:
148151
ports:
149152
- 8000
150153
```
151-
</p></details>
154+
</details>
152155
153156
Execute the following to bring up your deployment:
154157
```
155158
$ SPLUNK_PASSWORD=<password> docker-compose up -d
156159
```
157160

158161
## Create standalone with SplunkBase app
159-
<details><summary>docker-compose.yml</summary><p>
162+
Apps showcased on SplunkBase can also be installed using this Docker image.
160163

161-
```
164+
<details><summary>docker-compose.yml</summary>
165+
166+
```yaml
162167
version: "3.6"
163168

164169
services:
@@ -174,17 +179,19 @@ services:
174179
ports:
175180
- 8000
176181
```
177-
</p></details>
182+
</details>
178183
179184
Execute the following to bring up your deployment:
180185
```
181186
$ SPLUNKBASE_PASSWORD=<splunkbase_password> SPLUNK_PASSWORD=<password> docker-compose up -d
182187
```
183188

184189
## Create standalone and universal forwarder
185-
<details><summary>docker-compose.yml</summary><p>
190+
You can also enable distributed deployments. In this case, we can create a Splunk universal forwarder running in a container to stream logs to a Splunk standalone, also running in a container.
186191

187-
```
192+
<details><summary>docker-compose.yml</summary>
193+
194+
```yaml
188195
version: "3.6"
189196

190197
networks:
@@ -225,7 +232,7 @@ services:
225232
- 8000
226233
- 8089
227234
```
228-
</p></details>
235+
</details>
229236
230237
Execute the following to bring up your deployment:
231238
```
@@ -235,9 +242,9 @@ $ SPLUNK_PASSWORD=<password> docker-compose up -d
235242
## Create heavy forwarder
236243
The following will allow you spin up a forwarder, and stream its logs to an independent, external indexer located at `idx1-splunk.company.internal`, as long as that hostname is reachable on your network.
237244

238-
<details><summary>docker-compose.yml</summary><p>
245+
<details><summary>docker-compose.yml</summary>
239246

240-
```
247+
```yaml
241248
version: "3.6"
242249

243250
networks:
@@ -263,7 +270,7 @@ services:
263270
ports:
264271
- 1514
265272
```
266-
</p></details>
273+
</details>
267274
268275
Execute the following to bring up your deployment:
269276
```
@@ -273,9 +280,9 @@ $ SPLUNK_PASSWORD=<password> docker-compose up -d
273280
## Create heavy forwarder and deployment server
274281
The following will allow you spin up a forwarder, and stream its logs to an independent, external indexer located at `idx1-splunk.company.internal`, as long as that hostname is reachable on your network. Additionally, it brings up a deployment server, which will download an app and distribute it to the heavy forwarder.
275282

276-
<details><summary>docker-compose.yml</summary><p>
283+
<details><summary>docker-compose.yml</summary>
277284

278-
```
285+
```yaml
279286
version: "3.6"
280287

281288
networks:
@@ -316,7 +323,7 @@ services:
316323
- SPLUNK_APPS_URL=https://artifact.company.internal/splunk_app.tgz
317324
- SPLUNK_PASSWORD
318325
```
319-
</p></details>
326+
</details>
320327
321328
Execute the following to bring up your deployment:
322329
```
@@ -330,9 +337,9 @@ $ docker run -it -e SPLUNK_PASSWORD=<password> splunk/splunk:latest create-defau
330337
```
331338

332339
Additionally, review the `docker-compose.yml` below to understand how linking Splunk instances together through roles and environment variables is accomplished:
333-
<details><summary>docker-compose.yml</summary><p>
340+
<details><summary>docker-compose.yml</summary>
334341

335-
```
342+
```yaml
336343
version: "3.6"
337344

338345
networks:
@@ -445,7 +452,7 @@ services:
445452
volumes:
446453
- ./default.yml:/tmp/defaults/default.yml
447454
```
448-
</p></details>
455+
</details>
449456
450457
Execute the following to bring up your deployment:
451458
```
@@ -459,9 +466,9 @@ $ docker run -it -e SPLUNK_PASSWORD=<password> splunk/splunk:latest create-defau
459466
```
460467

461468
Additionally, review the `docker-compose.yml` below to understand how linking Splunk instances together through roles and environment variables is accomplished:
462-
<details><summary>docker-compose.yml</summary><p>
469+
<details><summary>docker-compose.yml</summary>
463470

464-
```
471+
```yaml
465472
version: "3.6"
466473

467474
networks:
@@ -575,7 +582,7 @@ services:
575582
volumes:
576583
- ./default.yml:/tmp/defaults/default.yml
577584
```
578-
</p></details>
585+
</details>
579586
580587
Execute the following to bring up your deployment:
581588
```
@@ -589,9 +596,9 @@ $ docker run -it -e SPLUNK_PASSWORD=<password> splunk/splunk:latest create-defau
589596
```
590597

591598
Additionally, review the `docker-compose.yml` below to understand how linking Splunk instances together through roles and environment variables is accomplished:
592-
<details><summary>docker-compose.yml</summary><p>
599+
<details><summary>docker-compose.yml</summary>
593600

594-
```
601+
```yaml
595602
version: "3.6"
596603

597604
networks:
@@ -776,17 +783,17 @@ services:
776783
volumes:
777784
- ./default.yml:/tmp/defaults/default.yml
778785
```
779-
</p></details>
786+
</details>
780787
781788
Execute the following to bring up your deployment:
782789
```
783790
$ docker-compose up -d
784791
```
785792

786793
## Enable root endpoint on SplunkWeb
787-
<details><summary>docker-compose.yml</summary><p>
794+
<details><summary>docker-compose.yml</summary>
788795

789-
```
796+
```yaml
790797
version: "3.6"
791798

792799
services:
@@ -800,7 +807,7 @@ services:
800807
ports:
801808
- 8000
802809
```
803-
</p></details>
810+
</details>
804811
805812
Execute the following to bring up your deployment:
806813
```
@@ -810,9 +817,9 @@ $ SPLUNK_PASSWORD=<password> docker-compose up -d
810817
Then, visit SplunkWeb on your browser with the root endpoint in the URL, such as `http://localhost:8000/splunkweb`.
811818

812819
## Create sidecar forwarder
813-
<details><summary>k8s-sidecar.yml</summary><p>
820+
<details><summary>k8s-sidecar.yml</summary>
814821

815-
```
822+
```yaml
816823
apiVersion: v1
817824
kind: Pod
818825
metadata:
@@ -842,7 +849,7 @@ spec:
842849
- name: shared-data
843850
emptyDir: {}
844851
```
845-
</p></details>
852+
</details>
846853
847854
Execute the following to bring up your deployment:
848855
```

0 commit comments

Comments
 (0)