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: deploy-manage/api-keys/elastic-cloud-enterprise-api-keys.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
@@ -70,5 +70,5 @@ To create a bearer token:
70
70
{ "token": "eyJ0eXa...<very long string>...MgBmsw4s" }
71
71
```
72
72
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](cloud//reference/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](cloud://reference/cloud-enterprise/ece-api-command-line.md).
Copy file name to clipboardExpand all lines: deploy-manage/autoscaling/autoscaling-in-ece-and-ech.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
@@ -198,7 +198,7 @@ This example demonstrates how to use the {{ecloud}} RESTful API to create a depl
198
198
199
199
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).
200
200
201
-
To learn more about the {{ece}} API, see the [RESTful API](cloud//reference/cloud-enterprise/restful-api.md) documentation. For details on the {{ech}} API, check [RESTful API](cloud//reference/cloud-hosted/ec-api-restful.md).
201
+
To learn more about the {{ece}} API, see the [RESTful API](cloud://reference/cloud-enterprise/restful-api.md) documentation. For details on the {{ech}} API, check [RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md).
Copy file name to clipboardExpand all lines: deploy-manage/cloud-organization/tools-and-apis.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,15 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
10
10
{{ecloud}} API
11
11
: You can use the {{ecloud}} 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.
12
12
13
-
To learn more about the {{ecloud}} API, read through the [API overview](cloud//reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](cloud//reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
13
+
To learn more about the {{ecloud}} API, read through the [API overview](cloud://reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](cloud://reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
14
14
15
-
Calls to the {{ecloud}} API are subject to [Rate limiting](cloud//reference/cloud-hosted/ec-api-rate-limiting.md).
15
+
Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md).
16
16
17
17
18
18
Elasticsearch APIs
19
19
: 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.
20
20
21
-
To use these APIs on {{ecloud}} read our topic [Access the API console](cloud//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).
21
+
To use these APIs on {{ecloud}} read our topic [Access the API console](cloud://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).
22
22
23
23
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-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
@@ -17,7 +17,7 @@ System owned deployment templates are automatically updated during the ECE upgra
17
17
18
18
## Adding support for node_roles [ece_adding_support_for_node_roles]
19
19
20
-
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](cloud//reference/cloud-enterprise/changes-to-index-allocation-api.md).
20
+
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](cloud://reference/cloud-enterprise/changes-to-index-allocation-api.md).
21
21
22
22
There are a number of fields that need to be added to each Elasticsearch node in order to support `node_roles`:
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.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
@@ -39,7 +39,7 @@ curl -X PUT \
39
39
-d '{"capacity":<Capacity_Value_in_MB>}'
40
40
```
41
41
42
-
For more information on how to use API keys for authentication, check the section [Access the API from the Command Line](cloud//reference/cloud-enterprise/ece-api-command-line.md).
42
+
For more information on how to use API keys for authentication, check the section [Access the API from the Command Line](cloud://reference/cloud-enterprise/ece-api-command-line.md).
43
43
44
44
::::{important}
45
45
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.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/tools-apis.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
@@ -9,7 +9,7 @@
9
9
You can use these tools and APIs to interact with the following {{ece}} features:
10
10
11
11
*[{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
12
-
*[ECE scripts](cloud//reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
12
+
*[ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
13
13
*[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.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,7 +143,7 @@ $$$azure-integration-pricing$$$What is the pricing for this offer?
143
143
144
144
145
145
$$$azure-integration-regions$$$Which Azure regions are supported?
146
-
: Here is the [list of available Azure regions](cloud//reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions) supported in {{ecloud}}.
146
+
: Here is the [list of available Azure regions](cloud://reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions) supported in {{ecloud}}.
147
147
148
148
$$$azure-integration-subscription-levels$$$Which {{ecloud}} subscription levels are available?
149
149
: The subscription defaults to the Enterprise subscription, granting immediate access to advanced {{stack}} features like machine learning, and premium support response time SLAs. {{ecloud}} offers a number of different [subscription levels](https://elastic.co/pricing).
@@ -239,7 +239,7 @@ $$$azure-integration-cli-api$$$What other methods are available to deploy {{es}}
239
239
* **Deploy using {{ecloud}}**
240
240
241
241
* The {{ecloud}} [console](https://cloud.elastic.co?page=docs&placement=docs-body)
242
-
* The {{ecloud}} [REST API](cloud//reference/cloud-hosted/ec-api-restful.md)
242
+
* The {{ecloud}} [REST API](cloud://reference/cloud-hosted/ec-api-restful.md)
243
243
* The {{ecloud}} [command line tool](ecctl://reference/index.md)
244
244
* The {{ecloud}} [Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs)
245
245
@@ -327,7 +327,7 @@ $$$azure-integration-modify-deployment$$$How can I modify my {{ecloud}} deployme
327
327
* [Add or remove custom plugins](add-plugins-extensions.md).
328
328
* [Configure IP filtering](../../security/traffic-filtering.md).
329
329
* [Monitor your {{ecloud}} deployment](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to ensure it remains healthy.
330
-
* Add or remove API keys to use the [REST API](cloud//reference/cloud-hosted/ec-api-restful.md).
330
+
* Add or remove API keys to use the [REST API](cloud://reference/cloud-hosted/ec-api-restful.md).
331
331
* [And more](cloud-hosted.md)
332
332
333
333
@@ -384,7 +384,7 @@ Note that following restrictions for logging:
384
384
385
385
* Only logs from non-compute Azure services are ingested as part of the configuration detailed in this document. Logs from compute services, such as Virtual Machines, into the {{stack}} will be added in a future release.
386
386
387
-
* The Azure services must be in one of the [supported regions](cloud//reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions). All regions will be supported in the future.
387
+
* The Azure services must be in one of the [supported regions](cloud://reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions). All regions will be supported in the future.
388
388
389
389
::::
390
390
@@ -501,7 +501,7 @@ $$$azure-integration-failed-sso$$$I can’t SSO into my {{ecloud}} deployment.
501
501
502
502
503
503
$$$azure-integration-cant-see-deployment$$$I see some deployments in the {{ecloud}} console but not in the Azure Portal.
504
-
: Elastic Deployments created using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), the [{{es}} Service API](cloud//reference/cloud-hosted/ec-api-restful.md), or the [{{ecloud}} Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs) are only visible through the {{ecloud}} Console. To have the necessary metadata to be visible in the Azure Portal, {{ecloud}} deployments need to be created in Microsoft Azure.
504
+
: Elastic Deployments created using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), the [{{es}} Service API](cloud://reference/cloud-hosted/ec-api-restful.md), or the [{{ecloud}} Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs) are only visible through the {{ecloud}} Console. To have the necessary metadata to be visible in the Azure Portal, {{ecloud}} deployments need to be created in Microsoft Azure.
505
505
506
506
::::{note}
507
507
Mimicking this metadata by manually adding tags to an {{ecloud}} deployment will not work around this limitation. Instead, it will prevent you from being able to delete the deployment using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
The virtual hardware on which Elastic stack deployments run is defined by instance configurations. To learn more about what an instance configuration is, refer to [Instance configurations](cloud//reference/cloud-hosted/hardware.md#ec-getting-started-configurations).
11
+
The virtual hardware on which Elastic stack deployments run is defined by instance configurations. To learn more about what an instance configuration is, refer to [Instance configurations](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations).
12
12
13
13
When a deployment is created, each Elasticsearch tier and stateless resource (e.g., Kibana) gets an instance configuration assigned to it, based on the hardware profile used. The combination of instance configurations defined within each hardware profile is designed to provide the best possible outcome for each use case. Therefore, it is not advisable to use instance configurations that are not specified on the hardware profile, except in specific situations in which we may need to migrate an Elasticsearch tier or stateless resource to a different hardware type. An example of such a scenario is when a cloud provider stops supporting a hardware type in a specific region.
14
14
@@ -23,7 +23,7 @@ Prerequisites:
23
23
24
24
Follow these steps to migrate to a different instance configuration, replacing the default `$EC_API_KEY` value with your actual API key:
25
25
26
-
1. From the [list of instance configurations available for each region](cloud//reference/cloud-hosted/ec-regions-templates-instances.md), select the target instance configuration you want to migrate to.
26
+
1. From the [list of instance configurations available for each region](cloud://reference/cloud-hosted/ec-regions-templates-instances.md), select the target instance configuration you want to migrate to.
27
27
2. Get the deployment update payload from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body)**Edit** page, by selecting **Equivalent API request**, and store it in a file called `migrate_instance_configuration.json`.
28
28
29
29
Example payload containing relevant data for migrating the hot Elasticsearch tier:
@@ -81,6 +81,6 @@ Having an instance configuration mismatch between the deployment and the hardwar
81
81
82
82
## Deprecated instance configurations (ICs) and deployment templates (DTs) [ec-deprecated-icdt]
83
83
84
-
A list of deprecated and valid ICs/DTs can be found on the [Available regions, deployment templates and instance configurations](cloud//reference/cloud-hosted/ec-regions-templates-instances.md) page, as well as through the API, using `hide_deprecated` to return valid ICs/DTs. For example, to return valid ICs/DTs the following request can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&hide_deprecated=true`. To list only the deprecated ones, this can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&metadata=legacy:true`.
84
+
A list of deprecated and valid ICs/DTs can be found on the [Available regions, deployment templates and instance configurations](cloud://reference/cloud-hosted/ec-regions-templates-instances.md) page, as well as through the API, using `hide_deprecated` to return valid ICs/DTs. For example, to return valid ICs/DTs the following request can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&hide_deprecated=true`. To list only the deprecated ones, this can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&metadata=legacy:true`.
85
85
86
86
If a deprecated IC/DT is already in use, it can continue to be used. However, creating or migrating to a deprecated IC/DT is no longer possible and will result in a plan failing. In order to migrate to a valid IC/DT, navigate to the **Edit hardware profile** option in the Cloud UI or use the [Deployment API](https://www.elastic.co/docs/api/doc/cloud/operation/operation-migrate-deployment-template).
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.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
@@ -36,9 +36,9 @@ You can also create a deployment using the [Elastic Cloud API](https://www.elast
36
36
37
37
**Cloud provider**: The cloud platform where you’ll deploy your deployment. We support: Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. You do not need to provide your own keys.
38
38
39
-
**Region**: The cloud platform’s region your deployment will live. If you have compliance or latency requirements, you can create your deployment in any of our [supported regions](cloud//reference/cloud-hosted/regions.md). The region should be as close as possible to the location of your data.
39
+
**Region**: The cloud platform’s region your deployment will live. If you have compliance or latency requirements, you can create your deployment in any of our [supported regions](cloud://reference/cloud-hosted/regions.md). The region should be as close as possible to the location of your data.
40
40
41
-
**Hardware profile**: This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-change-hardware-profile.md) section. You can also view the [virtual hardware details](cloud//reference/cloud-hosted/hardware.md) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile.
41
+
**Hardware profile**: This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-change-hardware-profile.md) section. You can also view the [virtual hardware details](cloud://reference/cloud-hosted/hardware.md) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile.
42
42
43
43
**Version**: The Elastic Stack version that will get deployed. Defaults to the latest version. Our [version policy](available-stack-versions.md) describes which versions are available to deploy.
0 commit comments