Docker compose files on EXAMPLES.md are out of date
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- docker-compose
- Domain
- documentation
Research direction
Update the Docker Compose examples in EXAMPLES.md, starting with the standalone example linked in the issue and then checking the other compose snippets for the same outdated settings. Verify that the examples include the required Splunk terms acceptance and current Compose syntax, use clear service names, and provide a working local startup path.
Written by the indexing model from the issue text.
Description
Heya! I was happy to find an easy way to throw up a local splunk instance via the examples page - thanks.
However, if you use the compose file as is:
version: "3.6"
services:
so1:
image: ${SPLUNK_IMAGE:-splunk/splunk:latest}
container_name: so1
environment:
- SPLUNK_START_ARGS=--accept-license
- SPLUNK_PASSWORD
ports:
- 8000:8000
There's a couple issues:
- most importantly you need to add
- SPLUNK_GENERAL_TERMS=--accept-sgt-current-at-splunk-comor else it won't start. Thank you for the very helpful error though!! (so1 | For example: docker run -e SPLUNK_GENERAL_TERMS=--accept-sgt-current-at-splunk-com -e SPLUNK_START_ARGS=--accept-license -e SPLUNK_PASSWORD splunk/splunk). This causes it fatally stop so should be fixed - you don't need
container_name: so1- it will use the service name above - i suggest renaming
so1to besplunk. I know there's lots more uses of this service name in the example doc, butso1isn't useful when you dodocker ps- especially if you have a couple dozen containers running like i do. Later on you can even renameuf1tosplunk-forwarder. We've got the power to have nice names ...yes!! version: "3.6"can be removed - docker even complains ``versionis obsolete, it will be ignored, please remove it to avoid potential confusion- make it a happy path and just put a janky default password in there. If you want to get fancy, you can use an
.envfile that has a random password in it like these fine docs here do - one copy and paste your secure!
Here's what I ended up with that worked:
services:
splunk:
image: ${SPLUNK_IMAGE:-splunk/splunk:latest}
environment:
- SPLUNK_START_ARGS=--accept-license
- SPLUNK_PASSWORD=${SPLUNK_PASSWORD:-password123}
- SPLUNK_GENERAL_TERMS=--accept-sgt-current-at-splunk-com
ports:
- 8000:8000
sprinkle these changes through out the whole doc and keep up the good work!
- Dominant language
- Python
- Stars
- 549
- Forks
- 277
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from splunk/docker-splunk
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
splunk/docker-splunk#737 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
splunk/docker-splunk#732 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
splunk/docker-splunk#731 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
splunk/docker-splunk#724 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
splunk/docker-splunk#717 ·
All issues in splunk/docker-splunk
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
zostera/django-bootstrap4#894 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3276 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zilliztech/memsearch#759 ·