Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/CustomResources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ you can use to manage Splunk Enterprise deployments in your Kubernetes cluster.
- [SearchHeadCluster Resource Spec Parameters](#searchheadcluster-resource-spec-parameters)
- [ClusterMaster Resource Spec Parameters](#clustermaster-resource-spec-parameters)
- [IndexerCluster Resource Spec Parameters](#indexercluster-resource-spec-parameters)
- [Example of Guaranteed and Burstable QoS](#example-of-guaranteed-and-burstable-qos)
- [Examples of Guaranteed and Burstable QoS](#examples-of-guaranteed-and-burstable-qos)

For examples on how to use these custom resources, please see
[Configuring Splunk Enterprise Deployments](Examples.md).
Expand Down Expand Up @@ -234,9 +234,9 @@ the `IndexerCluster` resource provides the following `Spec` configuration parame
| replicas | integer | The number of indexer cluster members (defaults to 1) |


## Example of Guaranteed and Burstable QoS
## Examples of Guaranteed and Burstable QoS

As given in the [Kubernetes Quality of Service section](readme#using-kubernetes-quality-of-service-classes), you can set up your kubernetes cluster with different Quality of Services by using your Pods’ CPU and Memory resources values. Following are examples of Guaranteed and Burstable QoS:
You can change the CPU and memory resources, and assign different Quality of Services (QoS) classes to your pods using the [Kubernetes Quality of Service section](README.md#using-kubernetes-quality-of-service-classes). Here are some examples:

### A Guaranteed QoS Class example:
The minimum resource requirements for a Standalone Splunk Enterprise instance are 24 vCPU and 12GB RAM. Set equal ```requests``` and ```limits``` values for CPU and memory to establish a QoS class of Guaranteed.
Expand Down
6 changes: 3 additions & 3 deletions docs/Images.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Required Docker Images

The Splunk Operator requires three docker images to be present or available to your Kubernetes cluster:
The Splunk Operator requires these docker images to be present or available to your Kubernetes cluster:

* `splunk/splunk-operator`: The Splunk Operator image (built by this repository)
* `splunk/splunk:8.1.0`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (8.1.0 or later)
* `splunk/splunk-operator`: The Splunk Operator image built by this repository or the [official release](https://hub.docker.com/r/splunk/splunk-operator) (1.0.0 RC or later)
* `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (8.1.3 or later)

All of these images are publicly available, and published on [Docker Hub](https://hub.docker.com/).

Expand Down
9 changes: 5 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Review the [Change Log](ChangeLog.md) page for a history of changes in each rele

- Kubernetes, version 1.16.2+ and later.

The Splunk Operator should work with any [CNCF certified distribution]((https://www.cncf.io/certification/software-conformance/)) of Kubernetes. We do not have platform recommendations, but this is a table of platforms that our developers, customers, and partners have used successfully with the Splunk Operator.
The Splunk Operator should work with any [CNCF certified distribution](https://www.cncf.io/certification/software-conformance/) of Kubernetes. We do not have platform recommendations, but this is a table of platforms that our developers, customers, and partners have used successfully with the Splunk Operator.

| | |
| ---- | --- |
Expand All @@ -58,7 +58,7 @@ Each Splunk Operator release has specific Splunk Enterprise compatibility requir

### Splunk Apps Installation

Apps and add-ons can be installed using the Splunk Operator by following the instructions given at [Installing Splunk Apps](Examples#installing-splunk-apps). Premium apps such as Enterprise Security and IT Service Intelligence are currently not supported.
Apps and add-ons can be installed using the Splunk Operator by following the instructions given at [Installing Splunk Apps](Examples.md#installing-splunk-apps). Premium apps such as Enterprise Security and IT Service Intelligence are currently not supported.


### Docker requirements
Expand Down Expand Up @@ -93,7 +93,7 @@ In addition to the guidelines provided in the reference hardware, [Kubernetes Qu
| _Burstable_ | _CPU/Mem ```requests``` < CPU/Mem ```limits```_ | _When the CPU and memory ```requests``` value is set lower than the ```limits``` the pod is given a QoS class of Burstable. This level of service is useful in a user acceptance testing ___(UAT) environment___, where the pods run with minimum resources, and Kubernetes allocates additional resources depending on usage._|
| _BestEffort_ | _No CPU/Mem ```requests``` or ```limits``` are set_ | _When the ```requests``` or ```limits``` values are not set, the pod is given a QoS class of BestEffort. This level of service is sufficient for ___testing, or a small development task___._ |

Examples on how to implement these QoS are given at [Example of Guaranteed, Burstable and BestEffort QoS](CustomResources.md#example-of-guaranteed-and-burstable-qos) section.
Examples on how to implement these QoS are given at [Examples of Guaranteed and Burstable QoS](CustomResources.md#examples-of-guaranteed-and-burstable-qos) section.


### Storage guidelines
Expand All @@ -103,7 +103,8 @@ information.

### What Storage Type To Use?

The Kubernetes infrastructure must have access to storage that meets or exceeds the recommendations provided in the Splunk Enterprise storage type recommendations at [Reference Hardware documentation - what storage type to use for a given role?](https://docs.splunk.com/Documentation/Splunk/latest/Capacity/Referencehardware#What_storage_type_should_I_use_for_a_role.3F) In summary, Indexers with SmartStore need NVMe or SSD storage to provide the necessary IIOPs for a successful Splunk Enterprise environment.
The Kubernetes infrastructure must have access to storage that meets or exceeds the recommendations provided in the Splunk Enterprise storage type recommendations at [Reference Hardware documentation - what storage type to use for a given role?](https://docs.splunk.com/Documentation/Splunk/latest/Capacity/Referencehardware#What_storage_type_should_I_use_for_a_role.3F) In summary, Indexers with SmartStore need NVMe or SSD storage to provide the necessary IOPs for a successful Splunk Enterprise environment.


### Mandatory Use of Splunk SmartStore
For production environments, we are requiring the use of Splunk SmartStore. As a Splunk Enterprise deployment's data volume increases, demand for storage typically outpaces demand for compute resources. [Splunk's SmartStore Feature](https://docs.splunk.com/Documentation/Splunk/latest/Indexer/AboutSmartStore) allows you to manage your indexer storage and compute resources in a ___cost-effective___ manner by scaling those resources separately. SmartStore utilizes a fast storage cache on each indexer node to keep recent data locally available for search and keep other data in a remote object store. Look into the [SmartStore Resource Guide](SmartStore.md) document for configuring and using SmartStore through operator.
Expand Down