Skip to content

Commit ce192e1

Browse files
CSPL-4123: Update install and upgrade examples (#1601)
* update documentation around -cluster and -namespace yaml files * fix azure workflow lint error
1 parent 06230b3 commit ce192e1

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

.github/workflows/int-test-azure-workflow.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ jobs:
192192
cluster-name: ${{ env.TEST_CLUSTER_NAME }}
193193
inlineScript: |
194194
curl -LO https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml
195-
kubectl replace --force -f components.yaml || kubectl apply -f components.yaml
195+
kubectl replace --force -f components.yaml || kubectl apply -f components.yaml
196196
- name: install k8s dashboard
197197
uses: Azure/aks-set-context@v1
198198
with:

docs/SplunkOperatorUpgrade.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How to upgrade Splunk Operator and Splunk Enterprise Deployments
22

3-
To upgrade the Splunk Operator for Kubernetes, you will overwrite the prior Operator release with the latest version. Once the lastest version of `splunk-operator-namespace.yaml` ([see below](#upgrading-splunk-operator-and-splunk-operator-deployment)) is applied the CRD's are updated and Operator deployment is updated with newer version of Splunk Operator image. Any new spec defined by the operator will be applied to the pods managed by Splunk Operator for Kubernetes.
3+
To upgrade the Splunk Operator for Kubernetes, you will overwrite the prior Operator release with the latest version. Once the lastest version of `splunk-operator-cluster.yaml` or `splunk-operator-namespace.yaml` ([see below](#splunk-operator-upgrade)) is applied, the CRD's are updated and Operator deployment is updated with newer version of Splunk Operator image. Any new spec defined by the operator will be applied to the pods managed by Splunk Operator for Kubernetes.
44
55
A Splunk Operator for Kubernetes upgrade might include support for a later version of the Splunk Enterprise Docker image. In that scenario, after the Splunk Operator completes its upgrade, the pods managed by Splunk Operator for Kubernetes will be restarted using the latest Splunk Enterprise Docker image.
66
@@ -15,15 +15,22 @@ A Splunk Operator for Kubernetes upgrade might include support for a later versi
1515
* For general information about Splunk Enterprise compatibility and the upgrade process, see [How to upgrade Splunk Enterprise](https://docs.splunk.com/Documentation/Splunk/latest/Installation/HowtoupgradeSplunk).
1616
1717
* If you use forwarders, verify the Splunk Enterprise version compatibility with the forwarders in the [Compatibility between forwarders and Splunk Enterprise indexers](https://docs.splunk.com/Documentation/Forwarder/latest/Forwarder/Compatibilitybetweenforwardersandindexers) documentation.
18+
19+
* Verify which manifest you are using in your current setup: cluster or namespace. You can find this information by looking at the splunk-operator-controller-manager deployment that is already running. If the `WATCH_NAMESPACE` environment variable has an empty value, then the splunk-operator-cluster.yaml is being used, and the deployment is watching all namespaces in the cluster. If the `WATCH_NAMESPACE` environment variable has a value with the name of one or multiple namespaces, then the splunk-operator-namespace.yaml is being used, and you will need to follow the [instructions](#configuring-operator-to-watch-specific-namespace) to setup the correct namespaces to watch.
1820
1921

2022

2123
# Splunk Operator Upgrade
2224

2325
## Steps to upgrade from version greater than 1.0.5 to latest
2426

25-
1. Download the latest Splunk Operator installation yaml file.
26-
27+
1. Download the latest Splunk Operator installation yaml file for your deployment type.
28+
Cluster-wide:
29+
```
30+
wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/3.0.0/splunk-operator-cluster.yaml
31+
```​
32+
33+
Namespace Scoped:
2734
```
2835
wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator/releases/download/3.0.0/splunk-operator-namespace.yaml
2936
```
@@ -34,6 +41,12 @@ a. **NOTE** The `SPLUNK_GENERAL_TERMS` environment variable is set to an empty s
3441
3542
3643
3. Upgrade the Splunk Operator.​
44+
Cluster-wide:
45+
```
46+
kubectl apply -f splunk-operator-cluster.yaml --server-side
47+
```
48+
49+
Namespace Scoped:
3750
```
3851
kubectl apply -f splunk-operator-namespace.yaml --server-side
3952
```

0 commit comments

Comments
 (0)