Skip to content

Commit cb9a8d2

Browse files
committed
ece manage deployments complete section refined
1 parent 3ffe66a commit cb9a8d2

22 files changed

+195
-820
lines changed

deploy-manage/deploy/cloud-enterprise.md

Lines changed: 1 addition & 1 deletion
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

deploy-manage/deploy/cloud-enterprise/access-kibana.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To access Kibana:
1919

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

22-
3. Under **Applications**, select the Kibana **Launch** link and wait for Kibana to open.
22+
3. Under **Applications**, select the Kibana **Open** link and wait for Kibana to open.
2323

2424
::::{note}
2525
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.

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

Lines changed: 24 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,63 +7,38 @@ mapped_pages:
77
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html
88
---
99

10-
# Configure your deployment [ece-change-deployment]
11-
12-
In this section you will learn the different ways and possibilities to change your deployment configuration. There are several reasons why you might want to change the configuration of a deployment:
13-
14-
* To increase or decrease deployment capacity by changing the amount of reserved memory and storage.
15-
* To enable [autoscaling](../../../deploy-manage/autoscaling.md) so that available resources for certain deployment components adjust automatically as the demands on them change.
16-
* To enable high availability by adjusting the number of availability zones that your deployment runs in.
17-
* To add, remove, or update {{es}} or {{kib}} configuration settings.
18-
* To upgrade to new versions of Elasticsearch. You can upgrade from one major version to another, such as from 7.17 to 8.0, or from one minor version to another, such as 8.9.0 to 8.9.2. You can’t downgrade versions.
19-
* To update Elasticsearch clusters and Kibana after an updated Elastic Stack pack for a particular version has been added to your Elastic Cloud Enterprise installation.
20-
* To change what plugins are available on your deployment.
21-
22-
23-
You can perform the following configuration changes to your deployments:
24-
25-
* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the Edit UI.
26-
* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings.
27-
* [](./resize-deployment.md): Scale
28-
* [](./add-plugins.md): Enable or disable plugins from the list of available plugins.
29-
* [](./add-custom-bundles-plugins.md): Add custom plugins or configuration files to your {{es}} instances.
30-
* [](./resource-overrides.md): In certain use cases, extend the cluster capacity temporary.
31-
* [](./advanced-cluster-configuration.md): ...
32-
*
10+
% document scope: introduction to deployment configuration use cases
3311

34-
From the deployment menu you can also access to the configuration of the following features:
35-
36-
* Logs and metrics (Stack monitoring).
37-
* Snapshots
38-
* Secure settings
39-
40-
## Configuration use cases
41-
42-
There are several reasons why you might want to change the configuration of a deployment:
12+
# Configure your deployment [ece-change-deployment]
4313

44-
* To increase or decrease deployment capacity by changing the amount of reserved memory and storage.
45-
* To enable [autoscaling](../../../deploy-manage/autoscaling.md) so that available resources for certain deployment components adjust automatically as the demands on them change.
46-
* To enable high availability by adjusting the number of availability zones that your deployment runs in.
47-
* To add, remove, or update {{es}} or {{kib}} configuration settings.
48-
* To upgrade to new versions of Elasticsearch. You can upgrade from one major version to another, such as from 7.17 to 8.0, or from one minor version to another, such as 8.9.0 to 8.9.2. You can’t downgrade versions.
49-
* To update Elasticsearch clusters and Kibana after an updated Elastic Stack pack for a particular version has been added to your Elastic Cloud Enterprise installation.
50-
* To change what plugins are available on your deployment.
14+
You might want to change the configuration of your deployment to:
5115

52-
## Applying changes
16+
* Add features, such as machine learning or APM (application performance monitoring).
17+
* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment.
18+
* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time.
19+
* 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.
20+
* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions.
21+
* Change what plugins or custom bundles are available on your {{es}} cluster.
22+
* Change {{es}}, {{kib}}, or other stack application YML configuration settings.
5323

5424
For single availability zone deployments, there is downtime to portions of your cluster when changes are applied. For HA deployments and with the exception of major version upgrades, we can perform all these changes without interrupting your deployment. During the application of these changes, you can continue to search and index.
5525

56-
Many changes can also be done in bulk: in one action, you can add more memory and storage, upgrade minor versions, adjust the number of plugins and adjust fault tolerance by changing the number of availability zones. Elastic Cloud Enterprise performs all of these changes with a grow-and-shrink operation, making an Elasticsearch cluster and other instances with the new configuration join the existing deployment. After re-joining, updated nodes recover their indexes and start handling requests. When all updated new nodes are ready, the old nodes that were replaced are removed. If you do a major version upgrade, you cannot change the cluster configuration at the same time. Perform these configuration changes separately.
26+
When updating an existing deployment, you can make multiple changes in a single configuration update. For example, you increase memory and storage, upgrade minor versions, adjust the number of plugins, and adjust fault tolerance by changing the number of availability zonesall in one action.
5727

58-
::::{tip}
59-
When you scale up a deployment, 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. (Is your deployment under a heavy load? You might need to [stop routing requests](../../../deploy-manage/maintenance/ece/deployments-maintenance.md) first.)
28+
::::{note}
29+
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.
6030
::::
6131

62-
TBD - EDU
32+
## Preparing a deployment for production [ece-prepare-production]
33+
34+
To make sure you’re all set for production, consider the following actions:
6335

64-
This section describes how to configure and customize your deployments and the different features available for your deployments, such as:
36+
* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the **Edit** deployment view.
37+
* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings.
38+
* [](./resize-deployment.md): Considerations when scaling deployments.
39+
* [](./add-plugins.md): Enable or disable plugins from the list of available extensions in ECE.
40+
* [](./add-custom-bundles-plugins.md): Add custom plugins or external configuration files to your {{es}} instances.
41+
* [](./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.
42+
* [](./resource-overrides.md): Temporary extend cluster capacity to improve stability.
6543

66-
* Stack settings:
67-
* Plugins and extensions:
68-
* Custom bundles and plugins
69-
*
44+
Refer to [](./working-with-deployments.md) for additional actions and configurable features for your deployments, such as snapshots, secure settings, and monitoring.

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

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Each deployment is based on a [deployment template](./deployment-templates.md),
1414

1515
To create a deployment in ECE:
1616

17-
1. From the Cloud UI, select **Create deployment**.
17+
1. From the Cloud UI **Deployments** view, select **Create deployment**.
1818

1919
You can quickly create a deployment by setting the basic parameters shown in the UI. If you need more control, select **Advanced settings** to customize the deployment parameters, including autoscaling, storage, memory, data tiers, and additional Elastic Stack components. Refer to [](./customize-deployment.md) for more information.
2020

@@ -31,7 +31,7 @@ To create a deployment in ECE:
3131
* If the system templates do not meet your requirements, you can [modify them](./ece-configuring-ece-configure-system-templates.md) or [create your own custom templates](../../../deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md).
3232
::::
3333

34-
4. Choose your {{stack}} version. To manage available versions, refer to [](./manage-elastic-stack-versions.md).
34+
4. Choose your {{stack}} version. To manage available versions at platform level, refer to [](./manage-elastic-stack-versions.md).
3535

3636
5. Optionally, [use snapshots](../../tools/snapshot-and-restore/cloud-enterprise.md) to back up your data, or [restore data from another deployment](../../tools/snapshot-and-restore/ece-restore-across-clusters.md).
3737

@@ -53,26 +53,8 @@ After a deployment is spun up, you can scale the size and add other features; ho
5353

5454
## Next steps
5555

56-
% TBD, we have to refine a bit this section
57-
5856
That’s it! Now that you are up and running, you may want to:
5957

6058
* [Start exploring with {{kib}}](./access-kibana.md), our open-source visualization tool. If you’re not familiar with adding data, yet, {{kib}} can show you how to index your data into {{es}}.
6159
* [Connect your applications to {{es}}](./connect-elasticsearch.md) to start [ingesting data](../../../manage-data/ingest.md)
6260
* Learn how to configure and [manage your deployment](./working-with-deployments.md)
63-
64-
% From Shaina in Cloud, TBD.
65-
66-
## Preparing a deployment for production [ec-prepare-production]
67-
68-
To make sure you’re all set for production, consider the following actions:
69-
70-
* [Plan for your expected workloads](/deploy-manage/production-guidance/pl) and consider how many availability zones you’ll need.
71-
* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case.
72-
* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack.
73-
* [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts.
74-
* [Edit settings and defaults](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features.
75-
* [Manage your deployment](/deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete.
76-
* [Set up monitoring](/deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to learn how to configure your deployments for observability, which includes metric and log collection, troubleshooting views, and cluster alerts to automate performance monitoring.
77-
78-

deploy-manage/deploy/cloud-enterprise/customize-deployment.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ mapped_pages:
77
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-customize-deployment.html
88
---
99

10-
% Background and scope note: this document is about the Deployment -> Edit page, how ECE applies changes, and links to other configurable features
10+
% document scope: this document focuses on the Deployment -> Edit page, how ECE applies changes, and links to other configurable features
1111

12-
# Customize your deployment [ece-customize-deployment]
12+
# Customize your deployment components [ece-customize-deployment]
1313

14-
% TBD, refine this intro after checking the UI
15-
In ECE, you can customize your deployment at any time by selecting **Edit** from the deployment page. This allows you to modify the deployment architecture, adjust configuration settings, availability zones, resources, and enable or disable data tiers.
14+
In ECE, you can customize your deployment at any time by selecting **Edit** from the deployment page. This allows you to fine-tune its capacity and architecture, adjust configuration settings, availability zones, and enable or disable [data tiers](/manage-data/lifecycle/data-tiers.md).
1615

1716
::::{note}
1817
The configurable components and allowed values available on the Edit page depend on the [deployment template](./deployment-templates.md) and [instance configurations](./ece-configuring-ece-instance-configurations-default.md) associated with the deployment.
@@ -27,13 +26,23 @@ To customize your deployment:
2726

2827
3. From your deployment menu, go to the **Edit** page.
2928

30-
## Editing deployment
29+
4. Let the user interface guide you through the cluster configuration for your cluster. Refer to [](#ece-edit-deployment) for more details.
3130

32-
In the deployment edit page, you can change the following settings:
31+
::::{tip}
32+
When updating an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update.
33+
::::
34+
35+
5. Select a [configuration strategy](#configuration-strategies) and **Save your changes**. The orchestrator will prepare and execute a plan to apply the requested changes.
36+
37+
Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}.
38+
39+
## Editing deployment [ece-edit-deployment]
40+
41+
In the deployment edit page, you can configure the following settings and features:
3342

3443
* Enable [autoscaling](../../autoscaling.md) so that the available resources adjust automatically as demands on the deployment change.
3544

36-
* If you don’t want to autoscale your deployment, you can manually increase or decrease capacity by adjusting the size of hot, warm, cold, and frozen [data tiers](../../../manage-data/lifecycle/data-tiers.md) nodes. For example, you might want to add warm or cold tier nodes if you have time series data that is accessed less-frequently and rarely needs to be updated.
45+
* If you don’t want to autoscale your deployment, you can manually increase or decrease capacity of each [data tier](../../../manage-data/lifecycle/data-tiers.md) and component. For example, you might add warm or cold tier nodes for time series data that is accessed infrequently, or expand {{kib}} capacity to handle higher workloads.
3746

3847
* From the **Size per zone** drop-down menu, select what best fits your requirements.
3948

@@ -49,31 +58,27 @@ In the deployment edit page, you can change the following settings:
4958
:alt: Number of nodes per deployment size
5059
:::
5160

52-
* Adjust the number of **Availability zones** to increase fault tolerance for the deployment.
53-
54-
* Select **Edit user settings** to add configuration settings to the YML file of any component and further customize its behavior.
55-
56-
For more information, refer to [](edit-stack-settings.md).
61+
* Adjust the number of **Availability zones** for each component to enhance [fault tolerance](./ece-ha.md) in your deployment.
5762

58-
* Enable specific {{es}} plugins which are not enabled by default.
59-
* Enable additional features, such as Machine Learning or coordinating nodes.
60-
* Set specific configuration parameters for your {{es}} nodes or {{kib}} instances.
63+
* Enable additional components, such as [Machine Learning](../../../explore-analyze/machine-learning.md) nodes or an [Integrations server](./manage-integrations-server.md).
6164

62-
## Applying changes
65+
* Select **Manage user settings and extensions** at {{es}} level, or **Edit user settings** for other components, to customize the YML configuration settings and plugin extensions. For more details, refer to [](edit-stack-settings.md) and [](./add-plugins.md).
6366

64-
When clicking on **Save changes** in the Edit deployment page
67+
* Select the **Advanced edit** link at the bottom of the page to access the [](./advanced-cluster-configuration.md) view.
6568

66-
% TBD, explain a bit the different type of plans
69+
::::{warning}
70+
You can break things when using the advanced cluster configuration editor. Use this functionality only if you know what you are doing or if you are being directed by someone from Elastic.
71+
::::
6772

68-
* Select the method to apply changes
69-
* Rolling inline
70-
* Grow and shrink
73+
## Configuration strategies [configuration-strategies]
7174

72-
## Other configuration changes
75+
When you select **Save changes** on the Edit deployment page, the orchestrator initiates a plan to apply the new configuration to your deployment. You can control how these changes are applied to minimize disruption and ensure a smooth transition.
7376

74-
The following configuration settings are not available within the Edit deployment page:
77+
* Autodetect strategy (**recommended**): Let ECE will determine the strategy depending on the type changes to apply.
78+
* Rolling change per node: One node at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes.
79+
* Grow and shrink: The orchestrator creates nodes with the new configuration, then migrates data from the old ones, and eventually delete the original nodes. This strategy is automatically selected when adding or removing master-eligibie nodes.
80+
* Rolling grow and shrink: Similar to grow and shrink, but creating one node at a time. This strategy can take a lot longer than grow and shrink.
7581

76-
* Logs and Metrics (monitoring)
77-
* Secure settings (keystore settings)
78-
* Snapshots
82+
The `Extended maintenance` option will make ECE to [stop routing requests](../../maintenance/ece/start-stop-routing-requests.md) to all instances during the plan execution. The cluster will be unavailable for external connections while the configuration changes are in progress.
7983

84+
When executing plans, always review the reported configuration changes and track progress on the Activity page of the deployment, which includes separate tabs for {{es}} and {{kib}}.

raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md renamed to deploy-manage/deploy/cloud-enterprise/ece-integrations-server-api-example.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ece: all
5+
mapped_urls:
6+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-integrations-server-api-example.html
7+
---
8+
19
# Enable Integrations Server through the API [ece-integrations-server-api-example]
210

311
This example demonstrates how to use the Elastic Cloud Enterprise RESTful API to create a deployment with Integrations Server enabled.
412

5-
For more information on how to manage Integrations Server from the UI, check [Manage your Integrations Server](../../../deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md)
13+
For more information on how to manage Integrations Server from the UI, check [Manage your Integrations Server](manage-integrations-server.md)
614

715

816
## Requirements [ece_requirements_4]

0 commit comments

Comments
 (0)