Skip to content

Commit

Permalink
Merge branch 'main' into ben-migration-cleanup-cloudsec
Browse files Browse the repository at this point in the history
  • Loading branch information
natasha-moore-elastic authored Feb 27, 2025
2 parents a608d15 + cb32947 commit efb788b
Show file tree
Hide file tree
Showing 1,353 changed files with 43,189 additions and 17,353 deletions.
2 changes: 1 addition & 1 deletion cloud-account/change-your-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ applies:

# Change your password [ec-change-password]

If you created a password when you signed up for a {{ecloud}} account, or you added the password-based login method to your account, then you can change your password if needed.
If you created a password when you signed up for an {{ecloud}} account, or you added the password-based login method to your account, then you can change your password if needed.

If you know your current password:

Expand Down
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/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](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/ece-api-command-line.md).
6 changes: 3 additions & 3 deletions deploy-manage/autoscaling/ec-autoscaling-api-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ mapped_pages:

# Autoscaling through the API [ec-autoscaling-api-example]

This example demonstrates how to use the Elasticsearch Service RESTful API to create a deployment with autoscaling enabled.
This example demonstrates how to use the {{ecloud}} RESTful API to create a deployment with autoscaling enabled.

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).
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 {{ecloud}} API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).


## Requirements [ec_requirements]
Expand Down Expand Up @@ -46,7 +46,7 @@ $$$ec-autoscaling-api-example-requirements-table$$$

+ ✕ = Do not include the property.

+ These rules match the behavior of the Elasticsearch Service user console.
+ These rules match the behavior of the {{ecloud}} Console.

+ * The `elasticsearch` object must contain the property `"autoscaling_enabled": true`.

Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/autoscaling/ec-autoscaling-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ mapped_pages:

# Autoscaling example [ec-autoscaling-example]

To help you better understand the available autoscaling settings, this example describes a typical autoscaling workflow on sample Elasticsearch Service deployment.
To help you better understand the available autoscaling settings, this example describes a typical autoscaling workflow on sample {{ech}} deployment.

1. Enable autoscaling:

Expand Down
10 changes: 5 additions & 5 deletions deploy-manage/autoscaling/ec-autoscaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Currently, autoscaling behavior is as follows:


::::{note}
For any Elasticsearch Service 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.
The number of availability zones for each component of your {{ech}} deployments 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.
::::


Expand Down Expand Up @@ -85,10 +85,10 @@ The following are known limitations and restrictions with autoscaling:

To enable or disable autoscaling on a deployment:

1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2. On the **Deployments** page, select your deployment.

On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
On the **Deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.

3. In your deployment menu, select **Edit**.
4. Select desired autoscaling configuration for this deployment using **Enable Autoscaling for:** dropdown menu.
Expand All @@ -103,10 +103,10 @@ When autoscaling has been disabled, you need to adjust the size of data tiers an

Each autoscaling setting is configured with a default value. You can adjust these if necessary, as follows:

1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body).
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
2. On the **Deployments** page, select your deployment.

On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
On the **Deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.

3. In your deployment menu, select **Edit**.
4. To update a data tier:
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/autoscaling/ece-autoscaling-api-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mapped_pages:

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

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


## Requirements [ece_requirements_3]
Expand Down
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-organizations.html
applies:
applies_to:
deployment:
ess: all
serverless: all
hosted: all
---

# Manage your Cloud organization [ec-organizations]
Expand Down
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec-billing.html
- https://www.elastic.co/guide/en/serverless/current/general-manage-billing.html
applies:
applies_to:
deployment:
ess: all
serverless: all
hosted: all
---

# Billing
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-details.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization/billing/billing-faq.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-faq-billing.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization/billing/billing-models.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-models.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
navigation_title: "Hosted billing dimensions"
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-dimensions.html
applies:
hosted: all
applies_to:
deployment:
ess: all
---

# Cloud Hosted deployment billing dimensions [ec-billing-dimensions]
Expand Down Expand Up @@ -89,7 +90,7 @@ As is common with Cloud providers, we meter and bill snapshot storage using two

### How can I control the storage cost? [ec_how_can_i_control_the_storage_cost]

Snapshots in Elasticsearch Service save data incrementally at each snapshot event. This means that the effective snapshot size may be larger than the size of the current indices. The snapshot size increases as data is added or updated in the cluster, and deletions do not reduce the snapshot size until the snapshot containing that data is removed.
Snapshots in {{ech}} save data incrementally at each snapshot event. This means that the effective snapshot size may be larger than the size of the current indices. The snapshot size increases as data is added or updated in the cluster, and deletions do not reduce the snapshot size until the snapshot containing that data is removed.

API requests are executed every time a snapshot is taken or restored, affecting usage costs. In the event that you have any automated processes that use the Elasticsearch API to create or restore snapshots, these should be set so as to avoid unexpected charges.

Expand Down
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization/billing/ecu.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-ecu.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
navigation_title: "Elastic for Observability"
mapped_pages:
- https://www.elastic.co/guide/en/serverless/current/observability-billing.html
applies:
applies_to:
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
navigation_title: "Elasticsearch"
mapped_pages:
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-billing.html
applies:
applies_to:
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ mapped_urls:
- https://www.elastic.co/guide/en/serverless/current/general-check-subscription.html
- https://www.elastic.co/guide/en/cloud/current/ec-subscription-overview.html
- https://www.elastic.co/guide/en/cloud/current/ec-select-subscription-level.html
applies:
hosted: all
- https://www.elastic.co/guide/en/cloud/current/ec-licensing.html
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec-account-usage.html
- https://www.elastic.co/guide/en/serverless/current/general-monitor-usage.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
navigation_title: "Elastic for Security"
mapped_pages:
- https://www.elastic.co/guide/en/serverless/current/security-billing.html
applies:
applies_to:
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
navigation_title: "Serverless billing dimensions"
mapped_pages:
- https://www.elastic.co/guide/en/serverless/current/general-serverless-billing.html
applies:
applies_to:
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-contacts.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec-billing-history.html
- https://www.elastic.co/guide/en/serverless/current/general-billing-history.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
7 changes: 4 additions & 3 deletions deploy-manage/cloud-organization/operational-emails.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud/current/ec-operational-emails.html
applies:
hosted: all
applies_to:
deployment:
ess: all
---

# Operational emails [ec-operational-emails]
Expand All @@ -18,4 +19,4 @@ We also send an email alert if one of the nodes in your cluster is restarted due

These alerts are sent to all users within an {{ecloud}} organization, as well as to the email addresses listed as operational email contacts. This means that an external distribution list or automated service can receive notifications without the need to be added to the organization directly.

To configure recipients external to an {{ecloud}} organization for these notifications Elasticsearch Service, update the list of [operational email contacts](/deploy-manage/cloud-organization/billing/update-billing-operational-contacts.md).
To configure recipients external to an {{ecloud}} organization for these notifications, update the list of [operational email contacts](/deploy-manage/cloud-organization/billing/update-billing-operational-contacts.md).
5 changes: 3 additions & 2 deletions deploy-manage/cloud-organization/service-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ mapped_urls:
- https://www.elastic.co/guide/en/cloud/current/ec_subscribe_to_individual_regionscomponents.html
- https://www.elastic.co/guide/en/cloud/current/ec_service_status_api.html
- https://www.elastic.co/guide/en/serverless/current/general-serverless-status.html
applies:
hosted: all
applies_to:
deployment:
ess: all
serverless: all
---

Expand Down
18 changes: 9 additions & 9 deletions deploy-manage/cloud-organization/tools-and-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,30 @@ mapped_pages:

# Tools and APIs [ec-work-with-apis]

Most Elastic resources can be accessed and managed through RESTful APIs. While the Elasticsearch Service API is used to manage your deployments and their components, the Elasticsearch and Kibana APIs provide direct access to your data and your visualizations, respectively.
Most Elastic resources can be accessed and managed through RESTful APIs. While the {{ecloud}} API is used to manage your deployments and their components, the Elasticsearch and Kibana APIs provide direct access to your data and your visualizations, respectively.

Elasticsearch Service API
: 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.
{{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 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).
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).

Calls to the Elasticsearch Service API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/ec-api-rate-limiting.md).
Calls to the {{ecloud}} API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/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 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).
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).

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


Kibana APIs
: Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager.

The Kibana APIs cannot be accessed directly from the Elasticsearch Service console; you need to use `curl` or another HTTP tool to connect. Check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html) to learn about using the APIs and for details about all available endpoints.
The Kibana APIs cannot be accessed directly from the {{ecloud}} Console; you need to use `curl` or another HTTP tool to connect. Check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html) to learn about using the APIs and for details about all available endpoints.

Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-kibana) apply when using these APIs with an Elasticsearch Service Kibana instance as compared to an on-prem installation.
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-kibana) apply when using these APIs with Kibana on {{ecloud}} as compared to an on-prem installation.


Other Products
Expand Down
2 changes: 1 addition & 1 deletion deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ Learn more about [versioning and availability](/get-started/versioning-availabil

:::::{tip}
For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md).
:::::
:::::
Loading

0 comments on commit efb788b

Please sign in to comment.