Skip to content

Document resolved compose config workflow - #17

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-0c36
Draft

cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-0c36

Conversation

@cursor

@cursor cursor Bot commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Updated PoC configuration docs with the verified load order for .env / tpl.env, tracked config.env, validation, and redacted make config output.
  • Added installation preflight guidance to run make config before the first boot.
  • Added troubleshooting guidance for missing secret files, missing config.env, empty redacted Compose fields, and stale image/timezone values.
  • Fixed presales links to point at the current environment-loading section.

Codepaths covered

  • scripts/with-splunk-env.sh
  • scripts/load-config-env.sh
  • scripts/compose-config.sh
  • scripts/compose-up.sh
  • Makefile config / up workflows

Knowledge gaps addressed

  • How operators should safely inspect resolved Compose input without printing secrets.
  • Why config.env is the source of truth for SPLUNK_IMAGE and TZ.
  • How to interpret blank secret fields in redacted make config output.

Verification

  • pre-commit run --all-files
  • make test
Open in Web View Automation 

Co-authored-by: D. Dessy (Splunk) <ddessy@splunk.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant