Skip to content

ECE cloud id and endpoint docs refined #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 20, 2025
Merged

ECE cloud id and endpoint docs refined #529

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ca26cbe
ECE cloud id and endpoint docs refined
eedugon Feb 20, 2025
d8f0f82
doc a bit refined
eedugon Feb 20, 2025
b4c6721
Merge branch 'main' into ece_cloud_id_endpoint
eedugon Feb 20, 2025
65594c9
navigation title changed
eedugon Feb 20, 2025
cb78c67
Merge branch 'main' into ece_cloud_id_endpoint
eedugon Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions deploy-manage/deploy/cloud-enterprise/find-cloud-id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
---
navigation_title: Connect using Cloud ID
applies_to:
deployment:
ece: all
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-id.html
---

# Find your Cloud ID [ece-cloud-id]

The Cloud ID reduces the number of steps required to start sending data from Beats or Logstash to your hosted Elasticsearch cluster on Elastic Cloud Enterprise. Because we made it easier to send data, you can start exploring visualizations in Kibana on Elastic Cloud Enterprise that much more quickly.
The Cloud ID reduces the number of steps required to start sending data from Beats or Logstash to your hosted Elasticsearch cluster on {{ece}}. Because we made it easier to send data, you can start exploring visualizations in Kibana on {{ece}} that much more quickly.

:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id-beats-logstash.png
:alt: Exploring data from Beats or Logstash in Kibana after sending it to a hosted Elasticsearch cluster
:::

The Cloud ID works by assigning a unique ID to your hosted Elasticsearch cluster on Elastic Cloud Enterprise. All deployments automatically get a Cloud ID.
The Cloud ID works by assigning a unique ID to your hosted Elasticsearch cluster on {{ece}}. All deployments automatically get a Cloud ID.

You include your Cloud ID along with your Elastic Cloud Enterprise user credentials (defined in `cloud.auth`) when you run Beats or Logstash locally, and then let Elastic Cloud Enterprise handle all of the remaining connection details to send the data to your hosted cluster on Elastic Cloud Enterprise safely and securely.
You include your Cloud ID along with your {{ece}} user credentials (defined in `cloud.auth`) when you run Beats or Logstash locally, and then let {{ece}} handle all of the remaining connection details to send the data to your hosted cluster on {{ece}} safely and securely.

:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png
:alt: The Cloud ID and `elastic` user information shown when you create a deployment
:::


## What are Beats and Logstash? [ece_what_are_beats_and_logstash]

Not sure why you need Beats or Logstash? Here’s what they do:

* [Beats](https://www.elastic.co/products/beats) is our open source platform for single-purpose data shippers. The purpose of Beats is to help you gather data from different sources and to centralize the data by shipping it to Elasticsearch. Beats install as lightweight agents and ship data from hundreds or thousands of machines to your hosted Elasticsearch cluster on Elastic Cloud Enterprise. If you want more processing muscle, Beats can also ship to Logstash for transformation and parsing before the data gets stored in Elasticsearch.
* [Logstash](https://www.elastic.co/products/logstash) is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite place where you stash things, here your hosted Elasticsearch cluster on Elastic Cloud Enterprise. Logstash supports a variety of inputs that pull in events from a multitude of common sources — logs, metrics, web applications, data stores, and various AWS services — all in continuous, streaming fashion.

* [Beats](https://www.elastic.co/products/beats) is our open source platform for single-purpose data shippers. The purpose of Beats is to help you gather data from different sources and to centralize the data by shipping it to Elasticsearch. Beats install as lightweight agents and ship data from hundreds or thousands of machines to your hosted Elasticsearch cluster on {{ece}}. If you want more processing muscle, Beats can also ship to Logstash for transformation and parsing before the data gets stored in Elasticsearch.
* [Logstash](https://www.elastic.co/products/logstash) is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite place where you stash things, here your hosted Elasticsearch cluster on {{ece}}. Logstash supports a variety of inputs that pull in events from a multitude of common sources — logs, metrics, web applications, data stores, and various AWS services — all in continuous, streaming fashion.

## Before you begin [ece_before_you_begin_16]

Expand All @@ -41,18 +43,15 @@ To use the Cloud ID, you need:

In our examples, we use the `elastic` superuser that every Elasticsearch 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](https://www.elastic.co/guide/en/beats/metricbeat/current/feature-roles.html) documentation.



## Configure Beats with your Cloud ID [ece-cloud-id-beats]

The following example shows how you can send operational data from Metricbeat to Elastic Cloud Enterprise by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example.
The following example shows how you can send operational data from Metricbeat to {{ece}} by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example.

::::{tip}
For others, you can learn more about [getting started](https://www.elastic.co/guide/en/beats/libbeat/current/getting-started.html) with each Beat.
::::


To get started with Metricbeat and Elastic Cloud Enterprise:
To get started with Metricbeat and {{ece}}:

1. [Log into the Cloud UI](log-into-cloud-ui.md).
2. [Create a new deployment](create-deployment.md) and copy down the password for the `elastic` user.
Expand Down
14 changes: 10 additions & 4 deletions deploy-manage/deploy/cloud-enterprise/find-endpoint-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
navigation_title: Connect to your deployment using endpoint URLs
applies_to:
deployment:
ece: all
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-connect.html
---

% note: this document is super outdated, the curl example doesn't use authentication and we add a note about Elasticsearch 5.0 or later to add user & password

# Find your endpoint URL [ece-connect]

To connect to your Elasticsearch cluster, you need to look up the the cluster Endpoint URL:
To connect to your Elasticsearch cluster, you need to look up the the Endpoint URLs:

1. [Log into the Cloud UI](log-into-cloud-ui.md), if you aren’t logged in already.
2. On the **Deployments** page, select one of your deployments.
Expand Down Expand Up @@ -33,7 +39,7 @@ To connect to your Elasticsearch cluster, you need to look up the the cluster En
Currently, we support the following ways of connecting to an Elasticsearch cluster:

RESTful API with JSON over HTTP and HTTPS
: Used by the `curl` command and most programming languages that aren’t Java. To interact with your cluster, use your Elasticsearch cluster endpoint information from the **Overview** page in the Cloud UI. Port 9200 is used for plain text, insecure HTTP connections while port 9243 is used for HTTPS. Using HTTPS is generally recommended, as it is more secure.
: Used by the `curl` command and most programming languages that aren’t Java. To interact with your cluster, use your Elasticsearch cluster endpoint information from the deployment overview page in the Cloud UI. Port 9200 is used for plain text, insecure HTTP connections, while port 9243 is used for HTTPS. Using HTTPS is generally recommended, as it is more secure.

If this is your first time using Elasticsearch, you can try out some `curl` commands to become familiar with the basics. If you’re on an operating system like macOS or Linux, you probably already have the `curl` command installed. For example, to connect to your cluster from the command line over HTTPS with the `curl` command:

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you either delete the ingest methods section (line 71) or give the title heading formatting?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a heading, but I wouldn't mind deleting it, whatever you prefer :)

Expand All @@ -60,7 +66,7 @@ RESTful API with JSON over HTTP and HTTPS
If you created a cluster on Elasticsearch 5.0 or later or if you already enabled the security features, you must include authentication details with the -u parameter. For example: `curl -u elastic:W0UN0Rh9WX8eKeN69grVk3bX https://85943ce00a934471cb971009e73d2d39.us-east-1.aws.found.io:9243`. You can check [Get existing ECE security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) for how to get the CA certificate (`elastic-ece-ca-cert.pem` in this example) and use it to connect to the Elasticsearch cluster.
::::

## Ingest methods

Ingest methods
: There are several ways to connect to Elasticsearch, perform searches, insert data, and more. See the [ingesting data](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-ingest-data.html) documentation.
There are several ways to connect to Elasticsearch, perform searches, insert data, and more. See the [ingesting data](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-ingest-data.html) documentation.