Skip to content

Commit cebc46f

Browse files
authored
Fix broken cross-repo links, versions in search connectors docker instructions (elastic#123700) (elastic#125341)
(cherry picked from commit 91c2654) # Conflicts: # docs/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md # docs/reference/elasticsearch-plugins/cloud/ec-adding-plugins.md # docs/reference/elasticsearch/configuration-reference/elastic-cloud-serverless-elasticsearch-settings.md # docs/reference/query-languages/esql/esql-enrich-data.md
1 parent c36b4db commit cebc46f

File tree

53 files changed

+292
-76
lines changed

Some content is hidden

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

53 files changed

+292
-76
lines changed

docs/reference/community-contributed.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ a number of clients that have been contributed by the community for various lang
4242

4343
## Go [go]
4444

45-
Also see the [official Elasticsearch Go client](go-elasticsearch://docs/reference/index.md).
45+
Also see the [official Elasticsearch Go client](go-elasticsearch://reference/index.md).
4646

4747
* [elastigo](https://github.com/mattbaird/elastigo): Go client. **Last commit more than a year ago**
4848

@@ -56,23 +56,23 @@ Also see the [official Elasticsearch Go client](go-elasticsearch://docs/referenc
5656

5757
## Java [java]
5858

59-
Also see the [official Elasticsearch Java client](elasticsearch-java://docs/reference/index.md).
59+
Also see the [official Elasticsearch Java client](elasticsearch-java://reference/index.md).
6060

6161
* [Flummi](https://github.com/otto-de/flummi): Java Rest client with comprehensive Query DSL API.
6262

6363
* [Jest](https://github.com/searchbox-io/Jest): Java Rest client. **No longer maintained**
6464

6565
## JavaScript [javascript]
6666

67-
See the [official Elasticsearch JavaScript client](elasticsearch-js://docs/reference/index.md).
67+
See the [official Elasticsearch JavaScript client](elasticsearch-js://reference/index.md).
6868

6969
## Julia [julia]
7070

71-
* [ElasticsearchClient.jl](https://github.com/OpenSesame/ElasticsearchClient.jl): Elasticsearch client inspired by the [official Elasticsearch Ruby client](elasticsearch-ruby://docs/reference/index.md).
71+
* [ElasticsearchClient.jl](https://github.com/OpenSesame/ElasticsearchClient.jl): Elasticsearch client inspired by the [official Elasticsearch Ruby client](elasticsearch-ruby://reference/index.md).
7272

7373
## Kotlin [kotlin]
7474

75-
* [ES Kotlin](https://github.com/mbuhot/eskotlin): Elasticsearch Query DSL for kotlin based on the [official Elasticsearch Java client](elasticsearch-java://docs/reference/index.md). **Last commit more than a year ago**
75+
* [ES Kotlin](https://github.com/mbuhot/eskotlin): Elasticsearch Query DSL for kotlin based on the [official Elasticsearch Java client](elasticsearch-java://reference/index.md). **Last commit more than a year ago**
7676

7777
* [ES Kotlin Wrapper Client](https://github.com/jillesvangurp/es-kotlin-wrapper-client): Kotlin extension functions and abstractions for the [official Elasticsearch high-level client](https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html). Aims to reduce the amount of boilerplate needed to do searches, bulk indexing and other common things users do with the client. **No longer maintained**
7878

@@ -82,7 +82,7 @@ See the [official Elasticsearch JavaScript client](elasticsearch-js://docs/refer
8282

8383
## .NET [dotnet]
8484

85-
See the [official Elasticsearch .NET client](elasticsearch-net://docs/reference/index.md).
85+
See the [official Elasticsearch .NET client](elasticsearch-net://reference/index.md).
8686

8787
## Perl [perl]
8888

@@ -92,7 +92,7 @@ Also see the [official Elasticsearch Perl client](https://www.elastic.co/guide/e
9292

9393
## PHP [php]
9494

95-
Also see the [official Elasticsearch PHP client](elasticsearch-php://docs/reference/index.md).
95+
Also see the [official Elasticsearch PHP client](elasticsearch-php://reference/index.md).
9696

9797
* [Elastica](https://github.com/ruflin/Elastica): PHP client.
9898

@@ -102,7 +102,7 @@ Also see the [official Elasticsearch PHP client](elasticsearch-php://docs/refere
102102

103103
## Python [python]
104104

105-
See the [official Elasticsearch Python client](elasticsearch-py://docs/reference/index.md).
105+
See the [official Elasticsearch Python client](elasticsearch-py://reference/index.md).
106106

107107
## R [r]
108108

@@ -114,7 +114,7 @@ See the [official Elasticsearch Python client](elasticsearch-py://docs/reference
114114

115115
## Ruby [ruby]
116116

117-
Also see the [official Elasticsearch Ruby client](elasticsearch-ruby://docs/reference/index.md).
117+
Also see the [official Elasticsearch Ruby client](elasticsearch-ruby://reference/index.md).
118118

119119
* [chewy](https://github.com/toptal/chewy): An ODM and wrapper for the official Elasticsearch client.
120120

@@ -128,7 +128,7 @@ Also see the [official Elasticsearch Ruby client](elasticsearch-ruby://docs/refe
128128

129129
## Rust [rust]
130130

131-
Also see the [official Elasticsearch Rust client](elasticsearch-rs://docs/reference/index.md).
131+
Also see the [official Elasticsearch Rust client](elasticsearch-rs://reference/index.md).
132132

133133
* [rs-es](https://github.com/benashford/rs-es): A REST API client with a strongly-typed Query DSL. **Last commit more than a year ago**
134134

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html
4+
---
5+
6+
# Add plugins provided with Elasticsearch Service [ec-adding-elastic-plugins]
7+
8+
You can use a variety of official plugins that are compatible with your version of {{es}}. When you upgrade to a new {{es}} version, these plugins are simply upgraded with the rest of your deployment.
9+
10+
## Before you begin [ec_before_you_begin_6]
11+
12+
Some restrictions apply when adding plugins. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](cloud://release-notes/cloud-hosted/known-issues.md#ec-restrictions-plugins).
13+
14+
Only Gold, Platinum, Enterprise and Private subscriptions, running version 2.4.6 or later, have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries.
15+
16+
To enable a plugin for a deployment:
17+
18+
1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
19+
2. Find your deployment on the home page in the Elasticsearch Service card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments.
20+
21+
On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
22+
23+
3. From the **Actions** dropdown, select **Edit deployment**.
24+
4. Select **Manage user settings and extensions**.
25+
5. Select the **Extensions** tab.
26+
6. Select the plugins that you want to enable.
27+
7. Select **Back**.
28+
8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed.
29+
30+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html
4+
---
5+
6+
# Add plugins and extensions [ec-adding-plugins]
7+
8+
Plugins extend the core functionality of {{es}}. There are many suitable plugins, including:
9+
10+
* Discovery plugins, such as the cloud AWS plugin that allows discovering nodes on EC2 instances.
11+
* Analysis plugins, to provide analyzers targeted at languages other than English.
12+
* Scripting plugins, to provide additional scripting languages.
13+
14+
Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md\).
15+
16+
There are two ways to add plugins to a deployment in Elasticsearch Service:
17+
18+
* [Enable one of the official plugins already available in Elasticsearch Service](/reference/elasticsearch-plugins/cloud/ec-adding-elastic-plugins.md\).
19+
* [Upload a custom plugin and then enable it per deployment](/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md\).
20+
21+
Custom plugins can include the official {{es}} plugins not provided with Elasticsearch Service, any of the community-sourced plugins, or [plugins that you write yourself](/extend/index.md). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](/reference/elasticsearch-plugins/cloud/ec-custom-bundles.md\).
22+
23+
To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](/reference/elasticsearch-plugins/index.md).
24+
25+
For a detailed guide with examples of using the Elasticsearch Service API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md\).
26+
27+
Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](cloud://release-notes/cloud-hosted/known-issues.md#ec-restrictions-plugins).
28+
29+
30+
31+

docs/reference/elasticsearch-plugins/integrations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Integrations are not plugins, but are external tools or modules that make it eas
2020

2121
### Supported by Elastic: [_supported_by_elastic]
2222

23-
* [Logstash output to Elasticsearch](logstash://docs/reference/plugins-outputs-elasticsearch.md): The Logstash `elasticsearch` output plugin.
24-
* [Elasticsearch input to Logstash](logstash://docs/reference/plugins-inputs-elasticsearch.md) The Logstash `elasticsearch` input plugin.
25-
* [Elasticsearch event filtering in Logstash](logstash://docs/reference/plugins-filters-elasticsearch.md) The Logstash `elasticsearch` filter plugin.
26-
* [Elasticsearch bulk codec](logstash://docs/reference/plugins-codecs-es_bulk.md) The Logstash `es_bulk` plugin decodes the Elasticsearch bulk format into individual events.
23+
* [Logstash output to Elasticsearch](logstash://reference/plugins-outputs-elasticsearch.md): The Logstash `elasticsearch` output plugin.
24+
* [Elasticsearch input to Logstash](logstash://reference/plugins-inputs-elasticsearch.md) The Logstash `elasticsearch` input plugin.
25+
* [Elasticsearch event filtering in Logstash](logstash://reference/plugins-filters-elasticsearch.md) The Logstash `elasticsearch` filter plugin.
26+
* [Elasticsearch bulk codec](logstash://reference/plugins-codecs-es_bulk.md) The Logstash `es_bulk` plugin decodes the Elasticsearch bulk format into individual events.
2727

2828

2929
### Supported by the community: [_supported_by_the_community_2]
@@ -71,7 +71,7 @@ Integrations are not plugins, but are external tools or modules that make it eas
7171

7272
### Supported by Elastic: [_supported_by_elastic_2]
7373

74-
* [es-hadoop](elasticsearch-hadoop://docs/reference/preface.md): Elasticsearch real-time search and analytics natively integrated with Hadoop. Supports Map/Reduce, Cascading, Apache Hive, Apache Pig, Apache Spark and Apache Storm.
74+
* [es-hadoop](https://www.elastic.co/elasticsearch/hadoop): Elasticsearch real-time search and analytics natively integrated with Hadoop. Supports Map/Reduce, Cascading, Apache Hive, Apache Pig, Apache Spark and Apache Storm.
7575

7676

7777
### Supported by the community: [_supported_by_the_community_5]
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
navigation_title: "Serverless differences"
3+
mapped_pages:
4+
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-differences.html
5+
---
6+
7+
# Differences from other {{es}} offerings [elasticsearch-differences]
8+
9+
10+
[{{es-serverless}}](docs-content://solutions/search.md) handles all the infrastructure management for you, providing a fully managed {{es}} service.
11+
12+
If you’ve used {{es}} before, you’ll notice some differences in how you work with the service on {{serverless-full}}, because a number of APIs and settings are not required for serverless projects.
13+
14+
This guide helps you understand what’s different, what’s available, and how to work effectively when running {{es}} on {{serverless-full}}.
15+
16+
17+
## Fully managed infrastructure [elasticsearch-differences-serverless-infrastructure-management]
18+
19+
{{es-serverless}} manages all infrastructure automatically, including:
20+
21+
* Cluster scaling and optimization
22+
* Node management and allocation
23+
* Shard distribution and replication
24+
* Resource utilization and monitoring
25+
26+
This fully managed approach means many traditional {{es}} infrastructure APIs and settings are not available to end users, as detailed in the following sections.
27+
28+
29+
## Index size guidelines [elasticsearch-differences-serverless-index-size]
30+
31+
To ensure optimal performance, follow these recommendations for sizing individual indices on {{es-serverless}}:
32+
33+
| Use case | Maximum index size | Project configuration |
34+
| --- | --- | --- |
35+
| Vector search | 150GB | Vector optimized |
36+
| General search (non data-stream) | 300GB | General purpose |
37+
| Other uses (non data-stream) | 600GB | General purpose |
38+
39+
For large datasets that exceed the recommended maximum size for a single index, consider splitting your data across smaller indices and using an alias to search them collectively.
40+
41+
These recommendations do not apply to indices using better binary quantization (BBQ). Refer to [vector quantization](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization) in the core {{es}} docs for more information.
42+
43+
44+
## API availability [elasticsearch-differences-serverless-apis-availability]
45+
46+
Because {{es-serverless}} manages infrastructure automatically, certain APIs are not available, while others remain fully accessible.
47+
48+
::::{tip}
49+
Refer to the [{{es-serverless}} API reference](https://www.elastic.co/docs/api/doc/elasticsearch-serverless) for a complete list of available APIs.
50+
51+
::::
52+
53+
54+
The following categories of operations are unavailable:
55+
56+
Infrastructure operations
57+
: * All `_nodes/*` operations
58+
* All `_cluster/*` operations
59+
* Most `_cat/*` operations, except for index-related operations such as `/_cat/indices` and `/_cat/aliases`
60+
61+
62+
Storage and backup
63+
: * All `_snapshot/*` operations
64+
* Repository management operations
65+
66+
67+
Index management
68+
: * `indices/close` operations
69+
* `indices/open` operations
70+
* Recovery and stats operations
71+
* Force merge operations
72+
73+
74+
When attempting to use an unavailable API, you’ll receive a clear error message:
75+
76+
```json
77+
{
78+
"error": {
79+
"root_cause": [
80+
{
81+
"type": "api_not_available_exception",
82+
"reason": "Request for uri [/<API_ENDPOINT>] with method [<METHOD>] exists but is not available when running in serverless mode"
83+
}
84+
],
85+
"status": 410
86+
}
87+
}
88+
```
89+
90+
91+
## Settings availability [elasticsearch-differences-serverless-settings-availability]
92+
93+
In {{es-serverless}}, you can only configure [index-level settings](/reference/elasticsearch/index-settings/index.md). Cluster-level settings and node-level settings are not required by end users and the `elasticsearch.yml` file is fully managed by Elastic.
94+
95+
Available settings
96+
: **Index-level settings**: Settings that control how {{es}} documents are processed, stored, and searched are available to end users. These include:
97+
98+
* Analysis configuration
99+
* Mapping parameters
100+
* Search/query settings
101+
* Indexing settings such as `refresh_interval`
102+
103+
104+
Managed settings
105+
: **Infrastructure-related settings**: Settings that affect cluster resources or data distribution are not available to end users. These include:
106+
107+
* Node configurations
108+
* Cluster topology
109+
* Shard allocation
110+
* Resource management
111+
112+
113+
114+
## Feature availability [elasticsearch-differences-serverless-feature-categories]
115+
116+
Some features that are available in Elastic Cloud Hosted and self-managed offerings are not available in {{es-serverless}}. These features have either been replaced by a new feature, are planned to be released in future, or are not applicable in the new serverless architecture.
117+
118+
119+
### Replaced features [elasticsearch-differences-serverless-features-replaced]
120+
121+
These features have been replaced by a new feature and are therefore not available on {{es-serverless}}:
122+
123+
* **Index lifecycle management ({{ilm-init}})** is not available, in favor of [**data stream lifecycle**](docs-content://manage-data/data-store/index-basics.md).
124+
125+
In an Elastic Cloud Hosted or self-managed environment, {{ilm-init}} lets you automatically transition indices through data tiers according to your performance needs and retention requirements. This allows you to balance hardware costs with performance. {{es-serverless}} eliminates this complexity by optimizing your cluster performance for you.
126+
127+
Data stream lifecycle is an optimized lifecycle tool that lets you focus on the most common lifecycle management needs, without unnecessary hardware-centric concepts like data tiers.
128+
129+
* **Watcher** is not available, in favor of [**Alerts**](docs-content://explore-analyze/alerts-cases/alerts.md#rules-alerts).
130+
131+
Kibana Alerts allows rich integrations across use cases like APM, metrics, security, and uptime. Prepackaged rule types simplify setup and hide the details of complex, domain-specific detections, while providing a consistent interface across Kibana.
132+
133+
134+
135+
### Planned features [elasticsearch-differences-serverless-feature-planned]
136+
137+
The following features are planned for future support in all {{serverless-full}} projects:
138+
139+
* Reindexing from remote clusters
140+
* Cross-project search and replication
141+
* Snapshot and restore
142+
* Migrations from non-serverless deployments
143+
* Audit logging
144+
* Clone index API
145+
* Traffic filtering and VPCs
146+
147+
148+
149+
### Unplanned features [elasticsearch-differences-serverless-feature-unavailable]
150+
151+
The following features are not available in {{es-serverless}} and are not planned for future support:
152+
153+
* [Custom plugins and bundles](docs-content://deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md)
154+
* {{es}} for Apache Hadoop
155+
* [Scripted metric aggregations](/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md)
156+
* Managed web crawler: You can use the [self-managed web crawler](https://github.com/elastic/crawler) instead.
157+
* Managed Search connectors: You can use [self-managed Search connectors](/reference/ingestion-tools/search-connectors/self-managed-connectors.md) instead.

docs/reference/elasticsearch/configuration-reference/monitoring-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ By default, {{es}} {{monitor-features}} are enabled but data collection is disab
2222

2323
Except where noted otherwise, these settings can be dynamically updated on a live cluster with the [cluster-update-settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) API.
2424

25-
To adjust how monitoring data is displayed in the monitoring UI, configure [`xpack.monitoring` settings](kibana://docs/reference/configuration-reference/monitoring-settings.md) in `kibana.yml`. To control how monitoring data is collected from {{ls}}, configure monitoring settings in `logstash.yml`.
25+
To adjust how monitoring data is displayed in the monitoring UI, configure [`xpack.monitoring` settings](kibana://reference/configuration-reference/monitoring-settings.md) in `kibana.yml`. To control how monitoring data is collected from {{ls}}, configure monitoring settings in `logstash.yml`.
2626

2727
For more information, see [Monitor a cluster](docs-content://deploy-manage/monitor.md).
2828

docs/reference/elasticsearch/configuration-reference/security-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ All of these settings can be added to the `elasticsearch.yml` configuration file
2121
`xpack.security.enabled`
2222
: ([Static](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#static-cluster-setting)) Defaults to `true`, which enables {{es}} {{security-features}} on the node. This setting must be enabled to use Elasticsearch’s authentication, authorization and audit features.<br>
2323

24-
If set to `false`, {{security-features}} are disabled, which is not recommended. It also affects all {{kib}} instances that connect to this {{es}} instance; you do not need to disable {{security-features}} in those `kibana.yml` files. For more information about disabling {{security-features}} in specific {{kib}} instances, see [{{kib}} security settings](kibana://docs/reference/configuration-reference/security-settings.md).
24+
If set to `false`, {{security-features}} are disabled, which is not recommended. It also affects all {{kib}} instances that connect to this {{es}} instance; you do not need to disable {{security-features}} in those `kibana.yml` files. For more information about disabling {{security-features}} in specific {{kib}} instances, see [{{kib}} security settings](kibana://reference/configuration-reference/security-settings.md).
2525

2626

2727
`xpack.security.autoconfiguration.enabled`

0 commit comments

Comments
 (0)