Splunk Add-on for GitHub Setup

Prerequisites

Tool or access	Purpose	Verify
Bash and Python 3	Run bundled setup and validation helpers	bash --version && python3 --version
Required product/platform access	Inspect or configure the selected target	Complete the documented preflight
Credential files for live modes	Keep secrets out of chat	Verify paths only

Workflow Overview

┌───────────┐   ┌───────────────┐   ┌───────────────┐   ┌─────────────────┐
│ Preflight │ → │ Render/review │ → │ Apply/handoff │ → │ Validate evidence │
└───────────┘   └───────────────┘   └───────────────┘   └─────────────────┘

When to Activate

• Onboard, configure, render, or validate GitHub audit/security data in Splunk.
• Preview and review the splunk github ta setup workflow before any live apply phase.
• Diagnose failed prerequisites, generated assets, configuration, or validation evidence.

Scope

Follow the documented read-only or render-first path whenever it is available. This skill does not imply permission to mutate live systems. Require explicit apply flags, protected credentials, and operator review for state changes.

Examples

Inspect the supported setup modes before selecting one:

bash skills/splunk-github-ta-setup/scripts/setup.sh --help

Expected output: usage, supported modes, and required arguments are displayed without changing the target environment.

Inspect validation modes before running completion checks:

bash skills/splunk-github-ta-setup/scripts/validate.sh --help

Expected output: offline, live, and completion options are displayed when the skill supports them; help exits without mutation.

Troubleshooting

Issue	Cause	Resolution
Preflight fails	A required tool or access path is missing	Resolve it before rendering or applying
Rendered assets are incomplete	Required non-secret inputs are absent	Complete intake and render again
Apply is blocked	Review, credentials, or explicit acceptance is missing	Use the documented handoff
Validation is incomplete	Live evidence is unavailable	Record the gap and keep completion open

TA Completion Gate

For every TA/add-on or dashboard companion run, satisfy the shared TA completion gate: configure and enable the data ingest path owned by this skill or its required companion, validate events or metrics in the target indexes/source types, and verify any pre-built/package-shipped dashboards are visible, macro-aligned, and returning data. If the package ships no dashboards, record that evidence explicitly and hand off dashboard use to the consuming app, ES/ITSI/ARI content, or readiness doctor.

Render-first automation for Splunk_TA_github (Splunkbase 6254, verified 3.3.0). The renderer emits reviewable GitHub Cloud API inputs, a PAT account runbook, HEC/syslog handoffs, and validation SPL. It never handles PAT or HEC token values.

Package Verification Boundary

The package-derived baseline is 4.0.0, the current public release, which advertises Splunk 10.5. Both 3.3.0 and 4.0.0 were unpacked and diffed here, and the rendered templates follow 4.0.0, so the shared installer's default pin needs no review override. When Splunkbase publishes a newer release, re-check its modular-input/account schema, source types, and shipped views before advancing the pin.

Workflow

bash skills/splunk-github-ta-setup/scripts/setup.sh --render \
  --index github --account-name github_prod

bash skills/splunk-github-ta-setup/scripts/setup.sh --install --create-index --index github

Configure the GitHub account from account-setup.md, review inputs.local.conf.template, and enable selected inputs.

bash skills/splunk-github-ta-setup/scripts/validate.sh --index github

Readiness handoff:

bash skills/splunk-data-source-readiness-doctor/scripts/setup.sh \
  --phase collect --source-pack github_audit

See reference.md for source types and HEC/GHES guardrails.