Skip to content

Commit c7aec77

Browse files
Merge branch 'main' into dist_arch
2 parents cfa0278 + 1a78c05 commit c7aec77

File tree

849 files changed

+10722
-20741
lines changed

Some content is hidden

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

849 files changed

+10722
-20741
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ To create a bearer token:
7070
{ "token": "eyJ0eXa...<very long string>...MgBmsw4s" }
7171
```
7272
73-
2. Specify the bearer token in the Authentication header of your API requests. To learn more, check [accessing the API from the command line](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/ece-api-command-line.md).
73+
2. Specify the bearer token in the Authentication header of your API requests. To learn more, check [accessing the API from the command line](cloud://reference/cloud-enterprise/ece-api-command-line.md).
7474

deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ This example demonstrates how to use the {{ecloud}} RESTful API to create a depl
198198

199199
The example deployment has a hot data and content tier, warm data tier, cold data tier, and a machine learning node, all of which will scale within the defined parameters. To learn about the autoscaling settings, check [Deployment autoscaling](../autoscaling.md) and [Autoscaling example](#ec-autoscaling-example).
200200

201-
To learn more about the {{ece}} API, see the [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/restful-api.md) documentation. For details on the {{ech}} API, check [RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md).
201+
To learn more about the {{ece}} API, see the [RESTful API](cloud://reference/cloud-enterprise/restful-api.md) documentation. For details on the {{ech}} API, check [RESTful API](cloud://reference/cloud-hosted/ec-api-restful.md).
202202

203203
### Requirements [ec_requirements]
204204

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The available resources of self-managed deployments are static, so trained model
3232
{{serverless-full}} Security and Observability projects are only charged for data ingestion and retention. They are not charged for processing power (VCU usage), which is used for more complex operations, like running advanced search models. For example, in Search projects, models such as ELSER require significant processing power to provide more accurate search results.
3333

3434
## Enabling autoscaling through APIs - adaptive allocations [enabling-autoscaling-through-apis-adaptive-allocations]
35+
3536
$$$nlp-model-adaptive-resources$$$
3637

3738
Model allocations are independent units of work for NLP tasks. If you set the numbers of threads and allocations for a model manually, they remain constant even when not all the available resources are fully used or when the load on the model requires more resources. Instead of setting the number of allocations manually, you can enable adaptive allocations to set the number of allocations based on the load on the process. This can help you to manage performance and cost more easily. (Refer to the [pricing calculator](https://cloud.elastic.co/pricing) to learn more about the possible costs.)
@@ -55,6 +56,7 @@ When you create inference endpoints on {{serverless-short}} using Kibana, adapti
5556
:::
5657

5758
### Optimizing for typical use cases [optimizing-for-typical-use-cases]
59+
5860
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.
5961

6062
* If you want to optimize for ingest, set the number of threads to `1` (`"threads_per_allocation": 1`).
@@ -86,6 +88,11 @@ The used resources for trained model deployments depend on three factors:
8688
* the use case you optimize the model deployment for (ingest or search)
8789
* whether model autoscaling is enabled with adaptive allocations/resources to have dynamic resources, or disabled for static resources
8890

91+
::::{note}
92+
On {{serverless-short}}, VCUs for {{ml}} are based on the amount of vCPU and memory consumed. For {{ml}}, `1` VCU equals `0.125` of vCPU and `1GB` of memory, where vCPUs are measured by allocations multiplied by threads, and where memory is the amount consumed by trained models or {{ml}} jobs.
93+
As a math formula, `VCUs = 8 * allocations * threads`, or `1` VCU for every `1GB` of memory consumed, whichever is greater.
94+
::::
95+
8996
If you use a self-managed cluster or ECK, vCPUs level ranges are derived from the `total_ml_processors` and `max_single_ml_node_processors` values. Use the [get {{ml}} info API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info) to check these values.
9097

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

deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ To change your subscription level:
4141

4242
### Feature usage notifications [ec_feature_usage_notifications]
4343

44-
:::{applies_to}
45-
:hosted: all
46-
:::
44+
```{applies_to}
45+
deployment:
46+
ess: all
47+
```
4748

4849
If you try to change your subscription to a lower level, but you are using features that belong either to your current level or to a higher one, you need to make some changes before you can proceed, as described in **Review required feature changes**.
4950

deploy-manage/cloud-organization/tools-and-apis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Most Elastic resources can be accessed and managed through RESTful APIs. While t
1010
{{ecloud}} API
1111
: You can use the {{ecloud}} API to manage your deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization.
1212

13-
To learn more about the {{ecloud}} API, read through the [API overview](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
13+
To learn more about the {{ecloud}} API, read through the [API overview](cloud://reference/cloud-hosted/ec-api-restful.md), try out some [getting started examples](cloud://reference/cloud-hosted/ec-api-examples.md), and check our [API reference documentation](https://www.elastic.co/docs/api/doc/cloud).
1414

15-
Calls to the {{ecloud}} API are subject to [Rate limiting](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-rate-limiting.md).
15+
Calls to the {{ecloud}} API are subject to [Rate limiting](cloud://reference/cloud-hosted/ec-api-rate-limiting.md).
1616

1717

1818
Elasticsearch APIs
1919
: This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more.
2020

21-
To use these APIs on {{ecloud}} read our topic [Access the API console](asciidocalypse://docs/cloud/docs/reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](elasticsearch://reference/elasticsearch/rest-apis/index.md).
21+
To use these APIs on {{ecloud}} read our topic [Access the API console](cloud://reference/cloud-hosted/ec-api-console.md), and to learn about all of the available endpoints check the [Elasticsearch API reference documentation](elasticsearch://reference/elasticsearch/rest-apis/index.md).
2222

2323
Some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the Elasticsearch APIs on {{ecloud}}.
2424

deploy-manage/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This section focuses on deploying and managing {{es}} and {{kib}}, as well as su
2525
To learn how to deploy optional {{stack}} components, refer to the following sections:
2626
* [Fleet and Elastic Agent](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md)
2727
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
28-
* [Beats](asciidocalypse://docs/beats/docs/reference/index.md)
28+
* [Beats](beats://reference/index.md)
2929
* [Logstash](asciidocalypse://docs/logstash/docs/reference/index.md)
3030
:::
3131

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
If you're deploying the {{stack}} in a self-managed cluster, then install the {{stack}} products you want to use in the following order:
2+
3+
* {{es}}
4+
* {{kib}}
5+
* [Logstash](logstash://reference/index.md)
6+
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](beats://reference/index.md)
7+
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
8+
* [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md)
9+
10+
Installing in this order ensures that the components each product depends on are in place.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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}}, Elasticsearch Hadoop {{stack-version}}, {{kib}} {{stack-version}}, and Logstash {{stack-version}}.
2+
3+
If you’re upgrading an existing installation, see [](/deploy-manage/upgrade.md) for information about how to ensure compatibility with {{stack-version}}.

deploy-manage/deploy/cloud-enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ mapped_urls:
1111

1212
{{ece}} (ECE) is an Elastic self-managed solution for deploying, orchestrating, and managing {{es}} clusters at scale. It provides a centralized platform that allows organizations to run {{es}}, {{kib}}, and other {{stack}} components across multiple machines.
1313

14-
ECE evolves from the Elastic hosted Cloud SaaS offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises.
14+
ECE evolves from the [{{ech}}](./elastic-cloud.md) offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises.
1515

1616
With {{ece}}, you can:
1717

@@ -51,7 +51,7 @@ The section covers the following tasks:
5151
* [Work with deployments](./cloud-enterprise/working-with-deployments.md)
5252
- Use [](./cloud-enterprise/deployment-templates.md) to [](./cloud-enterprise/create-deployment.md)
5353
- [](./cloud-enterprise/customize-deployment.md)
54-
- Use the deployment [Cloud ID](./cloud-enterprise/find-cloud-id.md) and [Endpoint URLs](./cloud-enterprise/find-endpoint-url.md) for clients connection
54+
- [Connect your applications to {{es}}](./cloud-enterprise/connect-elasticsearch.md)
5555

5656
* Learn about [](./cloud-enterprise/tools-apis.md) that you can use with ECE
5757

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ece: all
5+
mapped_pages:
6+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-access-kibana.html
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html
8+
---
9+
10+
# Access Kibana [ece-access-kibana]
11+
12+
Kibana is an open source analytics and visualization platform designed to search, view, and interact with data stored in Elasticsearch indices.
13+
14+
::::{tip}
15+
Most deployment templates include a Kibana instance, but if it wasn’t part of the initial deployment you can [customize your deployment components](./customize-deployment.md) to add {{kib}}.
16+
::::
17+
18+
To access Kibana:
19+
20+
1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
21+
2. On the **Deployments** page, select your deployment.
22+
23+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
24+
25+
3. Under **Applications**, select the Kibana **Open** link and wait for Kibana to open.
26+
27+
::::{note}
28+
Both ports 443 and 9243 can be used to access Kibana. SSO only works with 9243 on older deployments, where you will see an option in the Cloud UI to migrate the default to port 443. In addition, any version upgrade will automatically migrate the default port to 443.
29+
::::
30+
31+
4. Log into Kibana. Single sign-on (SSO) is enabled between your {{ece}} account and the Kibana instance. If you’re logged in already, then Kibana opens without requiring you to log in again. However, if your token has expired, choose from one of these methods to log in:
32+
33+
* Select **Login with Cloud**. You’ll need to log in with an [ECE account](/deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md) credentials and then you’ll be redirected to Kibana.
34+
* Log in with the `elastic` superuser. The password was provided when you created your cluster and [can be reset](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
35+
* Log in with [any users you created in Kibana already](/deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md).
36+
37+
::::{tip}
38+
On AWS and not able to access Kibana? [Check if you need to update your endpoint URL first](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip).
39+
::::
40+
41+
In production systems, you might need to control what Elasticsearch data users can access through Kibana, so you need create credentials that can be used to access the necessary Elasticsearch resources. This means granting read access to the necessary indexes, as well as access to update the `.kibana` index. Refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth.md) for more information.
42+

0 commit comments

Comments
 (0)