Skip to content

Commit 60b71ef

Browse files
authored
Merge branch 'main' into observability-landing-page
2 parents 9802ceb + 6dc4561 commit 60b71ef

File tree

64 files changed

+670
-345
lines changed

Some content is hidden

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

64 files changed

+670
-345
lines changed
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Comment on removed .md files
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened]
6+
7+
jobs:
8+
detect-removed-markdown:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
pull-requests: write
12+
13+
steps:
14+
- uses: actions/github-script@v7
15+
with:
16+
github-token: ${{ secrets.GITHUB_TOKEN }}
17+
script: |
18+
const prNumber = context.payload.pull_request.number;
19+
20+
// Get all files in the PR
21+
const { data: files } = await github.rest.pulls.listFiles({
22+
owner: context.repo.owner,
23+
repo: context.repo.repo,
24+
pull_number: prNumber
25+
});
26+
27+
// Filter for removed .md files
28+
const removedMd = files
29+
.filter(f => f.status === 'removed' && f.filename.endsWith('.md'))
30+
.map(f => `- \`${f.filename}\``);
31+
32+
// Filter for renamed .md files
33+
const renamedMd = files
34+
.filter(f => f.status === 'renamed' && f.filename.endsWith('.md'))
35+
.map(f => `- \`${f.previous_filename}\` → \`${f.filename}\``);
36+
37+
// Create a comment if there are any removed or renamed files
38+
if (removedMd.length > 0 || renamedMd.length > 0) {
39+
// Build sections based on what changes were detected
40+
const sections = [];
41+
42+
// Add removed files section if there are any
43+
if (removedMd.length > 0) {
44+
sections.push(
45+
removedMd.length === 1
46+
? "The following Markdown file was **removed** in this PR:"
47+
: `The following ${removedMd.length} Markdown files were **removed** in this PR:`,
48+
...removedMd,
49+
""
50+
);
51+
}
52+
53+
// Add renamed files section if there are any
54+
if (renamedMd.length > 0) {
55+
sections.push(
56+
renamedMd.length === 1
57+
? "The following Markdown file was **renamed** in this PR:"
58+
: `The following ${renamedMd.length} Markdown files were **renamed** in this PR:`,
59+
...renamedMd,
60+
""
61+
);
62+
}
63+
64+
// Prepare comment body
65+
const body = [
66+
"## :warning: Markdown file changes detected",
67+
"",
68+
...sections,
69+
"### Action Required",
70+
"",
71+
"We currently do not have an easy way to implement redirects for removed or renamed files. If possible, please:",
72+
"",
73+
"- Keep files whenever possible and hide them from the TOC by using [`hidden`](https://elastic.github.io/docs-builder/configure/content-set/navigation/#hidden-files)",
74+
"- Add a notice at the top of the file indicating that the page has moved with a link to the new location",
75+
"- Ensure you've updated `redirects.yml` accordingly if files must be removed or renamed",
76+
"",
77+
"Thank you!"
78+
].join("\n");
79+
80+
// Post the comment on the PR
81+
await github.rest.issues.createComment({
82+
owner: context.repo.owner,
83+
repo: context.repo.repo,
84+
issue_number: prNumber,
85+
body
86+
});
87+
88+
console.log("Comment added about renamed or removed Markdown files");
89+
} else {
90+
console.log("No Markdown files were removed in this PR");
91+
}

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

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ Enterprise Search is not available in versions 9.0+.
3636

3737
| Required downloads | Minimum required ECE version |
3838
| --- | --- |
39-
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |
40-
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:9.0.0 | ECE 4.0.0 |
41-
| docker.elastic.co/cloud-release/kibana-cloud:9.0.0 | ECE 4.0.0 |
42-
| docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0 | ECE 4.0.0 |
39+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 9.0.1](https://download.elastic.co/cloud-enterprise/versions/9.0.1.zip) | ECE 4.0.0 |
40+
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:9.0.1 | ECE 4.0.0 |
41+
| docker.elastic.co/cloud-release/kibana-cloud:9.0.1 | ECE 4.0.0 |
42+
| docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.1 | ECE 4.0.0 |
4343
| | |
44-
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.0](https://download.elastic.co/cloud-enterprise/versions/8.18.0.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
45-
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
46-
| docker.elastic.co/cloud-release/kibana-cloud:8.18.0 | ECE 3.0.0 |
47-
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 | ECE 3.0.0 |
48-
| docker.elastic.co/cloud-release/enterprise-search-cloud:8.18.0 | ECE 3.0.0 |
44+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.1](https://download.elastic.co/cloud-enterprise/versions/8.18.1.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
45+
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.1 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
46+
| docker.elastic.co/cloud-release/kibana-cloud:8.18.1 | ECE 3.0.0 |
47+
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.1 | ECE 3.0.0 |
48+
| docker.elastic.co/cloud-release/enterprise-search-cloud:8.18.1 | ECE 3.0.0 |
4949
| | |
5050
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 7.17.27](https://download.elastic.co/cloud-enterprise/versions/7.17.27.zip) | ECE 2.2.2 |
5151
| docker.elastic.co/cloud-assets/elasticsearch:7.17.27-0 | ECE 2.2.2 |
@@ -65,17 +65,34 @@ Enterprise Search is not available in versions 9.0+.
6565
::::{dropdown} Expand to view the full list
6666
| Required downloads | Minimum required ECE version |
6767
| --- | --- |
68+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 9.0.1](https://download.elastic.co/cloud-enterprise/versions/9.0.1.zip) | ECE 4.0.0 |
69+
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:9.0.1 | ECE 4.0.0 |
70+
| docker.elastic.co/cloud-release/kibana-cloud:9.0.1 | ECE 4.0.0 |
71+
| docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.1 | ECE 4.0.0 |
72+
| | |
6873
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |
6974
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:9.0.0 | ECE 4.0.0 |
7075
| docker.elastic.co/cloud-release/kibana-cloud:9.0.0 | ECE 4.0.0 |
7176
| docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0 | ECE 4.0.0 |
7277
| | |
78+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.1](https://download.elastic.co/cloud-enterprise/versions/8.18.1.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
79+
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.1 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
80+
| docker.elastic.co/cloud-release/kibana-cloud:8.18.1 | ECE 3.0.0 |
81+
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.1 | ECE 3.0.0 |
82+
| docker.elastic.co/cloud-release/enterprise-search-cloud:8.18.1 | ECE 3.0.0 |
83+
| | |
7384
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.0](https://download.elastic.co/cloud-enterprise/versions/8.18.0.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
7485
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
7586
| docker.elastic.co/cloud-release/kibana-cloud:8.18.0 | ECE 3.0.0 |
7687
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 | ECE 3.0.0 |
7788
| docker.elastic.co/cloud-release/enterprise-search-cloud:8.18.0 | ECE 3.0.0 |
7889
| | |
90+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.6](https://download.elastic.co/cloud-enterprise/versions/8.17.6.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
91+
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.17.6 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
92+
| docker.elastic.co/cloud-release/kibana-cloud:8.17.6 | ECE 3.0.0 |
93+
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.17.6 | ECE 3.0.0 |
94+
| docker.elastic.co/cloud-release/enterprise-search-cloud:8.17.6 | ECE 3.0.0 |
95+
| | |
7996
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.5](https://download.elastic.co/cloud-enterprise/versions/8.17.5.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
8097
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.17.5 | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
8198
| docker.elastic.co/cloud-release/kibana-cloud:8.17.5 | ECE 3.0.0 |

deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ New or updated versions of the {{stack}} must be prepared to work with {{ece}} a
2929
Enterprise Search is not available in versions 9.0+.
3030
:::
3131

32-
The following are the most recently released {{stack}} packs for version 8.x, 7.x, and 6.x, respectively:
32+
The following are the most recently released {{stack}} packs for version 9.x, 8.x, 7.x, and 6.x, respectively:
3333

3434
$$$ece-elastic-stack-stackpacks-recent$$$
3535

36-
| Required downloads | Minimum required ECE version |
36+
| Stack pack download link | Minimum required ECE version |
3737
| --- | --- |
38-
| [{{es}}, {{kib}}, and APM stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |
39-
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.0](https://download.elastic.co/cloud-enterprise/versions/8.18.0.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
38+
| [{{es}}, {{kib}}, and APM stack pack: 9.0.1](https://download.elastic.co/cloud-enterprise/versions/9.0.1.zip) | ECE 4.0.0 |
39+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.1](https://download.elastic.co/cloud-enterprise/versions/8.18.1.zip) | ECE 3.0.0<br>(+ Docker 20.10.10+ required for 8.16+) |
4040
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 7.17.27](https://download.elastic.co/cloud-enterprise/versions/7.17.27.zip) | ECE 2.2.2 |
4141
| [{{es}}, {{kib}}, and APM stack pack: 6.8.23](https://download.elastic.co/cloud-enterprise/versions/6.8.23.zip) | ECE 1.1.4 |
4242

@@ -46,10 +46,13 @@ $$$ece-elastic-stack-stackpacks-recent$$$
4646
Following is the full list of available packs containing {{stack}} versions. Note that Enterprise Search was introduced with ECE 2.6.0 and requires that version or higher.
4747

4848
::::{dropdown} Expand to view the full list
49-
| Required downloads | Minimum required ECE version |
49+
| Stack pack download link | Minimum required ECE version |
5050
| --- | --- |
51+
| [{{es}}, {{kib}}, and APM stack pack: 9.0.1](https://download.elastic.co/cloud-enterprise/versions/9.0.1.zip) | ECE 4.0.0 |
5152
| [{{es}}, {{kib}}, and APM stack pack: 9.0.0](https://download.elastic.co/cloud-enterprise/versions/9.0.0.zip) | ECE 4.0.0 |
53+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.1](https://download.elastic.co/cloud-enterprise/versions/8.18.1.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
5254
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.18.0](https://download.elastic.co/cloud-enterprise/versions/8.18.0.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
55+
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.6](https://download.elastic.co/cloud-enterprise/versions/8.17.6.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
5356
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.5](https://download.elastic.co/cloud-enterprise/versions/8.17.5.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
5457
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.4](https://download.elastic.co/cloud-enterprise/versions/8.17.4.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |
5558
| [{{es}}, {{kib}}, APM, and Enterprise Search stack pack: 8.17.3](https://download.elastic.co/cloud-enterprise/versions/8.17.3.zip) | ECE 3.0.0<br>(+ docker 20.10.10+ required for 8.16+) |

deploy-manage/deploy/self-managed/_snippets/config-file-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The configuration format is [YAML](https://yaml.org/). Here is an example of changing the path of the data and logs directories in {{es}}:
1+
The `elasticsearch.yml` configuration format is [YAML](https://yaml.org/). Here is an example of changing the path of the data and logs directories in {{es}}:
22

33
```yaml
44
path:

deploy-manage/deploy/self-managed/_snippets/env-var-setting-subs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Environment variables referenced with the `${...}` notation within the configuration file will be replaced with the value of the environment variable. For example:
1+
Environment variables referenced with the `${...}` notation within the `elasticsearch.yml` configuration file will be replaced with the value of the environment variable. For example:
22

33
```yaml
44
node.name: ${HOSTNAME}

deploy-manage/deploy/self-managed/configure-elasticsearch.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ For a list of settings that must be configured before using your cluster in prod
3232
{{es}} has three configuration files:
3333

3434
* `elasticsearch.yml` for configuring {{es}}
35-
* `jvm.options` for configuring {{es}} JVM settings
36-
* `log4j2.properties` for configuring {{es}} logging
35+
* `jvm.options` for configuring {{es}} [JVM settings](elasticsearch://reference/elasticsearch/jvm-settings.md)
36+
* `log4j2.properties` for configuring [{{es}} logging](/deploy-manage/monitor/logging-configuration/elasticsearch-log4j-configuration-self-managed.md)
3737

3838
These files are located in the config directory, whose default location depends on whether the installation is from an archive distribution (`tar.gz` or `zip`) or a package distribution (Debian or RPM packages).
3939

@@ -92,4 +92,4 @@ Refer to the following documentation to learn how to perform key configuration t
9292
* [](/deploy-manage/manage-connectors.md): Manage connection information between Elastic and third-party systems.
9393
* [](/deploy-manage/remote-clusters.md): Enable communication between {{es}} clusters to support [cross-cluster replication](/deploy-manage/tools/cross-cluster-replication.md) and [cross-cluster search](/solutions/search/cross-cluster-search.md).
9494
* [](/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes.md): Learn how to add or remove nodes to change the size and capacity of your cluster.
95-
* [](/deploy-manage/production-guidance.md): Review tips and guidance that you can use to design a production environment that matches your workloads, policies, and deployment needs.
95+
* [](/deploy-manage/production-guidance.md): Review tips and guidance that you can use to design a production environment that matches your workloads, policies, and deployment needs.

deploy-manage/deploy/self-managed/installing-elasticsearch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Before you start, make sure that you [configure your system](/deploy-manage/depl
6565

6666
### {{es}} container images [elasticsearch-docker-images]
6767

68-
You can also run {{es}} inside a docket container image. Docker container images may be downloaded from the Elastic Docker Registry.
68+
You can also run {{es}} inside a docker container image. Docker container images may be downloaded from the Elastic Docker Registry.
6969

7070
You can [use Docker Compose](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md) to deploy multiple nodes at once.
7171

@@ -112,4 +112,4 @@ Don’t use third-party Java agents that attach to the JVM. These agents can red
112112
## Third-party dependencies [dependencies-versions]
113113

114114
:::{include} /deploy-manage/deploy/self-managed/_snippets/third-party-dependencies.md
115-
:::
115+
:::

deploy-manage/maintenance/start-stop-services/restart-an-ece-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ To restart a running or a stopped deployment:
1515

1616
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
1717

18-
3. In the **Deployment Management** section, select **Restart** and follow the steps to restart a deployment.
18+
3. In the **Actions** menu, select **Restart {{es}}** and follow the steps to restart a deployment.
1919

2020
You can also edit the configuration of the deployment before restarting it.

deploy-manage/monitor/stack-monitoring/eck-stack-monitoring.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ If Logs stack monitoring is configured for a Beat, and custom container argument
116116

117117
## Connect to an external monitoring {{es}} cluster [k8s_connect_to_an_external_monitoring_elasticsearch_cluster]
118118

119-
If you want to connect to a monitoring {{es}} cluster not managed by ECK, you can reference a Secret instead of an {{es}} cluster in the `monitoring` section through the `secretName` attribute:
119+
If you want to connect to a monitoring {{es}} cluster not managed by ECK, you can reference a Secret instead of an {{es}} cluster in the `monitoring` section through the `secretName` attribute.
120+
121+
The next example sends cluster metrics to a remote monitoring cluster not managed by ECK, whereas cluster logs are sent to a remote cluster handled by ECK:
120122

121123
```yaml
122124
apiVersion: elasticsearch.k8s.elastic.co/v1
@@ -143,7 +145,7 @@ spec:
143145
```
144146

145147
1. The `secretName` and `name` attributes are mutually exclusive, you have to choose one or the other.
146-
2. The `namespace` and `serviceName` attributes can only be used in conjunction with `name`, not with `secretName`.
148+
2. The `namespace` and `serviceName` attributes can only be used in conjunction with `name`, not with `secretName`, and only to reference clusters managed by the same ECK instance.
147149

148150
The referenced Secret must contain the following connection information:
149151

@@ -193,4 +195,4 @@ spec:
193195
- name: filebeat
194196
env:
195197
- foo: bar
196-
```
198+
```

deploy-manage/uninstall/delete-a-cloud-deployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ To delete an {{ece}} deployment:
5959

6060
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
6161

62-
3. Terminate the deployment.
63-
4. Select **Delete deployment** and follow the steps to delete the deployment permanently.
62+
3. From the **Actions** menu, [terminate the deployment](#terminate-a-deployment).
63+
4. From the **Actions** menu, select **Delete deployment** and follow the steps to delete the deployment permanently.
6464

6565
:::{warning}
6666
Deleting a deployment cannot be undone.
@@ -77,7 +77,7 @@ To terminate an {{ece}} deployment,
7777

7878
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
7979

80-
3. In the **Deployment Management** section, select **Terminate deployment**.
80+
3. From the **Actions** menu, select **Terminate deployment**.
8181

8282

8383
### Restore a deployment
@@ -89,7 +89,7 @@ To restore a terminated deployment,
8989
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
9090
2. On the **Deployments** page, select your deployment.
9191
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
92-
3. In the **Deployment Management** section, select **Restore** and then acknowledge the confirmation message.
92+
3. From the **Actions** menu, select **Restore deployment** and then acknowledge the confirmation message.
9393

9494
## {{eck}} [elastic-cloud-kubernetes]
9595

0 commit comments

Comments
 (0)