Skip to content

Commit 4c1a474

Browse files
committed
addressing changes for CSPL-1814 in documentation
Signed-off-by: vivekr-splunk <[email protected]>
1 parent 08d6f6e commit 4c1a474

File tree

4 files changed

+24
-23
lines changed

4 files changed

+24
-23
lines changed

docs/AppFramework.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ spec:
6767
secretRef: s3-secret
6868
```
6969
70-
6. Apply the Custom Resource specification: `kubectl apply -f Standalone.yaml`
70+
6. Apply the Custom Resource specification: `kubectl apply -n splunk-operator -f Standalone.yaml`
7171

7272
The App Framework detects the Splunk app or add-on archive files available in the App Source locations, and deploys them to the standalone instance path for local use.
7373

@@ -133,7 +133,7 @@ spec:
133133
secretRef: s3-secret
134134
```
135135

136-
6. Apply the Custom Resource specification: `kubectl apply -f ClusterMaster.yaml`
136+
6. Apply the Custom Resource specification: `kubectl apply -n splunk-operator -f ClusterMaster.yaml`
137137

138138
The App Framework detects the Splunk app or add-on archive files available in the App Source locations, and deploys the apps from the `adminApps` folder to the cluster manager instance for local use.
139139

@@ -208,7 +208,7 @@ spec:
208208
secretRef: s3-secret
209209
```
210210

211-
6. Apply the Custom Resource specification: `kubectl apply -f SearchHeadCluster.yaml`
211+
6. Apply the Custom Resource specification: `kubectl apply -n splunk-operator -f SearchHeadCluster.yaml`
212212

213213
The App Framework detects the Splunk app or add-on archive files available in the App Source locations, and deploys the apps from the `adminApps` folder to the Deployer instance for local use.
214214

docs/Examples.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The Splunk Operator makes creation of a cluster easy by utilizing a `ClusterMast
5454

5555
#### Cluster Manager
5656
```yaml
57-
cat <<EOF | kubectl apply -f -
57+
cat <<EOF | kubectl apply -n splunk-operator -f -
5858
apiVersion: enterprise.splunk.com/v3
5959
kind: ClusterMaster
6060
metadata:
@@ -73,7 +73,7 @@ The Splunk Operator also controls the upgrade cycle, and implements the recommen
7373
This example includes the `monitoringConsoleRef` parameter used to define a monitoring console pod. The monitoring console pod does not need to be running; the name can be predefined and the pod started later. To start the monitoring console pod, see [Monitoring Console](#monitoring-console), or use the example below:
7474

7575
```yaml
76-
cat <<EOF | kubectl apply -f -
76+
cat <<EOF | kubectl apply -n splunk-operator -f -
7777
apiVersion: enterprise.splunk.com/v3
7878
kind: MonitoringConsole
7979
metadata:
@@ -89,7 +89,7 @@ The passwords for the instance are generated automatically. To review the passwo
8989

9090
#### Indexer cluster peers
9191
```yaml
92-
cat <<EOF | kubectl apply -f -
92+
cat <<EOF | kubectl apply -n splunk-operator -f -
9393
apiVersion: enterprise.splunk.com/v3
9494
kind: IndexerCluster
9595
metadata:
@@ -123,7 +123,7 @@ splunk-operator-7c5599546c-wt4xl 1/1 Running 0 14h
123123
If you want to add more indexers as cluster peers, update your `IndexerCluster` CR and define the `replicas` parameter:
124124

125125
```yaml
126-
cat <<EOF | kubectl apply -f -
126+
cat <<EOF | kubectl apply -n splunk-operator -f -
127127
apiVersion: enterprise.splunk.com/v3
128128
kind: IndexerCluster
129129
metadata:
@@ -176,7 +176,7 @@ indexercluster.enterprise.splunk.com/example scaled
176176
You can also create [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) to manage dynamic scaling for you. For example:
177177
178178
```yaml
179-
cat <<EOF | kubectl apply -f -
179+
cat <<EOF | kubectl apply -n splunk-operator -f -
180180
apiVersion: autoscaling/v1
181181
kind: HorizontalPodAutoscaler
182182
metadata:
@@ -202,7 +202,7 @@ idc-example IndexerCluster/example 16%/50% 5 10 5
202202
To create a standalone search head that is preconfigured to search your indexer cluster, add the `clusterMasterRef` parameter:
203203

204204
```yaml
205-
cat <<EOF | kubectl apply -f -
205+
cat <<EOF | kubectl apply -n splunk-operator -f -
206206
apiVersion: enterprise.splunk.com/v3
207207
kind: Standalone
208208
metadata:
@@ -235,7 +235,7 @@ splunk-operator-7c5599546c-wt4xl 1/1 Running 0 14h
235235
Having a separate CR for cluster manager allows you to define parameters differently than the indexers, such as storage capacity and the storage class used by persistent volumes.
236236

237237
```yaml
238-
cat <<EOF | kubectl apply -f -
238+
cat <<EOF | kubectl apply -n splunk-operator -f -
239239
apiVersion: enterprise.splunk.com/v3
240240
kind: ClusterMaster
241241
metadata:
@@ -273,7 +273,7 @@ The Monitoring Console provides detailed topology and performance information ab
273273

274274

275275
```yaml
276-
cat <<EOF | kubectl apply -f -
276+
cat <<EOF | kubectl apply -n splunk-operator -f -
277277
apiVersion: enterprise.splunk.com/v3
278278
kind: MonitoringConsole
279279
metadata:
@@ -294,7 +294,7 @@ You can create a search head cluster that is configured to communicate with your
294294
and adding the `clusterMasterRef` parameter.
295295

296296
```yaml
297-
cat <<EOF | kubectl apply -f -
297+
cat <<EOF | kubectl apply -n splunk-operator -f -
298298
apiVersion: enterprise.splunk.com/v3
299299
kind: SearchHeadCluster
300300
metadata:
@@ -312,7 +312,7 @@ EOF
312312
This will automatically create a deployer with 3 search heads clustered together. Search head clusters require a minimum of 3 members. This example includes the `monitoringConsoleRef` parameter and name used to define a monitoring console (MC) pod. To start the monitoring console pod, see [Monitoring Console](#monitoring-console), or use the example below:
313313

314314
```yaml
315-
cat <<EOF | kubectl apply -f -
315+
cat <<EOF | kubectl apply -n splunk-operator -f -
316316
apiVersion: enterprise.splunk.com/v3
317317
kind: MonitoringConsole
318318
metadata:
@@ -689,7 +689,7 @@ spec:
689689
While configuring [`Indexer Clusters`](Examples.md#indexer-clusters) to use the `LicenseMaster`, you need to add `licenseMasterRef` only to the `ClusterMaster` spec as follows:
690690

691691
```yaml
692-
cat <<EOF | kubectl apply -f -
692+
cat <<EOF | kubectl apply -n splunk-operator -f -
693693
apiVersion: enterprise.splunk.com/v3
694694
kind: ClusterMaster
695695
metadata:

docs/MultisiteExamples.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
This document provides examples to configure a multisite cluster using the splunk-operator.
44

55

6-
- [Multisite Indexer Clusters in Kubernetes](#multisite-indexer-clusters-in-kubernetes)
7-
- [Multipart IndexerCluster](#multipart-indexercluster)
8-
- [Deploy the cluster-manager](#deploy-the-cluster-manager)
9-
- [Deploy the indexer sites](#deploy-the-indexer-sites)
10-
- [Connecting a search-head cluster to a multisite indexer-cluster](#connecting-a-search-head-cluster-to-a-multisite-indexer-cluster)
6+
- [Configuring Splunk Enterprise Multisite Deployments](#configuring-splunk-enterprise-multisite-deployments)
7+
- [Multisite Indexer Clusters in Kubernetes](#multisite-indexer-clusters-in-kubernetes)
8+
- [Multipart IndexerCluster](#multipart-indexercluster)
9+
- [Deploy the cluster-manager](#deploy-the-cluster-manager)
10+
- [Deploy the indexer sites](#deploy-the-indexer-sites)
11+
- [Connecting a search-head cluster to a multisite indexer-cluster](#connecting-a-search-head-cluster-to-a-multisite-indexer-cluster)
1112

1213
Please refer to the [Configuring Splunk Enterprise Deployments Guide](Example.md)
1314
for more information and examples about deploying the different Splunk resources
@@ -47,7 +48,7 @@ Limitation: all the IndexerCluster resources must be located in the same namespa
4748
Note: the image version is defined in these resources as this allows to control the upgrade cycle
4849

4950
```yaml
50-
cat <<EOF | kubectl apply -f -
51+
cat <<EOF | kubectl apply -n splunk-operator -f -
5152
---
5253
apiVersion: enterprise.splunk.com/v3
5354
kind: ClusterMaster
@@ -86,7 +87,7 @@ EOF
8687
#### Deploy the indexer sites
8788

8889
```yaml
89-
cat <<EOF | kubectl apply -f -
90+
cat <<EOF | kubectl apply -n splunk-operator -f -
9091
---
9192
apiVersion: enterprise.splunk.com/v3
9293
kind: IndexerCluster
@@ -134,7 +135,7 @@ Additional ansible default parameters must be set to activate multisite:
134135
(https://docs.splunk.com/Documentation/Splunk/latest/DistSearch/DeploymultisiteSHC#Integrate_a_search_head_cluster_with_a_multisite_indexer_cluster))
135136

136137
```yaml
137-
cat <<EOF | kubectl apply -f -
138+
cat <<EOF | kubectl apply -n splunk-operator -f -
138139
---
139140
apiVersion: enterprise.splunk.com/v3
140141
kind: SearchHeadCluster

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The `Standalone` custom resource is used to create a single instance deployment
140140

141141

142142
```yaml
143-
cat <<EOF | kubectl apply -f -
143+
cat <<EOF | kubectl apply -n splunk-operator -f -
144144
apiVersion: enterprise.splunk.com/v3
145145
kind: Standalone
146146
metadata:

0 commit comments

Comments
 (0)