Skip to content

Commit 9438285

Browse files
Merge branch 'main' into lens-metrics-trends
2 parents 99e831b + b7a1c39 commit 9438285

File tree

193 files changed

+4557
-4254
lines changed

Some content is hidden

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

193 files changed

+4557
-4254
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@
4747
/solutions/observability/get-started/ @elastic/ski-docs
4848
/solutions/search/ @elastic/developer-docs
4949
/solutions/security/ @elastic/experience-docs
50-
/solutions/security/get-started/ @elastic/ingest-docs @elastic/experience-docs
51-
/solutions/security/cloud/ @elastic/ingest-docs
5250

5351
/troubleshoot/ @elastic/docs
5452
/troubleshoot/deployments/ @elastic/admin-docs

cloud-account/dark-mode.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ applies_to:
66

77
# Use dark mode in Kibana
88

9-
The dark mode changes Kibana's default light appearance to a darker and higher-contrast color theme. From the application header, you can turn on dark mode or synchronize the color mode with your operating system settings.
9+
The dark mode changes Kibana's default light appearance to a darker color theme. From the application header, you can turn on dark mode or synchronize the color mode with your operating system settings.
1010

1111
:::{tip}
1212
If you're using {{ecloud}}, this setting only applies to the Kibana UI of your serverless projects and hosted deployments. If you'd like to change the {{ecloud}} Console color theme too, you must do so separately from its respective interface.
@@ -16,10 +16,15 @@ If you're using {{ecloud}}, this setting only applies to the Kibana UI of your s
1616

1717
1. Open the user menu from the header.
1818
2. Select **Appearance**.
19+
20+
:::{note}
21+
On self-managed deployments of {{kib}}, this option is located on your profile page. To access it, select **Edit profile** from the header's user menu.
22+
:::
23+
1924
3. Choose a color mode:
2025

2126
- **Light**: The default color mode of Kibana
22-
- **Dark**: The dark and high-contrast color mode of Kibana
27+
- **Dark**: The dark color mode of Kibana
2328
- **System**: Synchronizes Kibana's color mode with your system settings
2429
- **Space default**: Sets the color mode to the value defined in the [Space settings](kibana://reference/advanced-settings.md#kibana-general-settings)
2530

cloud-account/high-contrast.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
description: Use high-contrast mode in Kibana.
3+
applies_to:
4+
stack: ga 9.1
5+
serverless: ga
6+
products:
7+
- id: kibana
8+
---
9+
10+
# Use high-contrast mode in Kibana
11+
12+
You can change the interface contrast mode of Kibana to improve visibility and readability in low-light conditions.
13+
14+
1. Open the user menu from the header.
15+
2. Select **Appearance**.
16+
17+
:::{note}
18+
On self-managed deployments of {{kib}}, this option is located on your profile page. To access it, select **Edit profile** from the header's user menu.
19+
:::
20+
21+
3. Choose an interface contrast mode:
22+
23+
- **System**: Synchronizes Kibana's contrast mode with your system settings.
24+
- **Normal**: Normal contrast mode.
25+
- **High**: The high-contrast color mode of Kibana.
26+
27+
4. Select **Save changes**.
28+
5. Refresh the page to apply the selected contrast mode.

cloud-account/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ toc:
66
- file: change-your-password.md
77
- file: add-a-login-method.md
88
- file: multifactor-authentication.md
9-
- file: dark-mode.md
9+
- file: dark-mode.md
10+
- file: high-contrast.md

deploy-manage/_snippets/ecloud-security.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{{ecloud}} has built-in security. For example, HTTPS communications between {{ecloud}} and the internet, as well as inter-node communications, are secured automatically, and cluster data is encrypted at rest.
22

3+
In both {{ech}} and {{serverless-full}}, you can also configure [IP filters](/deploy-manage/security/ip-filtering-cloud.md) to prevent unauthorized access to your deployments and projects.
4+
35
In {{ech}}, you can augment these security features in the following ways:
4-
* Configure [traffic filtering](/deploy-manage/security/traffic-filtering.md) to prevent unauthorized access to your deployments.
6+
* [Configure private connectivity and apply VPC filtering](/deploy-manage/security/private-connectivity.md) to establish a secure connection for your {{ecloud}} deployments to communicate with other cloud services, and restrict traffic to deployments based on those private connections.
57
* Encrypt your deployment with a [customer-managed encryption key](/deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md).
68
* [Secure your settings](/deploy-manage/security/secure-settings.md) using {{es}} and {{kib}} keystores.
79
* Use the list of [{{ecloud}} static IPs](/deploy-manage/security/elastic-cloud-static-ips.md) to allow or restrict communications in your infrastructure.

deploy-manage/api-keys/elastic-cloud-api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ These keys provides access to the API that enables you to manage your deployment
3030
3. On the **API keys** tab of the **Organization** page, click **Create API key**.
3131
4. On the **Create API key** flyout, you can configure your new key by adding a name, set expiration, or assign [roles](../users-roles/cloud-organization/user-roles.md).
3232

33-
By default, API keys expire after three months. You can set the expiration to a different preset value or to a specific date, up to one year. If you need the key to work indefinitely, you can also set its expiration to Never. In this case, the key won’t expire.
33+
By default, API keys expire after three months. You can set the expiration to a different preset value or to a specific date, up to one year. If you need the key to work indefinitely, you can also set its expiration to Never. In this case, the key won’t expire. Each user is allowed to create up to 64 API keys.
3434

3535
::::{note}
3636
When an API key is nearing expiration, Elastic sends an email to the creator of the API key and each of the operational contacts. When you use an API key to authenticate, the API response header `X-Elastic-Api-Key-Expiration` indicates the key’s expiration date. You can log this value to detect API keys that are nearing expiration.

deploy-manage/autoscaling/trained-model-autoscaling.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ There are two ways to enable autoscaling:
2222
* through APIs by enabling adaptive allocations
2323
* in {{kib}} by enabling adaptive resources
2424

25+
For {{serverless-short}} projects, trained model autoscaling is automatically enabled and cannot be disabled.
26+
2527
::::{important}
2628
To fully leverage model autoscaling in {{ech}}, {{ece}}, and {{eck}}, it is highly recommended to enable [{{es}} deployment autoscaling](../../deploy-manage/autoscaling.md).
2729
::::
2830

29-
Trained model autoscaling is available for {{serverless-short}}, {{ech}}, {{ece}}, and {{eck}} deployments. In serverless deployments, processing power is managed differently across Search, Observability, and Security projects, which impacts their costs and resource limits.
31+
Trained model autoscaling is available for {{serverless-short}}, {{ech}}, {{ece}}, and {{eck}} deployments. In {{serverless-short}} projects, processing power is managed differently across Search, Observability, and Security projects, which impacts their costs and resource limits.
3032

3133
:::{admonition} Trained model auto-scaling for self-managed deployments
3234
The available resources of self-managed deployments are static, so trained model autoscaling is not applicable. However, available resources are still segmented based on the settings described in this section.
@@ -54,10 +56,6 @@ You can enable adaptive allocations by using:
5456

5557
If the new allocations fit on the current {{ml}} nodes, they are immediately started. If more resource capacity is needed for creating new model allocations, then your {{ml}} node will be scaled up if {{ml}} autoscaling is enabled to provide enough resources for the new allocation. The number of model allocations can be scaled down to 0. They cannot be scaled up to more than 32 allocations, unless you explicitly set the maximum number of allocations to more. Adaptive allocations must be set up independently for each deployment and [{{infer}} endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-inference).
5658

57-
:::{note}
58-
When you create inference endpoints on {{serverless-short}} using {{kib}}, adaptive allocations are automatically turned on, and there is no option to disable them.
59-
:::
60-
6159
### Optimizing for typical use cases [optimizing-for-typical-use-cases]
6260

6361
You can optimize your model deployment for typical use cases, such as search and ingest. When you optimize for ingest, the throughput will be higher, which increases the number of {{infer}} requests that can be performed in parallel. When you optimize for search, the latency will be lower during search processes.
@@ -73,16 +71,16 @@ You can choose from three levels of resource usage for your trained model deploy
7371

7472
Refer to the tables in the [Model deployment resource matrix](#model-deployment-resource-matrix) section to find out the settings for the level you selected.
7573

76-
:::{image} /deploy-manage/images/machine-learning-ml-nlp-deployment-id-elser-v2.png
74+
The image below shows the process of starting a trained model on an {{ech}} deployment. In {{serverless-short}} projects, the **Adaptive resources** toggle is not available when starting trained model deployments, as adaptive allocations are always enabled and cannot be disabled.
75+
76+
:::{image} /deploy-manage/images/ml-nlp-deployment-id-elser.png
7777
:alt: ELSER deployment with adaptive resources enabled.
7878
:screenshot:
7979
:width: 500px
8080
:::
8181

8282
In {{serverless-full}}, Search projects are given access to more processing resources, while Security and Observability projects have lower limits. This difference is reflected in the UI configuration: Search projects have higher resource limits compared to Security and Observability projects to accommodate their more complex operations.
8383

84-
On {{serverless-short}}, adaptive allocations are automatically enabled for all project types.
85-
8684
## Model deployment resource matrix [model-deployment-resource-matrix]
8785

8886
The used resources for trained model deployments depend on three factors:
@@ -100,10 +98,6 @@ If you use a self-managed cluster or ECK, vCPUs level ranges are derived from th
10098

10199
The following tables show you the number of allocations, threads, and vCPUs available in ECE and ECH when adaptive resources are enabled or disabled.
102100

103-
::::{note}
104-
On {{serverless-short}}, adaptive allocations are automatically enabled for all project types. However, the "Adaptive resources" control is not displayed in {{kib}} for Observability and Security projects.
105-
::::
106-
107101
### Ingest optimized
108102

109103
In case of ingest-optimized deployments, we maximize the number of model allocations.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
When installing the {{stack}}, you must use the same version across the entire stack. For example, if you are using {{es}} {{stack-version}}, you install Beats {{stack-version}}, APM Server {{stack-version}}, {{es}} Hadoop {{stack-version}}, {{kib}} {{stack-version}}, and Logstash {{stack-version}}.
1+
When installing the {{stack}}, you must use the same version across the entire stack. For example, if you are using {{es}} {{version.stack}}, you install Beats {{version.stack}}, APM Server {{version.stack}}, {{es}} Hadoop {{version.stack}}, {{kib}} {{version.stack}}, and Logstash {{version.stack}}.
22

3-
If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{stack-version}}.
3+
If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{version.stack}}.

deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ products:
1414
This type of installation is recommended for deployments with significant overall search and indexing throughput. You need:
1515

1616
* 3 hosts with at least 64 GB RAM each for directors and coordinators (ECE management services)
17-
* 3 hosts for allocators, each with one of the following RAM configurations:
17+
* A minimum of 3 hosts for allocators, using one of the following configurations per availability zone:
1818

19-
* 1 x 256 GB RAM
20-
* 2 x 128 GB RAM
21-
* 4 x 64 GB RAM
19+
* 1 host with 256 GB RAM → 3 hosts total
20+
* 2 hosts with 128 GB RAM each → 6 hosts total
21+
* 4 hosts with 64 GB RAM each → 12 hosts total
2222

2323
* 3 hosts with 16 GB RAM each for proxies
2424
* 3 availability zones
@@ -27,6 +27,10 @@ This type of installation is recommended for deployments with significant overal
2727
:alt: A large installation with nine to twelve hosts across three availability zones
2828
:::
2929

30+
::::{note}
31+
In the diagram, the Director Coordinator host in Availability zone 1, which represents the first host to be installed, has the allocator and proxy roles greyed out. This host temporarily holds all roles until the other nodes are added and configured. Eventually, the allocator and proxy roles will be removed from this host.
32+
::::
33+
3034
## Important considerations [ece_before_you_start_3]
3135

3236
Note that the large-sized {{ece}} installation separates the allocator and proxy roles from the director and coordinator roles (ECE management services).
@@ -100,8 +104,24 @@ Make sure you have completed all prerequisites and environment preparations desc
100104
bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"}}'
101105
```
102106

103-
6. [Change the deployment configuration](working-with-deployments.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently.
107+
6. [Log into the Cloud UI](log-into-cloud-ui.md).
108+
109+
7. [Change the deployment configuration](/deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` [system deployments](/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md) to use three availability zones and resize the nodes to use at least 4 GB of RAM. This ensures the system clusters are both highly available and sufficiently provisioned.
110+
111+
8. [Vacate all instances from the initial host](/deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md#move-nodes-from-allocators). This host runs some {{es}} and {{kib}} instances from system deployments, which must be moved to other allocators before proceeding.
112+
113+
Wait until all instances have been moved off the initial host before continuing.
114+
115+
9. [Remove the `allocator` and `proxy` roles](/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) from the initial host. You cannot remove the `allocator` role until all instances have been vacated.
116+
117+
::::{note}
118+
After removing the proxy role from the first host, the {{es}} and {{kib}} URLs shown in the Cloud UI will stop working. This happens because the **Deployment domain name** in **Platform** > **Settings** is set to the IP address of the first host, in the format `FIRST_HOST_IP.ip.es.io`. For more details, refer to [Change endpoint URLs](./change-endpoint-urls.md).
119+
120+
To resolve this, follow the steps in [Post-installation steps](./post-installation-steps.md) to complete the integration between your load balancer, ECE proxies, TLS certificates, and wildcard DNS record.
121+
::::
104122

105-
7. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment.
123+
::::{tip}
124+
If you don't yet have a load balancer, TLS certificates, or a wildcard DNS record ready, you can [change the endpoint URL](./change-endpoint-urls.md) to the IP address of one of the ECE proxies, using the format `PROXY_IP.ip.es.io`. This will allow you to continue using the deployment endpoint URLs provided by the Cloud UI.
125+
::::
106126
107-
Once the installation is complete, you can continue with [](./post-installation-steps.md).
127+
Once the installation is complete, you can continue with [](./post-installation-steps.md).

deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ This type of installation is recommended for many production setups. You need:
2121
:alt: A medium installation with nine to twelve hosts across three availability zones
2222
:::
2323

24+
::::{note}
25+
In the diagram, the Director Coordinator host in Availability zone 1, which represents the first host to be installed, has the allocator role greyed out. This host temporarily holds all roles until the other nodes are added and configured. Eventually, the allocator role will be removed from this host.
26+
::::
27+
2428
## Important considerations [ece_before_you_start_2]
2529

2630
* Monitor the load on proxies and make sure the volume of user requests routed by the proxies does not affect the resources available to the ECE management services.
@@ -85,8 +89,14 @@ Make sure you have completed all prerequisites and environment preparations desc
8589
bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}'
8690
```
8791

88-
5. [Change the deployment configuration](working-with-deployments.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently.
92+
5. [Log into the Cloud UI](log-into-cloud-ui.md).
93+
94+
6. [Change the deployment configuration](/deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` [system deployments](/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md) to use three availability zones and resize the nodes to use at least 4 GB of RAM. This ensures the system clusters are both highly available and sufficiently provisioned.
95+
96+
7. [Vacate all instances from the initial host](/deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md#move-nodes-from-allocators). This host runs some {{es}} and {{kib}} instances from system deployments, which must be moved to other allocators before proceeding.
97+
98+
Wait until all instances have been moved off the initial host before continuing.
8999

90-
6. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment.
100+
8. [Remove the `allocator` role](/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) from the initial host. You cannot remove the role until all instances have been vacated.
91101

92-
Once the installation is complete, you can continue with [](./post-installation-steps.md).
102+
Once the installation is complete, you can continue with [](./post-installation-steps.md).

0 commit comments

Comments
 (0)