Skip to content

Commit 43a83a7

Browse files
authored
Merge branch 'main' into h1-fix-solutions
2 parents 3cd5a22 + 1014811 commit 43a83a7

24 files changed

+582
-516
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Using [AutoOps for ECE, ECK, and self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) through Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions).
1+
Using [AutoOps for ECE, ECK, and self-managed clusters](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) through Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions).

deploy-manage/monitor/_snippets/autoops-cc-regions.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Choose from the following AWS regions:
2-
31
| Region | Name |
42
| --- | --- |
53
| us-east-2 | Ohio |

deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Find answers to your questions about AutoOps for ECE, ECK, and self-managed clus
1414
**General questions**
1515
* [Why should I use AutoOps for my clusters?](#why-autoops)
1616
* [Does this feature require additional payment?](#additional-payment)
17+
* [Is there an added cost for shipping metrics data to {{ecloud}}?](#autoops-metrics-cost)
1718
* [Which versions of {{es}} does AutoOps support?](#es-versions)
1819
* [Which deployment types can be connected to AutoOps?](#deployment-types)
1920

@@ -24,7 +25,7 @@ Find answers to your questions about AutoOps for ECE, ECK, and self-managed clus
2425
* [Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?](#elastic-ip-address)
2526

2627
**Questions about collected metrics**
27-
* [Where are AutoOps metrics stored, and does it cost extra to ship metrics data to {{ecloud}}?](#autoops-metrics)
28+
* [Where are AutoOps metrics stored?](#autoops-metrics-storage)
2829
* [What information does {{agent}} extract from my cluster?](#extracted-info)
2930

3031
## General questions
@@ -35,6 +36,11 @@ $$$additional-payment$$$ **Does this feature require additional payment?**
3536
: :::{include} /deploy-manage/_snippets/autoops-cc-payment-faq.md
3637
:::
3738

39+
$$$autoops-metrics-cost$$$ **Is there an added cost for shipping metrics data to {{ecloud}}?**
40+
: Elastic does not charge extra for this service, but your cloud service provider (CSP) might. When sending metrics data from your cluster in a CSP region to {{ecloud}}, shipping costs will be determined by your agreement with that CSP.
41+
42+
You can [choose the CSP region where your data is stored](#autoops-metrics-storage).
43+
3844
$$$es-versions$$$ **Which versions of {{es}} does AutoOps support?**
3945
: AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol).
4046

@@ -60,14 +66,12 @@ $$$elastic-ip-address$$$ **Do I have to define an Elastic IP address to enable t
6066
: For more information, refer to [](/deploy-manage/security/elastic-cloud-static-ips.md).
6167

6268
## Questions about collected metrics
63-
$$$autoops-metrics$$$ **Where are AutoOps metrics stored, and does it cost extra to ship metrics data to {{ecloud}}?**
64-
: You can choose the CSP and region in which your cluster metrics will be stored.
69+
$$$autoops-metrics-storage$$$ **Where are AutoOps metrics stored?**
70+
: You can choose where to store your metrics from the following AWS regions:
6571

6672
:::{include} ../_snippets/autoops-cc-regions.md
6773
:::
6874

69-
Shipping metrics to {{ecloud}} may come at an additional cost. For example, when sending metrics data from your cluster in a CSP region to {{ecloud}}, shipping costs will be determined by your agreement with that CSP.
70-
7175
$$$extracted-info$$$ **What information does {{agent}} extract from my cluster?**
7276
: {{agent}} only extracts and sends cluster metrics to {{ecloud}}, not the underlying data within your cluster. The following metrics are collected:
7377

deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you have an {{es}} cluster set up for local development or testing, you can c
2222
Ensure your system meets the following requirements before proceeding:
2323

2424
* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol).
25-
* Your cluster is on an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [trial](https://cloud.elastic.co/registration).
25+
* Your cluster is on an [Enterprise self-managed license](https://www.elastic.co/subscriptions).
2626
* The agent you install for the connection is allowed to send metrics to {{ecloud}}.
2727

2828
## Connect to AutoOps (private preview) [connect-to-autoops]
@@ -92,9 +92,9 @@ Select one of the following methods to install {{agent}}:
9292

9393
* **Kubernetes**
9494
* **Docker**
95+
* **Linux**
9596
<!-- Not applicable for private preview
96-
* Linux
97-
* Windows
97+
* **Windows**
9898
-->
9999

100100
:::{important}
@@ -204,7 +204,7 @@ If you manually assign privileges, you won't be able to allow {{agent}} to acces
204204

205205
:::::
206206
* **System architecture**: Select the system architecture of the machine running the agent.
207-
* **Metrics storage location**: Select where to store your metrics data from the list of available cloud service providers and regions.
207+
* **Metrics storage location**: Select where to store your metrics data from the list of available regions.
208208

209209
:::{include} ../_snippets/autoops-cc-regions.md
210210
:::
@@ -220,8 +220,8 @@ The wizard will generate an installation command based on your configuration. De
220220
* Docker
221221
* Docker
222222
* Docker compose
223-
<!-- Not applicable for private preview
224223
* Linux
224+
<!-- Not applicable for private preview
225225
* Windows
226226
-->
227227

deploy-manage/production-guidance/elasticsearch-in-production-environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The following topics, covered in other sections of the documentation, offer valu
5959
* Consider [data streams](/manage-data/data-store/data-streams.md) and [index lifecycle management](/manage-data/lifecycle/index-lifecycle-management.md) to manage and retain your data efficiently over time.
6060

6161
::::{tip}
62-
[Elastic integrations](https://www.elastic.co/integrations) provide default index lifecycle policies, and you can [build your own policies for your custom integrations](/manage-data/lifecycle/index-lifecycle-management/tutorial-automate-rollover.md).
62+
[Elastic integrations](https://www.elastic.co/integrations) provide default index lifecycle policies, and you can [build your own policies for your custom integrations](/manage-data/lifecycle/index-lifecycle-management/ilm-tutorials.md).
6363
::::
6464

6565
### Security and monitoring [security-and-monitoring]
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
A lifecycle policy specifies the phases in the index lifecycle and the actions to perform in each phase. A lifecycle can have up to five phases: `hot`, `warm`, `cold`, `frozen`, and `delete`.
2+
3+
For example, you might define a policy named `timeseries_policy` that has the following two phases:
4+
5+
* A `hot` phase that defines a rollover action to specify that an index rolls over when it reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 days.
6+
* A `delete` phase that sets `min_age` to remove the index 90 days after rollover.
7+
8+
::::{note}
9+
The `min_age` value is relative to the rollover time, not the index creation time. [Learn more](../../troubleshoot/elasticsearch/index-lifecycle-management-errors.md#min-age-calculation).
10+
::::
11+
12+
13+
You can create the policy in {{kib}} or with the [create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API.
14+
15+
::::{tab-set}
16+
:group: kibana-api
17+
:::{tab-item} {{kib}}
18+
:sync: kibana
19+
To create the policy from {{kib}}, open the menu and go to **Stack Management > Index Lifecycle Policies**. Click **Create policy**.
20+
21+
:::{image} /manage-data/images/elasticsearch-reference-create-policy.png
22+
:alt: Create policy page
23+
:screenshot:
24+
:::
25+
:::
26+
27+
:::{tab-item} API
28+
:sync: api
29+
Use the [Create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API to add an ILM policy to the {{es}} cluster:
30+
31+
```console
32+
PUT _ilm/policy/timeseries_policy
33+
{
34+
"policy": {
35+
"phases": {
36+
"hot": { <1>
37+
"actions": {
38+
"rollover": {
39+
"max_primary_shard_size": "50GB", <2>
40+
"max_age": "30d"
41+
}
42+
}
43+
},
44+
"delete": {
45+
"min_age": "90d", <3>
46+
"actions": {
47+
"delete": {} <4>
48+
}
49+
}
50+
}
51+
}
52+
}
53+
```
54+
55+
1. The `min_age` defaults to `0ms`, so new indices enter the `hot` phase immediately.
56+
2. Trigger the `rollover` action when either of the conditions are met.
57+
3. Move the index into the `delete` phase 90 days after rollover.
58+
4. Trigger the `delete` action when the index enters the delete phase.
59+
60+
:::
61+
::::
62+
63+
:::{tip}
64+
For more details about default {{ilm-init}} policy settings, refer to [Create a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md#ilm-create-policy).
65+
:::

manage-data/data-store/aliases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ POST _aliases
268268
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.
269269

270270
::::{tip}
271-
We recommend using data streams to store append-only time series data. If you need to update or delete existing time series data, you can perform update or delete operations directly on the data stream backing index. If you frequently send multiple documents using the same `_id` expecting last-write-wins, you may want to use an index alias with a write index instead. See [Manage time series data without data streams](../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md#manage-time-series-data-without-data-streams).
271+
We recommend using data streams to store append-only time series data. If you need to update or delete existing time series data, you can perform update or delete operations directly on the data stream backing index. If you frequently send multiple documents using the same `_id` expecting last-write-wins, you may want to use an index alias with a write index instead. See the tutorial [](../lifecycle/index-lifecycle-management/tutorial-time-series-without-data-streams.md).
272272
::::
273273

274274

manage-data/data-store/data-streams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To determine whether you should use a data stream for your data, you should cons
2626
* You mostly perform indexing requests, with occasional updates and deletes.
2727
* You index documents without an `_id`, or when indexing documents with an explicit `_id` you expect first-write-wins behavior.
2828

29-
For most time series data use-cases, a data stream will be a good fit. However, if you find that your data doesn’t fit into these categories (for example, if you frequently send multiple documents using the same `_id` expecting last-write-wins), you may want to use an index alias with a write index instead. See documentation for [managing time series data without a data stream](../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md#manage-time-series-data-without-data-streams) for more information.
29+
For most time series data use-cases, a data stream will be a good fit. However, if you find that your data doesn’t fit into these categories (for example, if you frequently send multiple documents using the same `_id` expecting last-write-wins), you may want to use an index alias with a write index instead. See the tutorial [](../lifecycle/index-lifecycle-management/tutorial-time-series-without-data-streams.md) for more information.
3030

3131
Keep in mind that some features such as [Time Series Data Streams (TSDS)](../data-store/data-streams/time-series-data-stream-tsds.md) and [data stream lifecycles](../lifecycle/data-stream.md) require a data stream.
3232

@@ -106,7 +106,7 @@ Data streams are designed for use cases where existing data is rarely updated. Y
106106
If you need to update a larger number of documents in a data stream, you can use the [update by query](data-streams/use-data-stream.md#update-docs-in-a-data-stream-by-query) and [delete by query](data-streams/use-data-stream.md#delete-docs-in-a-data-stream-by-query) APIs.
107107

108108
::::{tip}
109-
If you frequently send multiple documents using the same `_id` expecting last-write-wins, you may want to use an index alias with a write index instead. See [Manage time series data without data streams](../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md#manage-time-series-data-without-data-streams).
109+
If you frequently send multiple documents using the same `_id` expecting last-write-wins, you may want to use an index alias with a write index instead. See the tutorial [](../lifecycle/index-lifecycle-management/tutorial-time-series-without-data-streams.md).
110110
::::
111111

112112

manage-data/data-store/data-streams/modify-data-stream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Follow these steps:
344344
```
345345

346346
4. If you do not want to mix new and old data in your new data stream, pause the indexing of new documents. While mixing old and new data is safe, it could interfere with data retention. See [Mixing new and old data in a data stream](../data-streams/modify-data-stream.md#data-stream-mix-new-old-data).
347-
5. If you use {{ilm-init}} to [automate rollover](../../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md), reduce the {{ilm-init}} poll interval. This ensures the current write index doesn’t grow too large while waiting for the rollover check. By default, {{ilm-init}} checks rollover conditions every 10 minutes.
347+
5. If you use {{ilm-init}} to [automate rollover](../../lifecycle/index-lifecycle-management/tutorial-time-series-with-data-streams.md), reduce the {{ilm-init}} poll interval. This ensures the current write index doesn’t grow too large while waiting for the rollover check. By default, {{ilm-init}} checks rollover conditions every 10 minutes.
348348

349349
The following [cluster update settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) request lowers the `indices.lifecycle.poll_interval` setting to `1m` (one minute).
350350

manage-data/data-store/data-streams/set-up-data-stream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ For an example, see [Data stream privileges](../../../deploy-manage/users-roles/
213213

214214
## Convert an index alias to a data stream [convert-index-alias-to-data-stream]
215215

216-
Prior to {{es}} 7.9, you’d typically use an [index alias with a write index](../../lifecycle/index-lifecycle-management/tutorial-automate-rollover.md#manage-time-series-data-without-data-streams) to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with [data tiers](../../lifecycle/data-tiers.md).
216+
Prior to {{es}} 7.9, you’d typically use an [index alias with a write index](../../lifecycle/index-lifecycle-management/tutorial-time-series-without-data-streams.md) to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with [data tiers](../../lifecycle/data-tiers.md).
217217

218218
To convert an index alias with a write index to a data stream with the same name, use the [migrate to data stream API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream). During conversion, the alias’s indices become hidden backing indices for the stream. The alias’s write index becomes the stream’s write index. The stream still requires a matching index template with data stream enabled.
219219

0 commit comments

Comments
 (0)