Skip to content

Commit 52ce8fa

Browse files
authored
Merge branch 'main' into fix-apps-formatting
2 parents fe3d425 + 4dce399 commit 52ce8fa

File tree

252 files changed

+998
-1511
lines changed

Some content is hidden

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

252 files changed

+998
-1511
lines changed

deploy-manage/api-keys/elastic-cloud-enterprise-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ To create a bearer token:
7070
{ "token": "eyJ0eXa...<very long string>...MgBmsw4s" }
7171
```
7272
73-
2. Specify the bearer token in the Authentication header of your API requests. To learn more, check [accessing the API from the command line](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-enterprise/ece-api-command-line.md).
73+
2. Specify the bearer token in the Authentication header of your API requests. To learn more, check [accessing the API from the command line](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/ece-api-command-line.md).
7474

deploy-manage/autoscaling/ec-autoscaling-api-example.md

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

88
This example demonstrates how to use the Elasticsearch Service RESTful API to create a deployment with autoscaling enabled.
99

10-
The example deployment has a hot data and content tier, warm data tier, cold data tier, and a machine learning node, all of which will scale within the defined parameters. To learn about the autoscaling settings, check [Deployment autoscaling](../autoscaling.md) and [Autoscaling example](ec-autoscaling-example.md). For more information about using the Elasticsearch Service API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/ec-api-restful.md).
10+
The example deployment has a hot data and content tier, warm data tier, cold data tier, and a machine learning node, all of which will scale within the defined parameters. To learn about the autoscaling settings, check [Deployment autoscaling](../autoscaling.md) and [Autoscaling example](ec-autoscaling-example.md). For more information about using the Elasticsearch Service API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).
1111

1212

1313
## Requirements [ec_requirements]

deploy-manage/autoscaling/ece-autoscaling-api-example.md

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

88
This example demonstrates how to use the Elastic Cloud Enterprise RESTful API to create a deployment with autoscaling enabled.
99

10-
The example deployment has a hot data and content tier, warm data tier, cold data tier, and a machine learning node, all of which will scale within the defined parameters. To learn about the autoscaling settings, check [Deployment autoscaling](../autoscaling.md) and [Autoscaling example](ece-autoscaling-example.md). For more information about using the Elastic Cloud Enterprise API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-enterprise/restful-api.md).
10+
The example deployment has a hot data and content tier, warm data tier, cold data tier, and a machine learning node, all of which will scale within the defined parameters. To learn about the autoscaling settings, check [Deployment autoscaling](../autoscaling.md) and [Autoscaling example](ece-autoscaling-example.md). For more information about using the Elastic Cloud Enterprise API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/restful-api.md).
1111

1212

1313
## Requirements [ece_requirements_3]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
1010
Elasticsearch Service API
1111
: You can use the Elasticsearch Service API to manage your deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization.
1212

13-
To learn more about the Elasticsearch Service API, read through the [API overview](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/ec-api-restful.md), try out some [getting started examples](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
13+
To learn more about the Elasticsearch Service API, read through the [API overview](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
1414

15-
Calls to the Elasticsearch Service API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/ec-api-rate-limiting.md).
15+
Calls to the Elasticsearch Service API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-rate-limiting.md).
1616

1717

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 in Elasticsearch Service read our topic [Access the Elasticsearch API console](asciidocalypse://docs/cloud/docs/reference/cloud/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 in Elasticsearch Service read our topic [Access the Elasticsearch 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).
2222

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

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
@@ -12,7 +12,7 @@ System owned deployment templates have already been updated to support both data
1212

1313
## Adding support for node_roles [ece_adding_support_for_node_roles]
1414

15-
The `node_roles` field defines the roles that an Elasticsearch topology element can have, which is used in place of `node_type` when a new feature such as autoscaling is enabled, or when a new data tier is added. This field is supported on [Elastic stack versions 7.10 and above](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-enterprise/changes-to-index-allocation-api.md).
15+
The `node_roles` field defines the roles that an Elasticsearch topology element can have, which is used in place of `node_type` when a new feature such as autoscaling is enabled, or when a new data tier is added. This field is supported on [Elastic stack versions 7.10 and above](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/changes-to-index-allocation-api.md).
1616

1717
There are a number of fields that need to be added to each Elasticsearch node in order to support `node_roles`:
1818

deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To configure index management when you create a deployment template:
3939
Index curation
4040
: Creates new indices on hot nodes first and moves them to warm nodes later on, based on the data views (formerly *index patterns*) you specify. Also manages replica counts for you, so that all shards of an index can fit on the right data nodes. Compared to index lifecycle management, index curation for time-based indices supports only one action, to move indices from nodes on one data configuration to another, but it is more straightforward to set up initially and all setup can be done directly from the Cloud UI.
4141

42-
If your user need to delete indices once they are no longer useful to them, they can run [Curator](asciidocalypse://docs/curator/docs/reference/elasticsearch/elasticsearch-client-curator/index.md) on-premise to manage indices for Elasticsearch clusters hosted on Elastic Cloud Enterprise.
42+
If your user need to delete indices once they are no longer useful to them, they can run [Curator](asciidocalypse://docs/curator/docs/reference/index.md) on-premise to manage indices for Elasticsearch clusters hosted on Elastic Cloud Enterprise.
4343

4444
To configure index curation:
4545

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ curl -X PUT \
3636
-d '{"capacity":<Capacity_Value_in_MB>}'
3737
```
3838

39-
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/cloud-enterprise/ece-api-command-line.md).
39+
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

4141
::::{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.

deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,5 +99,5 @@ While the `TransportClient` is deprecated, your custom endpoint aliases still wo
9999
```
100100

101101

102-
For more information on configuring the `TransportClient`, see [Configure the Java Transport Client](asciidocalypse://docs/elasticsearch-java/docs/reference/elasticsearch/elasticsearch-client-java-api-client/index.md).
102+
For more information on configuring the `TransportClient`, see [Configure the Java Transport Client](asciidocalypse://docs/elasticsearch-java/docs/reference/index.md).
103103

deploy-manage/deploy/cloud-enterprise/find-cloud-id.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,23 @@ To use the Cloud ID, you need:
4141
* The unique Cloud ID for your deployment, available from the deployment overview page.
4242
* A user ID and password that has permission to send data to your cluster.
4343

44-
In our examples, we use the `elastic` superuser that every Elasticsearch cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/ingestion-tools/beats-metricbeat/feature-roles.md) documentation.
44+
In our examples, we use the `elastic` superuser that every Elasticsearch cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation.
4545

4646
## Configure Beats with your Cloud ID [ece-cloud-id-beats]
4747

4848
The following example shows how you can send operational data from Metricbeat to {{ece}} by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example.
4949

5050
::::{tip}
51-
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/ingestion-tools/index.md) with each Beat.
51+
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat.
5252
::::
5353

5454
To get started with Metricbeat and {{ece}}:
5555

5656
1. [Log into the Cloud UI](log-into-cloud-ui.md).
5757
2. [Create a new deployment](create-deployment.md) and copy down the password for the `elastic` user.
5858
3. On the deployment overview page, copy down the Cloud ID.
59-
4. Set up the Beat of your choice, such as [Metricbeat](asciidocalypse://docs/beats/docs/reference/ingestion-tools/beats-metricbeat/metricbeat-installation-configuration.md).
60-
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/ingestion-tools/beats-metricbeat/configure-cloud-id.md).
59+
4. Set up the Beat of your choice, such as [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md).
60+
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md).
6161

6262
::::{note}
6363
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.

deploy-manage/deploy/cloud-enterprise/tools-apis.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
You can use these tools and APIs to interact with the following {{ece}} features:
1010

11-
* [{{ecloud}} Control (ecctl)](asciidocalypse://docs/ecctl/docs/reference/cloud/ecctl/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
12-
* [ECE scripts](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
11+
* [{{ecloud}} Control (ecctl)](asciidocalypse://docs/ecctl/docs/reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
12+
* [ECE scripts](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
1313
* [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics that you can send to Elastic Support for troubleshooting and investigation purposes.
1414

1515

0 commit comments

Comments
 (0)