Splunk DB Connect 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
- Install or plan DB Connect, configure DBX Java and JDBC drivers, prepare identities, connections, inputs, outputs,
lookups, SQL Explorer, dbxquery, dbxoutput, dbxlookup, DB Connect over Federated Search, or validate DB Connect
topology.
- Preview and review the splunk db connect 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-db-connect-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-db-connect-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 |
Shared add-on completion gate
Whenever this workflow installs, configures, or hands off a registry-listed
Splunk app or add-on, follow the
shared completion gate. Package delivery
alone is not success; capture JDBC input/output data evidence and shipped-view
evidence, or explicit package evidence that no dashboards ship.
Use this skill for Splunk DB Connect (splunk_app_db_connect, Splunkbase app
2686) and the supported Splunk-published JDBC driver add-ons. The default
path is render, preflight, and validate only. Installing packages is explicit
and delegated to splunk-app-install; live DB Connect object mutation is out of
scope for v1.
Safety Rules
- Never ask for database passwords, tokens, wallet passphrases, private keys, or
CyberArk/Vault secrets in chat.
- Never put secrets in argv, specs, environment-variable prefixes, rendered
files, or JDBC URLs.
- Use local chmod-600 secret files or external secret references only.
- Treat DBX encrypted-value prefixes as non-portable local artifacts;
do not paste or render them as identity values.
- Do not deploy DB Connect through Deployment Server.
- Do not install DB Connect on universal forwarders or indexers.
- Do not self-service DB Connect installation on Splunk Cloud Classic; use IDM,
a customer-managed heavy forwarder, or a Splunk Cloud support workflow.
- Treat Splunk Cloud Victoria as a Cloud search-head DB Connect target. Model
customer-managed heavy forwarders as Enterprise runtime hosts paired to Cloud.
- Do not install archived JDBC add-ons unless the spec explicitly opts into
archived driver handling.
- Do not use the automated install handoff for FIPS DB Connect. FIPS requires a
fresh manual installation plan and PKCS12 keystore/truststore handling.
Primary Workflow
- Copy
template.example to a local working spec and fill in only non-secret
values.
- Run a read-only preflight:
bash skills/splunk-db-connect-setup/scripts/setup.sh \
--preflight \
--spec my-db-connect.yaml
- Render and validate the handoff packet:
bash skills/splunk-db-connect-setup/scripts/setup.sh \
--render \
--validate \
--spec my-db-connect.yaml \
--output-dir splunk-db-connect-rendered
The install helper applies supported DBX/Splunk JDBC add-ons. Any requested
archived, custom, or otherwise unsupported driver emits a manual-driver
handoff and makes the install request return nonzero before any package is
installed; a skipped driver is not reported as a completed install.
- If app installation is required, use the explicit install path:
bash skills/splunk-db-connect-setup/scripts/setup.sh \
--install-apps \
--accept-install \
--spec my-db-connect.yaml \
--output-dir splunk-db-connect-rendered
- Apply DBX objects manually or through a future version after reviewing the
rendered
dbx/*.preview files. This v1 skill does not mutate DB Connect
identities, connections, inputs, outputs, or lookups.
Supported Topologies
- Single search head
- Distributed search with a dedicated DBX search head or heavy forwarder
- Search head cluster through the deployer
- Heavy forwarder
- Heavy forwarder HA with etcd planning
- Splunk Cloud Victoria with outbound allowlist planning
- Splunk Cloud Classic through IDM, a customer-managed heavy forwarder, or a
support-managed install path
Required Runtime Checks
Rendered assets include checks for:
- DB Connect app and JDBC add-on installation
- Java
17 or 21 on Enterprise/customer-managed runtimes; Splunk-managed
JRE validation for Splunk Cloud Victoria search heads
- working KV Store
- DBX file permissions
- JDBC driver placement on every DBX instance
- SHC deployer bundle workflow when search head clusters are involved
- Cloud Victoria outbound database connectivity allowlists
- Splunk Cloud custom JDBC driver app skeletons under
lib/dbxdrivers
- index and optional HEC readiness
- REST, btool, SQL Explorer,
dbxquery, dbxoutput, and dbxlookup validation
- DB Connect over Federated Search saved-search handoffs
Read reference.md for driver catalog details, topology notes, Cloud behavior,
security controls, migration notes, and troubleshooting.
1---2name: splunk-db-connect-setup3description: "Use when the user asks to install or plan DB Connect, configure DBX Java and JDBC drivers, prepare4 identities, connections, inputs, outputs, lookups, SQL Explorer, dbxquery, dbxoutput, dbxlookup, DB5 Connect over Federated Search, or validate DB Connect topology. Render, preflight, validate, and hand6 off production-safe Splunk DB Connect JDBC ingestion, lookup, enrichment, and export assets for Splunk7 Platform."8compatibility: "Splunk Cloud Platform 10.5.2605: conditional. Follow documented package, entitlement, topology, and customer-managed runtime guardrails; self-managed paths remain on the public 10.4 baseline."9metadata:10 source: https://skillmd.com/skills/chambear2809/splunk-db-connect-setup11 splunk_cloud_10_5: "conditional"12 compatibility_verified: "2026-08-20"13---1415# Splunk DB Connect Setup1617## Prerequisites1819| Tool or access | Purpose | Verify |20|---|---|---|21| Bash and Python 3 | Run bundled setup and validation helpers | `bash --version && python3 --version` |22| Required product/platform access | Inspect or configure the selected target | Complete the documented preflight |23| Credential files for live modes | Keep secrets out of chat | Verify paths only |2425## Workflow Overview2627```text28┌───────────┐ ┌───────────────┐ ┌───────────────┐ ┌─────────────────┐29│ Preflight │ → │ Render/review │ → │ Apply/handoff │ → │ Validate evidence │30└───────────┘ └───────────────┘ └───────────────┘ └─────────────────┘31```3233## When to Activate3435- Install or plan DB Connect, configure DBX Java and JDBC drivers, prepare identities, connections, inputs, outputs,36 lookups, SQL Explorer, dbxquery, dbxoutput, dbxlookup, DB Connect over Federated Search, or validate DB Connect37 topology.38- Preview and review the splunk db connect setup workflow before any live apply phase.39- Diagnose failed prerequisites, generated assets, configuration, or validation evidence.4041## Scope4243Follow the documented read-only or render-first path whenever it is available.44This skill does not imply permission to mutate live systems. Require explicit45apply flags, protected credentials, and operator review for state changes.4647## Examples4849Inspect the supported setup modes before selecting one:5051```bash52bash skills/splunk-db-connect-setup/scripts/setup.sh --help53```5455Expected output: usage, supported modes, and required arguments are displayed56without changing the target environment.5758Inspect validation modes before running completion checks:5960```bash61bash skills/splunk-db-connect-setup/scripts/validate.sh --help62```6364Expected output: offline, live, and completion options are displayed when the65skill supports them; help exits without mutation.6667## Troubleshooting6869| Issue | Cause | Resolution |70|---|---|---|71| Preflight fails | A required tool or access path is missing | Resolve it before rendering or applying |72| Rendered assets are incomplete | Required non-secret inputs are absent | Complete intake and render again |73| Apply is blocked | Review, credentials, or explicit acceptance is missing | Use the documented handoff |74| Validation is incomplete | Live evidence is unavailable | Record the gap and keep completion open |7576## Shared add-on completion gate7778Whenever this workflow installs, configures, or hands off a registry-listed79Splunk app or add-on, follow the80[shared completion gate](../shared/ta_completion_gate.md). Package delivery81alone is not success; capture JDBC input/output data evidence and shipped-view82evidence, or explicit package evidence that no dashboards ship.8384Use this skill for Splunk DB Connect (`splunk_app_db_connect`, Splunkbase app85`2686`) and the supported Splunk-published JDBC driver add-ons. The default86path is render, preflight, and validate only. Installing packages is explicit87and delegated to `splunk-app-install`; live DB Connect object mutation is out of88scope for v1.8990## Safety Rules9192- Never ask for database passwords, tokens, wallet passphrases, private keys, or93 CyberArk/Vault secrets in chat.94- Never put secrets in argv, specs, environment-variable prefixes, rendered95 files, or JDBC URLs.96- Use local chmod-600 secret files or external secret references only.97- Treat DBX encrypted-value prefixes as non-portable local artifacts;98 do not paste or render them as identity values.99- Do not deploy DB Connect through Deployment Server.100- Do not install DB Connect on universal forwarders or indexers.101- Do not self-service DB Connect installation on Splunk Cloud Classic; use IDM,102 a customer-managed heavy forwarder, or a Splunk Cloud support workflow.103- Treat Splunk Cloud Victoria as a Cloud search-head DB Connect target. Model104 customer-managed heavy forwarders as Enterprise runtime hosts paired to Cloud.105- Do not install archived JDBC add-ons unless the spec explicitly opts into106 archived driver handling.107- Do not use the automated install handoff for FIPS DB Connect. FIPS requires a108 fresh manual installation plan and PKCS12 keystore/truststore handling.109110## Primary Workflow1111121. Copy `template.example` to a local working spec and fill in only non-secret113 values.1142. Run a read-only preflight:115116```bash117bash skills/splunk-db-connect-setup/scripts/setup.sh \118 --preflight \119 --spec my-db-connect.yaml120```1211223. Render and validate the handoff packet:123124```bash125bash skills/splunk-db-connect-setup/scripts/setup.sh \126 --render \127 --validate \128 --spec my-db-connect.yaml \129 --output-dir splunk-db-connect-rendered130```131132The install helper applies supported DBX/Splunk JDBC add-ons. Any requested133archived, custom, or otherwise unsupported driver emits a manual-driver134handoff and makes the install request return nonzero before any package is135installed; a skipped driver is not reported as a completed install.1361374. If app installation is required, use the explicit install path:138139```bash140bash skills/splunk-db-connect-setup/scripts/setup.sh \141 --install-apps \142 --accept-install \143 --spec my-db-connect.yaml \144 --output-dir splunk-db-connect-rendered145```1461475. Apply DBX objects manually or through a future version after reviewing the148 rendered `dbx/*.preview` files. This v1 skill does not mutate DB Connect149 identities, connections, inputs, outputs, or lookups.150151## Supported Topologies152153- Single search head154- Distributed search with a dedicated DBX search head or heavy forwarder155- Search head cluster through the deployer156- Heavy forwarder157- Heavy forwarder HA with etcd planning158- Splunk Cloud Victoria with outbound allowlist planning159- Splunk Cloud Classic through IDM, a customer-managed heavy forwarder, or a160 support-managed install path161162## Required Runtime Checks163164Rendered assets include checks for:165166- DB Connect app and JDBC add-on installation167- Java `17` or `21` on Enterprise/customer-managed runtimes; Splunk-managed168 JRE validation for Splunk Cloud Victoria search heads169- working KV Store170- DBX file permissions171- JDBC driver placement on every DBX instance172- SHC deployer bundle workflow when search head clusters are involved173- Cloud Victoria outbound database connectivity allowlists174- Splunk Cloud custom JDBC driver app skeletons under `lib/dbxdrivers`175- index and optional HEC readiness176- REST, btool, SQL Explorer, `dbxquery`, `dbxoutput`, and `dbxlookup` validation177- DB Connect over Federated Search saved-search handoffs178179Read `reference.md` for driver catalog details, topology notes, Cloud behavior,180security controls, migration notes, and troubleshooting.