Skip to content

Commit c1ac691

Browse files
CSPL-3673: Update install docs with arguments (#1483)
* Update documents with --server-side option for install * remove --force-conflicts * fix typo
1 parent 781caa1 commit c1ac691

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

docs/Install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ By installing `splunk-operator-cluster.yaml` Operator will watch all the namespa
1818

1919
```
2020
wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-cluster.yaml
21-
kubectl apply -f splunk-operator-cluster.yaml
21+
kubectl apply -f splunk-operator-cluster.yaml --server-side
2222
```
2323

2424
## Install operator to watch multiple namespaces
@@ -48,7 +48,7 @@ In order to install operator with restrictive permission to watch only single na
4848

4949
```
5050
wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-namespace.yaml
51-
kubectl apply -f splunk-operator-namespace.yaml
51+
kubectl apply -f splunk-operator-namespace.yaml --server-side
5252
```
5353

5454
## Private Registries

docs/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,16 @@ For production environments, we are requiring the use of Splunk SmartStore. As a
113113

114114
A Kubernetes cluster administrator can install and start the Splunk Operator for specific namespace by running:
115115
```
116-
kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-namespace.yaml --server-side --force-conflicts
116+
kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-namespace.yaml --server-side
117117
```
118118

119119
A Kubernetes cluster administrator can install and start the Splunk Operator for cluster-wide by running:
120120
```
121-
kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-cluster.yaml --server-side --force-conflicts
121+
kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.7.1/splunk-operator-cluster.yaml --server-side
122122
```
123123

124+
The reason for appending `--server-side` to the apply command is that some of the CRDs are getting too long according to the CRD standards. There are no real implications caused by this.
125+
124126
The [Advanced Installation Instructions](Install.md) page offers guidance for advanced configurations, including the use of private image registries, installation at cluster scope, and installing the Splunk Operator as a user who is not a Kubernetes administrator. Users of Red Hat OpenShift should review the [Red Hat OpenShift](OpenShift.md) page.
125127

126128
*Note: We recommended that the Splunk Enterprise Docker image is copied to a private registry, or directly onto your Kubernetes workers before creating large Splunk Enterprise deployments. See the [Required Images Documentation](Images.md) page, and the [Advanced Installation Instructions](Install.md) page for guidance on working with copies of the Docker images.*

docs/SplunkOperatorUpgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator
3333
3434
3. Upgrade the Splunk Operator.​
3535
```
36-
kubectl apply -f splunk-operator-namespace.yaml --server-side --force-conflicts
36+
kubectl apply -f splunk-operator-namespace.yaml --server-side
3737
```
3838
3939
After applying the yaml, a new operator pod will be created and the existing operator pod will be terminated. Example:

0 commit comments

Comments
 (0)