Skip to content

CSPL-3707: Update documentation around minimum number of indexer cluster peers #1558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlieberman-splunk merged 3 commits into from
Aug 18, 2025
Merged

CSPL-3707: Update documentation around minimum number of indexer cluster peers #1558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a5c801
document minimum number of CR replicas
rlieberman-splunk Aug 5, 2025
93c5163
update examples documentation
rlieberman-splunk Aug 5, 2025
6565555
Merge branch 'develop' of https://github.com/splunk/splunk-operator i…
rlieberman-splunk Aug 18, 2025
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
4 changes: 2 additions & 2 deletions docs/CustomResources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ the `Standalone` resource provides the following `Spec` configuration parameters

| Key | Type | Description |
| ---------- | ------- | ------------------------------------------------- |
| replicas | integer | The number of standalone replicas (defaults to 1) |
| replicas | integer | The number of standalone replicas (miminum of 1, which is the default) |


## SearchHeadCluster Resource Spec Parameters
Expand Down Expand Up @@ -263,7 +263,7 @@ the `IndexerCluster` resource provides the following `Spec` configuration parame

| Key | Type | Description |
| ---------- | ------- | ----------------------------------------------------- |
| replicas | integer | The number of indexer cluster members (defaults to 1) |
| replicas | integer | The number of indexer cluster members (minimum of 3, which is the default) |


## MonitoringConsole Resource Spec Parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/Examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ EOF
```
This will automatically configure a cluster, with a predetermined number of index cluster peers generated automatically based upon the replication_factor (RF) set. This example includes the `monitoringConsoleRef` parameter used to define a monitoring console pod.

NOTE: If you try to specify the number of `replicas` on an IndexerCluster CR less than the RF (as set on ClusterManager,) the Splunk Operator will always scale the number of peers to either the `replication_factor` for single site indexer clusters, or to the `origin` count in `site_replication_factor` for multi-site indexer clusters.
NOTE: If you try to specify the number of `replicas` on an IndexerCluster CR less than the RF (as set on ClusterManager,) the Splunk Operator will always scale the number of peers to either the `replication_factor` for single site indexer clusters, or to the `origin` count in `site_replication_factor` for multi-site indexer clusters. The minimum number of indexer cluster peers is 3.

After starting the cluster manager, indexer cluster peers, and monitoring console pods using the examples above, use the `kubectl get pods` command to verify your environment:
```
Expand Down
Loading