SUPPORT.md

Navigation

• Preface
• System requirements
• Contact
• Support violation

Preface

Splunk Enterprise contains many settings that allow customers to tailor their Splunk environment. However, because not all settings apply to all customers, Splunk will only support the most common subset of all configurations. Throughout this document, the term "supported" means you can contact Splunk Support for assistance with issues.

System requirements

If you intend for this containerized Splunk Enterprise deployment to be supported in your Enterprise Support Agreement, you must verify you meet all of the requirements below. Failure to do so will render your deployment in an unsupported state. See Support violation below.

The following prerequisites and dependencies must be installed on each node you plan on deploying the container.

• Linux-based operating system, such as Debian, CentOS, and so on.
• Chipset:
  • splunk/splunk image supports x86-64 chipsets
  • splunk/universalforwarder image supports both x86-64 and s390x chipsets
• Kernel version 4.x
• Docker engine:

  • Docker Enterprise Engine 17.06.2 or higher

  • Docker Community Engine 17.06.2 or higher

    Note: If you are using podman, CRI-O, containerd or other container runtimes, please be aware that these are currently outside of our support/testing matrix. It's possible that this Docker image still works, although you may need to manually add the environment variable KUBERNETES_SERVICE_HOST=kubernetes to configure the provisioning hooks properly.

• OverlayFS overlay2 Docker daemon storage driver
  1. Edit /etc/docker/daemon.json. If it does not yet exist, create it.
  2. Assuming the file was empty, add the following contents:

     { "storage-driver": "overlay2" }
     

     Note: If you already have an existing JSON file, add only "storage-driver": "overlay2" as a key-value pair. Docker does not start if the daemon.json file contains badly-formed JSON.

See also

• Supported platforms for containerized Splunk software environments
• Recommended hardware and capacity
• Basic instructions to deploy and run Splunk Enterprise inside containers

Contact

Splunk Support only provides support for the single instance Splunk Validated Architectures (S-Type), Universal Forwarders and Heavy Forwarders. For all other configurations, contact Splunk Professional Services.

For additional support, you can:

• Post a question to Splunk Answers.
• Join us on Slack and post in the #docker channel.

If you are a Splunk Enterprise customer with a valid support entitlement contract and have a Splunk-related question, you can

• Open a support case on the https://www.splunk.com/ support portal.

Support violation

In the following conditions, Splunk Support reserves the right to deem your installation unsupported and not provide assistance when issues arise:

• You do not have an active support contract.
• You are running Splunk Enterprise and/or Splunk Universal Forwarder in a container on a platform not officially supported by Splunk.
• You are using features not officially supported by Splunk.

In the event you fall into an unsupported state, you may find support on Splunk Answers or through the open-source communities found on GitHub for this docker-splunk project or the related splunk-ansible project.