Splunk module · weave

Setup

Configure credentials via environment variables. We recommend sourcing them through 1Password or your secrets manager rather than committing them to the shell rc.

Official API reference

weave commands for this module are checked against the vendor's published API.

Splunk REST API

Variable	Description	Status
SPLUNK_URL	Required for authentication.	required
SPLUNK_TOKEN	Required for authentication.	required

Sanity-check the wiring:

weave secrets check
weave splunk --help
weave doctor   # reports SPLUNK_URL status

Capabilities

What this module can do, by entity and verb. ✓ means a working CLI surface; · means not (yet) wired.

Entity	find	list	show	do	snapshot	diff	apply
index	·	✓	·	·	·	·	·
saved-search	·	✓	·	·	·	·	·
user	·	✓	·	·	✓	✓	✓

Commands

Every registered CLI command, grouped by verb. Each example uses placeholder arguments — substitute real values for your environment.

list (3)

list indexes

read

List indexes.

weave splunk list indexes <arg>

list saved-searches

read

List saved searches.

weave splunk list saved-searches <arg>

list users

read

List Splunk users.

weave splunk list users <arg>

snapshot / diff / apply are generated automatically from the State Kinds declared on this module — see the State kinds section below for per-kind details. Workflow: snapshot → edit YAML → diff → apply --yes (or confirm interactively; apply --dry-run previews the same diff).

State kinds

Resources this module can snapshot and diff; apply where the kind supports live writes (see Round-trip per kind). Always run diff before apply; use --yes in automation after review. Files live under .weave-state/splunk/.

This module is on the thinner integration path — use snapshot / diff for audit; confirm apply per kind below before relying on writes.

users

snapshot diff apply

Splunk users — roles round-trip via POST /authentication/users/{name}.

Scope: —
Round-trip: Full round-trip — snapshot, diff, apply.

State file skeleton

module: splunk
kind: users
items:
  - # <fields specific to this kind — see snapshot output>

Workflows

End-to-end recipes from operators who already run this module in production. Copy, adapt, and put under change-control.

User roles audit

Snapshot Splunk users, edit roles, diff and apply.

weave splunk snapshot users
$EDITOR .weave-state/splunk/<host>/users.yaml
weave splunk diff users
weave splunk apply users

List saved searches

weave splunk list saved-searches

List indexes

weave splunk list indexes

Terraform parity

For each Terraform resource in the canonical provider, here's the equivalent live-API verb in weave. Use this as a migration cheat-sheet, not a 1:1 contract — weave deliberately stays in the live-state lane, not the desired-state lane.

Terraform resource	weave equivalent
splunk_user	weave splunk snapshot/diff/apply users Roles round-trip via authentication/users endpoint.
splunk_index	weave splunk list indexes Management REST with output_mode=json.

Troubleshooting & source

Missing credentials

Run weave doctor — it reports which env vars (including SPLUNK_URL) are set and which are blank.

Unexpected behaviour from a state apply

Re-run weave splunk diff <kind> to confirm the controller's current state, then re-snapshot before the next apply. The driver always re-snapshots before diffing.

Open the source

The module lives at https://github.com/andy-broyles/weavewhatever/tree/main/src/weave/modules/splunk. File a bug or feature request at https://github.com/andy-broyles/weavewhatever/issues.