Skip to content

Commit 69a74dc

Browse files
authored
Merge branch 'main' into roles
2 parents 92134cc + b388a78 commit 69a74dc

File tree

652 files changed

+32561
-1586
lines changed

Some content is hidden

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

652 files changed

+32561
-1586
lines changed

cloud-account/change-your-password.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ applies:
88

99
# Change your password [ec-change-password]
1010

11-
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.
11+
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.
1212

1313
If you know your current password:
1414

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ mapped_pages:
55

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

8-
This example demonstrates how to use the Elasticsearch Service RESTful API to create a deployment with autoscaling enabled.
8+
This example demonstrates how to use the {{ecloud}} 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-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 {{ecloud}} API in general, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).
1111

1212

1313
## Requirements [ec_requirements]
@@ -46,7 +46,7 @@ $$$ec-autoscaling-api-example-requirements-table$$$
4646

4747
+ ✕ = Do not include the property.
4848

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

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

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

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

66
# Autoscaling example [ec-autoscaling-example]
77

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

1010
1. Enable autoscaling:
1111

deploy-manage/autoscaling/ec-autoscaling.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Currently, autoscaling behavior is as follows:
4545

4646

4747
::::{note}
48-
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.
48+
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.
4949
::::
5050

5151

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

8686
To enable or disable autoscaling on a deployment:
8787

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

91-
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.
91+
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.
9292

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

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

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

109-
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.
109+
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.
110110

111111
3. In your deployment menu, select **Edit**.
112112
4. To update a data tier:

deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ As is common with Cloud providers, we meter and bill snapshot storage using two
9090

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

93-
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.
93+
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.
9494

9595
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.
9696

deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ mapped_urls:
33
- https://www.elastic.co/guide/en/serverless/current/general-check-subscription.html
44
- https://www.elastic.co/guide/en/cloud/current/ec-subscription-overview.html
55
- https://www.elastic.co/guide/en/cloud/current/ec-select-subscription-level.html
6+
- https://www.elastic.co/guide/en/cloud/current/ec-licensing.html
67
applies_to:
78
deployment:
89
ess: all

deploy-manage/cloud-organization/operational-emails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ We also send an email alert if one of the nodes in your cluster is restarted due
1919

2020
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.
2121

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

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,30 @@ mapped_pages:
55

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

8-
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.
8+
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.
99

10-
Elasticsearch Service API
11-
: 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.
10+
{{ecloud}} API
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.
1212

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).
13+
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).
1414

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

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

2525

2626
Kibana APIs
2727
: 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.
2828

29-
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.
29+
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.
3030

31-
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.
31+
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.
3232

3333

3434
Other Products

deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $$$allocator-sample-tags$$$Tags are simple key-value pairs. A small sampling of
3939
: Indicates allocators that can run CPU-intensive workloads faster than others.
4040

4141
`instanceFamily: i3`, `instanceFamily: m5`
42-
: Indicates the host type, used extensively on our hosted Elasticsearch Service to identify hosts with specific hardware characteristics. If you run your own hardware on-premise and have standardized on several specific host configurations, you could use similar tags. If you are deploying ECE on another cloud platform, you could use the instance type or machine type names from your provider.
42+
: Indicates the host type, used extensively on {{ech}} to identify hosts with specific hardware characteristics. If you run your own hardware on-premise and have standardized on several specific host configurations, you could use similar tags. If you are deploying ECE on another cloud platform, you could use the instance type or machine type names from your provider.
4343

4444
Avoid tags that describe a particular use case or an Elastic Stack component you plan to run on these allocators. Examples of tags to avoid include `elasticsearch: false` or `kibana: true`. You should define the intended use at the level of instance configurations instead and tag your allocators only to describe hardware characteristics.
4545

deploy-manage/deploy/elastic-cloud/access-kibana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To access Kibana:
3333
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
3434
2. On the **Deployments** page, select your deployment.
3535

36-
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.
36+
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.
3737

3838
3. Under **Applications**, select the Kibana **Launch** link and wait for Kibana to open.
3939

0 commit comments

Comments
 (0)