Skip to content

Commit a9370ef

Browse files
authored
Merge branch 'main' into release-9.0.5
2 parents 5aa71e4 + bf9335d commit a9370ef

File tree

22 files changed

+447
-196
lines changed

22 files changed

+447
-196
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
:::{dropdown} Can I use Cloud Connect to connect my {{ech}} clusters to AutoOps?
22

33
This path is not supported. Currently, we only support using Cloud Connect to connect ECE, ECK, and self-managed clusters to AutoOps.
4+
5+
For {{ech}} clusters, AutoOps is set up and enabled automatically in all supported [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md), and can be [accessed](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) from the deployment overview page.
46
:::

deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ For detailed {{es-serverless}} project rates, see the [{{es-serverless}} pricing
3030
* **Indexing:** The VCUs used to index incoming documents.
3131
* **Search:** The VCUs used to return search results, with the latency and queries per second (QPS) you require.
3232
* **Machine learning:** The VCUs used to perform inference, NLP tasks, and other ML activities.
33+
* **Tokens:** The Elastic Managed LLM is charged per 1Mn Input and Output tokens. The LLM powers all AI Search features such as Playground and AI Assistant for Search, and is enabled by default.
3334

3435

3536
## Data storage and billing [elasticsearch-billing-information-about-the-search-ai-lake-dimension-gb]
@@ -43,10 +44,6 @@ You can control costs using the following strategies:
4344

4445
* **Search Power setting:** [Search Power](../../deploy/elastic-cloud/project-settings.md#elasticsearch-manage-project-search-power-settings) controls the speed of searches against your data. With Search Power, you can improve search performance by adding more resources for querying, or you can reduce provisioned resources to cut costs.
4546
* **Search boost window**: By limiting the number of days of [time series data](../../../solutions/search/ingest-for-search.md#elasticsearch-ingest-time-series-data) that are available for caching, you can reduce the number of search VCUs required.
46-
* **Machine learning trained model autoscaling:** Configure your trained model deployment to allow it to scale down to zero allocations when there are no active inference requests:
47-
48-
* When starting or updating a trained model deployment, [Enable adaptive resources](../../autoscaling/trained-model-autoscaling.md#enabling-autoscaling-in-kibana-adaptive-resources) and set the VCU usage level to **Low**.
49-
* When using the inference API for {{es}} or ELSER, [enable `adaptive_allocations`](../../autoscaling/trained-model-autoscaling.md#enabling-autoscaling-through-apis-adaptive-allocations).
5047

5148
* **Indexing Strategies:** Consider your indexing strategies and how they might impact overall VCU usage and costs:
5249

deploy-manage/monitor/autoops.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ products:
1212

1313
AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization.
1414

15-
AutoOps is currently only available for [{{ech}} deployments](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md).
16-
1715
:::{image} /deploy-manage/images/cloud-autoops-overview-page.png
1816
:alt: The Overview page
1917
:::

deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Cloud Connect enables users of ECE, ECK, and self-managed clusters to use {{eclo
1717

1818
In this section, you'll find the following information:
1919

20-
* How to [connect your cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md)
20+
* How to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md)
21+
* How to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md)
2122
* How to [manage users of your connected clusters](/deploy-manage/monitor/autoops/cc-manage-users.md)
2223
* [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps for your clusters
2324
* A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
navigation_title: Connect your local development cluster
6+
---
7+
8+
# Connect your local development cluster to AutoOps
9+
10+
If you have an {{es}} cluster set up for local development or testing, you can connect it to AutoOps using Docker.
11+
12+
## Prerequisites
13+
14+
Ensure your system meets the following requirements before proceeding:
15+
16+
* You have set up [{{es}} for local development](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md).
17+
* You have installed [Docker Desktop](https://www.docker.com/products/docker-desktop).
18+
* You have an {{ecloud}} account with the [Organization owner role](/deploy-manage/monitor/autoops/cc-manage-users.md#assign-roles).
19+
20+
## Connect your local development cluster to AutoOps
21+
22+
Complete the following steps to connect your local development cluster to AutoOps.
23+
24+
1. Run the following command in your terminal to open the `/etc/hosts` file in a text editor with administrator privileges:
25+
26+
```sh
27+
vim /etc/hosts
28+
```
29+
2. On a new line in the `/etc/hosts` file, add an entry to map the {{es}} cluster URL to the IP address representing the local development cluster.
30+
31+
The entry should be formatted as `127.0.0.1 {{hostname}}`.
32+
3. Save the changes.
33+
4. In your terminal, run the following command to reload the hostname service:
34+
* For Linux:
35+
```sh
36+
/bin/systemctl restart systemd-hostnamed
37+
```
38+
* For macOS:
39+
```sh
40+
sudo dscacheutil -flushcache
41+
```
42+
5. Follow the instructions to [Connect to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#connect-to-autoops) with the following differences:
43+
* In the [Select installation method](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#select-installation-method) step, select **Docker**.
44+
* In the [Configure agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#configure-agent) step, when prompted to enter your **{{es}} endpoint URL**, enter the name of your local development cluster or enter the following:
45+
```sh
46+
http://localhost:9200
47+
```
48+
* In the [Install agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#install-agent) step, paste the command into the text editor and replace `docker run -d \` with:
49+
```sh
50+
docker run -d --network host \
51+
```
52+
53+
This replacement is also required if your cluster is running on macOS.
54+
55+
After completing all the steps, you can [Access AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#access-autoops).
56+
57+
58+
59+

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

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@ applies_to:
44
self:
55
ece:
66
eck:
7-
navigation_title: Connect your cluster
7+
navigation_title: Connect your self-managed cluster
88
---
99

10-
# Connect your cluster to AutoOps
10+
# Connect your self-managed cluster to AutoOps
1111

1212
To use AutoOps with your ECE, ECK, or self-managed cluster, you first need to create an {{ecloud}} account or log in to your existing account. An installation wizard will then guide you through the steps of installing {{agent}} to send metrics from your cluster to AutoOps in {{ecloud}}.
1313

1414
Complete the steps in the following subsections to connect your cluster to AutoOps. The connection process takes about 10 minutes.
1515

16+
:::{note}
17+
If you have an {{es}} cluster set up for local development or testing, you can connect it to AutoOps using Docker. Refer to [](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md).
18+
:::
19+
1620
## Prerequisites
1721

1822
Ensure your system meets the following requirements before proceeding:
@@ -21,7 +25,7 @@ Ensure your system meets the following requirements before proceeding:
2125
* 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).
2226
* The agent you install for the connection is allowed to send metrics to {{ecloud}}.
2327

24-
## Connect to AutoOps
28+
## Connect to AutoOps (private preview) [connect-to-autoops]
2529

2630
:::{note}
2731
:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md
@@ -86,8 +90,8 @@ This is the first step of the installation wizard. Your cluster ships metrics to
8690

8791
Select one of the following methods to install {{agent}}:
8892

89-
* Kubernetes
90-
* Docker
93+
* **Kubernetes**
94+
* **Docker**
9195
<!-- Not applicable for private preview
9296
* Linux
9397
* Windows
@@ -208,7 +212,8 @@ The wizard will generate an installation command based on your configuration. De
208212

209213
* Kubernetes
210214
* YAML
211-
* Helm Chart
215+
<!-- Not applicable for private preview
216+
* Helm Chart -->
212217
* Docker
213218
* Docker
214219
* Docker compose
@@ -226,18 +231,18 @@ Complete the following steps to run the command:
226231
1. Copy the command.
227232
2. Paste it into a text editor and update the placeholder values in the following environment variables:
228233

229-
| Environment variable | Description |
230-
| --- | --- |
231-
| `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which {{agent}} ships data. The URL is generated based on the CSP and region you pick. <br> This URL shouldn't be edited. |
232-
| `AUTOOPS_ES_URL` | The URL {{agent}} uses to communicate with {{es}}. |
233-
| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values. <br> This variable shouldn't be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. |
234-
| `ELASTICSEARCH_READ_USERNAME` | The username for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. |
235-
| `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_USERNAME`. |
236-
| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. <br> This key shouldn't be edited. |
237-
| `AUTOOPS_TEMP_RESOURCE_ID` | The temporary ID for the current installation wizard. |
238-
239-
4. Run the command from the machine where you want to install the agent.
240-
5. Return to the wizard and select **I have run the command**.
234+
| Environment variable | Description |
235+
| --- | --- |
236+
| `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which {{agent}} ships data. The URL is generated based on the CSP and region you pick. <br> This URL shouldn't be edited. |
237+
| `AUTOOPS_ES_URL` | The URL {{agent}} uses to communicate with {{es}}. |
238+
| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values. <br> This variable shouldn't be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. |
239+
| `ELASTICSEARCH_READ_USERNAME` | The username for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. |
240+
| `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_USERNAME`. |
241+
| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. <br> This key shouldn't be edited. |
242+
| `AUTOOPS_TEMP_RESOURCE_ID` | The temporary ID for the current installation wizard. |
243+
244+
3. Run the command from the machine where you want to install the agent.
245+
4. Return to the wizard and select **I have run the command**.
241246

242247
It might take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps.
243248

deploy-manage/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,7 @@ toc:
676676
- file: monitor/autoops/ec-autoops-faq.md
677677
- hidden: monitor/autoops/cc-autoops-as-cloud-connected.md
678678
- hidden: monitor/autoops/cc-connect-self-managed-to-autoops.md
679+
- hidden: monitor/autoops/cc-connect-local-dev-to-autoops.md
679680
- hidden: monitor/autoops/cc-manage-users.md
680681
- hidden: monitor/autoops/cc-cloud-connect-autoops-faq.md
681682
- hidden: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md

deploy-manage/users-roles/cluster-or-deployment-auth/file-based.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,10 @@ stringData:
215215
roles: kibana_admin,ingest_admin # optional, not part of kubernetes.io/basic-auth
216216
```
217217
218+
::::{tip}
219+
To create custom roles that can be referenced in this list refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md#roles-management-file).
220+
::::
221+
218222
You can make this file available to {{eck}} by adding it as a file realm secret:
219223
220224
```yaml

explore-analyze/alerts-cases/alerts/alerting-setup.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,11 @@ Likewise, you can customize the **Rules Settings** sub-feature privileges relate
5151

5252
To create a rule that uses the [Cases connector](kibana://reference/connectors-kibana/cases-action-type.md), you must also have `All` privileges for the **Cases** feature.
5353

54-
The rule type also affects the privileges that are required. For example, to create or edit {{ml}} rules, you must have `all` privileges for the **Analytics > {{ml-app}}** feature. For {{stack-monitor-app}} rules, you must have the `monitoring_user` role. For {{observability}} rules, you must have `all` privileges for the appropriate {{observability}} features. For Security rules, refer to [Detections prerequisites and requirements](../../../solutions/security/detect-and-alert/detections-requirements.md).
54+
The rule type also affects the privileges that are required to create and edit rules. For example:
55+
* For {{ml}} rules, you must have `all` privileges for the **Analytics > {{ml-app}}** feature.
56+
* For {{stack-monitor-app}} rules, you must have the `monitoring_user` role.
57+
* For most {{observability}} rules, you must have `all` privileges for the appropriate {{observability}} features. However, for a custom threshold rule, you only need the `stack alerts` privilege.
58+
* For Security rules, refer to [Detections prerequisites and requirements](../../../solutions/security/detect-and-alert/detections-requirements.md).
5559

5660
::::
5761

explore-analyze/query-filter/languages/querydsl.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,6 @@ products:
1111

1212
# Query DSL
1313

14-
$$$filter-context$$$
15-
16-
$$$query-dsl-allow-expensive-queries$$$
17-
18-
$$$relevance-scores$$$
19-
2014
## What's Query DSL? [search-analyze-query-dsl]
2115

2216
**Query DSL** is a full-featured JSON-style query language that enables complex searching, filtering, and aggregations. It is the original and most powerful query language for {{es}} today.
@@ -65,21 +59,21 @@ $$$query-dsl-allow-expensive-queries$$$
6559

6660
**Allow expensive queries**: Certain types of queries will generally execute slowly due to the way they are implemented, which can affect the stability of the cluster. Those queries can be categorized as follows:
6761

68-
- Queries that need to do linear scans to identify matches:
62+
- Queries that need to do linear scans to identify matches:
6963

7064
- [`script` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-script-query.md)
7165
- queries on [numeric](elasticsearch://reference/elasticsearch/mapping-reference/number.md), [date](elasticsearch://reference/elasticsearch/mapping-reference/date.md), [boolean](elasticsearch://reference/elasticsearch/mapping-reference/boolean.md), [ip](elasticsearch://reference/elasticsearch/mapping-reference/ip.md), [geo_point](elasticsearch://reference/elasticsearch/mapping-reference/geo-point.md) or [keyword](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md) fields that are not indexed but have [doc values](elasticsearch://reference/elasticsearch/mapping-reference/doc-values.md) enabled
7266

73-
- Queries that have a high up-front cost:
67+
- Queries that have a high up-front cost:
7468

7569
- [`fuzzy` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-fuzzy-query.md) (except on [`wildcard`](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md#wildcard-field-type) fields)
7670
- [`regexp` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-regexp-query.md) (except on [`wildcard`](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md#wildcard-field-type) fields)
7771
- [`prefix` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-prefix-query.md) (except on [`wildcard`](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md#wildcard-field-type) fields or those without [`index_prefixes`](elasticsearch://reference/elasticsearch/mapping-reference/index-prefixes.md))
7872
- [`wildcard` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-wildcard-query.md) (except on [`wildcard`](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md#wildcard-field-type) fields)
7973
- [`range` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-range-query.md) on [`text`](elasticsearch://reference/elasticsearch/mapping-reference/text.md) and [`keyword`](elasticsearch://reference/elasticsearch/mapping-reference/keyword.md) fields
8074

81-
- [Joining queries](elasticsearch://reference/query-languages/query-dsl/joining-queries.md)
82-
- Queries that may have a high per-document cost:
75+
- [Joining queries](elasticsearch://reference/query-languages/query-dsl/joining-queries.md)
76+
- Queries that may have a high per-document cost:
8377

8478
- [`script_score` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-script-score-query.md)
8579
- [`percolate` queries](elasticsearch://reference/query-languages/query-dsl/query-dsl-percolate-query.md)

0 commit comments

Comments
 (0)