Skip to content

Commit 7cfe56e

Browse files
replace asciidocalypse elasticsearch links
1 parent 9cf6823 commit 7cfe56e

File tree

475 files changed

+2317
-2317
lines changed

Some content is hidden

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

475 files changed

+2317
-2317
lines changed

deploy-manage/cloud-organization/tools-and-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
1818
Elasticsearch APIs
1919
: This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.
2020

21-
To use these APIs on {{ecloud}} read our topic [Access the API console](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/rest-apis/index.md).
21+
To use these APIs on {{ecloud}} read our topic [Access the API console](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](elasticsearch://reference/elasticsearch/rest-apis/index.md).
2222

2323
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.
2424

deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
mapped_pages:
2+
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-custom-bundle-plugin.html
44
navigation_title: "Custom bundles and plugins"
5-
applies_to:
5+
applies_to:
66
deployment:
77
ece:
88
---
@@ -360,7 +360,7 @@ You do not need to do this step if you are using default filename and password (
360360
}
361361
```
362362
363-
4. To use this bundle, you can refer it in the [GeoIP processor](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/enrich-processor/geoip-processor.md) of an ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file` such as:
363+
4. To use this bundle, you can refer it in the [GeoIP processor](elasticsearch://reference/ingestion-tools/enrich-processor/geoip-processor.md) of an ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file` such as:
364364
365365
```sh
366366
...

deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `node_roles` field defines the roles that an Elasticsearch topology element
1717
There are a number of fields that need to be added to each Elasticsearch node in order to support `node_roles`:
1818

1919
* **id**: Unique identifier of the topology element. This field, along with the `node_roles`, identifies an Elasticsearch topology element.
20-
* **node_roles**: The list of node roles. Allowable roles are: `master`, `ingest`, `ml`, `data_hot`, `data_content`, `data_warm`, `data_cold`, `data_frozen`, `remote_cluster_client`, and `transform`. For details, check [Node roles](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#node-roles).
20+
* **node_roles**: The list of node roles. Allowable roles are: `master`, `ingest`, `ml`, `data_hot`, `data_content`, `data_warm`, `data_cold`, `data_frozen`, `remote_cluster_client`, and `transform`. For details, check [Node roles](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles).
2121
* **topology_element_control**: Controls for the topology element.
2222

2323
* **min**: The absolute minimum size limit for a topology element. If the value is `0`, that means the topology element can be disabled.

deploy-manage/deploy/cloud-enterprise/ece-ha.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Increasing the number of zones should not be used to add more resources. The con
3131

3232
## Master nodes [ece-ece-ha-2-master-nodes]
3333

34-
$$$ece-ha-tiebreaker$$$Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available.
34+
$$$ece-ha-tiebreaker$$$Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available.
3535

3636
When you create a cluster with nodes in two availability zones when a third zone is available, Elastic Cloud Enterprise can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By tagging allocators hosts in Elastic Cloud Enterprise, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down.
3737

38-
By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone.
38+
By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone.
3939

4040
::::{warning}
4141
Clusters that only have two or fewer master-eligible node are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. You must have [at least three master-eligible nodes](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md).

deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ This section focuses on the allocator role, and explains how to plan its capacit
1515
* [Storage](#ece-alloc-storage)
1616

1717

18-
## Memory [ece-alloc-memory]
18+
## Memory [ece-alloc-memory]
1919

2020
You should plan your deployment size based on the amount of data you ingest. Memory is the main scaling unit for a deployment. Other units, like CPU and disks, are proportional to the memory size. The memory available for an allocator is called *capacity*.
2121

2222
During installation, the allocator capacity defaults to 85% of the host physical memory, as the rest is reserved for ECE system services.
2323

24-
::::{note}
24+
::::{note}
2525
ECE does not support hot-adding of resources to a running node. When increasing CPU/memory allocated to a ECE node, a restart is needed to utilize the additional resources.
2626
::::
2727

@@ -38,13 +38,13 @@ curl -X PUT \
3838

3939
For more information on how to use API keys for authentication, check the section [Access the API from the Command Line](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/ece-api-command-line.md).
4040

41-
::::{important}
41+
::::{important}
4242
Prior to ECE 3.5.0, regardless of the use of this API, the [CPU quota](#ece-alloc-cpu) used the memory specified at installation time.
4343
::::
4444

4545

4646

47-
### Examples [ece_examples]
47+
### Examples [ece_examples]
4848

4949
Here are some examples to make Elastic deployments and ECE system services run smoothly on your host:
5050

@@ -56,14 +56,14 @@ Note that the recommended reservations above are not guaranteed upper limits, if
5656
These fluctuations should not be a concern in practice. To get actual limits that could be used in alerts, you could add 4GB to the recommended values above.
5757

5858

59-
## CPU quotas [ece-alloc-cpu]
59+
## CPU quotas [ece-alloc-cpu]
6060

6161
ECE uses CPU quotas to assign shares of the allocator host to the instances that are running on it. To calculate the CPU quota, use the following formula:
6262

6363
`CPU quota = DeploymentRAM / HostCapacity`
6464

6565

66-
### Examples [ece_examples_2]
66+
### Examples [ece_examples_2]
6767

6868
Consider a 32GB deployment hosted on a 128GB allocator.
6969

@@ -84,19 +84,19 @@ If you use 12GB Allocator system service reservation, the CPU quota is 28%:
8484
Those percentages represent the upper limit of the % of the total CPU resources available in a given 100ms period.
8585

8686

87-
## Processors setting [ece-alloc-processors-setting]
87+
## Processors setting [ece-alloc-processors-setting]
8888

8989
In addition to the [CPU quotas](#ece-alloc-cpu), the `processors` setting also plays a relevant role.
9090

91-
The allocated `processors` setting originates from Elasticsearch and is responsible for calculating your [thread pools](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/thread-pool-settings.md#node.processors). While the CPU quota defines the percentage of the total CPU resources of an allocator that are assigned to an instance, the allocated `processors` define how the thread pools are calculated in Elasticsearch, and therefore how many concurrent search and indexing requests an instance can process. In other words, the CPU ratio defines how fast a single task can be completed, while the `processors` setting defines how many different tasks can be completed at the same time.
91+
The allocated `processors` setting originates from Elasticsearch and is responsible for calculating your [thread pools](elasticsearch://reference/elasticsearch/configuration-reference/thread-pool-settings.md#node.processors). While the CPU quota defines the percentage of the total CPU resources of an allocator that are assigned to an instance, the allocated `processors` define how the thread pools are calculated in Elasticsearch, and therefore how many concurrent search and indexing requests an instance can process. In other words, the CPU ratio defines how fast a single task can be completed, while the `processors` setting defines how many different tasks can be completed at the same time.
9292

9393
We rely on Elasticsearch and the `-XX:ActiveProcessorCount` JVM setting to automatically detect the allocated `processors`.
9494

95-
In earlier versions of ECE and Elasticsearch, the [Elasticsearch processors](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/thread-pool-settings.md#node.processors) setting was used to configure the allocated `processors` according to the following formula:
95+
In earlier versions of ECE and Elasticsearch, the [Elasticsearch processors](elasticsearch://reference/elasticsearch/configuration-reference/thread-pool-settings.md#node.processors) setting was used to configure the allocated `processors` according to the following formula:
9696

9797
`Math.min(16,Math.max(2,(16*instanceCapacity*1.0/1024/64).toInt))`
9898

99-
The following table gives an overview of the allocated `processors` that are used to calculate the Elasticsearch [thread pools](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/thread-pool-settings.md) based on the preceding formula:
99+
The following table gives an overview of the allocated `processors` that are used to calculate the Elasticsearch [thread pools](elasticsearch://reference/elasticsearch/configuration-reference/thread-pool-settings.md) based on the preceding formula:
100100

101101
| instance size | vCPU |
102102
| --- | --- |
@@ -110,18 +110,18 @@ The following table gives an overview of the allocated `processors` that are use
110110
This table also provides a rough indication of what the auto-detected value could be on newer versions of ECE and Elasticsearch.
111111

112112

113-
## Storage [ece-alloc-storage]
113+
## Storage [ece-alloc-storage]
114114

115115
ECE has specific [hardware prerequisites](ece-hardware-prereq.md) for storage. Disk space is consumed by system logs, container overhead, and deployment data.
116116

117117
The main factor for selecting a disk quota is the deployment data, that is, data from your Elasticsearch, Kibana, and APM nodes. The biggest portion of data is consumed by the Elasticsearch nodes.
118118

119-
::::{note}
119+
::::{note}
120120
ECE uses [XFS](ece-software-prereq.md#ece-xfs) to enforce specific disk space quotas to control the disk consumption for the deployment nodes running on your allocator.
121121
::::
122122

123123

124-
::::{important}
124+
::::{important}
125125
You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly.
126126
::::
127127

@@ -144,7 +144,7 @@ You can change the value of the disk multiplier at different levels:
144144
3. Adjust the disk quota to your needs.
145145

146146

147-
::::{important}
147+
::::{important}
148148
The override only persists during the lifecycle of the instance container. If a new container is created, for example during a `grow_and_shrink` plan or a vacate operation, the quota is reset to its default. To increase the storage ratio in a persistent way, [edit the instance configurations](ece-configuring-ece-instance-configurations-edit.md).
149149
::::
150150

deploy-manage/deploy/cloud-enterprise/post-installation-steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88
After your Elastic Cloud Enterprise installation is up, some additional steps might be required:
99

1010
* Add your own load balancer. Load balancers are user supplied and we do not currently provide configuration steps for you.
11-
* [Add more capacity](../../maintenance/ece/scale-out-installation.md) to your Elastic Cloud Enterprise installation, [resize your deployment](resize-deployment.md), [upgrade to a newer Elasticsearch version](../../upgrade/deployment-or-cluster.md), and [add some plugins](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md).
11+
* [Add more capacity](../../maintenance/ece/scale-out-installation.md) to your Elastic Cloud Enterprise installation, [resize your deployment](resize-deployment.md), [upgrade to a newer Elasticsearch version](../../upgrade/deployment-or-cluster.md), and [add some plugins](elasticsearch://reference/elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md).
1212
* [Configure ECE system deployments](system-deployments-configuration.md) to ensure a highly available and resilient setup.
1313
* [Configure ECE for deployment templates](configure-deployment-templates.md) to indicate what kind of hardware you have available for Elastic Stack deployments.
1414
* [Install your security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) to enable TLS/SSL authentication for secure connections over HTTPS.
@@ -19,7 +19,7 @@ After your Elastic Cloud Enterprise installation is up, some additional steps mi
1919
* Learn how to work around host maintenance or a host failure by [moving nodes off of an allocator](../../maintenance/ece/move-nodes-instances-from-allocators.md).
2020
* If you received a license from Elastic, [manage the licenses](../../license/manage-your-license-in-ece.md) for your Elastic Cloud Enterprise installation.
2121

22-
::::{warning}
22+
::::{warning}
2323
During installation, the system generates secrets that are placed into the `/mnt/data/elastic/bootstrap-state/bootstrap-secrets.json` secrets file, unless you passed in a different path with the --host-storage-path parameter. Keep the information in the `bootstrap-secrets.json` file secure by removing it from its default location and placing it into a secure storage location.
2424
::::
2525

0 commit comments

Comments
 (0)