docs: restructure external Splunk integration guide - #154
docs: restructure external Splunk integration guide#154kupratyu-splunk wants to merge 3 commits into
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dde08a8e9a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Place a TLS-terminating load balancer, ingress, or reverse proxy in front of the | ||
| SAIA service. The certificate must be trusted by customer browsers. Preserve | ||
| streaming responses and allow the exact `SPLUNK_WEB_ORIGIN` when CORS | ||
| configuration is required. |
There was a problem hiding this comment.
When a customer follows this instruction by enabling CORS header injection on the load balancer or reverse proxy, normal SAIA responses can contain duplicate Access-Control-Allow-Origin values and be rejected by browsers. The operator's generated nginx configuration explicitly handles preflights, while FastAPI already supplies CORS headers on non-OPTIONS responses (pkg/ai/features/saia/impl.go:1397-1407); its regression test also requires that the proxy not add those headers to normal responses (pkg/ai/features/saia/impl_test.go:536-543). The runbook should tell the external proxy to preserve the upstream CORS headers without adding another set, rather than instructing it to allow the origin itself.
Useful? React with 👍 / 👎.
| | Value | Requirement | | ||
| |---|---| | ||
| | `http://<host>:30080` (plain HTTP NodePort) | `https://<host>:<port>` | | ||
| | Browser blocks XHR from HTTPS Splunk page | Same scheme — no block | | ||
| | Requires keeping Splunk Web on HTTP | Splunk Web can stay on HTTPS | | ||
|
|
||
| --- | ||
| | SAIA service | `${AISERVICE}-saia-service`, normally port `8080` | | ||
| | HTTPS URL | Stable `SAIA_URL`, normally on port `443` | |
There was a problem hiding this comment.
When the TLS terminator runs outside Kubernetes—the normal case for an on-premises load balancer or standalone reverse proxy—it cannot route to the cluster-only service name on port 8080 as this table instructs. The NodePort configuration exposes SAIA at a worker-node address on port 30080 (tools/cluster_setup/k0s-cluster-config.yaml:196-200), so following the documented backend value will result in DNS failures or 502/504 responses. Distinguish in-cluster proxies, which can use ${AISERVICE}-saia-service:8080, from external proxies, which must use one or more worker addresses and the configured NodePort.
Useful? React with 👍 / 👎.
| If the management certificate uses a private CA, add that CA to the SAIA pod's | ||
| trust store before testing. |
There was a problem hiding this comment.
When the Splunk management endpoint uses the private CA explicitly supported here, installing that CA interactively in a running SAIA pod is not sufficient: Step 2 subsequently deletes every SAIA pod, so the modified container filesystem and trust entry are lost before end-to-end testing. The operator-generated pod specs only mount the feature ConfigMap (and optionally the service TLS secret), with no custom trust-store volume exposed (pkg/ai/features/saia/impl.go:869-887 and api/v1/aiservice_types.go:100-127). Document a persistent supported method—such as a SAIA image containing the CA or an operator-managed CA mount—rather than merely saying to add it to the current pod's trust store.
Useful? React with 👍 / 👎.
Drop the standalone Problem Statement and Testing sections; fold verification steps into "What the Customer Should Do" so the doc reads as: what to do, which files to edit, what values to provide, then what to do if testing fails. Co-Authored-By: Claude <noreply@anthropic.com>
1 participant
Description
Related Issues
Type of Change
Changes Made
Testing Performed
make test)make lint)Test Environment
Test Steps
Documentation
Checklist
Breaking Changes
Impact:
Migration Path:
Screenshots/Recordings
Additional Notes
Reviewer Notes
Please pay special attention to:
Commit Message Convention: This PR follows Conventional Commits