Skip to content

Commit c278b91

Browse files
ECE - Manage deployments content added (#725)
Next and hopefully final PR for ECE content elastic/docs-projects#339 Pages to review: - [Manage deployments](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/725/deploy-manage/deploy/cloud-enterprise/working-with-deployments) with all childs. Notes: - Tools and APIs is still in progress / pending - We still need to integrate the information and links about managing ECE through APIs. I haven't included any of this in my last PRs because I don't really know where this info is. We can include that at a later stage. --------- Co-authored-by: shainaraskas <[email protected]>
1 parent 32f08c0 commit c278b91

Some content is hidden

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

48 files changed

+705
-1167
lines changed

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+

deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md

Lines changed: 72 additions & 121 deletions
Large diffs are not rendered by default.

deploy-manage/deploy/cloud-enterprise/add-plugins.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: Configure plugins and extensions
23
applies_to:
34
deployment:
45
ece:
@@ -8,6 +9,10 @@ applies_to:
89

910
Plugins extend the core functionality of {{es}}. {{ece}} makes it easy to add plugins to your deployment by providing a number of plugins that work with your version of {{es}}. One advantage of these plugins is that you generally don’t have to worry about upgrading plugins when upgrading to a new {{es}} version, unless there are breaking changes. The plugins are upgraded along with the rest of your deployment.
1011

12+
::::{note}
13+
This page refers to {{es}} plugins that come built-in with the {{ece}} platform. For details on adding other plugins, refer to [](./add-custom-bundles-plugins.md).
14+
::::
15+
1116
Adding plugins to a deployment is as simple as selecting it from the list of available plugins, but different versions of {{es}} support different plugins. Plugins are available for different purposes, such as:
1217

1318
* National language support, phonetic analysis, and extended unicode support
@@ -21,7 +26,7 @@ You can also [create](elasticsearch://extend/index.md) and add custom plugins.
2126
To add plugins when creating a new deployment:
2227

2328
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) and select **Create deployment**.
24-
2. Make your initial deployment selections, then select **Customize Deployment**.
29+
2. Make your initial deployment selections, then select **Advanced settings**.
2530
3. Beneath the {{es}} master node, expand the **Manage plugins and settings** caret.
2631
4. Select the plugins you want.
2732
5. Select **Create deployment**.

deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_pages:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-advanced-configuration.html
47
---

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

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,36 @@ mapped_pages:
88

99
# Change endpoint URLs [ece-administering-endpoints]
1010

11-
For applications without SSL or HTTPS protocol support, you can use a local endpoint with the HTTP protocol, which in turn connects to your Elasticsearch cluster or to Kibana either using the HTTP or the HTTPS protocol.
11+
{{es}} and {{kib}} endpoint URLs are constructed using the `CLUSTER_ID` of the component ({{es}} or {{kib}}), and the domain name (`CNAME`) configured in the **Deployment Endpoints** section of the **Platform > Settings** UI.
1212

13-
By default, cluster and Kibana endpoint URLs are constructed according to the following pattern, where `CLUSTER_ID` and `LOCAL_HOST_IP` are values that depend on your specific installation:
13+
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:
1414

1515
```sh
1616
http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200
1717
https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243
1818
```
1919

20-
For example:
21-
22-
```sh
23-
http://2882c82e54d4361.us-west-5.aws.found.io:9200
24-
https://2882c82e54d4361.us-west-5.aws.found.io:9243
25-
```
26-
27-
::::{tip}
28-
To find your endpoints, select a deployment review the information on the **Elasticsearch** and **Kibana** pages.
20+
::::{important}
21+
If your application does not support HTTPS, you can connect to the HTTP endpoint on port 9200. However, for security reasons, it is recommended to use **HTTPS (9243)** whenever possible.
2922
::::
3023

3124
To change endpoints in the Cloud UI:
3225

3326
1. [Log into the Cloud UI](log-into-cloud-ui.md).
3427
2. From the **Platform** menu, select **Settings**.
35-
3. Specify the deployment domain name value for your cluster and Kibana endpoints.
28+
3. Specify the deployment domain name (`CNAME`) value for your cluster and Kibana endpoints.
3629
4. Select **Update Deployment endpoints**. The new endpoint becomes effective immediately.
3730

31+
To find your deployment endpoints, select a deployment and review the information on the **Elasticsearch** and **Kibana** pages.
32+
3833
::::{tip}
3934
If you install Elastic Cloud Enterprise on AWS, you likely need to modify the cluster endpoint. To learn more, check [Endpoint URLs Inaccessible on AWS](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip).
4035
::::
4136

42-
4337
::::{tip}
4438
If you have an App Search instance, after specifying a new deployment domain name value you need to reapply the App Search [cluster configuration](advanced-cluster-configuration.md), either with or without any changes.
4539
::::
4640

47-
4841
::::{note}
4942
The built-in Proxy Certificate only validates against the default endpoint format described on this page. Once you change it, it is necessary to upload a new Proxy Certificate as described in [Manage security certificates](/deploy-manage/security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). For test only, clients can be configured with hostname verification disabled until the new certificate is uploaded.
5043
::::
51-
52-

deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ mapped_pages:
66
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-templates.html
77
---
88

9-
# Configure deployment templates [ece-configuring-ece-templates]
9+
# Manage deployment templates [ece-configuring-ece-templates]
1010

1111
Deployment templates combine components of the Elastic Stack, such as Elasticsearch nodes and Kibana instances, for different use cases. Compared to a one-size-fits-all approach to deploying the Elastic Stack, templates provide much greater flexibility and ensure that your deployments have the resources they need to support your use cases. To make the most of deployment templates, you must configure ECE for them.
1212

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
navigation_title: Configure
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_pages:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html
8+
---
9+
10+
% document scope: introduction to deployment configuration use cases
11+
12+
# Configure your deployment [ece-change-deployment]
13+
14+
You can modify your deployment to adjust resources, enable additional features, or optimize performance. To make sure you’re all set for production, consider the following actions:
15+
16+
* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the **Edit** deployment view.
17+
* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings.
18+
* [](./resize-deployment.md): Learn how to scale a deployment, including important considerations, and a practical example.
19+
* [](./add-plugins.md): Enable or disable plugins from the list of available extensions in ECE.
20+
* [](./add-custom-bundles-plugins.md): Add custom plugins or external configuration files to your {{es}} instances.
21+
* [](./ece-regional-deployment-aliases.md): Configure custom aliases to create predictable and human-readable URLs for your {{stack}} components, making them easier to share and use.
22+
* [](./resource-overrides.md): Temporary extend cluster capacity to improve stability.
23+
24+
Refer to [](./working-with-deployments.md) for additional actions and configurable features for your deployments, such as snapshots, secure settings, and monitoring.
25+
26+
## When to modify your deployment [ece-prepare-production]
27+
28+
You might want to change the configuration of your deployment to:
29+
30+
* Add features, such as [machine learning](/explore-analyze/machine-learning.md) or [APM (application performance monitoring)](/solutions/observability/apps/application-performance-monitoring-apm.md).
31+
* [Increase or decrease capacity](./resize-deployment.md) by changing the amount of reserved memory and storage for different parts of your deployment.
32+
* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as [data tiers](/manage-data/lifecycle/data-tiers.md) and machine learning nodes, adjust automatically as the demands on them change over time.
33+
* Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on.
34+
* [Upgrade](../../upgrade/deployment-or-cluster/upgrade-on-ece.md) to new versions of {{es}}. You can upgrade from one major version to another, such as from 8.18 to 9.0, or from one minor version to another, such as 8.16 to 8.17. You can’t downgrade versions.
35+
* Change what plugins are available on your deployment.
36+
* Update {{es}}, {{kib}}, or other stack application YML configuration settings.
37+
38+
## Applying deployment changes
39+
40+
When you modify a deployment and select **Save changes**, {{ece}} prepares and executes a **plan** to apply the requested updates and bring the deployment to the desired state. The type of plan depends on the nature of the changes and the selected [configuration strategy](./customize-deployment.md#configuration-strategies). Some plans involve creating new instances and migrating data, while others may require restarting certain components of the deployment.
41+
42+
For single availability zone deployments, there is downtime to portions of your cluster when changes are applied. For [high availability](./ece-ha.md) deployments, with the exception of major version upgrades, we these changes can be made without interrupting your deployment. While these changes are being applied, you can continue to search and index.
43+
44+
::::{note}
45+
When applying changes, existing data may be migrated to new nodes. For clusters containing large amounts of data, this migration can take some time, especially if your deployment is under a heavy workload. Refer to [Configuration strategies](./customize-deployment.md#configuration-strategies) to learn about the different ways ECE applies changes.
46+
::::
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
navigation_title: Connect to Elasticsearch
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_pages:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-id.html
8+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-connect.html
9+
---
10+
11+
# Connect to Elasticsearch [ece-connect]
12+
13+
This section explains how to connect client applications to an {{es}} deployment running on ECE. You can use the [endpoint URL](#ece-connect-endpoint) available in the deployment UI, or the [Cloud ID](#ece-cloud-id) for a simplified setup with compatible clients such as Beats and Logstash.
14+
15+
% TBD - not sure if this is totally accurate
16+
% {{ece}} clusters running on ECE only support connections over **HTTP/HTTPS** through the RESTful API. Direct connections to the transport port are not supported.
17+
18+
To successfully connect to a deployment, you need both the connection details and valid authentication credentials for an authorized user in the target deployment. For more details on authentication and authorization mechanisms in ECE, refer to [Users and roles](../../users-roles.md#orchestrator-level).
19+
20+
## Connect using the endpoint URL [ece-connect-endpoint]
21+
22+
To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deployment page in the [Cloud UI](./log-into-cloud-ui.md).
23+
24+
::::{important}
25+
Application endpoints in ECE are generated based on the domain name configured in **Platform > Settings**. To learn how to modify these endpoints, refer to [Change endpoint URLs](./change-endpoint-urls.md).
26+
::::
27+
28+
Once you have the endpoint, use it in your client application. To test connectivity, you can:
29+
* Open the endpoint in your browser and enter authentication details when prompted.
30+
* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
31+
32+
```sh
33+
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
34+
{
35+
"name" : "instance-0000000000",
36+
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",
37+
"cluster_uuid" : "w2SXqdACQCy5AAixXRxeXg",
38+
"version" : {
39+
"number" : "8.17.3",
40+
"build_flavor" : "default",
41+
"build_type" : "docker",
42+
"build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2",
43+
"build_date" : "2025-02-28T10:07:26.089129809Z",
44+
"build_snapshot" : false,
45+
"lucene_version" : "9.12.0",
46+
"minimum_wire_compatibility_version" : "7.17.0",
47+
"minimum_index_compatibility_version" : "7.0.0"
48+
},
49+
"tagline" : "You Know, for Search"
50+
}
51+
```
52+
53+
The previous example authenticates to the cluster using the default `elastic` user. For more information on authentication and authorization in {{es}}, refer to [](../../users-roles.md).
54+
55+
::::{note}
56+
When connecting to {{es}}, you can use one of the following ports:
57+
* Port 9243 – Secure HTTPS (**recommended**).
58+
* Port 9200 – Plaintext HTTP (**not recommended**).
59+
::::
60+
61+
## Connect using Cloud ID [ece-cloud-id]
62+
63+
The Cloud ID reduces the number of steps required to start sending data from [Beats](https://www.elastic.co/guide/en/beats/libbeat/current/index.html) or [Logstash](https://www.elastic.co/guide/en/logstash/current/index.html) to your hosted {{es}} cluster on ECE, by assigning a unique ID to your cluster.
64+
65+
::::{note}
66+
Connections through Cloud IDs are only supported in Beats and Logstash.
67+
::::
68+
69+
70+
Cloud IDs are available in every deployment page, as showed below:
71+
72+
:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png
73+
:alt: The Cloud ID and `elastic` user information shown when you create a deployment
74+
:::
75+
76+
Include this ID along with your user credentials (defined in `cloud.auth`) in your Beat or Logstash configuration. ECE will handle the remaining connection details, ensuring secure data transfer to your hosted cluster.
77+
78+
### Before you begin [ece_before_you_begin_16]
79+
80+
To use the Cloud ID, you need:
81+
82+
* A deployment with an {{es}} cluster to send data to.
83+
* Beats or Logstash, installed locally wherever you want to send data from.
84+
* To configure Beats or Logstash, you need:
85+
* The unique Cloud ID for your deployment, available from the deployment overview page.
86+
* A user ID and password that has permission to send data to your {{es}} cluster.
87+
88+
::::{important}
89+
In our examples, we use the `elastic` superuser that every {{es}} cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation.
90+
::::
91+
92+
### Example: Configure Beats with your Cloud ID [ece-cloud-id-beats]
93+
94+
The following example shows how you can send operational data from Metricbeat to a new ECE deployment by using the Cloud ID. While this example uses Metricbeat, the same approach applies to other Beats.
95+
96+
::::{tip}
97+
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat.
98+
::::
99+
100+
To get started with Metricbeat and {{ece}}:
101+
102+
1. [Log into the Cloud UI](log-into-cloud-ui.md).
103+
2. [Create a new deployment](create-deployment.md) and copy down the password for the `elastic` user.
104+
3. On the deployment overview page, copy down the Cloud ID.
105+
4. Set up the Beat of your choice, such as [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md).
106+
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md).
107+
108+
::::{note}
109+
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information.
110+
::::
111+
112+
6. Open Kibana and explore!
113+
114+
Metricbeat creates a data view (formerly *index pattern*) with defined fields, searches, visualizations, and dashboards that you can start exploring in Kibana. Look for information related to system metrics, such as CPU usage, utilization rates for memory and disk, and details for processes.

0 commit comments

Comments
 (0)