Skip to content

Commit 7889084

Browse files
authored
Merge branch 'main' into deploy_ece
2 parents 8a3ceda + ee10feb commit 7889084

File tree

213 files changed

+1297
-4372
lines changed

Some content is hidden

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

213 files changed

+1297
-4372
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Quick start options**
2+
3+
* [**Elastic Cloud**](/deploy-manage/deploy/elastic-cloud.md): Get a hosted solution up and running in minutes.
4+
* [**Elastic Cloud Hosted**](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md): Our hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a [14-day free trial](https://cloud.elastic.co/registration).
5+
* [**Elastic Cloud Serverless**](/deploy-manage/deploy/elastic-cloud/serverless.md): Create serverless projects for autoscaled and fully managed Elastic deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
6+
* [**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing.
7+
8+
**Advanced options**
9+
10+
* [**Self-managed**](/deploy-manage/deploy/self-managed.md): Install, configure, and run Elastic on your own premises.
11+
* [**Elastic Cloud Enterprise**](https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
12+
* [**Elastic Cloud on Kubernetes**](/deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes.

deploy-manage/deploy.md

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
55
---
66

7-
# Deploy
8-
97
% What needs to be done: Write from scratch
108

119
% GitHub issue: https://github.com/elastic/docs-projects/issues/334
@@ -17,9 +15,90 @@ mapped_urls:
1715
% - [ ] ./raw-migrated-files/docs-content/serverless/intro.md
1816
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md
1917

20-
⚠️ **This page is a work in progress.** ⚠️
18+
# Deploy
19+
20+
Whether you're planning to use Elastic's pre-built solutions or Serverless projects, build your own applications with {{es}}, or analyze your data using {{kib}} tools, you'll need to deploy Elastic first.
21+
22+
This page will help you understand your deployment options and choose the approach that best fits your needs.
23+
24+
## Core components
25+
26+
Every Elastic deployment requires {{es}} as its core data store and search/analytics engine.
27+
Additionally, {{kib}} provides the user interface for all Elastic solutions and Serverless projects. It is required for most use cases, from data exploration to monitoring and security analysis.
28+
29+
Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need.
30+
31+
:::{tip}
32+
Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment.
33+
:::
34+
35+
## Choosing your deployment type
36+
37+
:::{include} _snippets/deployment-options-overview.md
38+
:::
39+
40+
### Who manages the infrastructure?
41+
42+
#### Managed by Elastic
43+
44+
If you want to focus on using Elastic products rather than managing infrastructure, choose:
45+
46+
- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features
47+
- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions
48+
49+
#### Self-hosted options
50+
51+
If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator:
52+
53+
- **Fully self-managed**: Complete control and responsibility for your Elastic deployment
54+
- **With orchestration**:
55+
- **Elastic Cloud on Kubernetes (ECK)**: If you need Kubernetes-native orchestration
56+
- **Elastic Cloud Enterprise (ECE)**: If you need a multi-tenant orchestration platform
57+
58+
:::::{note}
59+
:::{dropdown} About orchestration
60+
61+
An orchestrator automates the deployment and management of multiple Elastic clusters, handling tasks like scaling, upgrades, and monitoring.
62+
63+
Consider orchestration if you:
64+
- Need to manage multiple Elastic clusters
65+
- Want automated operations at scale
66+
- Have a Kubernetes environment (ECK)
67+
- Need to build a multi-tenant platform (ECE)
68+
69+
Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using ECK or ECE:
70+
- You'll still use the same Elasticsearch and Kibana features and configurations
71+
- Most product documentation remains applicable
72+
- You can add other Elastic products as needed
73+
- The orchestrator handles operational tasks while you focus on using and configuring the products
74+
75+
::::{tip}
76+
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
77+
::::
78+
:::
79+
:::::
80+
81+
### Versioning and compatibility
82+
83+
In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility.
84+
85+
With other deployment types ({{ecloud}} Hosted, ECE, and ECK), you control which {{stack}} versions you deploy and when you upgrade. The ECE and ECK orchestrators themselves also receive regular version updates, independent of the {{stack}} versions they manage.
86+
87+
Consider this when choosing your deployment type:
88+
89+
- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility
90+
- Choose other deployment types if you need more control over version management
91+
92+
:::{tip}
93+
Learn more about [versioning and availability](/get-started/versioning-availability.md).
94+
:::
95+
96+
### Cost considerations
2197

22-
The documentation team is working to combine content pulled from the following pages:
98+
- **Serverless**: Pay for what you use
99+
- **Cloud hosted**: Subscription-based with resource allocation
100+
- **Self-hosted options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO)
23101

24-
* [/raw-migrated-files/docs-content/serverless/intro.md](/raw-migrated-files/docs-content/serverless/intro.md)
25-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
102+
:::::{tip}
103+
For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md).
104+
:::::

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ Advanced users may force an upgrade by manually deleting Pods themselves. The de
176176
Operations that reduce the number of nodes in the cluster cannot make progress without user intervention, if the Elasticsearch index replica settings are incompatible with the intended downscale. Specifically, if the Elasticsearch index settings demand a higher number of shard copies than data nodes in the cluster after the downscale operation, ECK cannot migrate the data away from the node about to be removed. You can address this in the following ways:
177177

178178
* Adjust the Elasticsearch [index settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) to a number of replicas that allow the desired node removal.
179-
* Use [`auto_expand_replicas`](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index.md#dynamic-index-settings) to automatically adjust the replicas to the number of data nodes in the cluster.
179+
* Use [`auto_expand_replicas`](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index-modules.md) to automatically adjust the replicas to the number of data nodes in the cluster.
180180

181181

182182
## Advanced control during rolling upgrades [k8s-advanced-upgrade-control]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The kernel setting `vm.max_map_count=262144` can be set on the host directly, by
1313

1414
For more information, check the Elasticsearch documentation on [Virtual memory](/deploy-manage/deploy/self-managed/vm-max-map-count.md).
1515

16-
Optionally, you can select a different type of file system implementation for the storage. For possible options, check the [store module documentation](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index-store-settings.md).
16+
Optionally, you can select a different type of file system implementation for the storage. For possible options, check the [store module documentation](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/store.md).
1717

1818
```yaml
1919
spec:
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
# Deployment comparison reference
3+
4+
This reference provides detailed comparisons of features and capabilities across Elastic's deployment options: self-managed deployments, Elastic Cloud Hosted, and Serverless. For a high-level overview of deployment types and guidance on choosing between them, see the [overview](../deploy.md).
5+
6+
## Security features
7+
8+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
9+
|-------------------|-------------|--------------------------------|-------------------------|
10+
| Custom security configurations | Yes | Limited | No |
11+
| Authentication realms and custom roles | Yes | Yes | No |
12+
| Audit logging | Yes | Yes | No |
13+
14+
## Management features
15+
16+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
17+
|-------------------|-------------|--------------------------------|-------------------------|
18+
| Full control over configuration | Yes | Limited | No |
19+
| Infrastructure flexibility | Yes | No | No |
20+
| Autoscaling | No | Yes | Yes |
21+
| Data tiers management | No | Yes | No |
22+
| Snapshot management | No | Yes | No |
23+
| High availability and disaster recovery | Yes | Yes | Yes |
24+
| Multi-cloud support | No | Yes | Yes |
25+
| Shard management and replicas | Yes | Yes | No |
26+
27+
## Monitoring features
28+
29+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
30+
|-------------------|-------------|--------------------------------|-------------------------|
31+
| Watcher | Yes | Yes | No |
32+
33+
## Data lifecycle features
34+
35+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
36+
|-------------------|-------------|--------------------------------|-------------------------|
37+
| Index lifecycle management (ILM) | Yes | Yes | No (uses data streams) |
38+
| Data tiers management | No | Yes | No |
39+
| Snapshot management | No | Yes | No |
40+
41+
## Integration features
42+
43+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
44+
|-------------------|-------------|--------------------------------|-------------------------|
45+
| Custom plugins | Yes | No | No |
46+
| Self-managed connectors | Yes | No | Limited |
47+
| Elasticsearch-Hadoop integration | Yes | Yes | No |
48+
| Cross cluster search (CCS) | Yes | Yes | No |
49+
| Cross cluster replication | Yes | Yes | Yes |
50+
51+
## Development and testing features
52+
53+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
54+
|-------------------|-------------|--------------------------------|-------------------------|
55+
| Advanced testing and development | Yes | No | No |
56+
| Java (JVM) customization | Yes | No | No |
57+

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

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ When attempting to use an unavailable API, you’ll receive a clear error messag
9292

9393
## Settings availability [elasticsearch-differences-serverless-settings-availability]
9494

95-
In {{es-serverless}}, you can only configure [index-level settings](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index.md#index-modules-settings). Cluster-level settings and node-level settings are not required by end users and the `elasticsearch.yml` file is fully managed by Elastic.
95+
In {{es-serverless}}, you can only configure [index-level settings](asciidocalypse://docs/elasticsearch/docs/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.
9696

9797
Available settings
9898
: **Index-level settings**: Settings that control how {{es}} documents are processed, stored, and searched are available to end users. These include:
@@ -146,24 +146,12 @@ The following features are planned for future support in all {{serverless-full}}
146146
* Clone index API
147147
* Traffic filtering and VPCs
148148

149-
The following {{es-serverless}} project-specific features are planned for future support:
150-
151-
* [Behavioral Analytics](../../../solutions/search/site-or-app/behavioral-analytics.md)
152-
* [Search Applications](../../../solutions/search/search-applications.md)
153-
* Managed web crawler
154-
155-
You can use the [self-managed web crawler](https://github.com/elastic/crawler) in the meantime.
156-
157-
* Managed Search connectors
158-
159-
You can use [self-managed Search connectors](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) in the meantime.
160-
161-
162-
163149
### Unplanned features [elasticsearch-differences-serverless-feature-unavailable]
164150

165151
The following features are not available in {{es-serverless}} and are not planned for future support:
166152

167153
* [Custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md)
168154
* [{{es}} for Apache Hadoop](asciidocalypse://docs/elasticsearch-hadoop/docs/reference/ingestion-tools/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md)
169155
* [Scripted metric aggregations](asciidocalypse://docs/elasticsearch/docs/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](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) instead.

deploy-manage/deploy/self-managed.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,4 @@ mapped_pages:
55

66
# Self-managed cluster [dependencies-versions]
77

8-
See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.
9-
8+
See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.

deploy-manage/deploy/self-managed/bootstrap-checks-max-map-count.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ mapped_pages:
77

88
Continuing from the previous [point](max-size-virtual-memory-check.md), to use `mmap` effectively, Elasticsearch also requires the ability to create many memory-mapped areas. The maximum map count check checks that the kernel allows a process to have at least 262,144 memory-mapped areas and is enforced on Linux only. To pass the maximum map count check, you must configure `vm.max_map_count` via `sysctl` to be at least `262144`.
99

10-
Alternatively, the maximum map count check is only needed if you are using `mmapfs` or `hybridfs` as the [store type](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index-store-settings.md) for your indices. If you [do not allow](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/index-store-settings.md#allow-mmap) the use of `mmap` then this bootstrap check will not be enforced.
10+
Alternatively, the maximum map count check is only needed if you are using `mmapfs` or `hybridfs` as the [store type](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/store.md) for your indices. If you [do not allow](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/store.md#allow-mmap) the use of `mmap` then this bootstrap check will not be enforced.
1111

deploy-manage/deploy/self-managed/deploy-cluster.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ $$$dedicated-host$$$
2424

2525
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
2626

27-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
2827
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md)
2928

3029
% Doesn't exist

deploy-manage/deploy/self-managed/important-settings-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Don’t modify anything within the data directory or run processes that might in
6060
::::
6161
6262
63-
Elasticsearch offers a deprecated setting that allows you to specify multiple paths in `path.data`. To learn about this setting, and how to migrate away from it, refer to [Multiple data paths](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/path-settings.md#multiple-data-paths).
63+
Elasticsearch offers a deprecated setting that allows you to specify multiple paths in `path.data`. To learn about this setting, and how to migrate away from it, refer to [Multiple data paths](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/index-settings/path.md#multiple-data-paths).
6464

6565

6666
## Cluster name setting [_cluster_name_setting]

0 commit comments

Comments
 (0)