The Splunk Operator for Kubernetes (SOK) makes it easy for Splunk administrators to deploy and operate Splunk Enterprise deployments on Kubernetes. Packaged as a container, it uses the operator pattern to manage Splunk-specific custom resources, handling the underlying Kubernetes objects for you.
- Published docs site: https://splunk.github.io/splunk-operator/
- In-repo docs index:
docs/README.md - Getting started:
docs/GettingStarted.md - Custom resources & operations:
docs/operate/ - Architecture & internals:
docs/develop/Architecture.md
Prerequisites and full setup are documented in
docs/develop/DevelopmentSetup.md.
make help # list all available targets
make build # compile the operator binary
make test # run unit tests (Ginkgo/Gomega, envtest)
make install # install CRDs into the current cluster
make deploy IMG=<image> NAMESPACE=<ns> SPLUNK_GENERAL_TERMS="--accept-sgt-current-at-splunk-com"Starting with operator version 3.0.0, which includes support for Splunk Enterprise version 10.x, an additional Docker-Splunk specific parameter is required to start containers. This is a breaking change, and user action is required. Starting in 10.x image versions of Splunk Enterprise, license acceptance requires an additional SPLUNK_GENERAL_TERMS=--accept-sgt-current-at-splunk-com argument. This indicates that users have read and accepted the current/latest version of the Splunk General Terms, available at https://www.splunk.com/en_us/legal/splunk-general-terms.html as may be updated from time to time. Unless you have jointly executed with Splunk a negotiated version of these General Terms that explicitly supersedes this agreement, by accessing or using Splunk software, you are agreeing to the Splunk General Terms posted at the time of your access and use and acknowledging its applicability to the Splunk software. Please read and make sure you agree to the Splunk General Terms before you access or use this software. Only after doing so should you include the --accept-sgt-current-at-splunk-com flag to indicate your acceptance of the current/latest Splunk General Terms and launch this software. All examples below have been updated with this change. If you use the below examples and the ‘–accept-sgt-current-at-splunk-com’ flag, you are indicating that you have read and accepted the current/latest version of the Splunk General Terms, as may be updated from time to time, and acknowledging its applicability to this software - as noted above.
- Development setup:
docs/develop/DevelopmentSetup.md - Contributing guide:
docs/develop/Contributing.md - AI agent guide (routing & ownership):
AGENTS.md
Apache License 2.0. See LICENSE.
