Skip to content

Commit 6a6fb71

Browse files
Merge branch 'main' into 34-Elastic-Connectors-in-Security
2 parents f3edea0 + c7d2e6f commit 6a6fb71

File tree

225 files changed

+4517
-2511
lines changed

Some content is hidden

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

225 files changed

+4517
-2511
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

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/autoscaling/trained-model-autoscaling.md

Lines changed: 9 additions & 35 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. However, the "Adaptive resources" control is not displayed in {{kib}} for Observability and Security projects.
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.
@@ -152,16 +146,6 @@ In case of ingest-optimized deployments, we maximize the number of model allocat
152146

153147
:::
154148

155-
:::{tab-item} {{serverless-short}}
156-
157-
| Level | Allocations | Threads | VCUs |
158-
| --- | --- | --- | --- |
159-
| Low | Exactly 2 | 1 | 16 |
160-
| Medium | Exactly 32 | 1 | 256 |
161-
| High | 512 for Search<br> No static allocations for Security and Observability<br> | 1 | 4096 for Search<br> No static allocations for Security and Observability<br> |
162-
163-
:::
164-
165149
::::
166150

167151
### Search optimized
@@ -188,9 +172,9 @@ In case of search-optimized deployments, we maximize the number of threads. The
188172

189173
| Level | Allocations | Threads | VCUs |
190174
| --- | --- | --- | --- |
191-
| Low | 0 to 1 dynamically | Always 2 | 0 to 16 dynamically |
192-
| Medium | 1 to 2 (if threads=16), dynamically | Maximum (for example, 16) | 8 to 256 dynamically |
193-
| High | 1 to 32 (if threads=16), dynamically<br> 1 to 128 for Security and Observability<br> | Maximum (for example, 16) | 8 to 4096 for Search<br> 8 to 1024 for Security and Observability<br> |
175+
| Low | 0 to 1 dynamically | 2 | 0 to 16 dynamically |
176+
| Medium | 0 to 2 dynamically for Search and Observatibility<br> 1 to 2 dynamically for Security | 4 | 0 to 256 dynamically for Search and Observatibility<br> 8 to 256 dynamically for Security |
177+
| High | 0 to 32 dynamically for Search and Observatibility<br> 1 to 128 dynamically for Security<br> | 8 | 0 to 4096 dynamically for Search<br> 0 to 1024 dynamically for Observability<br>8 to 1014 dynamically for Security |
194178

195179
:::
196180

@@ -212,14 +196,4 @@ In case of search-optimized deployments, we maximize the number of threads. The
212196

213197
:::
214198

215-
:::{tab-item} {{serverless-short}}
216-
217-
| Level | Allocations | Threads | VCUs |
218-
| --- | --- | --- | --- |
219-
| Low | 1 statically | Always 2 | 16 |
220-
| Medium | 2 statically (if threads=16) | Maximum (for example, 16) | 256 |
221-
| High | 32 statically (if threads=16) for Search<br> No static allocations for Security and Observability<br> | Maximum (for example, 16) | 4096 for Search<br> No static allocations for Security and Observability<br> |
222-
223-
:::
224-
225199
::::
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/add-custom-bundles-plugins.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Custom plugins can include the official {{es}} plugins not provided with {{ece}}
7171
"elasticsearch_version" : "<es_version>" <2>
7272
},
7373
{
74-
"url": "http://www.MYURL.com/my-custom-plugin.zip",
74+
"url": "<MY_HOST_URL>/my-custom-plugin.zip",
7575
"name": "my-custom-plugin",
7676
"elasticsearch_version": "7.17.1"
7777
}
@@ -105,7 +105,7 @@ This example adds a custom LDAP bundle for deployment level role-based access co
105105
"user_bundles": [
106106
{
107107
"name": "ldap-cert",
108-
"url": "http://www.MYURL.com/ldapcert.zip", <1>
108+
"url": "<MY_HOST_URL>/ldapcert.zip", <1>
109109
"elasticsearch_version": "*"
110110
}
111111
]
@@ -151,7 +151,7 @@ In this example, we assume the Identity Provider does not publish its SAML metad
151151
"user_bundles": [
152152
{
153153
"name": "saml-metadata",
154-
"url": "http://www.MYURL.com/saml-metadata.zip", <1>
154+
"url": "<MY_HOST_URL>/saml-metadata.zip", <1>
155155
"elasticsearch_version": "*"
156156
}
157157
]
@@ -254,7 +254,7 @@ To import a JVM trust store:
254254
"user_bundles": [
255255
{
256256
"name": "custom-ca-certs",
257-
"url": "http://www.MYURL.com/cacerts.zip", <1>
257+
"url": "<MY_HOST_URL>/cacerts.zip", <1>
258258
"elasticsearch_version": "*" <2>
259259
}
260260
]
@@ -309,7 +309,7 @@ To import a JVM trust store:
309309
"user_bundles": [
310310
{
311311
"name": "custom-geoip-db",
312-
"url": "http://www.MYURL.com/my-geoip-file.zip",
312+
"url": "<MY_HOST_URL>/my-geoip-file.zip",
313313
"elasticsearch_version": "*"
314314
}
315315
]
@@ -359,7 +359,7 @@ To import a JVM trust store:
359359
"user_bundles": [
360360
{
361361
"name": "custom-synonyms",
362-
"url": "http://www.MYURL.com/synonyms.zip",
362+
"url": "<MY_HOST_URL>/synonyms.zip",
363363
"elasticsearch_version": "*"
364364
}
365365
]

deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1418,7 +1418,7 @@ Having added support for `node_roles` and autoscaling to your custom template, i
14181418
1. Obtain the existing deployment templates by sending the following `GET` request, and take note of the `id` of the template you wish to update.
14191419

14201420
```sh
1421-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
1421+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
14221422
```
14231423

14241424
2. Send a `PUT` request with the updated template on the payload, in order to effectively replace the outdated template with the new one. Note that the following request is just an example, you have to replace `{{template_id}}` with the `id` you collected on step 1. and set the payload to the updated template JSON. Check [set deployment template API](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-deployment-template-v2) for more details.

deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ products:
1515
By default, the deployments `CNAME` is set to `LOCAL_HOST_IP.ip.es.io`, where `LOCAL_HOST_IP` is the IP address of the first installed ECE host. This results in the following default endpoint URLs:
1616

1717
```sh
18-
http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200
19-
https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243
18+
http://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9200
19+
https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
2020
```
2121

2222
::::{important}

deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ $$$fill-anti-affinity$$$`fill-anti-affinity` (default)
4242
To check how allocator affinity is currently configured:
4343

4444
```sh
45-
curl -X GET -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
45+
curl -X GET -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
4646
{
4747
"errors": [{
4848
"code": "platform.config.store.not_found",
@@ -56,7 +56,7 @@ If a configuration option cannot be found, the default `fill-anti-affinity` stra
5656
To set allocator affinity to the `distribute-anti-affinity` strategy:
5757

5858
```sh
59-
curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
59+
curl -X POST -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
6060
{
6161
"changed": false,
6262
"name": "constructor",
@@ -67,7 +67,7 @@ curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform
6767
To update allocator affinity to the `distribute` strategy:
6868

6969
```sh
70-
curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
70+
curl -X PUT -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
7171
{
7272
"changed": true,
7373
"name": "constructor",
@@ -78,7 +78,7 @@ curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/
7878
To change allocator affinity back to the default behavior:
7979

8080
```sh
81-
curl -X DELETE -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
81+
curl -X DELETE -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
8282
{
8383

8484
}

deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Make sure to use a supported combination of Linux distribution and container eng
144144

145145
```text
146146
[engine]
147-
env = ["HTTP_PROXY=http://{proxy-ip}:{proxy-port}", "HTTPS_PROXY=http://{proxy-ip}:{proxy-port}"]
147+
env = ["HTTP_PROXY=http://<PROXY_IP>:<PROXY_PORT>", "HTTPS_PROXY=http://<PROXY_IP>:<PROXY_PORT>"]
148148
```
149149

150150
7. Reload systemd configuration

deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Once you have the endpoint, use it in your client application. To test connectiv
3232
* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
3333

3434
```sh
35-
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
35+
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
3636
{
3737
"name" : "instance-0000000000",
3838
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",

0 commit comments

Comments
 (0)