Skip to content

Commit 4741f3b

Browse files
eedugoneedugon
committed
edit user settings content refined
1 parent 2f59b98 commit 4741f3b

13 files changed

+129
-109
lines changed

‎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

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

Lines changed: 43 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,46 +24,55 @@ To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deploym
2424
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).
2525
::::
2626

27-
Once you have the endpoint, use it in your client application. To test connectivity, open the endpoint in your browser or modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
28-
29-
```sh
30-
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
31-
{
32-
"name" : "instance-0000000000",
33-
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",
34-
"cluster_uuid" : "w2SXqdACQCy5AAixXRxeXg",
35-
"version" : {
36-
"number" : "8.17.3",
37-
"build_flavor" : "default",
38-
"build_type" : "docker",
39-
"build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2",
40-
"build_date" : "2025-02-28T10:07:26.089129809Z",
41-
"build_snapshot" : false,
42-
"lucene_version" : "9.12.0",
43-
"minimum_wire_compatibility_version" : "7.17.0",
44-
"minimum_index_compatibility_version" : "7.0.0"
45-
},
46-
"tagline" : "You Know, for Search"
47-
}
48-
```
49-
50-
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).
27+
Once you have the endpoint, use it in your client application. To test connectivity, you can:
28+
* Open the endpoint in your browser and enter authentication details when prompted.
29+
* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
30+
31+
```sh
32+
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
33+
{
34+
"name" : "instance-0000000000",
35+
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",
36+
"cluster_uuid" : "w2SXqdACQCy5AAixXRxeXg",
37+
"version" : {
38+
"number" : "8.17.3",
39+
"build_flavor" : "default",
40+
"build_type" : "docker",
41+
"build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2",
42+
"build_date" : "2025-02-28T10:07:26.089129809Z",
43+
"build_snapshot" : false,
44+
"lucene_version" : "9.12.0",
45+
"minimum_wire_compatibility_version" : "7.17.0",
46+
"minimum_index_compatibility_version" : "7.0.0"
47+
},
48+
"tagline" : "You Know, for Search"
49+
}
50+
```
51+
52+
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).
53+
54+
::::{note}
55+
When connecting to {{es}}, you can use one of the following ports:
56+
* Port 9243 – Secure HTTPS (**recommended**).
57+
* Port 9200 – Plaintext HTTP (**not recommended**).
58+
::::
59+
60+
## Connect using Cloud ID [ece-cloud-id]
61+
62+
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.
5163

5264
::::{note}
53-
When connecting to {{es}}, you can use one of the following ports:
54-
* Port 9243 – Secure HTTPS (**recommended**).
55-
* Port 9200 – Plaintext HTTP (**not recommended**).
65+
Connections through Cloud IDs are only supported in Beats and Logstash.
5666
::::
5767

58-
## Connect using Cloud ID [ece-cloud-id]
5968

60-
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}}. It works by assigning a unique ID to your hosted {{es}} cluster on {{ece}}. All deployments automatically get a Cloud ID.
69+
Cloud IDs are available in every deployment page, as showed below:
6170

62-
You include your Cloud ID along with your 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.
71+
:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png
72+
:alt: The Cloud ID and `elastic` user information shown when you create a deployment
73+
:::
6374

64-
::::{note}
65-
For information about beats or logstash refer to xxxx
66-
::::
75+
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.
6776

6877
### Before you begin [ece_before_you_begin_16]
6978

@@ -81,7 +90,7 @@ To use the Cloud ID, you need:
8190

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

84-
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.
93+
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.
8594

8695
::::{tip}
8796
For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat.

‎deploy-manage/deploy/cloud-enterprise/create-deployment.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_urls:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-create-deployment.html
47
---
@@ -48,15 +51,8 @@ After a deployment is spun up, you can scale the size and add other features; ho
4851

4952
## Next steps
5053

51-
Once you have created your deployment, consider the following activities:
52-
(TBD)
54+
After creating your deployment, you may want to:
5355

5456
* [Access {{kib}}](./access-kibana.md)
55-
56-
* Connect your applications to your {{es}} cluster to start sending data.
57-
* [Add data](../../../manage-data/ingest.md)
58-
* Configure [users and roles](../../users-roles.md)
59-
* TBD
60-
From "here", you can start ingesting data or simply [try a sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana) set to get started.
61-
62-
Check all other actions from [](./working-with-deployments.md).
57+
* [Connect your applications to {{es}}](./connect-elasticsearch.md) to start [ingesting data](../../../manage-data/ingest.md)
58+
* Learn how to configure and [manage your deployment](./working-with-deployments.md)

‎deploy-manage/deploy/cloud-enterprise/customize-deployment.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-customize-deployment.html
47
---

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The components of the Elastic Stack that we support as part of a deployment are
1414
* Kibana instances
1515
* APM and Fleet instances
1616

17-
Elastic Cloud Enterprise comes with some deployment templates already built in, but you can [create new deployment templates](ece-configuring-ece-create-templates.md) to address a particular use case you might have. To make the most out of your hardware, we also recommend that you [configure deployment templates](configure-deployment-templates.md), so that ECE knows where to deploy components of the Elastic Stack.
17+
Elastic Cloud Enterprise comes with some system deployment templates already built in, but you can [create new deployment templates](ece-configuring-ece-create-templates.md) to address a particular use case you might have. To make the most out of your hardware, we also recommend that you tag your allocators and follow the instructions from [](configure-deployment-templates.md), so that ECE knows where to deploy components of the Elastic Stack.
1818

19-
The deployment templates available are:
19+
The system deployment templates available by default are:
2020

2121
* **Default template**
2222

@@ -42,8 +42,6 @@ The deployment templates available are:
4242

4343
This template allows you to consolidate your logs, metrics, application traces, and system availability with purpose-built UIs. Check the [**Elastic Observability**](../../../solutions/observability/get-started/what-is-elastic-observability.md) documentation for more information.
4444

45-
46-
4745
## Instance configurations [ece-getting-started-instance-configurations]
4846

4947
For instances to run well when they are used in your Elastic Cloud Enterprise deployment, they need the right hardware that supports their intended purpose. For that, Elastic Cloud Enterprise uses *instance configurations*. Instance configurations match the Elastic Stack components to allocators for deployment, and indicate how memory and storage resources get sized relative to each other, and what sizes are available. For example: If you have a logging use case that needs lots of storage space, you probably want your instance configuration to use at least some storage with large spindle drives rather than fast but more expensive SSD storage.

raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md renamed to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
navigation_title: APM user settings
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_urls:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-apm-settings.html
8+
---
9+
110
# Add APM user settings [ece-manage-apm-settings]
211

312
Starting in {{stack}} version 8.0, how you change APM settings and the settings that are available to you depend on how you spin up Elastic APM. There are two modes:
@@ -90,3 +99,4 @@ If the size of the HTTP request frequently exceeds the maximum, you might need t
9099
apm-server:
91100
max_event_size: 407200
92101
```
102+

raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md renamed to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
1+
---
2+
navigation_title: Elasticsearch user settings
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_urls:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html
8+
---
9+
110
# Add Elasticsearch user settings [ece-add-user-settings]
211

312
Change how Elasticsearch runs by providing your own user settings. User settings are appended to the `elasticsearch.yml` configuration file for your cluster and provide custom configuration options. Elastic Cloud Enterprise supports many of the user settings for the version of Elasticsearch that your cluster is running.
413

5-
::::{tip}
6-
Some settings that could break your cluster if set incorrectly are blocked, such as certain zen discovery and security settings. For examples of a few of the settings that are generally safe in cloud environments, check [Additional Examples of Supported User Settings](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-user-settings-examples.html) and [Editing Your User Settings](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) that can be enabled on our Elastic Cloud hosted offering.
14+
::::{note}
15+
ECE blocks the configuration of certain settings that could break your cluster if misconfigured, including some zen discovery and security settings. For a list of settings that are generally safe in cloud environments, check [{{es}} settings](asciidocalypse://pending-link-lisa) on ECE reference documentation.
716
::::
817

18+
To add user settings for {{es}} follow the instructions provided in [](./edit-stack-settings.md)
919

10-
To add user settings:
11-
12-
1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
20+
1. [Log into the Cloud UI](./log-into-cloud-ui.md).
1321
2. On the **Deployments** page, select your deployment.
1422

1523
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
1624

1725
3. From your deployment menu, go to the **Edit** page.
18-
4. In the **Elasticsearch** section, select **Edit elasticsearch.yml**. For deployments with existing user settings, you may have to expand the **User setting overrides** caret for each node type instead.
26+
4. In the **Elasticsearch** section, select **Manage user settings and extensions**. For deployments with existing user settings, you may have to expand the **User setting overrides** caret for each node type instead.
1927
5. Update the user settings.
2028
6. Select **Save changes**.
2129

2230
::::{warning}
2331
If you encounter the **Edit elasticsearch.yml** carets, be sure to make your changes on all Elasticsearch node types.
2432
::::
2533

26-
27-
28-
## Enable email notifications from Gmail [ece_enable_email_notifications_from_gmail]
34+
## Example: enable email notifications from Gmail [ece_enable_email_notifications_from_gmail]
2935

3036
You can configure email notifications to Gmail for a user that you specify. For details, refer to [Configuring email actions](../../../explore-analyze/alerts-cases/watcher/actions-email.md).
3137

32-
::::{warning}
38+
::::{important}
3339
Before you add the `xpack.notification.email*` setting in Elasticsearch user settings, make sure you add the account SMTP password to the keystore as a [secret value](../../../deploy-manage/security/secure-settings.md).
3440
::::

raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md renamed to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
navigation_title: Enterprise search user settings
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_urls:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-enterprise-search-settings.html
8+
---
9+
110
# Add Enterprise Search user settings [ece-manage-enterprise-search-settings]
211

312
:::{important}
@@ -25,3 +34,6 @@ If a setting is not supported by Elastic Cloud Enterprise, an error message disp
2534
::::
2635

2736

37+
38+
39+

raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md renamed to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1+
---
2+
navigation_title: Kibana user settings
3+
applies_to:
4+
deployment:
5+
ece: all
6+
mapped_urls:
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana-settings.html
8+
---
9+
110
# Add Kibana user settings [ece-manage-kibana-settings]
211

3-
Elastic Cloud Enterprise supports most of the standard Kibana and X-Pack settings. Through a YAML editor in the console, you can append Kibana properties to the `kibana.yml` file. Your changes to the configuration file are read on startup.
12+
Elastic Cloud Enterprise supports most of the standard Kibana settings. Through a YAML editor in the console, you can append Kibana properties to the `kibana.yml` file. Your changes to the configuration file are read on startup.
413

514
::::{important}
615
Be aware that some settings that could break your cluster if set incorrectly and that the syntax might change between major versions. Before upgrading, be sure to review the full list of the [latest Kibana settings and syntax](asciidocalypse://docs/kibana/docs/reference/configuration-reference/general-settings.md).
716
::::
817

9-
1018
To change Kibana settings:
1119

1220
1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
@@ -31,7 +39,6 @@ If you have a license from 2018 or earlier, you might receive a warning that you
3139
::::
3240

3341

34-
3542
## Example: Increase the timeout for creating reports [ece_example_increase_the_timeout_for_creating_reports]
3643

3744
When creating reports, you can adjust the number of milliseconds before a worker times out. This is particularly helpful for instances with a slow or heavy load.
@@ -49,4 +56,3 @@ If large exports are causing performance or storage issues, you can increase the
4956
xpack.reporting.csv.maxSizeBytes: "20971520"
5057
```
5158

52-

‎deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md‎

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,27 @@
11
---
2+
navigation_title: Edit stack settings
3+
applies_to:
4+
deployment:
5+
ece: all
26
mapped_urls:
37
- https://www.elastic.co/guide/en/cloud-enterprise/current/editing-user-settings.html
4-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html
5-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana-settings.html
6-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-apm-settings.html
7-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-enterprise-search-settings.html
88
---
99

10-
# Edit stack settings
10+
# Edit stack user settings [editing-user-settings]
1111

12-
% What needs to be done: Refine
12+
From the {{ece}} console you can customize settings for {{es}}, {{kib}}, and other {{stack}} components by applying **user settings** to your deployments. These settings are internally mapped to the appropriate YAML configuration files, such as `elasticsearch.yml` and `kibana.yml`, and they affect all users of that cluster.
1313

14-
% GitHub issue: https://github.com/elastic/docs-projects/issues/339
14+
To customize the settings of your deployments' {{stack}} components:
1515

16-
% Use migrated content from existing pages that map to this page:
16+
1. Open your deployment page in the ECE [Cloud UI](./log-into-cloud-ui.md).
17+
2. In the left navigation menu, select **Edit**.
18+
3. Look for the **Manage user settings and extensions** and **Edit user settings** links for each deployment, and select the one corresponding to the component you want to update, such as {{es}} or {{kib}.
19+
4. Apply the necessary settings in the **Users Settings** tab of the editor and select **Back** when finished.
20+
5. Select **Save** to apply the changes to the deployment. Saving your changes initiates a configuration plan change that restarts the affected components for you.
1721

18-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md
19-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md
20-
% Notes: instructions only, link to reference
21-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md
22-
% Notes: instructions only, link to reference
23-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md
24-
% Notes: instructions only, link to reference
25-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md
22+
The following sections provide extra details and examples for different components:
2623

27-
% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc):
28-
29-
$$$ece-edit-apm-fleet-tls$$$
30-
31-
$$$ece-edit-apm-standalone-settings-ece$$$
32-
33-
34-
35-
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
36-
37-
* [/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md](/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md)
38-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md)
39-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md)
40-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md)
41-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md)
24+
* [](./edit-stack-settings-elasticsearch.md).
25+
* [](./edit-stack-settings-kibana.md).
26+
* [](./edit-stack-settings-apm.md).
27+
* [](./edit-stack-settings-enterprise.md).

0 commit comments

Comments
 (0)