Skip to content

Commit 60bb558

Browse files
Merge branch 'main' into issue-1932-prompts-tiles
2 parents 2cc574b + d0ce52a commit 60bb558

File tree

59 files changed

+341
-350
lines changed

Some content is hidden

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

59 files changed

+341
-350
lines changed

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/elastic-cloud/heroku-getting-started-installing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ If you want your add-on to run a specific version of {{es}}, use the `--elastics
4242

4343
To find which {{es}} versions and plugins are currently available, you can omit the version to default to the latest one and add plugins later on from the [{{heroku}} console](https://cloud.elastic.co?page=docs&placement=docs-body). To use your own custom plugins, you can upload and select these plugins in the console as well.
4444

45-
For example: Install the add-on version {{stack-version}} and include the phonetic analysis plugin for MY_APP:
45+
For example: Install the add-on version {{version.stack}} and include the phonetic analysis plugin for MY_APP:
4646

4747
```bash subs=true
48-
heroku addons:create foundelasticsearch --elasticsearch-version {{stack-version}} --plugins analysis-phonetic --app MY_APP
48+
heroku addons:create foundelasticsearch --elasticsearch-version {{version.stack}} --plugins analysis-phonetic --app MY_APP
4949
```
5050

5151
After the add-on gets added, you can perform future version upgrades and plugin changes through the [console](heroku-getting-started-accessing.md).

deploy-manage/deploy/self-managed/_snippets/wolfi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ To use the Wolfi image, append `-wolfi` to the image tag in the Docker command.
55
For example:
66

77
```sh subs=true
8-
docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{stack-version}}
8+
docker pull docker.elastic.co/elasticsearch/elasticsearch-wolfi:{{version.stack}}
99
```

deploy-manage/deploy/self-managed/air-gapped-install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ EPR_BIND_ADDRESS="0.0.0.0"
9898
EPR_BIND_PORT="8443"
9999
EPR_TLS_CERT="/etc/elastic/epr/epr.pem"
100100
EPR_TLS_KEY="/etc/elastic/epr/epr-key.pem"
101-
EPR_IMAGE="docker.elastic.co/package-registry/distribution:{{stack-version}}"
101+
EPR_IMAGE="docker.elastic.co/package-registry/distribution:{{version.stack}}"
102102

103103
podman create \
104104
--name "elastic-epr" \
@@ -149,7 +149,7 @@ ExecStart=/usr/bin/podman run \
149149
-v /etc/elastic/epr/epr-key.pem:/etc/ssl/epr.key:ro \
150150
-e EPR_ADDRESS=0.0.0.0:8443 \
151151
-e EPR_TLS_CERT=/etc/ssl/epr.crt \
152-
-e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution:{{stack-version}}
152+
-e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution:{{version.stack}}
153153
ExecStop=/usr/bin/podman stop --ignore --cidfile=%t/%n.ctr-id
154154
ExecStopPost=/usr/bin/podman rm -f --ignore --cidfile=%t/%n.ctr-id
155155
Type=notify
@@ -178,7 +178,7 @@ The following example script downloads artifacts from the internet to be later s
178178
#!/usr/bin/env bash
179179
set -o nounset -o errexit -o pipefail
180180

181-
STACK_VERSION={{stack-version}}
181+
STACK_VERSION={{version.stack}}
182182
ARTIFACT_DOWNLOADS_BASE_URL=https://artifacts.elastic.co/downloads
183183

184184
DOWNLOAD_BASE_DIR=${DOWNLOAD_BASE_DIR:?"Make sure to set DOWNLOAD_BASE_DIR when running this script"}

deploy-manage/deploy/self-managed/install-elasticsearch-docker-basic.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
3535
3. Pull the {{es}} Docker image.
3636

3737
```sh subs=true
38-
docker pull docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
38+
docker pull docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
3939
```
4040

4141
4. Optional: Install [Cosign](https://docs.sigstore.dev/cosign/system_config/installation/) for your environment. Then use Cosign to verify the {{es}} image’s signature.
@@ -44,13 +44,13 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
4444

4545
```sh subs=true
4646
wget https://artifacts.elastic.co/cosign.pub
47-
cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
47+
cosign verify --key cosign.pub docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
4848
```
4949

5050
The `cosign` command prints the check results and the signature payload in JSON format:
5151

5252
```sh subs=true
53-
Verification for docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} --
53+
Verification for docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} --
5454
The following checks were performed on each of these signatures:
5555
- The cosign claims were validated
5656
- Existence of the claims in the transparency log was verified offline
@@ -60,7 +60,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
6060
5. Start an {{es}} container.
6161

6262
```sh subs=true
63-
docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
63+
docker run --name es01 --net elastic -p 9200:9200 -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
6464
```
6565

6666
::::{tip}
@@ -71,7 +71,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
7171
{{ml-cap}} features such as [semantic search with ELSER](/solutions/search/semantic-search/semantic-search-elser-ingest-pipelines.md) require a larger container with more than 1GB of memory. If you intend to use the {{ml}} capabilities, then start the container with this command:
7272

7373
```sh subs=true
74-
docker run --name es01 --net elastic -p 9200:9200 -it -m 6GB -e "xpack.ml.use_auto_machine_memory_percent=true" docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
74+
docker run --name es01 --net elastic -p 9200:9200 -it -m 6GB -e "xpack.ml.use_auto_machine_memory_percent=true" docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
7575
```
7676

7777
The command prints the `elastic` user password and an enrollment token for {{kib}}.
@@ -114,7 +114,7 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
114114
2. Start a new {{es}} container. Include the enrollment token as an environment variable.
115115

116116
```sh subs=true
117-
docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
117+
docker run -e ENROLLMENT_TOKEN="<token>" --name es02 --net elastic -it -m 1GB docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
118118
```
119119

120120
3. Call the [cat nodes API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes) to verify the node was added to the cluster.
@@ -128,20 +128,20 @@ Use Docker commands to start a single-node {{es}} cluster for development or tes
128128
1. Pull the {{kib}} Docker image.
129129

130130
```sh subs=true
131-
docker pull docker.elastic.co/kibana/kibana:{{stack-version}}
131+
docker pull docker.elastic.co/kibana/kibana:{{version.stack}}
132132
```
133133

134134
2. Optional: Verify the {{kib}} image’s signature.
135135

136136
```sh subs=true
137137
wget https://artifacts.elastic.co/cosign.pub
138-
cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{stack-version}}
138+
cosign verify --key cosign.pub docker.elastic.co/kibana/kibana:{{version.stack}}
139139
```
140140

141141
3. Start a {{kib}} container.
142142

143143
```sh subs=true
144-
docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{stack-version}}
144+
docker run --name kib01 --net elastic -p 5601:5601 docker.elastic.co/kibana/kibana:{{version.stack}}
145145
```
146146

147147
4. When {{kib}} starts, it outputs a unique generated link to the terminal. To access {{kib}}, open this link in a web browser.

deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com
4444
```txt subs=true
4545
...
4646
# Version of Elastic products
47-
STACK_VERSION={{stack-version}}
47+
STACK_VERSION={{version.stack}}
4848
...
4949
```
5050

deploy-manage/deploy/self-managed/install-elasticsearch-docker-configure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ For example:
6666
```sh subs=true
6767
docker run -it --rm \
6868
-v full_path_to/config:/usr/share/elasticsearch/config \
69-
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} \
69+
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} \
7070
bin/elasticsearch-keystore create -p
7171
```
7272

@@ -75,7 +75,7 @@ You can also use a `docker run` command to add or update secure settings in the
7575
```sh subs=true
7676
docker run -it --rm \
7777
-v full_path_to/config:/usr/share/elasticsearch/config \
78-
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} \
78+
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} \
7979
bin/elasticsearch-keystore \
8080
add my.secure.setting \
8181
my.other.secure.setting
@@ -94,7 +94,7 @@ If you’ve already created the keystore and don’t need to update it, you can
9494
In some environments, it might make more sense to prepare a custom image that contains your configuration. A `Dockerfile` to achieve this might be as simple as:
9595

9696
```sh subs=true
97-
FROM docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
97+
FROM docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
9898
COPY --chown=elasticsearch:elasticsearch elasticsearch.yml /usr/share/elasticsearch/config/
9999
```
100100

deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Increased ulimits for [nofile](setting-system-settings.md) and [nproc](/deploy-m
132132
To check the Docker daemon defaults for ulimits, run:
133133

134134
```sh subs=true
135-
docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
135+
docker run --rm docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}} /bin/bash -c 'ulimit -Hn && ulimit -Sn && ulimit -Hu && ulimit -Su'
136136
```
137137

138138
If needed, adjust them in the Daemon or override them per container. For example, when using `docker run`, set:
@@ -167,7 +167,7 @@ To manually set the heap size in production, bind mount a [JVM options](elastics
167167
For testing, you can also manually set the heap size using the `ES_JAVA_OPTS` environment variable. For example, to use 1GB, use the following command.
168168

169169
```sh subs=true
170-
docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="<token>" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
170+
docker run -e ES_JAVA_OPTS="-Xms1g -Xmx1g" -e ENROLLMENT_TOKEN="<token>" --name es01 -p 9200:9200 --net elastic -it docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
171171
```
172172

173173
The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend using `ES_JAVA_OPTS` in production.
@@ -178,7 +178,7 @@ The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend
178178
Pin your deployments to a specific version of the {{es}} Docker image. For example:
179179

180180
```sh subs=true
181-
docker.elastic.co/elasticsearch/elasticsearch:{{stack-version}}
181+
docker.elastic.co/elasticsearch/elasticsearch:{{version.stack}}
182182
```
183183

184184

deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ Download and install the archive for Linux or MacOS.
4343

4444
### Linux [install-linux]
4545

46-
The Linux archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
46+
The Linux archive for {{es}} {{version.stack}} can be downloaded and installed as follows:
4747

4848
```sh subs=true
49-
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-linux-x86_64.tar.gz
50-
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-linux-x86_64.tar.gz.sha512
51-
shasum -a 512 -c elasticsearch-{{stack-version}}-linux-x86_64.tar.gz.sha512 <1>
52-
tar -xzf elasticsearch-{{stack-version}}-linux-x86_64.tar.gz
53-
cd elasticsearch-{{stack-version}}/ <2>
49+
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-linux-x86_64.tar.gz
50+
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-linux-x86_64.tar.gz.sha512
51+
shasum -a 512 -c elasticsearch-{{version.stack}}-linux-x86_64.tar.gz.sha512 <1>
52+
tar -xzf elasticsearch-{{version.stack}}-linux-x86_64.tar.gz
53+
cd elasticsearch-{{version.stack}}/ <2>
5454
```
5555

5656
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-linux-x86_64.tar.gz: OK`.
@@ -60,13 +60,13 @@ cd elasticsearch-{{stack-version}}/ <2>
6060

6161
### MacOS [install-macos]
6262

63-
The MacOS archive for {{es}} {{stack-version}} can be downloaded and installed as follows:
63+
The MacOS archive for {{es}} {{version.stack}} can be downloaded and installed as follows:
6464

6565
```sh subs=true
66-
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
67-
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
68-
tar -xzf elasticsearch-{{stack-version}}-darwin-x86_64.tar.gz
69-
cd elasticsearch-{{stack-version}}/ <2>
66+
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz
67+
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
68+
tar -xzf elasticsearch-{{version.stack}}-darwin-x86_64.tar.gz
69+
cd elasticsearch-{{version.stack}}/ <2>
7070
```
7171

7272
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output `elasticsearch-<version>-darwin-x86_64.tar.gz: OK`.
@@ -75,7 +75,7 @@ cd elasticsearch-{{stack-version}}/ <2>
7575
::::{admonition} macOS Gatekeeper warnings
7676
:class: important
7777

78-
Apple’s rollout of stricter notarization requirements affected the notarization of the {{stack-version}} {{es}} artifacts. If macOS displays a dialog when you first run {{es}} that interrupts it, then you need to take an action to allow it to run.
78+
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version.stack}} {{es}} artifacts. If macOS displays a dialog when you first run {{es}} that interrupts it, then you need to take an action to allow it to run.
7979

8080
To prevent Gatekeeper checks on the {{es}} files, run the following command on the downloaded .tar.gz archive or the directory to which was extracted:
8181

0 commit comments

Comments
 (0)