Skip to content

Commit 1e1c1d5

Browse files
authored
Merge branch 'main' into remove-eem
2 parents 44e942d + a68a66c commit 1e1c1d5

File tree

67 files changed

+1444
-972
lines changed

Some content is hidden

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

67 files changed

+1444
-972
lines changed

deploy-manage/cloud-organization/billing/billing-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ $$$faq-included$$$What is included in my paid {{ech}} deployment?
9999

100100
* Free 1GB RAM {{kib}} instance
101101
* Free 1GB RAM Machine Learning node
102-
* Free 1GB RAM APM server
102+
* Free 1GB RAM APM / Integrations Server instance
103103
* A free allowance for [data transfer and snapshot storage costs](#faq-dts)
104104

105105
Note that if you go above the free tier of Kibana/ML/APM (for example, a 2GB {{kib}} instance), you will be charged in full for the size of that instance.

deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
navigation_title: APM user settings
33
mapped_pages:
44
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-apm-settings.html
5+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-apm-settings.html
56
applies_to:
67
deployment:
78
ece: all

deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
navigation_title: Elasticsearch user settings
33
mapped_pages:
44
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html
5+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-user-settings-examples.html
56
applies_to:
67
deployment:
78
ece: all
@@ -17,9 +18,11 @@ Change how {{es}} runs by providing your own user settings. User settings are ap
1718
If a feature requires both standard `elasticsearch.yml` settings and [secure settings](/deploy-manage/security/secure-settings.md), configure the secure settings first. Updating standard user settings can trigger a cluster rolling restart, and if the required secure settings are not yet in place, the nodes might fail to start. Adding secure settings does not trigger a restart.
1819
:::
1920

20-
{{ece}} automatically rejects `elasticsearch.yml` settings that could break your cluster, including some zen discovery and security settings.
21+
{{ece}} automatically rejects `elasticsearch.yml` settings that could break your cluster, including some zen discovery and security settings. For a detailed list of settings, refer to the [{{es}} configuration reference](elasticsearch://reference/elasticsearch/configuration-reference/index.md).
2122

22-
For a list of supported settings, check [Supported {{es}} settings](elasticsearch://reference/elasticsearch/configuration-reference/index.md).
23+
::::{note}
24+
Most of the user settings that are available for the {{es}} version that your cluster is running are also available on {{ece}}, regardless of being marked as "supported on {{ech}}".
25+
::::
2326

2427
To add or edit {{es}} user settings:
2528

@@ -37,6 +40,7 @@ To add or edit {{es}} user settings:
3740
If you encounter the **Edit elasticsearch.yml** carets, be sure to make your changes on all {{es}} node types.
3841
::::
3942

43+
$$$ece-change-user-settings-examples$$$
4044
## Example: enable email notifications [ece_enable_email_notifications_from_gmail]
4145

4246
To enable email notifications in your {{es}} cluster, you need to configure an email account and related settings. For complete instructions, refer to [Configuring email accounts](/explore-analyze/alerts-cases/watcher/actions-email.md#configuring-email).

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-podman-5-migration.html
24
applies_to:
35
deployment:
46
ece: all

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

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ This table compares Observability capabilities between {{ech}} deployments and S
109109
| **APM integration** ||| Use **Managed Intake Service** (supports Elastic APM and OTLP protocols) |
110110
| [**APM Agent Central Configuration**](/solutions/observability/apm/apm-agent-central-configuration.md) ||| Not available in Serverless |
111111
| [**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 |
112-
| [**Android agent/SDK instrumentation**](apm-agent-android://reference/index.md) ||| Not available in Serverless |
112+
| [**Android agent/SDK instrumentation**](opentelemetry://reference/edot-sdks/android/index.md) ||| Not available in Serverless |
113113
| [**AWS Firehose integration**](/solutions/observability/cloud/monitor-amazon-web-services-aws-with-amazon-data-firehose.md) ||| |
114114
| **Custom roles for Kibana Spaces** || **Planned** | Anticipated in a future release |
115115
| [**Data stream lifecycle**](/manage-data/lifecycle/data-stream.md) ||| Primary lifecycle management method in Serverless |
@@ -118,7 +118,7 @@ This table compares Observability capabilities between {{ech}} deployments and S
118118
| **[Fleet Agent policies](/reference/fleet/agent-policy.md)** ||| |
119119
| **[Fleet server](/reference/fleet/fleet-server.md)** | - Self-hosted <br>- Hosted || Fully managed by Elastic |
120120
| [**Index lifecycle management**](/manage-data/lifecycle/index-lifecycle-management.md) ||| Use [**Data stream lifecycle**](/manage-data/lifecycle/data-stream.md) instead |
121-
| **[iOS agent/SDK instrumentation](apm-agent-ios://reference/index.md)** ||| Not available in Serverless |
121+
| **[iOS agent/SDK instrumentation](opentelemetry://reference/edot-sdks/ios/index.md)** ||| Not available in Serverless |
122122
| **[Kibana Alerts](/deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts.md)** ||| |
123123
| **[LogsDB index mode](/manage-data/data-store/data-streams/logs-data-stream.md)** ||| - Reduces storage footprint <br> - Enabled by default <br>- Cannot be disabled |
124124
| **[Logs management](/solutions/observability/logs.md)** ||| |
@@ -162,7 +162,10 @@ These recommendations do not apply to indices using better binary quantization (
162162

163163
## Available {{es}} APIs [elasticsearch-differences-serverless-apis-availability]
164164

165-
Because {{serverless-full}} manages infrastructure automatically, certain Elasticsearch APIs are not available:
165+
In {{serverless-full}}, access is limited to a subset of {{es}} APIs, as Elastic manages the underlying infrastructure. These restrictions help maintain cluster stability, availability, and data integrity, ensuring reliable operation of Serverless projects.
166+
167+
The following {{es}} APIs are not available in {{serverless-full}}:
168+
166169

167170
Infrastructure operations
168171
: * All `_nodes/*` operations
@@ -201,7 +204,7 @@ Refer to the [{{es-serverless}} API reference](https://www.elastic.co/docs/api/d
201204

202205
## Available {{es}} settings [elasticsearch-differences-serverless-settings-availability]
203206

204-
In {{serverless-full}} Elasticsearch projects, you can only configure [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md). Cluster-level settings and node-level settings are fully managed by Elastic.
207+
In {{serverless-full}} projects, configuration available to users is limited to certain [index-level settings](elasticsearch://reference/elasticsearch/index-settings/index.md), while Elastic manages cluster-level and node-level settings to maintain stability, availability, performance, and data integrity. These restrictions help ensure the reliability of Serverless projects.
205208

206209
Available settings
207210
: **Index-level settings**: Settings that control how documents are processed, stored, and searched are available to end users. These include:
@@ -219,6 +222,24 @@ Managed settings
219222
* Shard allocation
220223
* Resource management
221224

225+
When attempting to use an unavailable index setting, you'll receive this error:
226+
227+
```json
228+
{
229+
"error": {
230+
"root_cause": [
231+
{
232+
"type": "illegal_argument_exception",
233+
"reason": "Settings [xyz] are not available when running in serverless mode"
234+
}
235+
],
236+
"type": "illegal_argument_exception",
237+
"reason": "Settings [xyz] are not available when running in serverless mode"
238+
},
239+
"status": 400
240+
}
241+
```
242+
222243
## Learn more
223244

224245
- [{{serverless-full}} roadmap](https://www.elastic.co/cloud/serverless/roadmap): See upcoming features and development plans for the Serverless platform

deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ $$$ec-restrictions-apis-kibana$$$
7272
* {{es}} plugins, are not enabled by default for security purposes. Reach out to support if you would like to enable {{es}} plugins support on your account.
7373
* Some {{es}} plugins do not apply to {{ecloud}}. For example, you won’t ever need to change discovery, as {{ecloud}} handles how nodes discover one another.
7474
% * In {{es}} 5.0 and later, site plugins are no longer supported. This change does not affect the site plugins {{ecloud}} might provide out of the box, such as Kopf or Head, since these site plugins are serviced by our proxies and not {{es}} itself.
75-
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/lifecycle/index-lifecycle-management/index-management-in-kibana.md) if you want more detailed information or perform index management actions.
75+
% * In {{es}} 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](/manage-data/data-store/index-basics.md#manage-indices) if you want more detailed information or perform index management actions.
7676

7777

7878
## Watcher [ec-restrictions-watcher]
@@ -81,7 +81,7 @@ Watcher encryption Key Setup is not supported.
8181

8282
Changing the default throttle period is not possible. You can specify a throttle period per watch, however.
8383

84-
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#cloud-email-service-limits)
84+
Watcher comes preconfigured with a directly usable email account provided by Elastic. However, this account can’t be reconfigured and is subject to some limitations. For more information on the limits of the Elastic mail server, check the [cloud email service limits](/deploy-manage/deploy/elastic-cloud/tools-apis.md#email-service-limits).
8585

8686
Alternatively, a custom mail server can be configured as described in [Configuring a custom mail server](../../../explore-analyze/alerts-cases/watcher/enable-watcher.md#watcher-custom-mail-server)
8787

deploy-manage/deploy/elastic-cloud/tools-apis.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,16 @@ serverless: unavailable
104104

105105
:::{include} /deploy-manage/deploy/_snippets/tpec.md
106106
:::
107+
108+
## Elastic Cloud email service
109+
110+
{{ecloud}} provides a built-in email service used by the preconfigured [email connector](kibana://reference/connectors-kibana/email-action-type.md), available in both {{ech}} deployments and {{serverless-full}} projects. This service can be used to send [alert](/explore-analyze/alerts-cases/alerts.md) notifications and is also supported in {{ech}} by [Watcher](/explore-analyze/alerts-cases/watcher/enable-watcher.md).
111+
112+
### Email service limits
113+
114+
The following quotas apply to both {{ech}} deployments and {{serverless-full}} projects when using the Elastic email service:
115+
116+
* Email sending quota: 500 emails per 15 minute period.
117+
* Maximum number of recipients per message: 30 recipients per email (To, CC, and BCC all count as recipients).
118+
* Maximum message size (including attachments): 10 MB per message (after Base64 encoding).
119+
* The email-sender can't be customized (Any custom `From:` header will be removed).

deploy-manage/tools/snapshot-and-restore/s3-repository.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,12 +380,16 @@ There are a number of storage systems that provide an S3-compatible API, and the
380380

381381
By default {{es}} communicates with your storage system using HTTPS, and validates the repository’s certificate chain using the JVM-wide truststore. Ensure that the JVM-wide truststore includes an entry for your repository. If you wish to use unsecured HTTP communication instead of HTTPS, set `s3.client.CLIENT_NAME.protocol` to `http`.
382382

383-
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. Other S3-compatible storage systems may also work with {{es}}, but these are not covered by the {{es}} test suite.
384-
385383
There are many systems, including some from very well-known storage vendors, which claim to offer an S3-compatible API despite failing to emulate S3’s behavior in full. If you are using such a system for your snapshots, consider using a [shared filesystem repository](shared-file-system-repository.md) based on a standardized protocol such as NFS to access your storage system instead. The `s3` repository type requires full compatibility with S3. In particular it must support the same set of API endpoints, with the same parameters, return the same errors in case of failures, and offer consistency and performance at least as good as S3 even when accessed concurrently by multiple nodes. You will need to work with the supplier of your storage system to address any incompatibilities you encounter. Don't report {{es}} issues involving storage systems which claim to be S3-compatible unless you can demonstrate that the same issue exists when using a genuine AWS S3 repository.
386384

387385
You can perform some basic checks of the suitability of your storage system using the [repository analysis API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze). If this API does not complete successfully, or indicates poor performance, then your storage system is not fully compatible with AWS S3 and therefore unsuitable for use as a snapshot repository. However, these checks do not guarantee full compatibility.
388386

387+
::::{admonition} Using MinIO with {{es}}
388+
[MinIO](https://minio.io) is an example of a storage system that provides an S3-compatible API. The `s3` repository type allows {{es}} to work with MinIO-backed repositories as well as repositories stored on AWS S3. The {{es}} test suite includes some checks which aim to detect deviations in behavior between MinIO and AWS S3. Elastic will report directly to the MinIO project any deviations in behavior found by these checks. If you are running a version of MinIO whose behavior deviates from that of AWS S3 then you must upgrade your MinIO installation. If in doubt, please contact the MinIO support team for further information.
389+
390+
The performance, reliability, and durability of a MinIO-backed repository depend on the properties of the underlying infrastructure and on the details of your MinIO configuration. You must design your storage infrastructure and configure MinIO in a way that ensures your MinIO-backed repository has performance, reliability, and durability characteristics which match AWS S3 in order for it to be fully S3-compatible. If you need assistance with your MinIO configuration, please contact the MinIO support team.
391+
::::
392+
389393
Most storage systems can be configured to log the details of their interaction with {{es}}. If you are investigating a suspected incompatibility with AWS S3, it is usually simplest to collect these logs and provide them to the supplier of your storage system for further analysis. If the incompatibility is not clear from the logs emitted by the storage system, configure {{es}} to log every request it makes to the S3 API by [setting the logging level](/deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md) of the `com.amazonaws.request` logger to `DEBUG`.
390394

391395
To prevent leaking sensitive information such as credentials and keys in logs, {{es}} rejects configuring this logger at high verbosity unless [insecure network trace logging](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#http-rest-request-tracer) is enabled. To do so, you must explicitly enable it on each node by setting the system property `es.insecure_network_trace_enabled` to `true`.

0 commit comments

Comments
 (0)