[ECE] Clarify supported Ubuntu version #1621

kunisen · 2025-06-05T10:26:36Z

(This is the 2nd try of previously wrongly raised PR - #1620)

Description

Previously we specify Ubuntu (Operating system / OS) version directly like 20.04 or 22.04.
However, we later also 24.04, and maybe in the future we will have even more versions.

All the compatible and supported version could be found in our support matrix - https://www.elastic.co/support/matrix#elastic-cloud-enterprise.

But writing the version directly to public doc page other than support matrix seems to be easily forgotten to update, and thus we are left behind in public doc page that it does not mention 24.04 now.
=> This causes confusion on users, because it's telling different in between public ECE docs and support matrix.

This was brought up by @rheppe in an internal discussion here.

The rationale is that support matrix is the source of truth, per what we have confirmed with @Kushmaro. So we would like to update the public docs based on support matrix.

Additional Notes

We removed note Docker 25 and higher are not compatible with ECE 3.7. because the current branch of docs is for ECE 4.0, and we can see from support matrix, it's supported.
We also explicitly mentioned that, the command mentioned in sudo apt install -y docker-ce=5:24.0.* docker-ce-cli=5:24.0.* containerd.io is just an example of install Docker 24.0 on Ubuntu. We added this because per support matrix, ECE 4.0 also supports other docker versions, and we can see from the screenshots below, it's hard to make an exclusive list in the public doc page, thus it makes more logical sense to say "it's a command example".

Before / After PR merge

Before

After

No 20.04 or 22.04 version number present

eedugon · 2025-06-05T13:26:35Z

@kunisen : thanks for proposing this. I'm totally ok with the new approach.

But taking a look at the Support Matrix for ECE 4.0.0 it looks we don't even support Docker 24.0 anymore, so better to add in the example Docker 26 or 27, which are actually supported for ECE 4.0.0 in Ubuntu 20 / 22 and 24.

Also, the title of this PR talks about main Ubuntu versions, but the changes are about being Docker versioning agnostic and telling users to go to the support matrix, which is perfect to me.

Regarding Ubuntu Version, shouldn't we update the parent doc (/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md) also which links this doc as the doc for Ubuntu 20 & 22? We should say it's valid for Ubuntu 24 also or just mention Ubuntu in a generic way.

eedugon

Some comments added.

deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

eedugon · 2025-06-05T13:27:53Z

deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

@@ -55,7 +50,7 @@ Docker 25 and higher are not compatible with ECE 3.7.
      $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
    ```

-4. Install the correct version of the `docker-ce` package, for Ubuntu 20.04 LTS (Focal Fossa) or Ubuntu 22.04 LTS (Jammy Jellyfish):
+4. Install the correct version of the `docker-ce` package. Following is an example of installing Docker 24.0. If you decide to install a different Docker version, make sure to replace with the desired version in the commands below.


I wouldn't suggest in the example to install Docker 24, as it's not supported for ECE 4.0.0.
I'd suggest Docker 26 or 27 based on the support matrix.

eedugon · 2025-06-05T13:28:32Z

deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

@@ -55,7 +50,7 @@ Docker 25 and higher are not compatible with ECE 3.7.
      $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
    ```

-4. Install the correct version of the `docker-ce` package, for Ubuntu 20.04 LTS (Focal Fossa) or Ubuntu 22.04 LTS (Jammy Jellyfish):
+4. Install the correct version of the `docker-ce` package. Following is an example of installing Docker 24.0. If you decide to install a different Docker version, make sure to replace with the desired version in the commands below.

    ```sh
    sudo apt install -y docker-ce=5:24.0.* docker-ce-cli=5:24.0.* containerd.io


Same as before, better to leave a supported example (like Docker 26 or 27).

eedugon · 2025-06-05T19:18:44Z

Sorry for closing and reopening! Completely by mistake 🤦‍♂️

Co-authored-by: Edu González de la Herrán <[email protected]>

#1621 (comment)

kunisen · 2025-06-06T06:29:23Z

Thanks @eedugon You are absolutely right!

[1]

I changed this page too to make all OS version agnostic.
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1621/deploy-manage/deploy/cloud-enterprise/configure-operating-system

I also combined RHEL and Rocky Linux section because they are referring to the same link.

[2]

I made a quick test in my lab

# check docker-ce and docker-ce-cli versions
root@sl-kuniyasusen-e1e1432f-host1:~# apt-cache madison docker-ce docker-ce-cli | grep 27.0
 docker-ce | 5:27.0.3-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages
 docker-ce | 5:27.0.2-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages
 docker-ce | 5:27.0.1-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages
docker-ce-cli | 5:27.0.3-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages
docker-ce-cli | 5:27.0.2-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages
docker-ce-cli | 5:27.0.1-1~ubuntu.22.04~jammy | https://download.docker.com/linux/ubuntu jammy/stable amd64 Packages

# install docker-ce and docker-ce-cli version 27.0
root@sl-kuniyasusen-e1e1432f-host1:~# sudo apt install -y docker-ce=5:27.0.* docker-ce-cli=5:27.0.* containerd.io
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Selected version '5:27.0.3-1~ubuntu.22.04~jammy' (Docker CE:jammy [amd64]) for 'docker-ce'
Selected version '5:27.0.3-1~ubuntu.22.04~jammy' (Docker CE:jammy [amd64]) for 'docker-ce-cli'
Suggested packages:
  aufs-tools cgroupfs-mount | cgroup-lite
The following held packages will be changed:
  containerd.io docker-ce docker-ce-cli
The following packages will be upgraded:
  containerd.io docker-ce docker-ce-cli
3 upgraded, 0 newly installed, 0 to remove and 84 not upgraded.
E: Held packages were changed and -y was used without --allow-change-held-packages.

So the same command sudo apt install -y docker-ce=5:27.0.* docker-ce-cli=5:27.0.* containerd.io but only with version replacement could be used to install docker v27.

The final line E: Held packages were changed and -y was used without --allow-change-held-packages. was I did pin / hold the docker version, so it's fine to see this and if a new install, we shouldn't see this one, so I believe we should be all good.
https://www.elastic.co/docs/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu

eedugon · 2025-06-06T11:05:17Z

@kunisen , let me be a bit picky now, as I think we are doing a great progress... shouldn't we add the important banner also in the RHEL / Rocky Linux doc? Considering that the other 2 docs have the banner highly visible I'd do the same.

I mean this one:

Of course for RHEL we should mention Podman instead of Docker in the text.

Also the banner (or something similar) could also be added to the parent page (the one you have recently updated: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1621/deploy-manage/deploy/cloud-enterprise/configure-operating-system).

Maybe not as an important admonition but linking to the support matrix to ensure the user chooses properly a fully supported version of OS and CRI (Docker or Podman).

#1621 (comment)

kunisen · 2025-06-07T05:20:13Z

Sure @eedugon added per the request and here we go :)

I used Container Engine instead of Docker so that it could cover both Docker and Podman

::::{important}
Make sure to use a combination of Linux distribution and Container Engine version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more.
::::

kunisen · 2025-06-07T05:21:29Z

Maybe not as an important admonition but linking to the support matrix to ensure the user chooses properly a fully supported version of OS and CRI (Docker or Podman).

Could you help update this please?
I probably didn't get this correctly.
Thanks! 🙏

eedugon

LGTM, I think we are ready.

eedugon · 2025-06-05T13:32:22Z

deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

@@ -22,18 +22,13 @@ The following instructions show you how to prepare your hosts on 20.04 LTS (Foca

 ## Install Docker [ece-install-docker-ubuntu]

-Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04.
+Install the compatible Docker version on Ubuntu.


Suggested change

Install the compatible Docker version on Ubuntu.

Install a compatible Docker version on Ubuntu.

github-actions · 2025-06-12T00:20:38Z

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

Update configure-host-ubuntu.md

6a11c3f

kunisen self-assigned this Jun 5, 2025

kunisen requested a review from a team as a code owner June 5, 2025 10:26

kunisen added documentation Improvements or additions to documentation supportability ability enable self-service or support of product ece Elastic Cloud Enterprise labels Jun 5, 2025

kunisen requested review from Kushmaro and rheppe June 5, 2025 10:27

eedugon reviewed Jun 5, 2025

View reviewed changes

eedugon closed this Jun 5, 2025

eedugon reopened this Jun 5, 2025

elastic deleted a comment from rheppe Jun 5, 2025

kunisen and others added 4 commits June 6, 2025 15:05

Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

6be52e5

Co-authored-by: Edu González de la Herrán <[email protected]>

Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md

982968c

Co-authored-by: Edu González de la Herrán <[email protected]>

Make it more version agnostic

a1c5ca3

#1621 (comment)

Update configure-operating-system.md

9a63e6d

eedugon mentioned this pull request Jun 6, 2025

[ECE] Configure operating system instructions for Ubuntu with ECE 4.0 #1630

Open

add note to RHEL about using compatible container engine

6f4559e

#1621 (comment)

final refinements

81d928e

eedugon approved these changes Jun 11, 2025

View reviewed changes

eedugon and others added 2 commits June 11, 2025 11:26

Merge branch 'main' into kunisen-docpr-ece-slack-20250605-2

5287941

Merge branch 'main' into kunisen-docpr-ece-slack-20250605-2

9c82312

kunisen enabled auto-merge (squash) June 12, 2025 00:20

kunisen merged commit fa92859 into main Jun 12, 2025
6 of 7 checks passed

kunisen deleted the kunisen-docpr-ece-slack-20250605-2 branch June 12, 2025 00:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[ECE] Clarify supported Ubuntu version #1621

[ECE] Clarify supported Ubuntu version #1621

Uh oh!

kunisen commented Jun 5, 2025

Uh oh!

eedugon commented Jun 5, 2025 •

edited

Loading

Uh oh!

eedugon left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

eedugon Jun 5, 2025

Uh oh!

eedugon Jun 5, 2025

Uh oh!

eedugon commented Jun 5, 2025

Uh oh!

kunisen commented Jun 6, 2025

Uh oh!

eedugon commented Jun 6, 2025

Uh oh!

kunisen commented Jun 7, 2025

Uh oh!

kunisen commented Jun 7, 2025

Uh oh!

eedugon left a comment

Uh oh!

eedugon Jun 5, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

	Install the compatible Docker version on Ubuntu.
	Install a compatible Docker version on Ubuntu.

[ECE] Clarify supported Ubuntu version #1621

[ECE] Clarify supported Ubuntu version #1621

Uh oh!

Conversation

kunisen commented Jun 5, 2025

Description

Additional Notes

Before / After PR merge

Before

After

Uh oh!

eedugon commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eedugon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

eedugon Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

eedugon Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

eedugon commented Jun 5, 2025

Uh oh!

kunisen commented Jun 6, 2025

[1]

[2]

Uh oh!

eedugon commented Jun 6, 2025

Uh oh!

kunisen commented Jun 7, 2025

Uh oh!

kunisen commented Jun 7, 2025

Uh oh!

eedugon left a comment

Choose a reason for hiding this comment

Uh oh!

eedugon Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

eedugon commented Jun 5, 2025 •

edited

Loading

eedugon left a comment •

edited

Loading