Skip to content

Commit 1ab7c85

Browse files
authored
Merge branch 'main' into autoops-vs-stack-monitoring
2 parents 8141c35 + 7470ce5 commit 1ab7c85

File tree

46 files changed

+1242
-233
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1242
-233
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "Docs preview comment"
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, reopened, synchronize]
6+
7+
permissions:
8+
contents: read
9+
issues: write
10+
pull-requests: write
11+
12+
jobs:
13+
preview-links:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Comment preview links for changed docs
17+
uses: actions/github-script@v7
18+
with:
19+
github-token: ${{ secrets.GITHUB_TOKEN }}
20+
script: |
21+
const pr = context.payload.pull_request;
22+
const prNum = pr.number;
23+
const owner = context.repo.owner;
24+
const repo = context.repo.repo;
25+
const base = `https://docs-v3-preview.elastic.dev/${owner}/${repo}/pull/${prNum}`;
26+
27+
// 1) List all files in this PR
28+
const { data: files } = await github.rest.pulls.listFiles({
29+
owner, repo, pull_number: prNum
30+
});
31+
32+
// 2) Filter to only added/modified .md files (skip removed and _snippets/)
33+
const links = files
34+
.filter(f =>
35+
f.status !== 'removed' &&
36+
/\.md$/i.test(f.filename) &&
37+
!/(^|\/)_snippets\//i.test(f.filename)
38+
)
39+
.map(f => {
40+
let p = f.filename.replace(/\/index\.md$/i, '/');
41+
if (p === f.filename) p = p.replace(/\.md$/i, '');
42+
return `- [\`${f.filename}\`](${base}/${p})`;
43+
});
44+
45+
if (!links.length) return; // nothing to do
46+
47+
// 3) Build the comment body
48+
const body = [
49+
"🔍 **Preview links for changed docs:**",
50+
"",
51+
...links,
52+
"",
53+
"🔔 *The preview site may take up to **3 minutes** to finish building. These links will become live once it completes.*"
54+
].join("\n");
55+
56+
// 4) Post or update a single bot comment
57+
const { data: comments } = await github.rest.issues.listComments({
58+
owner, repo, issue_number: prNum
59+
});
60+
const existing = comments.find(c =>
61+
c.user.type === 'Bot' &&
62+
c.body.startsWith("🔍 **Preview links for changed docs:**")
63+
);
64+
65+
if (existing) {
66+
await github.rest.issues.updateComment({
67+
owner, repo,
68+
comment_id: existing.id,
69+
body
70+
});
71+
} else {
72+
await github.rest.issues.createComment({
73+
owner, repo,
74+
issue_number: prNum,
75+
body
76+
});
77+
}

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ products:
1212

1313
# Configure a RHEL host [ece-configure-hosts-rhel-centos]
1414

15-
16-
1715
The following instructions show you how to prepare your hosts on Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9.
1816

1917
* [Prerequisites](#ece-prerequisites-rhel8)
20-
* [Configure the host](#ece-configure-hosts-rhel8-podman)
21-
18+
* [Install Podman and configure the host](#ece-configure-hosts-rhel8-podman)
2219

2320
## Prerequisites [ece-prerequisites-rhel8]
2421

@@ -28,7 +25,11 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
2825

2926
**Example:** For AWS, allowing traffic between hosts is implemented using security groups.
3027

31-
## Configure the host [ece-configure-hosts-rhel8-podman]
28+
::::{important}
29+
Make sure to use a supported combination of Linux distribution and container engine version as defined in our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Unsupported combinations can lead to various issues in your ECE environment, including failures when creating system deployments, upgrading workload deployments, proxy timeouts, and more.
30+
::::
31+
32+
## Install Podman and configure the host [ece-configure-hosts-rhel8-podman]
3233

3334
1. Install the OS packages `lvm2`, `iptables`, `sysstat`, and `net-tools` by executing:
3435

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ products:
1212

1313
# Configure a SUSE host [ece-configure-hosts-sles12]
1414

15-
The following instructions show you how to prepare your hosts on SLES 12 SP5 or 15.
15+
The following instructions explain how to prepare your hosts on SUSE Linux Enterprise Server 12 SP5 (SLES 12) or 15 (SLES 15).
1616

1717
* [Install Docker](#ece-install-docker-sles12)
18-
* [Set up XFS on SLES](#ece-xfs-setup-sles12)
18+
* [Set up XFS quotas](#ece-xfs-setup-sles12)
1919
* [Update the configurations settings](#ece-update-config-sles)
2020
* [Configure the Docker daemon options](#ece-configure-docker-daemon-sles12)
2121

@@ -26,11 +26,10 @@ If you want to install {{ece}} (ECE) on your own hosts, the steps for preparing
2626

2727
Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with ECE.
2828

29-
30-
## Install Docker [ece-install-docker-sles12]
29+
## Install Docker on SLES [ece-install-docker-sles12]
3130

3231
::::{important}
33-
Make sure to use a combination of Linux distribution and Docker 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.
32+
Make sure to use a supported combination of Linux distribution and container engine version as defined in our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Unsupported combinations can lead to various issues in your ECE environment, including failures when creating system deployments, upgrading workload deployments, proxy timeouts, and more.
3433
::::
3534

3635

@@ -87,7 +86,7 @@ Make sure to use a combination of Linux distribution and Docker version that is
8786

8887

8988

90-
## Set up XFS on SLES [ece-xfs-setup-sles12]
89+
## Set up XFS quotas [ece-xfs-setup-sles12]
9190

9291
XFS is required to support disk space quotas for {{es}} data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On SLES 12 and 15, you need to set up an XFS file system and have quotas enabled.
9392

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

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,20 @@ products:
1212

1313
# Configure an Ubuntu host [ece-configure-hosts-ubuntu]
1414

15-
The following instructions show you how to prepare your hosts on 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish).
15+
The following instructions show you how to prepare your hosts on Ubuntu.
1616

17-
* [Install Docker 24.0](#ece-install-docker-ubuntu)
17+
* [Install Docker](#ece-install-docker-ubuntu)
1818
* [Set up XFS quotas](#ece-xfs-setup-ubuntu)
1919
* [Update the configurations settings](#ece-update-config-ubuntu)
2020
* [Configure the Docker daemon options](#ece-configure-docker-daemon-ubuntu)
2121

2222

23-
## Install Docker [ece-install-docker-ubuntu]
23+
## Install Docker on Ubuntu [ece-install-docker-ubuntu]
2424

25-
Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04.
25+
Install a compatible Docker version on Ubuntu.
2626

2727
::::{important}
28-
Make sure to use a combination of Linux distribution and Docker 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.
29-
::::
30-
31-
32-
::::{note}
33-
Docker 25 and higher are not compatible with ECE 3.7.
28+
Make sure to use a supported combination of Linux distribution and container engine version as defined in our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Unsupported combinations can lead to various issues in your ECE environment, including failures when creating system deployments, upgrading workload deployments, proxy timeouts, and more.
3429
::::
3530

3631

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

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

6055
```sh
61-
sudo apt install -y docker-ce=5:24.0.* docker-ce-cli=5:24.0.* containerd.io
56+
sudo apt install -y docker-ce=5:27.0.* docker-ce-cli=5:27.0.* containerd.io
6257
```
6358

6459

deploy-manage/deploy/cloud-enterprise/configure-operating-system.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ products:
1313

1414
Before installing {{ece}}, you have to prepare your hosts with one of the following Linux distributions:
1515

16-
* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu.md)
17-
* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel.md)
18-
* [Rocky Linux 8 and 9](configure-host-rhel.md)
19-
* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse.md)
16+
* [Ubuntu](configure-host-ubuntu.md)
17+
* [Red Hat Enterprise Linux (RHEL) and Rocky Linux](configure-host-rhel.md)
18+
* [SUSE Linux Enterprise Server (SLES)](configure-host-suse.md)
19+
20+
::::{important}
21+
Make sure to use a supported combination of Linux distribution and container engine version, such as `Docker` or `Podman`, as defined in our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Unsupported combinations can lead to various issues in your ECE environment, including failures when creating system deployments, upgrading workload deployments, proxy timeouts, and more.
22+
::::

deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Note that since version 2.7.0, system deployments are automatically upgraded whe
1616

1717
| {{ece}} version | Admin cluster | Logging & Metrics cluster | Security cluster |
1818
| --- | --- | --- | --- |
19+
| 4.0.1 | 8.18.0 | 8.18.0 | 8.18.0 |
1920
| 4.0.0 | 8.18.0 | 8.18.0 | 8.18.0 |
21+
| 3.8.1 | 8.17.4 | 8.17.4 | 8.17.4 |
2022
| 3.8.0 | 8.17.4 | 8.17.4 | 8.17.4 |
2123
| 3.7.3 | 7.17.24 | 7.17.24 | 8.15.2 |
2224
| 3.7.2 | 7.17.22 | 7.17.22 | 8.13.4 |

deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Versions of the {{stack}}, containing {{es}}, {{kib}}, and other products, are a
1414

1515
The first table contains the stack versions that shipped with the 4.0 version of {{ece}}. You can also check the [most recent stack packs and Docker images](#ece-recent-download-list), which might have released after the 4.0 version of ECE, as well as the [full list of available stack packs and Docker images](#ece-full-download-list).
1616

17-
| Docker images included with {{ece}} 4.0.0 |
17+
| Docker images included with {{ece}} 4.0.1 |
1818
| --- |
19-
| docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.0 |
19+
| docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1 |
2020
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 |
2121
| docker.elastic.co/cloud-release/kibana-cloud:8.18.0 |
2222
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 |

deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To perform an offline installation without a private Docker registry, you have t
1616
1. On an internet-connected host that has Docker installed, download the [Available Docker Images](ece-install-offline-images.md). Note that for ECE version 4.0, if you want to use {{stack}} version 9.0 in your deployments, you need to download and make available both the version 8.x and version 9.x Docker images (the version 8.x images are required for system deployments).
1717

1818
```sh
19-
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.0
19+
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1
2020
docker pull docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
2121
docker pull docker.elastic.co/cloud-release/kibana-cloud:8.18.0
2222
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -26,15 +26,15 @@ To perform an offline installation without a private Docker registry, you have t
2626
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0
2727
```
2828

29-
For example, for {{ece}} 4.0.0 and the {{stack}} versions it shipped with, you need:
29+
For example, for {{ece}} 4.0.1 and the {{stack}} versions it shipped with, you need:
3030

31-
* {{ece}} 4.0.0
31+
* {{ece}} 4.0.1
3232
* {{es}} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
3333

3434
2. Create .tar files of the images:
3535

3636
```sh
37-
docker save -o ece.4.0.0.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.0
37+
docker save -o ece.4.0.1.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1
3838
docker save -o es.8.18.0.tar docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
3939
docker save -o kibana.8.18.0.tar docker.elastic.co/cloud-release/kibana-cloud:8.18.0
4040
docker save -o apm.8.18.0.tar docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -48,7 +48,7 @@ To perform an offline installation without a private Docker registry, you have t
4848
4. On each host, load the images into Docker, replacing `FILE_PATH` with the correct path to the .tar files:
4949

5050
```sh
51-
docker load < FILE_PATH/ece.4.0.0.tar
51+
docker load < FILE_PATH/ece.4.0.1.tar
5252
docker load < FILE_PATH/es.8.18.0.tar
5353
docker load < FILE_PATH/kibana.8.18.0.tar
5454
docker load < FILE_PATH/apm.8.18.0.tar

deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
2222
2. On an internet-connected host that has Docker installed, download the [Available Docker Images](ece-install-offline-images.md) and push them to your private Docker registry. Note that for ECE version 4.0, if you want to use {{stack}} version 9.0 in your deployments, you need to download and make available both the version 8.x and version 9.x Docker images.
2323

2424
```sh
25-
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.0
25+
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1
2626
docker pull docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
2727
docker pull docker.elastic.co/cloud-release/kibana-cloud:8.18.0
2828
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -32,9 +32,9 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
3232
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0
3333
```
3434

35-
For example, for {{ece}} 4.0.0 and the {{stack}} versions it shipped with, you need:
35+
For example, for {{ece}} 4.0.1 and the {{stack}} versions it shipped with, you need:
3636

37-
* {{ece}} 4.0.0
37+
* {{ece}} 4.0.1
3838
* {{es}} 9.0.0, {{kib}} 9.0.0, APM 9.0.0
3939

4040
:::{important}
@@ -44,7 +44,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
4444
3. Tag the Docker images with your private registry URL by replacing `REGISTRY` with your actual registry address, for example `my.private.repo:5000`:
4545

4646
```sh
47-
docker tag docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.0 REGISTRY/cloud-enterprise/elastic-cloud-enterprise:4.0.0
47+
docker tag docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:4.0.1 REGISTRY/cloud-enterprise/elastic-cloud-enterprise:4.0.1
4848
docker tag docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 REGISTRY/cloud-release/elasticsearch-cloud-ess:8.18.0
4949
docker tag docker.elastic.co/cloud-release/kibana-cloud:8.18.0 REGISTRY/cloud-release/kibana-cloud:8.18.0
5050
docker tag docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 REGISTRY/cloud-release/elastic-agent-cloud:8.18.0
@@ -57,7 +57,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
5757
4. Push the Docker images to your private Docker registry, using the same tags from the previous step. Replace `REGISTRY` with your actual registry URL, for example `my.private.repo:5000`:
5858

5959
```sh
60-
docker push REGISTRY/cloud-enterprise/elastic-cloud-enterprise:4.0.0
60+
docker push REGISTRY/cloud-enterprise/elastic-cloud-enterprise:4.0.1
6161
docker push REGISTRY/cloud-release/elasticsearch-cloud-ess:8.18.0
6262
docker push REGISTRY/cloud-release/kibana-cloud:8.18.0
6363
docker push REGISTRY/cloud-release/elastic-agent-cloud:8.18.0

deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,26 @@ ECE does not support hot-adding of resources to a running node. When increasing
3131
::::
3232

3333

34-
To adjust the allocator capacity, prior to ECE 3.5.0; it is necessary to reinstall ECE on the host with a new value assigned to the `--capacity` parameter. From ECE 3.5.0 onwards, just use the ECE API :
34+
To adjust the allocator capacity prior to ECE 3.5.0, you must reinstall ECE on the host with a new value assigned to the `--capacity` parameter. Starting with ECE 3.5.0, you can update the allocator capacity using the [allocator settings ECE API](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-allocator-settings). After making this change, you must restart the allocator service for it to take effect.
3535

3636
```sh
3737
curl -X PUT \
3838
http(s)://<ece_admin_url:port>/api/v1/platform/infrastructure/allocators/<allocator_id>/settings \
39-
-H “Authorization: ApiKey $ECE_API_KEY” \
39+
-H “Authorization: ApiKey $ECE_API_KEY\ <1>
4040
-H 'Content-Type: application/json' \
4141
-d '{"capacity":<Capacity_Value_in_MB>}'
4242
```
43-
44-
For more information on how to use API keys for authentication, check the section [Access the API from the Command Line](cloud://reference/cloud-enterprise/ece-api-command-line.md).
43+
1. For information on how to use API keys for authentication, refer to [Access the API from the command line](cloud://reference/cloud-enterprise/ece-api-command-line.md).
4544

4645
::::{important}
47-
Prior to ECE 3.5.0, regardless of the use of this API, the [CPU quota](#ece-alloc-cpu) used the memory specified at installation time.
46+
When running ECE on Podman, CPU quotas for existing instances cannot be disabled or updated. As a result, changing an allocator’s capacity won’t affect the CPU quotas of already running containers.
4847
::::
4948

49+
After applying the change, log in to the allocator host you updated and restart the allocator service:
5050

51+
```sh
52+
docker restart frc-allocators-allocator
53+
```
5154

5255
### Examples [ece_examples]
5356

@@ -67,6 +70,9 @@ ECE uses CPU quotas to assign shares of the allocator host to the instances that
6770

6871
`CPU quota = DeploymentRAM / HostCapacity`
6972

73+
::::{important}
74+
In ECE versions prior to 3.5.0, the CPU quota is always calculated using the memory specified at installation time, even if you later update the host capacity using the API.
75+
::::
7076

7177
### Examples [ece_examples_2]
7278

0 commit comments

Comments
 (0)