splunk / splunk/splunk-platform-automator
spa config: apply catalog settings to splunk_config.yml
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 137
- Forks
- 51
- Avg merge
- 7h 44m
- Merged PRs (30d)
- 14
Description
Summary
Apply feature-catalog snippets into an env splunk_config.yml from the CLI, without a skill.
#53 ships lookup only: spa features list / show / search / keys. Records include keys, a YAML snippet, and merge (deep vs replace) so an apply command can write the env config the same way spa-create-config does by hand today.
Ship
- Operator command (tentative
spa config set ID, stem at pickup) that merges the catalog snippet into$SPA_ENV_DIR/config/splunk_config.yml. - Flag/placeholder values for snippets; never print secrets; Splunkbase stays
lookup('env', ...). - Then
spa validate(or call it). - Skills may call this instead of patching YAML themselves.
- Tests: apply
setting.osonto a topology+provider skeleton; refuse unknown ids; no credential echo.
Related
Notes
Pickup-ready after #53. Never print secrets. Skills and agents call spa only.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the feature-catalog work in #53 and the existing CLI path for configuration commands. Implement the catalog apply flow for $SPA_ENV_DIR/config/splunk_config.yml, including merge behavior, placeholders, validation, and secret-safe errors. Add tests for applying setting.os to a topology and provider skeleton, rejecting unknown IDs, and avoiding credential output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100