Skip to content

Commit 3e6b3b5

Browse files
Merge branch 'main' into 1496-fix-agent-restrictions-for-serverless
2 parents 2f91fe7 + 74042e8 commit 3e6b3b5

File tree

48 files changed

+1065
-320
lines changed

Some content is hidden

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

48 files changed

+1065
-320
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
::::{note}
2+
With [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md), upgrades of the Elastic-managed infrastructure and project components are fully handled by Elastic. Users automatically receive the latest features and improvements, with no need to plan or perform project-level upgrades.
3+
4+
Keep in mind that the [ingest components](/deploy-manage/upgrade/ingest-components.md) or clients you manage externally, such as {{agent}}, {{beats}}, {{ls}}, or custom applications, still need to be updated manually.
5+
::::

deploy-manage/deploy/cloud-on-k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ ECK should work with all conformant **installers** listed in these [FAQs](https:
9191

9292
Alpha, beta, and stable API versions follow the same [conventions used by Kubernetes](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning).
9393

94-
### {{stack}} compatibility
94+
### {{stack}} compatibility [stack-compatibility]
9595

9696
ECK is compatible with the following {{stack}} applications:
9797

deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This table compares the core platform capabilities between {{ech}} deployments a
6161
| **Cloud provider support** | - AWS <br>- GCP <br>- Azure | - AWS <br>- Azure <br>- GCP | - [{{ech}} regions](cloud://reference/cloud-hosted/regions.md)<br>- [Serverless regions](/deploy-manage/deploy/elastic-cloud/regions.md) |
6262
| **Cluster scaling** | Manual with autoscaling option | Managed | Automatic scaling eliminates capacity planning - [Learn more](https://www.elastic.co/blog/elastic-serverless-architecture) |
6363
| **Custom plugins and bundles** ||| Not available in Serverless |
64-
| **Custom roles** ||| Not available in Serverless Observability projects. |
64+
| **Custom roles** ||| |
6565
| **Deployment health monitoring** | AutoOps or monitoring cluster | Managed by Elastic | - No monitoring cluster required <br>- Automatically handled by Elastic |
6666
| **Deployment model** | Single deployments with multiple solutions | Separate projects for specific use cases | Fundamental architectural difference - [Learn more](https://www.elastic.co/blog/elastic-serverless-architecture) |
6767
| **Deployment monitoring** | AutoOps or monitoring cluster | Managed | Monitoring is handled by Elastic |
@@ -112,7 +112,7 @@ This table compares Observability capabilities between {{ech}} deployments and S
112112
| [**APM Tail-based sampling**](/solutions/observability/apm/transaction-sampling.md#apm-tail-based-sampling) ||| - Not available in Serverless <br>- Consider **OpenTelemetry** tail sampling processor as an alternative |
113113
| [**Android agent/SDK instrumentation**](opentelemetry://reference/edot-sdks/android/index.md) ||| |
114114
| [**AWS Firehose integration**](/solutions/observability/cloud/monitor-amazon-web-services-aws-with-amazon-data-firehose.md) ||| |
115-
| **Custom roles for Kibana Spaces** || **Planned** | Anticipated in a future release |
115+
| [**Custom roles for Kibana Spaces**](/deploy-manage/manage-spaces.md#spaces-control-user-access) || | |
116116
| [**Data stream lifecycle**](/manage-data/lifecycle/data-stream.md) ||| Primary lifecycle management method in Serverless |
117117
| **[Elastic Serverless Forwarder](elastic-serverless-forwarder://reference/index.md)** ||| |
118118
| **[Elastic Synthetics Private Locations](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add)** ||| |

deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,13 @@ After uploading your files, you can select to enable them when creating a new {{
151151

152152
While you can update the ZIP file for any plugin or bundle, these are downloaded and made available only when a node is started.
153153

154-
You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available.
154+
:::{important}
155+
Be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for any reason, all the nodes could be impacted, as either a restart or a move node could make even HA clusters non-available. Also, shards of your indices may become unassigned if there's anything wrong with the bundle, for example if a file referenced by an index is missing due to the update.
156+
:::
157+
158+
:::{tip}
159+
If you need to update your extension, instead of updating an existing extension with a new file directly, we recommend that you create a new extension to test the behavior first, verify it's validity, and then reflect it to your deployment.
160+
:::
155161

156162
If the extension is not in use by any deployments, then you are free to update the files or extension details as much as you like. However, if the extension is in use, and if you need to update it with a new file, it is recommended to [create a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-add-your-plugin) rather than updating the existing one that is in use.
157163

deploy-manage/manage-spaces.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,6 @@ Elastic also allows you to manage spaces using APIs:
100100

101101

102102
## Define access to a space [spaces-control-user-access]
103-
```{applies_to}
104-
stack: ga
105-
serverless:
106-
elasticsearch: ga
107-
security: ga
108-
observability: unavailable
109-
```
110103

111104
Users can access spaces based on the roles that they have.
112105

deploy-manage/security/fips-ingest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ applies_to:
1414

1515
# FIPS mode for Ingest tools [fips-ingest]
1616

17-
{{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}} binaries are built and can be configured to use FIPS 140-2 compliant cryptography.
17+
{{agent}}, {{fleet}}, {{filebeat}}, {{metricbeat}}, and {{apm-server}} binaries are built and configured to use FIPS 140-2 compliant cryptography.
1818
Generally speaking FIPS 140-2 requirements can be summarized as:
1919
- linking against a FIPS certified cryptographic library
2020
- using only FIPS approved cryptographic functions
@@ -89,6 +89,7 @@ When you use {{agent}} and {{fleet-server}}, these limitations apply:
8989

9090
- [Azure Logs Integration (v2 preview)](integration-docs://reference/azure/events.md)
9191
- [Azure Event Hub Input](integration-docs://reference/azure/eventhub.md)
92+
- [SQL Input](integration-docs://reference/sql.md)
9293
- [PostgreSQL Integration](integration-docs://reference/postgresql.md)
9394
- [MongoDB Integration](integration-docs://reference/mongodb.md)
9495
- [MySQL Integration](integration-docs://reference/mysql.md)

deploy-manage/toc.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -797,12 +797,6 @@ toc:
797797
- file: upgrade.md
798798
children:
799799
- file: upgrade/plan-upgrade.md
800-
- file: upgrade/orchestrator.md
801-
children:
802-
- file: upgrade/orchestrator/upgrade-cloud-enterprise.md
803-
children:
804-
- file: upgrade/orchestrator/re-running-the-ece-upgrade.md
805-
- file: upgrade/orchestrator/upgrade-cloud-on-k8s.md
806800
- file: upgrade/prepare-to-upgrade.md
807801
children:
808802
- file: upgrade/prepare-to-upgrade/upgrade-assistant.md
@@ -823,6 +817,12 @@ toc:
823817
- file: upgrade/deployment-or-cluster/kibana-roll-back.md
824818
- file: upgrade/deployment-or-cluster/enterprise-search.md
825819
- file: upgrade/ingest-components.md
820+
- file: upgrade/orchestrator.md
821+
children:
822+
- file: upgrade/orchestrator/upgrade-cloud-enterprise.md
823+
children:
824+
- file: upgrade/orchestrator/re-running-the-ece-upgrade.md
825+
- file: upgrade/orchestrator/upgrade-cloud-on-k8s.md
826826
- file: uninstall.md
827827
children:
828828
- file: uninstall/uninstall-elastic-cloud-enterprise.md

deploy-manage/upgrade.md

Lines changed: 91 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,99 @@
1+
---
2+
applies_to:
3+
stack:
4+
deployment:
5+
eck:
6+
ess:
7+
ece:
8+
self:
9+
products:
10+
- id: kibana
11+
- id: cloud-enterprise
12+
- id: cloud-hosted
13+
- id: cloud-kubernetes
14+
- id: elasticsearch
15+
---
16+
117
# Upgrade
218

3-
Upgrading to the latest version provides access to the newest Elastic features, enhancements, performance improvements, and bug fixes. These updates reduce costs, speed up threat response, and improve investigative and analytical data tools.
19+
Upgrading to the latest version provides access to the newest Elastic features, security patches, performance improvements, and bug fixes. These updates reduce costs, speed up threat response, and improve investigative and analytical data tools.
420

5-
:::{important}
6-
In {{stack}} 9.0.0 and beyond, Enterprise Search is unavailable. For more information, refer to [Migrating to 9.x from Enterprise Search 8.x versions](https://www.elastic.co/guide/en/enterprise-search/8.18/upgrading-to-9-x.html).
21+
As Elastic releases new versions, older versions of Elastic products reach their end of life on a set schedule. To keep your deployment supported, stay up to date. For more information, refer to [Product End of Life Dates](https://www.elastic.co/support/eol).
22+
23+
:::{include} /deploy-manage/_snippets/serverless-upgrade.md
724
:::
825

9-
When Elastic releases new versions, older versions reach their end of life on a set schedule. To keep your deployment supported, stay up to date. For more information, refer to [Product End of Life Dates](https://www.elastic.co/support/eol).
26+
The upgrade procedure depends on how your deployment is managed. If you're using {{ech}} or {{ece}}, upgrades can often be performed with a single click in the {{ecloud}} UI. For self-managed deployments, upgrades must be carried out manually using a rolling upgrade process, upgrading the nodes one by one to minimize downtime and ensure cluster stability.
27+
28+
This section provides guidance to help you plan and safely perform upgrades of your {{stack}} components, with a primary focus on {{es}} and {{kib}} as the core of the stack. It also covers upgrades for orchestration platforms like {{ece}} and {{eck}}, as well as related components such as APM, {{beats}}, {{agent}}, and {{ls}}.
1029

11-
:::{note}
12-
Upgrading from a release candidate build, such as 9.0.0-rc1, is unsupported. Use pre-releases only for testing in a temporary environment.
30+
:::{important}
31+
In {{stack}} 9.0.0 and beyond, Enterprise Search is unavailable. For more information, refer to [Migrating to 9.x from Enterprise Search 8.x versions](https://www.elastic.co/guide/en/enterprise-search/8.19/upgrading-to-9-x.html).
1332
:::
1433

34+
## Upgrade overview
35+
36+
Upgrading your Elastic cluster or deployment involves several stages, including planning, preparation, and execution. This section guides you through the full upgrade process:
37+
38+
- [Plan your upgrade](./upgrade/plan-upgrade.md): Review compatibility, define your upgrade path and order, and understand important pre-upgrade considerations.
39+
40+
- [Prepare to upgrade](./upgrade/prepare-to-upgrade.md): Follow detailed preparation steps for major, minor, and patch upgrades. Identify breaking changes, run the Upgrade Assistant (for major upgrades), and verify readiness.
41+
42+
- [Upgrade your deployment or cluster](./upgrade/deployment-or-cluster.md): Step-by-step instructions for performing the upgrade, organized by deployment type:
43+
44+
- [Upgrade deployments on {{ech}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md)
45+
- [Upgrade deployments on {{ece}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md)
46+
- [Upgrade deployments on {{eck}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md)
47+
- [Upgrade self-managed clusters](/deploy-manage/upgrade/deployment-or-cluster/self-managed.md)
48+
49+
- [Upgrade ingest components](./upgrade/ingest-components.md): Covers supporting components such as {{beats}}, {{agent}}, {{ls}}, and APM Server.
50+
51+
Additionally, if you're using a self-managed orchestration platform such as {{ece}} or {{eck}}, refer to [Upgrade your ECE or ECK orchestrator](/deploy-manage/upgrade/orchestrator.md) to keep the orchestrator up to date.
52+
53+
## Availability during upgrades
54+
55+
{{es}} supports rolling upgrades, where nodes are upgraded one at a time to minimize downtime and ensure cluster stability. If your deployment or cluster follows high availability best practices, such as using replicated indices and distributing nodes across multiple availability zones, it should remain available throughout the entire upgrade process.
56+
57+
{{kib}} upgrades, however, require downtime. All running instances must be shut down before starting the upgrade.
58+
59+
::::{important}
60+
Ensure your deployment is properly sized and configured for high availability to reduce the risk of service interruption during upgrades.
61+
62+
If you want to learn more about scaling, high availability, and performance, refer to:
63+
* [Run {{es}} in production](/deploy-manage/production-guidance/elasticsearch-in-production-environments.md)
64+
* [Run {{kib}} in production](/deploy-manage/production-guidance/kibana-in-production-environments.md)
65+
* [{{ech}} > Plan for production](/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md)
66+
::::
67+
68+
You’ll find more information about availability considerations for specific deployment types in the related upgrade guides within this section.
69+
70+
## Upgrade paths [upgrade-paths]
71+
72+
You can upgrade to a higher version if the target version was released *after* your current version. Upgrades to versions released *before* your current version are not supported, even if the version number is higher. Refer to [out-of-order releases](/deploy-manage/upgrade/deployment-or-cluster.md#out-of-order-releases) for more information.
73+
74+
For example:
75+
- ✅ Upgrade allowed: From 9.0.4 to 9.1.0 (9.1.0 released *after* 9.0.4)
76+
- ❌ Not allowed: From 9.0.5 to 9.1.0 (9.1.0 released *before* 9.0.5) → wait for 9.1.1 to be released
77+
<!--
78+
Uncomment this example when 9.1.1 is released.
79+
- ✅ Upgrade allowed: From 9.0.5 to 9.1.1 (9.1.1 released *after* 9.0.5)
80+
-->
81+
82+
### Upgrade paths from 8.x [upgrade-paths-8.x]
83+
84+
To perform a major upgrade from 8.x, the required starting version depends on the target release:
85+
86+
- To upgrade to the **9.0.x series**, you must be on **8.18.x**.
87+
- To upgrade to **9.1.0 or later**, you must be on **8.19.x**, which is the latest minor release of the 8.x series.
88+
89+
::::{note}
90+
While 8.19 is the final minor release in the 8.x series, 8.18 was released at the same time as 9.0, enabling a supported upgrade path between the 8.18.x and 9.0.x series. This compatibility also applies to other features and clients.
91+
::::
92+
93+
If you're upgrading to the current {{version.stack}} release from an earlier 8.x version, first upgrade to the latest available 8.19 release.
94+
95+
#### Ingest tools and clients considerations
96+
97+
For flexible upgrade scheduling, 8.19 {{agent}}, {{beats}}, and {{ls}} are compatible with all 9.x versions of {{es}}.
98+
99+
By default, 8.x {{es}} clients are compatible with 9.x and use [REST API compatibility](elasticsearch://reference/elasticsearch/rest-apis/compatibility.md) to maintain compatibility with the 9.x cluster.

deploy-manage/upgrade/deployment-or-cluster.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,38 @@ products:
2828

2929
# Upgrade your deployment or cluster [upgrade-deployment-cluster]
3030

31-
When upgrading an existing cluster, you perform a minor or major upgrade. For example, a minor upgrade takes you from version 9.0.0 to 9.1.0, while a major upgrade takes you from version 8.0.0 to 9.0.0.
31+
This section contains the upgrade instructions for {{es}} clusters and {{kib}} instances. Upgrade procedures depend on whether you installed Elastic components using Elastic-managed or self-managed infrastructure.
3232

33-
Upgrade procedures depend on whether you installed Elastic components using Elastic-managed or self-managed infrastructure.
33+
## Prerequisites
34+
35+
Before proceeding with the upgrade, review the [Plan your upgrade](/deploy-manage/upgrade/plan-upgrade.md) guidance to understand compatibility and timing considerations, and follow the steps in [Prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md) to get your environment ready for the upgrade.
36+
37+
## Out-of-order releases [out-of-order-releases]
38+
39+
Elastic maintains several minor versions of {{es}} at the same time. This means releases do not always happen in order of their version numbers. You can only upgrade to {{version.stack}} if the version you are currently running meets both of these conditions:
40+
41+
* Has a lower version number than {{version.stack}}
42+
* Has an earlier release date than {{version.stack}}
43+
44+
If you are currently running a version with a lower version number but a later release date than {{version.stack}}, wait for a newer release before upgrading.
45+
46+
Additionally, upgrading from a release candidate build, such as 9.0.0-rc1, is unsupported. Use pre-releases only for testing in a temporary environment.
47+
48+
## Upgrade methods
3449

3550
If you’re using Elastic-managed infrastructure, use the following options:
3651

3752
* [Upgrade on {{ech}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md)
38-
* Upgrade on [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md), which is automatically performed by Elastic and requires no user management
3953

4054
If you’re using self-managed infrastructure - either on-prem or public cloud - use the following options:
4155

4256
* [Upgrade the {{stack}} on a self-managed cluster](/deploy-manage/upgrade/deployment-or-cluster/self-managed.md)
43-
* [Upgrade on {{ece}} (ECE)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md)
44-
* [Upgrade on {{eck}} (ECK)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md)
57+
* [Upgrade your deployment on {{ece}} (ECE)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md)
58+
* [Upgrade your deployment on {{eck}} (ECK)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md)
59+
60+
:::{include} /deploy-manage/_snippets/serverless-upgrade.md
61+
:::
62+
63+
## Next steps
64+
65+
Once you've successfully upgraded your deployment, you can [upgrade your ingest components](./ingest-components.md), such as {{ls}}, {{agent}}, or {{beats}}.

deploy-manage/upgrade/deployment-or-cluster/archived-settings.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/archived-settings.html
4+
applies_to:
5+
stack:
6+
deployment:
7+
eck:
8+
ess:
9+
ece:
10+
self:
411
products:
512
- id: elasticsearch
613
---

0 commit comments

Comments
 (0)