Skip to content

Commit 1b69773

Browse files
kosabogijmikell821
andauthored
Updates Upgrade ECK page (#702)
### [Preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/702/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s) This PR updates the Upgrade Elastic Cloud on Kubernetes page. Related issue: elastic/docs-projects#460 --------- Co-authored-by: Janeen Mikell Roberts <[email protected]>
1 parent 10f334e commit 1b69773

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ This page provides instructions on how to upgrade the ECK operator.
1010
For upgrades of Elastic Stack applications like Elasticsearch or Kibana, check [Upgrade the Elastic Stack version](../deployment-or-cluster.md).
1111

1212

13-
## Before you upgrade to ECK 2.16.1 [k8s-ga-upgrade]
13+
## Before you upgrade to ECK 3.0.0 [k8s-ga-upgrade]
1414

15-
The upgrade process results in an update to all the existing managed resources. This potentially triggers a rolling restart of all Elasticsearch and Kibana pods. This [list](#k8s-beta-to-ga-rolling-restart) details the affected target versions that will cause a rolling restart. If you have a large Elasticsearch cluster or multiple Elastic Stack deployments, the rolling restart could cause a performance degradation. When you plan to upgrade ECK for production workloads, take into consideration the time required to upgrade the ECK operator plus the time required to roll all managed workloads and Elasticsearch clusters. Check for more information on how to [control the rolling restarts during the upgrade](#k8s-beta-to-ga-rolling-restart).
15+
The upgrade process results in an update to all the existing managed resources. This potentially triggers a rolling restart of all Elasticsearch and Kibana pods. This [list](#k8s-beta-to-ga-rolling-restart) details the affected target versions that will cause a rolling restart. If you have a large Elasticsearch cluster or multiple Elastic Stack deployments, the rolling restart could cause a performance degradation. When you plan to upgrade ECK for production workloads, take into consideration the time required to upgrade the ECK operator plus the time required to roll all managed workloads and Elasticsearch clusters. For more details on controlling rolling restarts during the upgrade, refer to the [control the rolling restarts during the upgrade](#k8s-beta-to-ga-rolling-restart) section.
1616

17-
Before upgrading, refer to the [release notes](https://www.elastic.co/guide/en/cloud-on-k8s/current/release-notes-2.16.1.html) to make sure that the release does not contain any breaking changes that could affect you. The [release highlights document](https://www.elastic.co/guide/en/cloud-on-k8s/current/release-highlights-2.16.1.html) provides more details and possible workarounds for any breaking changes or known issues in each release.
17+
Before upgrading, refer to the [release notes](cloud-on-k8s://release-notes/index.md) to make sure that the release does not contain any breaking changes that could affect you. The [release highlights document](cloud-on-k8s://release-notes/index.md) provides more details and possible workarounds for any breaking changes or known issues in each release.
1818

19-
Note that the release notes and highlights only list the changes since the last release. If during the upgrade you skip any intermediate versions and go for example from 1.0.0 directly to 2.16.1, review the release notes and highlights of each of the skipped releases to understand all the breaking changes you might encounter during and after the upgrade.
19+
Note that the release notes and highlights only list the changes since the last release. If during the upgrade you skip any intermediate versions and go for example from 1.0.0 directly to 3.0.0, review the release notes and highlights of each of the skipped releases to understand all the breaking changes you might encounter during and after the upgrade.
2020

2121
::::{warning}
2222
When upgrading always ensure that the version of the CRDs installed in the cluster matches the version of the operator. If you are using Helm, the CRDs are upgraded automatically as part of the Helm chart. If you are using the YAML manifests, you must upgrade the CRDs manually. Running differing versions of the CRDs and the operator is not a supported configuration and can lead to unexpected behavior.
@@ -32,14 +32,14 @@ When upgrading always ensure that the version of the CRDs installed in the clust
3232
Release 1.7.0 moved the [CustomResourceDefinitions](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) (CRD) used by ECK to the v1 version. If you upgrade from a previous version of ECK, the new version of the CRDs replaces the existing CRDs. If you cannot remove the current ECK installation because you have production workloads that must not be deleted, the following approach is recommended.
3333

3434
```shell
35-
kubectl replace -f https://download.elastic.co/downloads/eck/2.16.1/crds.yaml
35+
kubectl replace -f https://download.elastic.co/downloads/eck/3.0.0/crds.yaml
3636
```
3737

3838
::::{note}
3939
If you skipped a release in which new CRDs where introduced, you will get an error message similar to `Error from server (NotFound): error when replacing "config/crds.yaml": customresourcedefinitions.apiextensions.k8s.io ... not found`. To add the missing CRDs run
4040

4141
```shell
42-
kubectl create -f https://download.elastic.co/downloads/eck/2.16.1/crds.yaml
42+
kubectl create -f https://download.elastic.co/downloads/eck/3.0.0/crds.yaml
4343
```
4444

4545
::::
@@ -48,9 +48,11 @@ kubectl create -f https://download.elastic.co/downloads/eck/2.16.1/crds.yaml
4848
Then upgrade the remaining objects with the operator manifest:
4949

5050
```shell
51-
kubectl apply -f https://download.elastic.co/downloads/eck/2.16.1/operator.yaml
51+
kubectl apply -f https://download.elastic.co/downloads/eck/3.0.0/operator.yaml
5252
```
5353

54+
If you are using Helm: force upgrade the CRD chart to move to the v1 CRDs.
55+
5456
```shell
5557
helm upgrade elastic-operator elastic/eck-operator-crds -n elastic-system --force
5658
```
@@ -71,13 +73,17 @@ Operator Lifecycle Manager (OLM) and OpenShift OperatorHub users that run with a
7173

7274
### Upgrading from ECK 2.0 or later [k8s_upgrading_from_eck_2_0_or_later]
7375

74-
There are no special instructions to follow if you upgrade from any 2.x version to 2.16.1. Use the upgrade method applicable to your installation method of choice.
76+
There are no special instructions to follow if you upgrade from any 2.x version to 3.0.0. Use the upgrade method applicable to your installation method of choice.
77+
78+
If you are using our YAML manifests:
7579

7680
```shell
77-
kubectl apply -f https://download.elastic.co/downloads/eck/2.16.1/crds.yaml
78-
kubectl apply -f https://download.elastic.co/downloads/eck/2.16.1/operator.yaml
81+
kubectl apply -f https://download.elastic.co/downloads/eck/3.0.0/crds.yaml
82+
kubectl apply -f https://download.elastic.co/downloads/eck/3.0.0/operator.yaml
7983
```
8084

85+
If you are using Helm:
86+
8187
```shell
8288
helm upgrade elastic-operator elastic/eck-operator -n elastic-system
8389
```
@@ -103,6 +109,8 @@ If you have a very large Elasticsearch cluster or multiple Elastic Stack deploym
103109
Once a resource is excluded from being managed by ECK, you will not be able to add/remove nodes, upgrade Stack version, or perform other [orchestration tasks](../../deploy/cloud-on-k8s/configure-deployments.md) by updating the resource manifest. You must remember to remove the exclusion to ensure that your Elastic Stack deployment is continually monitored and managed by the operator.
104110
::::
105111

112+
Exclude Elastic resources from being managed by the operator:
113+
106114

107115
```shell
108116
ANNOTATION='eck.k8s.elastic.co/managed=false'

0 commit comments

Comments
 (0)