Skip to content

Commit 0505ff8

Browse files
florent-leborgnejmikell821
florent-leborgne
and
jmikell821
authored
Port ECE 3.8 relevant changes to 4.0 (elastic#986)
This PR brings relevant changes added to ECE 3.8 docs to prepare for the 4.0 release, especially from: - elastic/cloud#138824 - elastic/cloud#138925 Another PR is on the way to update other remaining pieces elastic#972 FYI @jmikell821, changes to the upgrade instructions are very minimal given the refined scope of this doc in 4.0. I also updated the links to 3.8 ECE docs so I will only merge this when 3.8 is released. --------- Co-authored-by: Janeen Mikell Roberts <[email protected]>
1 parent 84962dd commit 0505ff8

File tree

5 files changed

+144
-37
lines changed

5 files changed

+144
-37
lines changed

‎deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md‎

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -71,27 +71,58 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
7171
SELINUX=enforcing
7272
```
7373

74-
4. Install podman:
74+
4. Install Podman:
75+
76+
* For Podman 4
7577

76-
* Install the latest available version `4.*` using dnf.
78+
* Install the latest available version `4.*` using dnf.
7779

78-
```sh
79-
sudo dnf install podman-4.* podman-remote-4.*
80-
```
80+
```sh
81+
sudo dnf install podman-4.* podman-remote-4.*
82+
```
8183

82-
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
84+
* To prevent automatic Podman major version updates, configure the Podman version to be locked at version `4.*` while still allowing minor and patch updates.
8385

84-
```sh
85-
## Install versionlock
86-
sudo dnf install 'dnf-command(versionlock)'
86+
```sh
87+
## Install versionlock
88+
sudo dnf install 'dnf-command(versionlock)'
8789
88-
## Lock major version
89-
sudo dnf versionlock add --raw 'podman-4.*'
90-
sudo dnf versionlock add --raw 'podman-remote-4.*'
90+
## Lock major version
91+
sudo dnf versionlock add --raw 'podman-4.*'
92+
sudo dnf versionlock add --raw 'podman-remote-4.*'
9193
92-
## Verify that podman-4.* and podman-remote-4.* appear in the output
93-
sudo dnf versionlock list
94-
```
94+
## Verify that podman-4.* and podman-remote-4.* appear in the output
95+
sudo dnf versionlock list
96+
```
97+
98+
* For Podman 5
99+
100+
* Install version `5.2.2-13.*` using dnf.
101+
102+
:::{note}
103+
As mentioned in [Migrating to Podman 5](migrate-to-podman-5.md) it is recommended to install Podman `5.2.2-13` since this is the latest supported version.
104+
105+
If you decide to install a previous Podman 5 version, make sure to replace `5.2.2-13` with the desired version in the commands below.
106+
107+
The version lock is still required for previous versions, to prevent automatic in-place updates that may be affected by a known [memory leak issue](https://github.com/containers/podman/issues/25473).
108+
:::
109+
110+
```sh
111+
sudo dnf install podman-5.2.2-13.* podman-remote-5.2.2-13.*
112+
```
113+
* To prevent automatic Podman updates to unsupported versions, configure the Podman version to be locked at version `5.2.2-13.*`.
114+
115+
```sh
116+
## Install versionlock
117+
sudo dnf install 'dnf-command(versionlock)'
118+
119+
## Lock major version
120+
sudo dnf versionlock add --raw 'podman-5.2.2-13.*'
121+
sudo dnf versionlock add --raw 'podman-remote-5.2.2-13.*'
122+
123+
## Verify that podman-5.2.2-13.* and podman-remote-5.2.2-13.* appear in the output
124+
sudo dnf versionlock list
125+
```
95126

96127
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:
97128

‎deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md‎

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -101,27 +101,58 @@ Using Docker or Podman as container runtime is a configuration local to the host
101101
SELINUX=enforcing
102102
```
103103

104-
4. Install podman:
104+
4. Install Podman:
105+
106+
* For Podman 4
105107

106-
* Install the latest available version `4.*` using dnf.
108+
* Install the latest available version `4.*` using dnf.
107109

108-
```sh
109-
sudo dnf install podman-4.* podman-remote-4.*
110-
```
110+
```sh
111+
sudo dnf install podman-4.* podman-remote-4.*
112+
```
111113

112-
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
114+
* To prevent automatic Podman major version updates, configure the Podman version to be locked at version `4.*` while still allowing minor and patch updates.
113115

114-
```sh
115-
## Install versionlock
116-
sudo dnf install 'dnf-command(versionlock)'
116+
```sh
117+
## Install versionlock
118+
sudo dnf install 'dnf-command(versionlock)'
117119
118-
## Lock major version
119-
sudo dnf versionlock add --raw 'podman-4.*'
120-
sudo dnf versionlock add --raw 'podman-remote-4.*'
120+
## Lock major version
121+
sudo dnf versionlock add --raw 'podman-4.*'
122+
sudo dnf versionlock add --raw 'podman-remote-4.*'
121123
122-
## Verify that podman-4.* and podman-remote-4.* appear in the output
123-
sudo dnf versionlock list
124-
```
124+
## Verify that podman-4.* and podman-remote-4.* appear in the output
125+
sudo dnf versionlock list
126+
```
127+
128+
* For Podman 5
129+
130+
* Install version `5.2.2-13.*` using dnf.
131+
132+
:::{note}
133+
As mentioned in [Migrating to Podman 5](migrate-to-podman-5.md) it is recommended to install Podman `5.2.2-13` since this is the latest supported version.
134+
135+
If you decide to install a previous Podman 5 version, make sure to replace `5.2.2-13` with the desired version in the commands below.
136+
137+
The version lock is still required for previous versions, to prevent automatic in-place updates that may be affected by a known [memory leak issue](https://github.com/containers/podman/issues/25473).
138+
:::
139+
140+
```sh
141+
sudo dnf install podman-5.2.2-13.* podman-remote-5.2.2-13.*
142+
```
143+
* To prevent automatic Podman updates to unsupported versions, configure the Podman version to be locked at version `5.2.2-13.*`.
144+
145+
```sh
146+
## Install versionlock
147+
sudo dnf install 'dnf-command(versionlock)'
148+
149+
## Lock major version
150+
sudo dnf versionlock add --raw 'podman-5.2.2-13.*'
151+
sudo dnf versionlock add --raw 'podman-remote-5.2.2-13.*'
152+
153+
## Verify that podman-5.2.2-13.* and podman-remote-5.2.2-13.* appear in the output
154+
sudo dnf versionlock list
155+
```
125156

126157
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:
127158

‎deploy-manage/deploy/cloud-enterprise/migrate-to-podman-5.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ece: all
5+
---
6+
# Migrating to Podman 5
7+
8+
Following are the supported upgrade paths for Podman 5 in {{ece}}.
9+
10+
| **From ↓** ... **To →** | Podman 5.2.2-9 | Podman 5.2.2-11 | Podman 5.2.2-13 | Podman 5.2.3 |
11+
|-----------------------------------------|----------------|-----------------|-----------------|--------------|
12+
| **<vanilla Linux installation> (grow)** | ✓ ^*^ | ✓ ^*^ | ✓ | X |
13+
| **Docker (grow-and-shrink)** | ✓ ^*^ | ✓ ^*^ | ✓ | X |
14+
| **Podman 4.9.4 (grow-and-shrink)** | ✓ ^*^ | ✓ ^*^ | ✓ | X |
15+
| **Podman 4.9.4 (in-place)** | ✓ | X | X | X |
16+
| **Podman 5.2.2-9 (in-place)** | - | X | X | X |
17+
18+
19+
20+
21+
^*^ *Supported but not recommended given that a newer version (Podman `5.2.2-13`) is available.*
22+
23+
Podman `5.2.2-13` is only supported when conducting a **fresh {{ece}} installation** or performing a **grow-and-shrink update** from Docker or Podman 4.
24+
25+
For **in-place updates**, it is recommended to use Podman `5.2.2-9`, since upgrades to versions `5.2.2-11` and `5.2.2-13` are affected by a known [memory leak issue](https://github.com/containers/podman/issues/25473).
26+
When performing an in-place update, please make sure to configure the Podman version to be locked at version `5.2.2-9.*`, by following the instructions below.
27+
28+
```sh
29+
## Install versionlock
30+
sudo dnf install 'dnf-command(versionlock)'
31+
32+
## Lock major version
33+
sudo dnf versionlock add --raw 'podman-5.2.2-9.*'
34+
sudo dnf versionlock add --raw 'podman-remote-5.2.2-9.*'
35+
36+
## Verify that podman-5.2.2-9.* and podman-remote-5.2.2-9.* appear in the output
37+
sudo dnf versionlock list
38+
```
39+
40+
Podman versions `5.2.3` and higher are not supported.

‎deploy-manage/toc.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ toc:
9494
- file: deploy/cloud-enterprise/deploy-large-installation.md
9595
- file: deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md
9696
- file: deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md
97+
children:
98+
- file: deploy/cloud-enterprise/migrate-to-podman-5.md
9799
- file: deploy/cloud-enterprise/log-into-cloud-ui.md
98100
- file: deploy/cloud-enterprise/post-installation-steps.md
99101
- file: deploy/cloud-enterprise/install-ece-on-additional-hosts.md

‎deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,18 @@ applies_to:
77
ece:
88
---
99

10-
% The upgrade procedure is expected to change with ECE 3.8.0 release. This document is currently a temporary draft, pending to be refined.
11-
1210
# Upgrade Elastic Cloud Enterprise [ece-upgrade]
1311

1412
This page provides instructions on how to upgrade the ECE operator.
1513

1614
To learn how to upgrade {{stack}} applications like {{es}} or {{kib}}, refer to [Upgrade the Elastic Stack version](../deployment-or-cluster.md).
1715

18-
Periodically, you might need to upgrade an Elastic Cloud Enterprise installation as new versions with additional features become available. The upgrade process updates all hosts that are part of an Elastic Cloud Enterprise installation to the latest version of ECE, with little or no downtime for managed deployments. To upgrade your deployment to {{stack}} 9.x, the minimum required ECE version is 3.0.0.
16+
Periodically, you might need to upgrade an Elastic Cloud Enterprise installation as new versions with additional features become available. The upgrade process updates all hosts that are part of an Elastic Cloud Enterprise installation to the latest version of ECE, with little or no downtime for managed deployments. To upgrade your deployment to {{stack}} 9.x, the minimum required ECE version is 4.0.0.
1917

2018
Before initiating the ECE upgrade process, review the [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) to ensure the operating system (OS), Docker, or Podman versions you're running are compatible with the ECE version you’re upgrading to. We recommend that Docker, Podman, and the operating system are at the target version before starting the ECE upgrade.
2119

2220
:::{note}
23-
During the upgrade window, there might be a short period of time during which you run a combination of versions which is not explicitly supported. For example, if you are on ECE 3.5 with Docker version 20.10 on Ubuntu 20.04, and plan to upgrade to ECE 3.7 on the same OS, you will need to upgrade Docker to version 24.0 first. In this case, and only during your upgrade window, we support the mixed OS/Docker versions. In general, this won’t be a problem. However, should anything become a blocker for the upgrade, [reach out to support for help](/troubleshoot/index.md#contact-us).
21+
During the upgrade window, there might be a short time period when you run a combination of versions that is not explicitly supported. For example, if you are on ECE 3.5 with Docker version 20.10 on Ubuntu 20.04 and plan to upgrade to ECE 3.7 on the same OS, you will need to upgrade Docker to version 24.0 first. In this case, and only during your upgrade window, we will support the mixed OS and container engine versions. In general, this won’t be a problem. However, should anything become a blocker for the upgrade, [reach out to support for help](/troubleshoot/index.md#contact-us).
2422
:::
2523

2624
## The upgrade version matrix [ece-upgrade-version-matrix]
@@ -37,7 +35,12 @@ The following table shows the recommended upgrade paths from older Elastic Cloud
3735
If you have to upgrade to any of the intermediate versions, follow the upgrade instructions of the relevant release before upgrading to 4.0.0:
3836
- [ECE 2.5 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/2.5/ece-upgrade.html)
3937
- [ECE 2.13 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/2.13/ece-upgrade.html)
40-
- [ECE 3.8 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/3.7/ece-upgrade.html)
38+
39+
:::{note}
40+
We don't recommend upgrading to 2.13.0, as it can cause issues and you may lose access to the admin console. We strongly recommend upgrading to 2.13.4.
41+
:::
42+
43+
- [ECE 3.8 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/3.8/ece-upgrade.html)
4144

4245
## The upgrade process [ece-upgrade-overview]
4346

@@ -79,8 +82,8 @@ Before starting the upgrade process, verify that your setup meets the following
7982
- **Proxies and load balancing**. To avoid any downtime for Elastic Cloud Enterprise, the installation must include more than one proxy and must use a load balancer as recommended. If only a single proxy is configured or if the installation is not using a load balancer, some downtime is expected when the containers on the proxies are upgraded. Each container upgrade typically takes five to ten seconds, times the number of containers on a typical host.
8083
- **For *offline* or *air-gapped* installations**. Additional steps are required to upgrade Elastic Cloud Enterprise. After downloading the installation script for the new version, pull and load the required container images and push them to a private Docker registry. To learn more about pulling and loading Docker images, check Install [ECE offline](../../../deploy-manage/deploy/cloud-enterprise/air-gapped-install.md).
8184
- Check the security cluster’s zone count. Due to internal limitations in ECE, the built-in security cluster cannot be scaled to two zones during the ECE upgrade procedure. If the zone count is set to 2 zones, scale the cluster to 3 or 1 zone(s) before upgrading ECE.
82-
- **[Verify if you can upgrade directly](#ece-upgrade-version-matrix)**. When upgrading to ECE 4.0 or a higher version:
83-
- You need to first upgrade to ECE 3.8.0 or later. Refer to the ECE version 3.8.0 upgrade instructions for details.
85+
- **[Verify if you can upgrade directly](#ece-upgrade-version-matrix)**. When upgrading to ECE 4.0 or a higher version:
86+
- You need to first upgrade to ECE 3.8.0 or later. Refer to the [ECE version 3.8.0 upgrade instructions](https://www.elastic.co/guide/en/cloud-enterprise/3.8/ece-upgrade.html) for details.
8487

8588
:::{warning}
8689
Don’t manually upgrade your system deployments if you are on ECE version 2.7.0 or a later version, as it can cause issues and you may lose access to the Cloud UI. Note that the only exception to that rule is when you’re upgrading to ECE 3.6.0 and your system deployments are at a version lower than 7.17.0.

0 commit comments

Comments
 (0)