Skip to content

Commit 437e0dc

Browse files
authored
Merge branch 'main' into mw-tsds-downsampling
2 parents 3a0f515 + 201f98f commit 437e0dc

File tree

138 files changed

+1244
-661
lines changed

Some content is hidden

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

138 files changed

+1244
-661
lines changed

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/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/autoscaling-in-eck.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ spec:
177177
max: 512Gi
178178
```
179179

180-
You can find [a complete example in the ECK GitHub repository](https://github.com/elastic/cloud-on-k8s/blob/{{eck_release_branch}}/config/recipes/autoscaling/elasticsearch.yaml) which will also show you how to fine-tune the [autoscaling deciders](/deploy-manage/autoscaling/autoscaling-deciders.md).
180+
You can find [a complete example in the ECK GitHub repository](https://github.com/elastic/cloud-on-k8s/blob/{{version.eck | M.M}}/config/recipes/autoscaling/elasticsearch.yaml) which will also show you how to fine-tune the [autoscaling deciders](/deploy-manage/autoscaling/autoscaling-deciders.md).
181181

182182

183183
#### Change the polling interval [k8s-autoscaling-polling-interval]

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

deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Versions of the {{stack}}, containing {{es}}, {{kib}}, and other products, are a
1414

1515
The first table contains the stack versions that shipped with the 4.0 version of {{ece}}. You can also check the [most recent stack packs and Docker images](#ece-recent-download-list), which might have released after the 4.0 version of ECE, as well as the [full list of available stack packs and Docker images](#ece-full-download-list).
1616

17-
| Docker images included with {{ece}} {{ece_version}} |
17+
| Docker images included with {{ece}} {{version.ece}} |
1818
| --- |
19-
| docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}} |
19+
| docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}} |
2020
| docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 |
2121
| docker.elastic.co/cloud-release/kibana-cloud:8.18.0 |
2222
| docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 |

deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To perform an offline installation without a private Docker registry, you have t
1616
1. On an internet-connected host that has Docker installed, download the [Available Docker Images](ece-install-offline-images.md). Note that for ECE version 4.0, if you want to use {{stack}} version 9.0 in your deployments, you need to download and make available both the version 8.x and version 9.x Docker images (the version 8.x images are required for system deployments).
1717

1818
```sh subs=true
19-
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
19+
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}}
2020
docker pull docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
2121
docker pull docker.elastic.co/cloud-release/kibana-cloud:8.18.0
2222
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -26,15 +26,15 @@ To perform an offline installation without a private Docker registry, you have t
2626
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0
2727
```
2828

29-
For example, for {{ece}} {{ece_version}} and the {{stack}} versions it shipped with, you need:
29+
For example, for {{ece}} {{version.ece}} and the {{stack}} versions it shipped with, you need:
3030

31-
* {{ece}} {{ece_version}}
31+
* {{ece}} {{version.ece}}
3232
* {{es}} 9.0.0, {{kib}} 9.0.0, and APM 9.0.0
3333

3434
2. Create .tar files of the images:
3535

3636
```sh subs=true
37-
docker save -o ece.{{ece_version}}.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
37+
docker save -o ece.{{version.ece}}.tar docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}}
3838
docker save -o es.8.18.0.tar docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
3939
docker save -o kibana.8.18.0.tar docker.elastic.co/cloud-release/kibana-cloud:8.18.0
4040
docker save -o apm.8.18.0.tar docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -48,7 +48,7 @@ To perform an offline installation without a private Docker registry, you have t
4848
4. On each host, load the images into Docker, replacing `FILE_PATH` with the correct path to the .tar files:
4949

5050
```sh subs=true
51-
docker load < FILE_PATH/ece.{{ece_version}}.tar
51+
docker load < FILE_PATH/ece.{{version.ece}}.tar
5252
docker load < FILE_PATH/es.8.18.0.tar
5353
docker load < FILE_PATH/kibana.8.18.0.tar
5454
docker load < FILE_PATH/apm.8.18.0.tar

deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
2222
2. On an internet-connected host that has Docker installed, download the [Available Docker Images](ece-install-offline-images.md) and push them to your private Docker registry. Note that for ECE version 4.0, if you want to use {{stack}} version 9.0 in your deployments, you need to download and make available both the version 8.x and version 9.x Docker images.
2323

2424
```sh subs=true
25-
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
25+
docker pull docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}}
2626
docker pull docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0
2727
docker pull docker.elastic.co/cloud-release/kibana-cloud:8.18.0
2828
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0
@@ -32,9 +32,9 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
3232
docker pull docker.elastic.co/cloud-release/elastic-agent-cloud:9.0.0
3333
```
3434

35-
For example, for {{ece}} {{ece_version}} and the {{stack}} versions it shipped with, you need:
35+
For example, for {{ece}} {{version.ece}} and the {{stack}} versions it shipped with, you need:
3636

37-
* {{ece}} {{ece_version}}
37+
* {{ece}} {{version.ece}}
3838
* {{es}} 9.0.0, {{kib}} 9.0.0, APM 9.0.0
3939

4040
:::{important}
@@ -44,7 +44,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
4444
3. Tag the Docker images with your private registry URL by replacing `REGISTRY` with your actual registry address, for example `my.private.repo:5000`:
4545

4646
```sh subs=true
47-
docker tag docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}} REGISTRY/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
47+
docker tag docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}} REGISTRY/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}}
4848
docker tag docker.elastic.co/cloud-release/elasticsearch-cloud-ess:8.18.0 REGISTRY/cloud-release/elasticsearch-cloud-ess:8.18.0
4949
docker tag docker.elastic.co/cloud-release/kibana-cloud:8.18.0 REGISTRY/cloud-release/kibana-cloud:8.18.0
5050
docker tag docker.elastic.co/cloud-release/elastic-agent-cloud:8.18.0 REGISTRY/cloud-release/elastic-agent-cloud:8.18.0
@@ -57,7 +57,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau
5757
4. Push the Docker images to your private Docker registry, using the same tags from the previous step. Replace `REGISTRY` with your actual registry URL, for example `my.private.repo:5000`:
5858

5959
```sh subs=true
60-
docker push REGISTRY/cloud-enterprise/elastic-cloud-enterprise:{{ece_version}}
60+
docker push REGISTRY/cloud-enterprise/elastic-cloud-enterprise:{{version.ece}}
6161
docker push REGISTRY/cloud-release/elasticsearch-cloud-ess:8.18.0
6262
docker push REGISTRY/cloud-release/kibana-cloud:8.18.0
6363
docker push REGISTRY/cloud-release/elastic-agent-cloud:8.18.0

0 commit comments

Comments
 (0)