-
Notifications
You must be signed in to change notification settings - Fork 163
[D&M] Drafts maintenance content #421
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 33 commits
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
eefbfff
[D&M] Drafts maintenance intro.
szabosteve 3a7999f
Merge branch 'main' into szabosteve/maintenance
szabosteve 4bd7d08
[E&A] Removes Kibana .-related info.
szabosteve 58c8731
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve 3dc5dfa
[D&M] Refines start and stop ES page.
szabosteve 9e1df49
[D&M] Links.
szabosteve 97ed2bf
Merge branch 'main' into szabosteve/maintenance
szabosteve 718b74c
[D&M] Adds intro for start and stop services.
szabosteve c828103
[D&M] ECE maintenance.
szabosteve d2a2738
[D&M] Fixes links.
szabosteve 3dd4b47
Merge branch 'main' into szabosteve/maintenance
szabosteve bf5b63e
[D&M] Deployments maintenance and request routing.
szabosteve fd0bfe3
Merge branch 'main' into szabosteve/maintenance
szabosteve 5fa1ae6
[M&D] Fixes links.
szabosteve d7b964b
[D&M] Adds maintenance activities section.
szabosteve b9ecbc6
[D&M] Refines host maintenance, scale out installtion.
szabosteve 5eb9d82
[D&M] Refines start and stop services.
szabosteve 3821471
Merge branch 'main' into szabosteve/maintenance
szabosteve e14ae74
Merge branch 'main' into szabosteve/maintenance
szabosteve 68b37f1
Fixes conflicts.
szabosteve f7148e9
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve ef5d5f1
Merge branch 'main' into szabosteve/maintenance
szabosteve 57e9042
[D&M] Fixes links.
szabosteve d78328a
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve 7ab401f
[D&M] Addresses feedback part 1.
szabosteve 47f301c
Apply suggestions from code review
szabosteve 797f02a
Update deploy-manage/maintenance/ece/start-stop-routing-requests.md
szabosteve bfeb442
Merge branch 'main' into szabosteve/maintenance
szabosteve b5cd996
[D&M] Addresses feedback part 2.
szabosteve db5ca27
Merge branch 'main' into szabosteve/maintenance
szabosteve 2091425
[D&M] Fixes errors.
szabosteve 06cffdc
[D&M] Fixes links.
szabosteve 2265940
[D&M] More link fix.
szabosteve 537a698
Apply suggestions from code review
szabosteve ba9cc10
Merge branch 'main' into szabosteve/maintenance
szabosteve 9675c6f
Update deploy-manage/maintenance/start-stop-services/start-stop-elast…
szabosteve 7120338
Merge branch 'main' into szabosteve/maintenance
szabosteve 7cc4aca
[D&M] Moves stop routing request skript instructions.
szabosteve dd86595
Merge branch 'szabosteve/maintenance' of github.com:elastic/docs-cont…
szabosteve 514f94f
Merge branch 'main' into szabosteve/maintenance
szabosteve cf4c789
Update deploy-manage/maintenance/start-stop-services/full-cluster-res…
szabosteve 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,21 @@ | ||
--- | ||
mapped_pages: | ||
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html | ||
applies_to: | ||
stack: | ||
deployment: | ||
eck: | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
ess: | ||
ece: | ||
self: | ||
--- | ||
szabosteve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Maintenance [ece-manage-kibana] | ||
# Maintenance [maintenance] | ||
|
||
Kibana is an open source analytics and visualization platform designed to work with Elasticsearch, 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 Elasticsearch queries in real time. | ||
szabosteve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This section outlines the key tasks and processes required to maintain a healthy, performant, and secure {{es}} infrastructure and its deployments. | ||
|
||
Most deployment templates include a Kibana instance, but if it wasn’t part of the initial deployment you can go to the **Kibana** page and **Enable** Kibana. | ||
|
||
The new Kibana instance takes a few moments to provision. After provisioning Kibana is complete, you can use the endpoint URL to access Kibana. | ||
|
||
::::{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 **Kibana** page you can also: | ||
|
||
* Terminate your Kibana instance, which stops it. The information is stored in your Elasticsearch cluster, so stopping and restarting should not risk your Kibana information. | ||
* Restart it after stopping. | ||
* Upgrade your Kibana instance version if it is out of sync with your Elasticsearch cluster. | ||
* Delete to fully remove the instance, wipe it from the disk, and stop charges. | ||
The topics covered include: | ||
szabosteve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* **[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. |
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 |
---|---|---|
@@ -1,9 +1,17 @@ | ||
--- | ||
applies_to: | ||
deployment: | ||
ece: | ||
--- | ||
|
||
# ECE maintenance | ||
szabosteve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
% What needs to be done: Write from scratch | ||
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] | ||
|
||
% GitHub issue: https://github.com/elastic/docs-projects/issues/353 | ||
[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. | ||
|
||
% Scope notes: Introduction about ECE maintenance and activities / actions. Explain the difference between deployments maintenance and ECE hosts infrastructure maintenance. | ||
[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 page is a work in progress.** ⚠️ | ||
This section provides guidance on best practices for both types of maintenance, helping you maintain a resilient ECE environment. |
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 |
---|---|---|
@@ -1,18 +1,18 @@ | ||
--- | ||
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] | ||
|
||
In some circumstances, you might need to temporarily restrict access to a node so you can perform corrective actions that might otherwise be difficult to complete. For example, if your cluster is being overwhelmed by requests because it is undersized for its workload, its nodes might not respond to efforts to resize. | ||
|
||
These actions act as a maintenance mode for cluster node. Performing these actions can stop the cluster from becoming completely unresponsive so that you can resolve operational issues much more effectively. | ||
These actions act as a maintenance mode for cluster node. Performing these actions can stop the cluster from becoming unresponsive so that you can resolve operational issues much more effectively. | ||
|
||
* [**Stop routing to the instance**](start-stop-routing-requests.md): Block requests from being routed to the cluster node. This is a less invasive action than pausing the cluster. | ||
* [**Pause an instance**](pause-instance.md): Suspend the node immediately by stopping the container that the node runs on without completing existing requests. This is a more aggressive action to regain control of an unresponsive node. | ||
|
||
As an alternative, to quickly add capacity to a deployment if it is unhealthy or at capacity, you can also [override the resource limit for a deployment](../../deploy/cloud-enterprise/resource-overrides.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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,44 @@ | ||
--- | ||
applies_to: | ||
deployment: | ||
ece: | ||
--- | ||
# Maintenance activities | ||
|
||
% What needs to be done: Write from scratch | ||
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. | ||
|
||
% GitHub issue: https://github.com/elastic/docs-projects/issues/353 | ||
## Available maintenance operations | ||
szabosteve marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
% Scope notes: summarize the list of activites | ||
### [Enable maintenance mode](enable-maintenance-mode.md) | ||
|
||
⚠️ **This page is a work in progress.** ⚠️ | ||
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.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 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-hosts-maintenance.md) | ||
|
||
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. | ||
|
||
### [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. | ||
|
||
## Best practices for maintenance | ||
|
||
* Always check available capacity before making changes. | ||
|
||
* Use maintenance mode to avoid unexpected disruptions. | ||
|
||
* Move nodes strategically to maintain high availability. | ||
|
||
* Perform maintenance during off-peak hours when possible. | ||
|
||
* Regularly review and optimize resource allocation. | ||
|
||
By following these guidelines, you can ensure the stability and efficiency of your environment while carrying out necessary maintenance activities. |
Oops, something went wrong.
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.