Skip to content

Commit 3e530fd

Browse files
Merge branch 'main' into ea-align
2 parents a43722f + b45378d commit 3e530fd

File tree

349 files changed

+2352
-2025
lines changed

Some content is hidden

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

349 files changed

+2352
-2025
lines changed

cloud-account/join-or-leave-an-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If you already belong to an organization, and you want to join a new one you wil
3535

3636
Alternatively, for Elastic Cloud Hosted deployments, there's a possibility to migrate your deployments to the new organization through back up and restore operations. In such case:
3737

38-
1. [Back up your deployments to any private repository](/deploy-manage/tools/snapshot-and-restore/ec-custom-repository.md) so that you can restore them to your new organization.
38+
1. [Back up your deployments to any private repository](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md) so that you can restore them to your new organization.
3939
2. Leave your current organization.
4040
3. Ask the administrator to invite you to the organization you want to join.
4141
4. Accept the invitation that you will get by email.
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+
:::::
Lines changed: 89 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,103 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_urls:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-generate-roles-token.html
47
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-revoke-roles-token.html
58
---
69

7-
# Generate roles tokens
10+
# Manage roles tokens
811

9-
% What needs to be done: Refine
12+
At the end of the {{ece}} installation process on the first host, you are provided with a roles token. This token can be used to install {{ece}} on additional hosts, but it does not include any role permissions.
1013

11-
% GitHub issue: https://github.com/elastic/docs-projects/issues/339
14+
You can [assign roles](./assign-roles-to-hosts.md) to the additional hosts through the Cloud UI later on, but this role assignment is a manual process.
1215

13-
% Scope notes: merge these two pages
16+
For automation purposes, you need to generate a new *ephemeral* or *persistent* token with the right role permissions, so that you can install {{ece}} on hosts and add the right roles at the same time.
1417

15-
% Use migrated content from existing pages that map to this page:
18+
This section covers the different types of tokens and the following tasks:
1619

17-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md
18-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md
20+
* [Generate roles tokens](#ece-generate-roles-token)
21+
* [Revoke roles tokens](#ece-revoke-roles-token)
1922

20-
⚠️ **This page is a work in progress.** ⚠️
23+
## Ephemeral and persistent roles tokens
2124

22-
The documentation team is working to combine content pulled from the following pages:
25+
Ephemeral and persistent tokens differ as follows:
2326

24-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-generate-roles-token.md)
25-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md](/raw-migrated-files/cloud/cloud-enterprise/ece-revoke-roles-token.md)
27+
Ephemeral token
28+
: Available for use during {{ece}} installation on additional hosts for one hour before the token is revoked automatically. Cannot be revoked manually.
29+
30+
Persistent token
31+
: Available for use during {{ece}} installation on additional hosts indefinitely. Can be revoked at any time.
32+
33+
The permitted roles are the same as those you can [assign in the Cloud UI](./assign-roles-to-hosts.md):
34+
35+
`allocator`
36+
: Allocates the available computing resources to Elasticsearch nodes or Kibana instances. In larger installations, a majority of the machines will be allocators.
37+
38+
`coordinator`
39+
: Serves as a distributed coordination system and resource scheduler.
40+
41+
`proxy`
42+
: Manages communication between a user and an Elasticsearch or Kibana instance.
43+
44+
`director`
45+
: Manages the ZooKeeper datastore. This role is typically shared with the coordinator role. In production deployments it can be separated from a coordinator.
46+
47+
## Generate roles tokens [ece-generate-roles-token]
48+
49+
To generate an ephemeral token for additional allocators:
50+
51+
```sh
52+
curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": [ "allocator"] }'
53+
{
54+
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Njk3N2I3ZC1hM2U2LTQ2MDUtYjcwZC0xNzIzMTI5YWY4ZTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCIsImV4cCI6MTQ5MzY0NjIxM30.xsaRb72CsNMuXKy6Y-PJgqLc0qmjCljlB4Smcx_MRxg"
55+
}
56+
```
57+
58+
To generate a persistent token for additional allocators:
59+
60+
```sh
61+
curl -H 'Content-Type: application/json' -u USER:PASSWORD https://COORDINATOR_HOST_IP:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": true, "roles": [ "allocator"] }'
62+
{
63+
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0Yzg5OTBkZi0xZmI3LTQ4MjAtYjg2OC02YmM5ZTg4NjA4MTQiLCJyb2xlcyI6WyJwcm94eSIsImFsbG9jYXRvciJdLCJpc3MiOiJib290c3RyYXAtaW5pdGlhbCJ9.mfTkO4j8uZJ-qwB2jmBuMScyYfLmcJpvKgSTLx2WV24",
64+
"token_id": "4c8990df-1fb7-4820-b868-6bc9e8860814"
65+
}
66+
```
67+
68+
## Revoke roles tokens [ece-revoke-roles-token]
69+
70+
At the end of the {{ece}} installation process on the first host, you are provided with a roles token. You can also generate new roles tokens yourself, either as ephemeral tokens that get deleted after 24 hours or as persistent tokens that get stored by {{ece}}. These tokens enable additional hosts to join an {{ece}} installation and should be kept secure or deleted if they are no longer needed.
71+
72+
If you delete all tokens and need to add more hosts to your installation, you should generate a new token first.
73+
74+
::::{important}
75+
During installation, an emergency token gets generated that enables you to install {{ece}} on additional hosts with all roles already assigned, except the allocator role. The emergency token can save your installation if all coordinators fail or are removed and you can no longer use the Cloud UI or the RESTful API. You should not delete this token. To learn more, check [Using the Emergency Roles Token](/troubleshoot/deployments/cloud-enterprise/use-emergency-roles-token.md).
76+
::::
77+
78+
To delete a token:
79+
80+
1. Retrieve the list of available tokens through the RESTful API :
81+
82+
```sh
83+
curl -u USER:PASSWORD https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens
84+
{
85+
"tokens": [{
86+
"token_id": "5f9cad2f-c6e7-4ee2-8f6e-53225df45be5",
87+
"roles": []
88+
}, {
89+
"token_id": "4c8990df-1fb7-4820-b868-6bc9e8860814",
90+
"roles": ["proxy", "allocator"]
91+
}]
92+
}
93+
```
94+
95+
2. Use the token ID to delete the tokens you no longer need: `4c8990df-1fb7-4820-b868-6bc9e8860814`:
96+
97+
```sh
98+
curl -XDELETE -u USER:PASSWORD 'https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens/4c8990df-1fb7-4820-b868-6bc9e8860814'
99+
{
100+
}
101+
```
102+
103+
3. Optional: To check that the token has been deleted, repeat Step 1 and make sure that the token is no longer listed.

deploy-manage/deploy/cloud-enterprise/resize-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To resize a deployment:
2626
: If the initial deployment you created uses only one availability zone, it is not fault tolerant. On a production system, enable [high availability](ece-ha.md) by changing your deployment to use at least two availability zones, three for mission-critical deployments. The number of instances comes from the number of zones and the type of template. Having more nodes or instances lets you scale out horizontally by adding more processing capacity to your deployment.
2727

2828
::::{warning}
29-
Deployments that use only one availability zone are not highly available and are at risk of data loss, if you do not [configure an external snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md#ece-manage-repositories-add) to enable regular backups. To safeguard against data loss, you must use at least two data centers and configure an external repository for backups.
29+
Deployments that use only one availability zone are not highly available and are at risk of data loss, if you do not [configure an external snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups. To safeguard against data loss, you must use at least two data centers and configure an external repository for backups.
3030
::::
3131

3232

deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ECE lets you manage snapshot repositories, so that you can back up and restore y
4747

4848
As mentioned earlier, the `logging-and-metrics` cluster stores important information about your environment logs and metrics. There are also additional configurations provided out-of-the-box, such as data views (formerly *index patterns*), visualizations, and dashboards, that will require running an external script to recreate if you do not have a snapshot to restore from. We recommend that you also back up the `logging-and-metrics` cluster, though it is up to you to decide if that information should be available to be restored.
4949

50-
To configure snapshot repositories, check [Add snapshot repository configurations](../../tools/snapshot-and-restore/cloud-enterprise.md#ece-manage-repositories-add).
50+
To configure snapshot repositories, check [Add snapshot repository configurations](../../tools/snapshot-and-restore/cloud-enterprise.md).
5151

5252

5353
### Sizing [ece_sizing]

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+

0 commit comments

Comments
 (0)