Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ To create a bearer token:
{ "token": "eyJ0eXa...<very long string>...MgBmsw4s" }
```

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).
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).

2 changes: 1 addition & 1 deletion deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ This example demonstrates how to use the {{ecloud}} RESTful API to create a depl

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).

To learn more about the {{ece}} API, see the [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/restful-api.md) documentation. For details on the {{ech}} API, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).
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).

### Requirements [ec_requirements]

Expand Down
6 changes: 3 additions & 3 deletions deploy-manage/cloud-organization/tools-and-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
{{ecloud}} API
: 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.

To learn more about the {{ecloud}} 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).
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).

Calls to the {{ecloud}} API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-rate-limiting.md).
Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md).


Elasticsearch APIs
: 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.

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).
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).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ System owned deployment templates are automatically updated during the ECE upgra

## Adding support for node_roles [ece_adding_support_for_node_roles]

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).
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).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ curl -X PUT \
-d '{"capacity":<Capacity_Value_in_MB>}'
```

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).
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).

::::{important}
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.
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy/cloud-enterprise/tools-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
You can use these tools and APIs to interact with the following {{ece}} features:

* [{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool.
* [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.
* [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation.
* [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.


Expand Down
10 changes: 5 additions & 5 deletions deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ $$$azure-integration-pricing$$$What is the pricing for this offer?


$$$azure-integration-regions$$$Which Azure regions are supported?
: Here is the [list of available Azure regions](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions) supported in {{ecloud}}.
: Here is the [list of available Azure regions](cloud://reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions) supported in {{ecloud}}.

$$$azure-integration-subscription-levels$$$Which {{ecloud}} subscription levels are available?
: 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).
Expand Down Expand Up @@ -239,7 +239,7 @@ $$$azure-integration-cli-api$$$What other methods are available to deploy {{es}}
* **Deploy using {{ecloud}}**

* The {{ecloud}} [console](https://cloud.elastic.co?page=docs&placement=docs-body)
* The {{ecloud}} [REST API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md)
* The {{ecloud}} [REST API](cloud://reference/cloud-hosted/ec-api-restful.md)
* The {{ecloud}} [command line tool](ecctl://reference/index.md)
* The {{ecloud}} [Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs)

Expand Down Expand Up @@ -327,7 +327,7 @@ $$$azure-integration-modify-deployment$$$How can I modify my {{ecloud}} deployme
* [Add or remove custom plugins](add-plugins-extensions.md).
* [Configure IP filtering](../../security/traffic-filtering.md).
* [Monitor your {{ecloud}} deployment](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to ensure it remains healthy.
* Add or remove API keys to use the [REST API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).
* Add or remove API keys to use the [REST API](cloud://reference/cloud-hosted/ec-api-restful.md).
* [And more](cloud-hosted.md)


Expand Down Expand Up @@ -384,7 +384,7 @@ Note that following restrictions for logging:

* 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.

* The Azure services must be in one of the [supported regions](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-regions-templates-instances.md#ec-azure_regions). All regions will be supported in the future.
* 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.

::::

Expand Down Expand Up @@ -501,7 +501,7 @@ $$$azure-integration-failed-sso$$$I can’t SSO into my {{ecloud}} deployment.


$$$azure-integration-cant-see-deployment$$$I see some deployments in the {{ecloud}} console but not in the Azure Portal.
: Elastic Deployments created using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), the [{{es}} Service API](asciidocalypse://docs/cloud/docs/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.
: 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.

::::{note}
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).
Expand Down
8 changes: 4 additions & 4 deletions deploy-manage/deploy/elastic-cloud/change-hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mapped_pages:

# Change hardware [ec-change-hardware-for-a-specific-resource]

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](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/hardware.md#ec-getting-started-configurations).
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).

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.

Expand All @@ -23,10 +23,10 @@ Prerequisites:

Follow these steps to migrate to a different instance configuration, replacing the default `$EC_API_KEY` value with your actual API key:

1. From the [list of instance configurations available for each region](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-regions-templates-instances.md), select the target instance configuration you want to migrate to.
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.

::::{note}
The target instance configuration must be compatible with the Elasticsearch tier or stateless resource you are updating.
The target instance configuration must be compatible with the Elasticsearch tier or stateless resource you are updating.
For example, if you are migrating the hot Elasticsearch tier, the target instance configuration must also be of the `es.datahot` family.
::::

Expand Down Expand Up @@ -87,6 +87,6 @@ Having an instance configuration mismatch between the deployment and the hardwar

## Deprecated instance configurations (ICs) and deployment templates (DTs) [ec-deprecated-icdt]

A list of deprecated and valid ICs/DTs can be found on the [Available regions, deployment templates and instance configurations](asciidocalypse://docs/cloud/docs/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`.
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`.

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).
4 changes: 2 additions & 2 deletions deploy-manage/deploy/elastic-cloud/cloud-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ Find more information about {{ech}} on the following pages:

* [Subscription Levels](/deploy-manage/license.md)
* [Version Policy](/deploy-manage/deploy/elastic-cloud/available-stack-versions.md)
* [{{ech}} Hardware](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/hardware.md)
* [{{ech}} Regions](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/regions.md)
* [{{ech}} Hardware](cloud://reference/cloud-hosted/hardware.md)
* [{{ech}} Regions](cloud://reference/cloud-hosted/regions.md)
* [Service Status](/deploy-manage/cloud-organization/service-status.md)
* [Getting help](/troubleshoot/index.md)
* [Restrictions and known problems](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ You can also create a deployment using the [Elastic Cloud API](https://www.elast

**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.

**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](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/regions.md). The region should be as close as possible to the location of your data.
**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.

**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](asciidocalypse://docs/cloud/docs/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.
**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.

**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.

Expand Down
Loading