-
Notifications
You must be signed in to change notification settings - Fork 159
ECE - Manage deployments content added #725
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.
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
Changes from all commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
e30b052
install and configure ECE refined
eedugon f2615a1
removed incorrect link to raw content
eedugon e43bec7
ECE install structure changed and duplicate content removed
eedugon f1ed120
sections moved in toc
eedugon 557b512
Merge branch 'main' into ece_install_configure
eedugon 3bc8a63
redirect added to fix asciidoc link after file name changes
eedugon 5adfc43
fixed another broken link
eedugon ec08e03
Update deploy-manage/deploy/cloud-enterprise/install.md
eedugon 23804d6
Update deploy-manage/deploy/cloud-enterprise/install.md
eedugon f82063b
Update deploy-manage/deploy/cloud-enterprise/air-gapped-install.md
eedugon 10514f5
Update deploy-manage/deploy/cloud-enterprise/air-gapped-install.md
eedugon b0b0f9b
Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md
eedugon 0374ee8
Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md
eedugon 2025200
Update deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md
eedugon 93b0fd6
Apply suggestions from code review
eedugon 8b39a14
working with shaina's suggestions
eedugon bec10bb
applying Shaina's guidance and suggestions
eedugon 25c0216
conflict solved
eedugon fc8a98b
Merge remote-tracking branch 'origin/main' into ece_deployments
eedugon 29bb745
create deployment doc completed
eedugon 0c0a072
access kibana moved to doc and toc updates
eedugon 6883214
change endpoint urls improved
eedugon 2f59b98
cloud id and endpoint docs merged
eedugon 4741f3b
edit user settings content refined
eedugon 3ffe66a
work in progress with deployments
eedugon cb9a8d2
ece manage deployments complete section refined
eedugon 3c075f9
merging main and solving conflicts
eedugon dda35c8
redirect updated to fix broken link
eedugon b285340
added pending applies_to tags
eedugon d0ba7ff
autoscaling links updated
eedugon c3f639c
Merge remote-tracking branch 'origin/main' into ece_deployments
eedugon 7888fbe
Apply suggestions from code review
eedugon 2d764eb
working on shaina's suggestions
eedugon 5854594
merging main and fixing conflict
eedugon b5c0419
fixing links
eedugon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
applies_to: | ||
deployment: | ||
ece: all | ||
mapped_pages: | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-access-kibana.html | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html | ||
--- | ||
|
||
# Access Kibana [ece-access-kibana] | ||
|
||
Kibana is an open source analytics and visualization platform designed to search, view, and interact with data stored in Elasticsearch indices. | ||
|
||
::::{tip} | ||
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}}. | ||
:::: | ||
|
||
To access Kibana: | ||
|
||
1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). | ||
2. On the **Deployments** page, select your deployment. | ||
|
||
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. | ||
|
||
3. Under **Applications**, select the Kibana **Open** link and wait for Kibana to open. | ||
|
||
::::{note} | ||
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. | ||
:::: | ||
|
||
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: | ||
|
||
* 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. | ||
* 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). | ||
* Log in with [any users you created in Kibana already](/deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md). | ||
|
||
::::{tip} | ||
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). | ||
:::: | ||
|
||
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. | ||
|
193 changes: 72 additions & 121 deletions
193
deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
deploy-manage/deploy/cloud-enterprise/configure-deployment.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
navigation_title: Configure | ||
applies_to: | ||
deployment: | ||
ece: all | ||
mapped_pages: | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html | ||
--- | ||
|
||
% document scope: introduction to deployment configuration use cases | ||
|
||
# Configure your deployment [ece-change-deployment] | ||
|
||
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: | ||
|
||
* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the **Edit** deployment view. | ||
* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings. | ||
* [](./resize-deployment.md): Learn how to scale a deployment, including important considerations, and a practical example. | ||
* [](./add-plugins.md): Enable or disable plugins from the list of available extensions in ECE. | ||
* [](./add-custom-bundles-plugins.md): Add custom plugins or external configuration files to your {{es}} instances. | ||
* [](./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. | ||
* [](./resource-overrides.md): Temporary extend cluster capacity to improve stability. | ||
|
||
Refer to [](./working-with-deployments.md) for additional actions and configurable features for your deployments, such as snapshots, secure settings, and monitoring. | ||
|
||
## When to modify your deployment [ece-prepare-production] | ||
|
||
You might want to change the configuration of your deployment to: | ||
|
||
* Add features, such as [machine learning](/explore-analyze/machine-learning.md) or [APM (application performance monitoring)](/solutions/observability/apps/application-performance-monitoring-apm.md). | ||
* [Increase or decrease capacity](./resize-deployment.md) by changing the amount of reserved memory and storage for different parts of your deployment. | ||
* 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. | ||
* 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. | ||
* [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. | ||
* Change what plugins are available on your deployment. | ||
* Update {{es}}, {{kib}}, or other stack application YML configuration settings. | ||
|
||
## Applying deployment changes | ||
|
||
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. | ||
|
||
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. | ||
|
||
::::{note} | ||
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. | ||
:::: |
114 changes: 114 additions & 0 deletions
114
deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
--- | ||
navigation_title: Connect to Elasticsearch | ||
applies_to: | ||
deployment: | ||
ece: all | ||
mapped_pages: | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-id.html | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-connect.html | ||
--- | ||
|
||
# Connect to Elasticsearch [ece-connect] | ||
|
||
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. | ||
|
||
% TBD - not sure if this is totally accurate | ||
% {{ece}} clusters running on ECE only support connections over **HTTP/HTTPS** through the RESTful API. Direct connections to the transport port are not supported. | ||
|
||
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). | ||
|
||
## Connect using the endpoint URL [ece-connect-endpoint] | ||
|
||
To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deployment page in the [Cloud UI](./log-into-cloud-ui.md). | ||
|
||
::::{important} | ||
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). | ||
:::: | ||
|
||
Once you have the endpoint, use it in your client application. To test connectivity, you can: | ||
* Open the endpoint in your browser and enter authentication details when prompted. | ||
* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values. | ||
|
||
```sh | ||
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243 | ||
{ | ||
"name" : "instance-0000000000", | ||
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c", | ||
"cluster_uuid" : "w2SXqdACQCy5AAixXRxeXg", | ||
"version" : { | ||
"number" : "8.17.3", | ||
"build_flavor" : "default", | ||
"build_type" : "docker", | ||
"build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2", | ||
"build_date" : "2025-02-28T10:07:26.089129809Z", | ||
"build_snapshot" : false, | ||
"lucene_version" : "9.12.0", | ||
"minimum_wire_compatibility_version" : "7.17.0", | ||
"minimum_index_compatibility_version" : "7.0.0" | ||
}, | ||
"tagline" : "You Know, for Search" | ||
} | ||
``` | ||
|
||
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). | ||
|
||
::::{note} | ||
When connecting to {{es}}, you can use one of the following ports: | ||
* Port 9243 – Secure HTTPS (**recommended**). | ||
* Port 9200 – Plaintext HTTP (**not recommended**). | ||
:::: | ||
|
||
## Connect using Cloud ID [ece-cloud-id] | ||
|
||
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. | ||
|
||
::::{note} | ||
Connections through Cloud IDs are only supported in Beats and Logstash. | ||
:::: | ||
|
||
|
||
Cloud IDs are available in every deployment page, as showed below: | ||
|
||
:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png | ||
:alt: The Cloud ID and `elastic` user information shown when you create a deployment | ||
::: | ||
|
||
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. | ||
|
||
### Before you begin [ece_before_you_begin_16] | ||
|
||
To use the Cloud ID, you need: | ||
|
||
* A deployment with an {{es}} cluster to send data to. | ||
* Beats or Logstash, installed locally wherever you want to send data from. | ||
* To configure Beats or Logstash, you need: | ||
* The unique Cloud ID for your deployment, available from the deployment overview page. | ||
* A user ID and password that has permission to send data to your {{es}} cluster. | ||
|
||
::::{important} | ||
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. | ||
:::: | ||
|
||
### Example: Configure Beats with your Cloud ID [ece-cloud-id-beats] | ||
|
||
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. | ||
|
||
::::{tip} | ||
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat. | ||
:::: | ||
|
||
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. | ||
3. On the deployment overview page, copy down the Cloud ID. | ||
4. Set up the Beat of your choice, such as [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md). | ||
5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md). | ||
|
||
::::{note} | ||
Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information. | ||
:::: | ||
|
||
6. Open Kibana and explore! | ||
|
||
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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.