You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This repo contains source files for Elastic documentation.
6
6
7
7
## Contribute
8
8
9
-
If you find any bugs in our documentation, or want to request an enhancement, please [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
9
+
If you find any bugs in our documentation, or want to request an enhancement, [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
10
10
11
11
We write our docs in markdown. See our [syntax guide](https://elastic.github.io/docs-builder/syntax/index.html) for examples and additional functionality.
*[**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).
3
+
*[**{{ecloud}}**](/deploy-manage/deploy/elastic-cloud.md): Get a hosted solution up and running in minutes.
4
+
*[**{{ech}}**](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md): Our hosted {{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
+
*[**{{serverless-full}}**](/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
6
*[**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing.
7
7
8
8
**Advanced options**
9
9
10
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.
11
+
*[**{{ece}}**](https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html): Deploy {{ecloud}} on public or private clouds, virtual machines, or your own premises.
{{ecloud}} has built-in security. For example, HTTPS communications between {{ecloud}} and the internet, as well as inter-node communications, are secured automatically, and cluster data is encrypted at rest.
2
+
3
+
In {{ech}}, you can augment these security features in the following ways:
4
+
* Configure [traffic filtering](/deploy-manage/security/traffic-filtering.md) to prevent unauthorized access to your deployments.
5
+
* Encrypt your deployment with a [customer-managed encryption key](/deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md).
6
+
*[Secure your settings](/deploy-manage/security/secure-settings.md) using {{es}} and {{kib}} keystores.
7
+
* Use the list of [{{ecloud}} static IPs](/deploy-manage/security/elastic-cloud-static-ips.md) to allow or restrict communications in your infrastructure.
8
+
9
+
{{ech}} doesn't support custom SSL certificates, which means that a custom CNAME for an {{ech}} endpoint such as *mycluster.mycompanyname.com* also is not supported.
10
+
11
+
Refer to [{{ecloud}} security](https://www.elastic.co/cloud/security) for more details about Elastic security and privacy programs.
Copy file name to clipboardExpand all lines: deploy-manage/api-keys/elasticsearch-api-keys.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ mapped_pages:
9
9
10
10
Several types of {{es}} API keys exist:
11
11
12
-
***Personal/User** API key: allows external services to access the Elastic Stack on behalf of a user.
12
+
***Personal/User** API key: allows external services to access the {{stack}} on behalf of a user.
13
13
***Cross-cluster** API key: allows other clusters to connect to this cluster.
14
-
***Managed** API key: created and managed by Kibana to run background tasks.
14
+
***Managed** API key: created and managed by {{kib}} to run background tasks.
15
15
16
16
To manage API keys in {{kib}}, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
Copy file name to clipboardExpand all lines: deploy-manage/autoscaling.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ By default, {{serverless-full}} automatically scales your {{es}} resources based
23
23
This feature is designed for indirect use by {{ech}}, {{ece}}, and {{eck}}. Direct use is not supported.
24
24
::::
25
25
26
-
Cluster autoscaling allows an operator to create tiers of nodes that monitor themselves and determine if scaling is needed based on an operator-defined policy. An Elasticsearch cluster can use the autoscaling API to report when additional resources are required. For example, an operator can define a policy that scales a warm tier based on available disk space. Elasticsearch monitors disk space in the warm tier. If it predicts low disk space for current and future shard copies, the autoscaling API reports that the cluster needs to scale. It remains the responsibility of the operator to add the additional resources that the cluster signals it requires.
26
+
Cluster autoscaling allows an operator to create tiers of nodes that monitor themselves and determine if scaling is needed based on an operator-defined policy. An {{es}} cluster can use the autoscaling API to report when additional resources are required. For example, an operator can define a policy that scales a warm tier based on available disk space. {{es}} monitors disk space in the warm tier. If it predicts low disk space for current and future shard copies, the autoscaling API reports that the cluster needs to scale. It remains the responsibility of the operator to add the additional resources that the cluster signals it requires.
27
27
28
28
A policy is composed of a list of roles and a list of deciders. The policy governs the nodes matching the roles. The deciders provide independent estimates of the capacity required. See [Autoscaling deciders](../deploy-manage/autoscaling/autoscaling-deciders.md) for details on available deciders.
Copy file name to clipboardExpand all lines: deploy-manage/autoscaling/autoscaling-deciders.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ applies_to:
16
16
17
17
# Autoscaling deciders [autoscaling-deciders]
18
18
19
-
[Autoscaling](/deploy-manage/autoscaling.md) in Elasticsearch enables dynamic resource allocation based on predefined policies. A key component of this mechanism is autoscaling deciders, which independently assess resource requirements and determine when scaling actions are necessary. Deciders analyze various factors, such as storage usage, indexing rates, and machine learning workloads, to ensure clusters maintain optimal performance without manual intervention.
19
+
[Autoscaling](/deploy-manage/autoscaling.md) in {{es}} enables dynamic resource allocation based on predefined policies. A key component of this mechanism is autoscaling deciders, which independently assess resource requirements and determine when scaling actions are necessary. Deciders analyze various factors, such as storage usage, indexing rates, and machine learning workloads, to ensure clusters maintain optimal performance without manual intervention.
20
20
21
21
::::{admonition} Indirect use only
22
22
This feature is designed for indirect use by {{ech}}, {{ece}}, and {{eck}}. Direct use is not supported.
@@ -96,7 +96,7 @@ The [autoscaling](../../deploy-manage/autoscaling.md) frozen shards decider (`fr
: (Optional, [byte value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) The memory needed per shard, in bytes. Defaults to 2000 shards per 64 GB node (roughly 32 MB per shard). Notice that this is total memory, not heap, assuming that the Elasticsearch default heap sizing mechanism is used and that nodes are not bigger than 64 GB.
99
+
: (Optional, [byte value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#byte-units)) The memory needed per shard, in bytes. Defaults to 2000 shards per 64 GB node (roughly 32 MB per shard). Notice that this is total memory, not heap, assuming that the {{es}} default heap sizing mechanism is used and that nodes are not bigger than 64 GB.
Copy file name to clipboardExpand all lines: deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md
+18-20Lines changed: 18 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ Currently, autoscaling behavior is as follows:
39
39
40
40
***Data tiers**
41
41
42
-
* Each Elasticsearch[data tier](../../manage-data/lifecycle/data-tiers.md) scales upward based on the amount of available storage. When we detect more storage is needed, autoscaling will scale up each data tier independently to ensure you can continue and ingest more data to your hot and content tier, or move data to the warm, cold, or frozen data tiers.
42
+
* Each {{es}}[data tier](../../manage-data/lifecycle/data-tiers.md) scales upward based on the amount of available storage. When we detect more storage is needed, autoscaling will scale up each data tier independently to ensure you can continue and ingest more data to your hot and content tier, or move data to the warm, cold, or frozen data tiers.
43
43
* In addition to scaling up existing data tiers, a new data tier will be automatically added when necessary, based on your [index lifecycle management policies](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-index-management.html).
44
44
* To control the maximum size of each data tier and ensure it will not scale above a certain size, you can use the maximum size per zone field.
45
45
* Autoscaling based on memory or CPU, as well as autoscaling downward, is not currently supported. In case you want to adjust the size of your data tier to add more memory or CPU, or in case you deleted data and want to scale it down, you can set the current size per zone of each data tier manually.
@@ -53,7 +53,7 @@ Currently, autoscaling behavior is as follows:
53
53
* The determination of when to scale is based on the expected memory and CPU requirements for the currently configured machine learning jobs and trained models.
54
54
55
55
::::{note}
56
-
For any Elasticsearch component the number of availability zones is not affected by autoscaling. You can always set the number of availability zones manually and the autoscaling mechanism will add or remove capacity per availability zone.
56
+
For any {{es}} component the number of availability zones is not affected by autoscaling. You can always set the number of availability zones manually and the autoscaling mechanism will add or remove capacity per availability zone.
57
57
::::
58
58
59
59
## When does autoscaling occur?[ec-autoscaling-factors]
@@ -81,7 +81,7 @@ In {{ece}} deployments, a warning is also issued in the ECE `service-constructor
81
81
82
82
The following are known limitations and restrictions with autoscaling:
83
83
84
-
* Autoscaling will not run if the cluster is unhealthy or if the last Elasticsearch plan failed.
84
+
* Autoscaling will not run if the cluster is unhealthy or if the last {{es}} plan failed.
85
85
86
86
In {{ech}} the following additional limitations apply:
87
87
@@ -129,12 +129,12 @@ Each autoscaling setting is configured with a default value. You can adjust thes
129
129
130
130
% ECE NOTE
131
131
::::{note} - {{ece}}
132
-
On Elastic Cloud Enterprise, system-owned deployment templates include the default values for all deployment autoscaling settings.
132
+
On {{ece}}, system-owned deployment templates include the default values for all deployment autoscaling settings.
133
133
::::
134
134
135
135
## Autoscaling example [ec-autoscaling-example]
136
136
137
-
To help you better understand the available autoscaling settings, this example describes a typical autoscaling workflow on sample Elastic Cloud Enterprise or {{ech}} deployment.
137
+
To help you better understand the available autoscaling settings, this example describes a typical autoscaling workflow on sample {{ece}} or {{ech}} deployment.
138
138
139
139
1. Enable autoscaling:
140
140
@@ -145,14 +145,13 @@ To help you better understand the available autoscaling settings, this example d
145
145
146
146
2. View and adjust autoscaling settings on data tiers:
147
147
148
-
1. Open the **Edit** page for your deployment to get the current and maximum size per zone of each Elasticsearch data tier. In this example, the hot data and content tier has the following settings:
148
+
1. Open the **Edit** page for your deployment to get the current and maximum size per zone of each {{es}} data tier. In this example, the hot data and content tier has the following settings:
149
149
150
-
||||
151
-
| --- | --- | --- |
152
-
|**Current size per zone**|**Maximum size per zone**||
153
-
| 45GB storage | 1.41TB storage ||
154
-
| 1GB RAM | 32GB RAM ||
155
-
| Up to 2.5 vCPU | 5 vCPU ||
150
+
| Current size per zone | Maximum size per zone |
151
+
| --- | --- |
152
+
| 45GB storage | 1.41TB storage |
153
+
| 1GB RAM | 32GB RAM |
154
+
| Up to 2.5 vCPU | 5 vCPU |
156
155
157
156
The fault tolerance for the data tier is set to 2 availability zones.
158
157
@@ -166,11 +165,10 @@ To help you better understand the available autoscaling settings, this example d
166
165
167
166
1. From the deployment **Edit** page you can check the minimum and maximum size of your deployment’s machine learning instances. In this example, the machine learning instance has the following settings:
168
167
169
-
||||
170
-
| --- | --- | --- |
171
-
|**Minimum size per zone**|**Maximum size per zone**||
172
-
| 1GB RAM | 64GB RAM ||
173
-
| 0.5 vCPU up to 8 vCPU | 32 vCPU ||
168
+
| Minimum size per zone | Maximum size per zone |
169
+
| --- | --- |
170
+
| 1GB RAM | 64GB RAM |
171
+
| 0.5 vCPU up to 8 vCPU | 32 vCPU |
174
172
175
173
The fault tolerance for the machine learning instance is set to 1 availability zone.
176
174
@@ -197,8 +195,8 @@ To learn more about the {{ece}} API, see the [RESTful API](cloud://reference/clo
197
195
198
196
Note the following requirements when you run this API request:
199
197
200
-
* All Elasticsearch components must be included in the request, even if they are not enabled (that is, if they have a zero size). All components are included in this example.
201
-
* The request requires a format that supports data tiers. Specifically, all Elasticsearch components must contain the following properties:
198
+
* All {{es}} components must be included in the request, even if they are not enabled (that is, if they have a zero size). All components are included in this example.
199
+
* The request requires a format that supports data tiers. Specifically, all {{es}} components must contain the following properties:
0 commit comments