Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
eefbfff
[D&M] Drafts maintenance intro.
szabosteve Feb 12, 2025
3a7999f
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 12, 2025
4bd7d08
[E&A] Removes Kibana .-related info.
szabosteve Feb 12, 2025
58c8731
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve Feb 12, 2025
3dc5dfa
[D&M] Refines start and stop ES page.
szabosteve Feb 13, 2025
9e1df49
[D&M] Links.
szabosteve Feb 13, 2025
97ed2bf
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 13, 2025
718b74c
[D&M] Adds intro for start and stop services.
szabosteve Feb 13, 2025
c828103
[D&M] ECE maintenance.
szabosteve Feb 13, 2025
d2a2738
[D&M] Fixes links.
szabosteve Feb 13, 2025
3dd4b47
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 13, 2025
bf5b63e
[D&M] Deployments maintenance and request routing.
szabosteve Feb 17, 2025
fd0bfe3
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 17, 2025
5fa1ae6
[M&D] Fixes links.
szabosteve Feb 17, 2025
d7b964b
[D&M] Adds maintenance activities section.
szabosteve Feb 17, 2025
b9ecbc6
[D&M] Refines host maintenance, scale out installtion.
szabosteve Feb 17, 2025
5eb9d82
[D&M] Refines start and stop services.
szabosteve Feb 17, 2025
3821471
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 17, 2025
e14ae74
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 17, 2025
68b37f1
Fixes conflicts.
szabosteve Feb 18, 2025
f7148e9
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve Feb 18, 2025
ef5d5f1
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 18, 2025
57e9042
[D&M] Fixes links.
szabosteve Feb 18, 2025
d78328a
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve Feb 18, 2025
7ab401f
[D&M] Addresses feedback part 1.
szabosteve Feb 19, 2025
47f301c
Apply suggestions from code review
szabosteve Feb 19, 2025
797f02a
Update deploy-manage/maintenance/ece/start-stop-routing-requests.md
szabosteve Feb 19, 2025
bfeb442
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 19, 2025
b5cd996
[D&M] Addresses feedback part 2.
szabosteve Feb 19, 2025
db5ca27
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 19, 2025
2091425
[D&M] Fixes errors.
szabosteve Feb 19, 2025
06cffdc
[D&M] Fixes links.
szabosteve Feb 19, 2025
2265940
[D&M] More link fix.
szabosteve Feb 19, 2025
537a698
Apply suggestions from code review
szabosteve Feb 19, 2025
ba9cc10
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 19, 2025
9675c6f
Update deploy-manage/maintenance/start-stop-services/start-stop-elast…
szabosteve Feb 19, 2025
7120338
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 19, 2025
7cc4aca
[D&M] Moves stop routing request skript instructions.
szabosteve Feb 19, 2025
dd86595
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve Feb 19, 2025
514f94f
Merge branch 'main' into szabosteve/maintenance
szabosteve Feb 19, 2025
cf4c789
Update deploy-manage/maintenance/start-stop-services/full-cluster-res…
szabosteve Feb 19, 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
13 changes: 10 additions & 3 deletions deploy-manage/maintenance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
---

# Maintenance [maintenance]
Expand All @@ -9,6 +16,6 @@ This section outlines the key tasks and processes required to maintain a healthy

The topics covered include:

* **ECE Maintenance**: Explains the procedures for maintaining both the host infrastructure and {{es}} deployments within Elastic Cloud Enterprise (ECE).
* **Start and Stop services**: Provides step-by-step instructions on how to safely start and stop your {{es}} deployment or {{kib}} instance, particularly when performing actions that require a restart.
* **Add and remove {{es}} nodes**: Guides you through the process of enrolling new nodes or safely removing existing ones from an {{es}} cluster to optimize resource utilization and cluster performance.
* **[ECE Maintenance](maintenance/ece.md)**: Explains the procedures for maintaining both the host infrastructure and {{es}} deployments within Elastic Cloud Enterprise (ECE).
* **[Start and Stop services](maintenance/start-stop-services.md)**: Provides step-by-step instructions on how to safely start and stop your {{es}} deployment or {{kib}} instance, particularly when performing actions that require a restart.
* **[Add and remove {{es}} nodes](maintenance/add-and-remove-elasticsearch-nodes.md)**: Guides you through the process of enrolling new nodes or safely removing existing ones from a self-managed {{es}} cluster to optimize resource utilization and cluster performance.
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
---

# Add and Remove Elasticsearch nodes [add-elasticsearch-nodes]
Expand All @@ -23,6 +30,16 @@ When you add more nodes to a cluster, it automatically allocates replica shards.

## Enroll nodes in an existing cluster [_enroll_nodes_in_an_existing_cluster_5]

::::{tip}
Refer to the following pages to learn more about how to add nodes to your cluster in different environments:

* [autoscaling](../autoscaling.md)
* [ECE](../deploy/cloud-enterprise/resize-deployment.md)
* [ECH](../deploy/elastic-cloud/configure.md)
* [ECK](../deploy/cloud-on-k8s/update-deployments.md)

::::

You can enroll additional nodes on your local machine to experiment with how an {{es}} cluster with multiple nodes behaves.

::::{note}
Expand Down Expand Up @@ -103,7 +120,6 @@ Although the voting configuration exclusions API is most useful for down-scaling
Voting exclusions are only required when removing at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes, nor are they required when removing fewer than half of the master-eligible nodes.
::::


Adding an exclusion for a node creates an entry for that node in the voting configuration exclusions list, which has the system automatically try to reconfigure the voting configuration to remove that node and prevents it from returning to the voting configuration once it has removed. The current list of exclusions is stored in the cluster state and can be inspected as follows:

```console
Expand Down
29 changes: 8 additions & 21 deletions deploy-manage/maintenance/ece.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
---
applies_to:
deployment:
ece:
---

# ECE maintenance

Elastic Cloud Enterprise (ECE), being a self-managed Elastic Stack deployment platform, abstracts much of the complexity of running {{es}}, but still requires regular maintenance at both the platform and deployment levels. Maintenance activities range from managing individual deployments to performing infrastructure-level updates on ECE hosts.

## Deployment maintenance and host infrastructure maintenance [ece-deployment-host-infra-maintenance]

Deployment maintenance focuses on managing individual {{es}} and {{kib}} instances within ECE. This includes actions such as pausing instances, stopping request routing to nodes, and moving instances between allocators to optimize resource usage or prepare for maintenance. These tasks help maintain service availability and performance without affecting the underlying infrastructure.
[Deployment maintenance](ece/deployments-maintenance.md) focuses on managing individual {{es}} and {{kib}} instances within ECE. This includes actions such as [pausing instances](ece/pause-instance.md), [stopping request routing to nodes](ece/start-stop-routing-requests.md), and [moving instances between allocators](ece/move-nodes-instances-from-allocators.md) to optimize resource usage or prepare for maintenance. These tasks help maintain service availability and performance without affecting the underlying infrastructure.

ECE host infrastructure maintenance involves managing virtual machines that host ECE itself. This includes tasks like applying operating system patches, upgrading software, or decommissioning hosts. Infrastructure maintenance often requires more careful planning, as it can impact multiple deployments running on the affected hosts. Methods such as placing allocators into maintenance mode and redistributing workloads provide a smooth transition during maintenance operations.
[ECE host infrastructure maintenance](ece/perform-ece-hosts-maintenance.md) involves managing virtual machines that host ECE itself. This includes tasks like applying operating system patches, upgrading software, or decommissioning hosts. Infrastructure maintenance often requires more careful planning, as it can impact multiple deployments running on the affected hosts. Methods such as placing allocators into [maintenance mode](ece/enable-maintenance-mode.md) and redistributing workloads provide a smooth transition during maintenance operations.

This section provides guidance on best practices for both types of maintenance, helping you maintain a resilient ECE environment.

## Enabling Kibana [ece-manage-kibana]

{{kib}} is an open source analytics and visualization platform designed to work with {{es}}, that makes it easy to perform advanced data analysis and to visualize your data in a variety of charts, tables, and maps. Its simple, browser-based interface enables you to quickly create and share dynamic dashboards that display changes to {{es}} queries in real time.

Most deployment templates include a {{kib}} instance, but if it wasn’t part of the initial deployment you can go to the **{{kib}}** page and **Enable** {{kib}}.

The new {{kib}} instance takes a few moments to provision. After provisioning {{kib}} is complete, you can use the endpoint URL to access {{kib}}.

::::{tip}
You can log into Kibana as the `elastic` superuser. The password was provided when you created your deployment or can be [reset](../users-roles/cluster-or-deployment-auth/built-in-users.md). 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).
::::

From the deployment **{{kib}}** page you can also:

* Terminate your {{kib}} instance, which stops it. The information is stored in your {{es}} cluster, so stopping and restarting should not risk your {{kib}} information.
* Restart it after stopping.
* Upgrade your {{kib}} instance version if it is out of sync with your {{es}} cluster.
* Delete to fully remove the instance, wipe it from the disk, and stop charges.
3 changes: 3 additions & 0 deletions deploy-manage/maintenance/ece/delete-ece-hosts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-delete-runner.html
applies_to:
deployment:
ece:
---

# Delete ECE hosts [ece-delete-runner]
Expand Down
3 changes: 3 additions & 0 deletions deploy-manage/maintenance/ece/deployments-maintenance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-maintenance-mode-deployments.html
applies_to:
deployment:
ece:
---

# Deployments maintenance [ece-maintenance-mode-deployments]
Expand Down
5 changes: 4 additions & 1 deletion deploy-manage/maintenance/ece/enable-maintenance-mode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-maintenance-mode.html
applies_to:
deployment:
ece:
---

# Enable maintenance mode [ece-maintenance-mode]
Expand All @@ -26,7 +29,7 @@ If you need the existing instances to stop routing requests you can [stop routin
* `ALLOCATOR_ID` Action target allocator id.
* `ENABLE_TRAFFIC` Wether traffic to the selected allocator instances should be enabled (`true`) or disabled (`false`).

This is an example of script execution to disable routing on all instances running on a given allocator: In this example the script disables routing on all instances running on a given allocator:
This is an example of script execution to disable routing on all instances running on a given allocator:

```bash
AUTH_HEADER="Authorization: ApiKey $(cat ~/api.key)" API_URL="https://adminconsole:12443" ALLOCATOR_ID="192.168.44.10" ENABLE_TRAFFIC=false ./allocator-toggle-routing-requests.sh
Expand Down
23 changes: 11 additions & 12 deletions deploy-manage/maintenance/ece/maintenance-activities.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
---
applies_to:
deployment:
ece:
---
# Maintenance activities

Maintenance activities ensure the smooth operation and scalability of your {{es}} installation. This section provides guidelines on performing essential maintenance tasks while minimizing downtime and maintaining high availability.

## Available maintenance operations

### Enable maintenance mode
### [Enable maintenance mode](enable-maintenance-mode.md)

Before performing maintenance on an allocator, you should enable maintenance mode to prevent new Elasticsearch clusters and Kibana instances from being provisioned. This ensures that existing deployments can be safely moved to other allocators or adjusted without disruption.

### Scale out installation
### [Scale out installation](scale-out-installation.md)

You can scale out your installation by adding capacity to meet growing demand or improve high availability. This process involves installing ECE on additional hosts, assigning roles to new hosts, and resizing deployments to utilize the expanded resources.

### Move nodes and instances betwwen allocators
### [Move nodes and instances between allocators](move-nodes-instances-from-allocators.md)

Moving {{es}} nodes, {{kib}} instances, and other components between allocators may be necessary to free up space, avoid downtime, or handle allocator failures. The process involves selecting target allocators and ensuring enough capacity to accommodate the migration.

### Perform ECE host maintenance
### [Perform ECE host maintenance](perform-ece-hosts-maintenance.md)

Maintaining ECE hosts is critical for applying system patches, performing hardware upgrades, and ensuring compliance with security standards. Different maintenance methods are available based on the level of disruption:
Maintaining ECE hosts is critical for applying system patches, performing hardware upgrades, and ensuring compliance with security standards. Learn about the various methods of maintaining hosts, and their impact on your ECE installation.

* Disabling the Docker daemon (nondestructive): Temporarily disables a host while keeping it in the installation.

* Deleting the host (destructive): Permanently removes a host, requiring reinstallation after maintenance.

* Shutting down the host (less destructive): Temporarily shuts down a host while preserving configurations for planned outages.

### Delete ECE hosts
### [Delete ECE hosts](delete-ece-hosts.md)

If a host is no longer required or is faulty, it can be removed from the Elastic Cloud Enterprise installation. Deleting a host only removes it from the installation but does not uninstall the software from the physical machine. Before deletion, allocators should be placed in maintenance mode, and nodes should be migrated to avoid disruption.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-move-nodes.html
applies_to:
deployment:
ece:
---

# Move nodes or instances from allocators [ece-move-nodes]
Expand All @@ -12,7 +15,7 @@ You might need to move Elasticsearch nodes, Kibana instances, and other componen
* To make room on an allocator: You can move some smaller deployments to another allocator if you need additional room for a larger one on an allocator.
* To move deployments after a failure: When host failures happen, you can move all deployments from the affected allocator to a healthy allocator quickly before spending any time on fixing the failure.

::::{tip}
::::{tip}
When you move all nodes from an existing allocator to the new one, ECE migrates the data to new nodes. The migration can take some time, especially when deployments contain large amounts of data and have a heavy workload. Is your deployment under a heavy workload? You might need to [stop routing requests](deployments-maintenance.md) first.
::::

Expand All @@ -26,6 +29,8 @@ If you followed our recommendation and [tagged your allocators](../../deploy/clo

When you move all nodes from an existing allocator to the new one, ECE migrates the data to new nodes. The migration can take some time, especially when clusters contain large amounts of data and have a heavy workload. Is your cluster under a heavy workload? You might need to [stop routing requests](deployments-maintenance.md) first.

## Moving nodes from allocators [move-nodes-from-allocators]

To move nodes from one allocator to another one:

1. [Log into the Cloud UI](../../deploy/cloud-enterprise/log-into-cloud-ui.md).
Expand Down Expand Up @@ -61,10 +66,9 @@ To move nodes from one allocator to another one:

Set Timeout
: On by default.
::::{tip}
If you did not enable maintenance mode, set a target allocator under the advanced options when moving nodes to make sure the nodes do not end up on the same allocator again. By default, moving a node moves it to any allocator that has enough capacity.
::::

::::{tip}
If you did not enable maintenance mode, set a target allocator under the advanced options when moving nodes to make sure the nodes do not end up on the same allocator again. By default, moving a node moves it to any allocator that has enough capacity.
::::

1. Repeat **step 6** for each of the node types until no nodes remain on the allocator.
2. Optionally, once the nodes have been moved, **Delete Allocator**.
8. Repeat **step 6** for each of the node types until no nodes remain on the allocator.
9. Optionally, once the nodes have been moved, **Delete Allocator**.
3 changes: 3 additions & 0 deletions deploy-manage/maintenance/ece/pause-instance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-maintenance-mode-pausing.html
applies_to:
deployment:
ece:
---

# Pause instance [ece-maintenance-mode-pausing]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-perform-host-maintenance.html
applies_to:
deployment:
ece:
---

# Perform ECE hosts maintenance [ece-perform-host-maintenance]
Expand Down
13 changes: 8 additions & 5 deletions deploy-manage/maintenance/ece/scale-out-installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-capacity.html
applies_to:
deployment:
ece:
---

# Scale out your installation [ece-add-capacity]
Expand All @@ -19,8 +22,8 @@ Check the available capacity:

If this is not sufficient, add more capacity to your installation:

* [Install Elastic Cloud Enterprise on additional hosts](../../deploy/cloud-enterprise/install-ece-on-additional-hosts.md) to create additional capacity.
* [Add capacity](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-allocator-settings) to existing allocators by updating the allocator settings when adding memory to the host.
* [Assign roles](../../deploy/cloud-enterprise/assign-roles-to-hosts.md) to the additional hosts. If you need to handle a larger search or logging workload, assign the new hosts the allocator role.
* (Optional) [Tag allocators](../../deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md) to the new host to indicate what kind of hardware you have available.
* [Resize your deployment](../../deploy/cloud-enterprise/resize-deployment.md) to handle a larger workload.
1. [Install Elastic Cloud Enterprise on additional hosts](../../deploy/cloud-enterprise/install-ece-on-additional-hosts.md) to create additional capacity.
2. [Add capacity](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-allocator-settings) to existing allocators by updating the allocator settings when adding memory to the host.
3. [Assign roles](../../deploy/cloud-enterprise/assign-roles-to-hosts.md) to the additional hosts. If you need to handle a larger search or logging workload, assign the new hosts the allocator role.
4. (Optional) [Tag allocators](../../deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md) to the new host to indicate what kind of hardware you have available.
5. [Resize your deployment](../../deploy/cloud-enterprise/resize-deployment.md) to handle a larger workload.
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
mapped_urls:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-maintenance-mode-routing.html
- https://www.elastic.co/guide/en/cloud/current/ec-maintenance-mode-routing.html
applies_to:
deployment:
ece:
---

# Start and stop routing requests
# Start and stop routing requests [maintenance-mode-routing]

## Request routing [maintenance-mode-routing]

The {{ecloud}} proxy service routes traffic from external sources to the deployment, between deployments, and between products within a deployment. For example, it routes API requests from your local machine to your deployment, CCR and CCS requests between your deployments, and communications between {{kib}} and {{es}}. It does not direct the TCP traffic between {{es}} nodes, nor does it manage requests starting within {{es}} outwards to external sources such as to snapshot repositories.

Expand All @@ -33,3 +35,4 @@ The instance will then report **Not routing requests**. It will complete existin
## Restart routing requests [restart-routing-requests]

To unblock HTTP requests for an instance, select **Start routing requests** under from instance’s menu.

24 changes: 20 additions & 4 deletions deploy-manage/maintenance/start-stop-services.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
---
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
---

# Start and stop services

This section covers the recommended procedures for:

* starting and stopping Elasticsearch
* starting and stopping Kibana
* restarting cloud-hosted deployments
* full cluster and rolling restarts
* [starting and stopping Elasticsearch](start-stop-services/start-stop-elasticsearch.md)
* [starting and stopping Kibana](start-stop-services/start-stop-kibana.md)
* [restarting an ECE deployment](start-stop-services/restart-an-ece-deployment.md)
* [restarting cloud-hosted deployments](start-stop-services/restart-cloud-hosted-deployment.md)
* [full cluster and rolling restarts](start-stop-services/full-cluster-restart-rolling-restart-procedures.md)

::::{note}
In ECK, when a resource – like {{es}} or {{kib}} – is declared, the reconciliation loop ensures the desired state is maintained. There is no built-in stop mechanism in Kubernetes because it’s designed for declarative state management. You either define a resource, and Kubernetes ensures it’s running, or you delete it. You can restart instances by deleting Pods, as the platform will start them immediately.

::::

Following these guidelines helps prevent data loss, minimize downtime, and maintain optimal performance across different environments.
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/restart-cluster.html
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
---

# Full Cluster restart and rolling restart procedures [restart-cluster]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-restart-deployment.html
applies_to:
deployment:
ece:
---

# Restart an ECE deployment [ece-restart-deployment]
Expand Down
Loading
Loading