Skip to content

Commit 92482af

Browse files
jmikell821jmikell821
authored
[Upgrade 9.0] Adds ECE/ECK upgrade topics (#812)
Contributes to elastic/docs-projects#247 and elastic/docs-projects#355. Previews: - [Upgrade on ECE](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/812/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece) - [Upgrade on ECK](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/812/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck)
1 parent 174b726 commit 92482af

File tree

3 files changed

+183
-9
lines changed

3 files changed

+183
-9
lines changed

‎deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,43 @@
22
navigation_title: "Upgrade on {{ece}}"
33
---
44

5-
# Upgrade on {{ece}} (ECE)
5+
# Upgrade your deployment on {{ece}} (ECE)
6+
7+
Similar to {{ech}}, a single click in the {{ecloud}} console can upgrade a deployment running on ECE to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, and all of your deployment components are upgraded simultaneously.
8+
9+
Once you're prepared to upgrade, do the following:
10+
11+
% Note: Add a link once confirmed where prepare to upgrade will reside in TOC.
12+
13+
1. Ensure your current ECE and Docker or Podman versions are [compatible](https://www.elastic.co/support/matrix/#elastic-cloud-enterprise) with the {{stack}} version you're upgrading to. For example, if you're upgrading to 9.0.0, the minimum required version is ECE 3.0. If you don’t have a compatible version installed, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md).
14+
2. Download the most recent [stack pack](/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md#ece_most_recent_elastic_stack_packs) for the version you’re upgrading to, then [add the stack pack](/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md#ece-manage-elastic-stack-add) to your installation using the Cloud UI.
15+
3. If not configured already, [assign a snapshots repository](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md) to your deployment to enable snapshots and back up your data. Although this is optional, we recommend this step.
16+
17+
## Perform the upgrade
18+
19+
1. [Log in to the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
20+
2. On the **Deployments** page, select your deployment.
21+
22+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
23+
24+
1. In the **Deployment version** section, click **Upgrade**.
25+
2. Select the version you're upgrading to. For example, `9.0.0`.
26+
3. Click **Upgrade**, then **Confirm upgrade**. The new configuration takes a few minutes to create.
27+
28+
::::{note}
29+
If any incompatibilities are detected when you attempt to upgrade, the UI provides a link to the Upgrade Assistant, which checks for deprecated settings in your cluster and indices and helps you resolve them. If there are any issues that would prevent a successful upgrade, the upgrade is blocked. After resolving the issues, return to the **Deployments** page and restart the upgrade.
30+
::::
31+
32+
**Security realm settings**
33+
34+
During the upgrade process, you are prompted to update the security realm settings if your user settings include a `xpack.security.authc.realms` value.
35+
36+
If the security realms are configured in `user_settings`, you’ll be prompted to modify the settings:
37+
38+
1. On the **Update security realm settings** window, edit the settings.
39+
2. Click **Update settings**. If the security realm settings are located in `user_settings_override`, contact support to help you upgrade.
40+
41+
## Next steps
42+
43+
Once you've successfully upgraded your deployment, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}.
44+

‎deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Log in to your {{ecloud}} environment:
1818

1919
1. Log in to the [{{ech}} console](https://cloud.elastic.co/login).
2020
2. Select your deployment on the home page in the {{ech}} card or go to the **Deployments** page.
21-
22-
Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
21+
22+
Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
2323

2424

2525
To upgrade a deployment:
@@ -45,9 +45,6 @@ Security realm settings
4545
1. On the **Update security realm settings** window, edit the settings.
4646
2. Click **Update settings**. If the security realm settings are located in `user_settings_override`, contact support to help you upgrade.
4747

48-
### Next steps [next-steps-ech]
48+
### Next steps
4949

50-
Once you've successfully upgraded on {{ech}}, do the following:
51-
52-
* [Upgrade Elastic APM](../../../solutions/observability/apps/upgrade.md)
53-
* [Upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md)
50+
Once you've successfully upgraded on {{ech}}, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}.

‎deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md

Lines changed: 139 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,142 @@
22
navigation_title: "Upgrade on {{eck}}"
33
---
44

5-
# Upgrade on {{eck}} (ECK)
5+
# Upgrade your deployment on {{eck}} (ECK)
6+
7+
The ECK orchestrator can safely perform upgrades to newer versions of the {{stack}}.
8+
9+
Once you are prepared to upgrade, ensure the ECK version is [compatible](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-supported.html) with the {{stack}} version you’re upgrading to. If it's incompatible, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md).
10+
11+
% Note: Add a link once confirmed where prepare to upgrade will reside in TOC.
12+
13+
## Perform the upgrade
14+
15+
1. In the resource spec file, modify the `version` field for the desired {{stack}} version.
16+
2. Save your changes. The orchestrator will start the upgrade process automatically.
17+
18+
In this example, we’re modifying the version to `9.0.0`.
19+
20+
```yaml
21+
apiVersion: elasticsearch.k8s.elastic.co/v1
22+
kind: Elasticsearch
23+
metadata:
24+
name: elasticsearch-sample
25+
namespace: production
26+
spec:
27+
version: 9.0.0
28+
monitoring:
29+
metrics:
30+
elasticsearchRefs:
31+
- name: monitoring-cluster
32+
namespace: observability
33+
logs:
34+
elasticsearchRefs:
35+
- name: monitoring-cluster
36+
namespace: observability
37+
http:
38+
service:
39+
spec:
40+
type: LoadBalancer
41+
nodeSets:
42+
- name: master
43+
count: 3
44+
config:
45+
node.roles: ["master"]
46+
xpack.ml.enabled: true
47+
node.store.allow_mmap: false
48+
volumeClaimTemplates:
49+
- metadata:
50+
name: elasticsearch-data
51+
spec:
52+
accessModes:
53+
- ReadWriteOnce
54+
resources:
55+
requests:
56+
storage: 20Gi
57+
storageClassName: standard
58+
podTemplate:
59+
metadata:
60+
labels:
61+
key: sample
62+
spec:
63+
initContainers:
64+
- name: sysctl
65+
securityContext:
66+
privileged: true
67+
command: ['sh', '-c', 'sysctl -w vm.max_map_count=262144']
68+
containers:
69+
- name: elasticsearch
70+
resources:
71+
requests:
72+
memory: 2Gi
73+
cpu: 0.5
74+
limits:
75+
memory: 2Gi
76+
cpu: 1
77+
- name: data
78+
count: 3
79+
config:
80+
node.roles: ["data", "ingest", "ml", "transform"]
81+
node.store.allow_mmap: false
82+
volumeClaimTemplates:
83+
- metadata:
84+
name: elasticsearch-data
85+
spec:
86+
accessModes:
87+
- ReadWriteOnce
88+
resources:
89+
requests:
90+
storage: 20Gi
91+
storageClassName: standard
92+
podTemplate:
93+
metadata:
94+
labels:
95+
key: sample
96+
spec:
97+
initContainers:
98+
- name: sysctl
99+
securityContext:
100+
privileged: true
101+
command: ['sh', '-c', 'sysctl -w vm.max_map_count=262144']
102+
containers:
103+
- name: elasticsearch
104+
resources:
105+
requests:
106+
memory: 2Gi
107+
cpu: 0.5
108+
limits:
109+
memory: 2Gi
110+
cpu: 1
111+
---
112+
apiVersion: kibana.k8s.elastic.co/v1
113+
kind: Kibana
114+
metadata:
115+
name: kibana-sample
116+
namespace: production
117+
spec:
118+
version: 9.0.0
119+
monitoring:
120+
metrics:
121+
elasticsearchRefs:
122+
- name: monitoring-cluster
123+
namespace: observability
124+
logs:
125+
elasticsearchRefs:
126+
- name: monitoring-cluster
127+
namespace: observability
128+
http:
129+
service:
130+
spec:
131+
type: LoadBalancer
132+
count: 1
133+
elasticsearchRef:
134+
name: elasticsearch-sample
135+
```
136+
137+
ECK will ensure that {{stack}} components are upgraded in the correct order. Upgrades to dependent resources are delayed until that dependency is upgraded. For example, the {{kib}} upgrade will start only when the associated {{es}} cluster has been upgraded.
138+
139+
Check out [Nodes orchestration](/deploy-manage/deploy/cloud-on-k8s/nodes-orchestration.md) for more information on how ECK manages upgrades and how to tune its behavior.
140+
141+
## Next steps
142+
143+
Once you've successfully upgraded your deployment, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}.

0 commit comments

Comments
 (0)