-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Uninstall section refinements (#592)
This PR improves the Uninstall section with the following updates: - Created an [overview page for Uninstall](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/592/deploy-manage/uninstall). - Refined content for [Elastic Cloud Enterprise](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/592/deploy-manage/uninstall/uninstall-elastic-cloud-enterprise). - Refined content for [Elastic Cloud on Kubernetes](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/592/deploy-manage/uninstall/uninstall-elastic-cloud-on-kubernetes). - Added content for [Elastic Cloud Hosted](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/592/deploy-manage/uninstall/delete-a-cloud-deployment). - Refined content for [self-managed deployments](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/592/deploy-manage/uninstall/uninstall-a-self-managed-cluster). --------- Co-authored-by: shainaraskas <[email protected]> Co-authored-by: Edu González de la Herrán <[email protected]>
- Loading branch information
3 people
authored
Feb 28, 2025
1 parent
6b53514
commit cccf0ba
Showing
6 changed files
with
131 additions
and
64 deletions.
There are no files selected for viewing
This file contains 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 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,7 +1,29 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| eck: | ||
| ess: | ||
| ece: | ||
| self: | ||
| serverless: | ||
| --- | ||
|
|
||
| # Uninstall | ||
|
|
||
| % What needs to be done: Write from scratch | ||
| Uninstalling Elastic components, such as {{es}} clusters, deployments, or orchestrators, may be necessary for several reasons. You might need to decommission a host, scale down a self-managed cluster, recover from an installation issue that can't be resolved, or start fresh with a clean setup. | ||
|
|
||
| Different Elastic environments require different uninstallation steps. Choose the guide that matches your setup: | ||
|
|
||
| * Uninstall an orchestrator: | ||
| * [Uninstall an {{ece}} host](/deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md) | ||
| * [Uninstall {{eck}} operator](/deploy-manage/uninstall/uninstall-elastic-cloud-on-kubernetes.md) | ||
|
|
||
| * Delete an orchestrated deployment: | ||
| * [{{ech}} deployments](/deploy-manage/uninstall/delete-a-cloud-deployment.md#elastic-cloud-hosted) | ||
| * [Serverless projects](/deploy-manage/uninstall/delete-a-cloud-deployment.md#serverless) | ||
| * [{{ece}} deployments](/deploy-manage/uninstall/delete-a-cloud-deployment.md#ece) | ||
|
|
||
| % GitHub issue: https://github.com/elastic/docs-projects/issues/362 | ||
| :::{note} | ||
| You can uninstall {{es}} nodes or {{kib}} instances on self-managed clusters, but step-by-step instructions are not currently available. For more details on the implications of removing {{es}} nodes, refer to [](/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes.md). | ||
| ::: | ||
|
|
||
| ⚠️ **This page is a work in progress.** ⚠️ |
This file contains 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,35 +1,85 @@ | ||
| --- | ||
| mapped_urls: | ||
| - https://www.elastic.co/guide/en/cloud-heroku/current/ech-delete-deployment.html | ||
| - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-delete-deployment.html | ||
| - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-terminate-deployment.html | ||
| - https://www.elastic.co/guide/en/cloud/current/ec-delete-deployment.html | ||
| - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-restore-deployment.html | ||
| - https://www.elastic.co/guide/en/cloud/current/ec-billing-stop.html | ||
| - https://www.elastic.co/guide/en/serverless/current/general-billing-stop-project.html | ||
| navigation_title: "Delete a cloud deployment" | ||
| applies_to: | ||
| deployment: | ||
| ess: | ||
| ece: | ||
| serverless: | ||
| --- | ||
|
|
||
| # Delete a cloud deployment | ||
| # Delete an Enterprise or Hosted deployment or a Serverless project | ||
|
|
||
| % What needs to be done: Refine | ||
| This page provides instructions for deleting several types of cloud deployments, and outlines key considerations before proceeding. | ||
|
|
||
| % Use migrated content from existing pages that map to this page: | ||
| ## {{ech}} [elastic-cloud-hosted] | ||
|
|
||
| % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md | ||
| % - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md | ||
| % - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md | ||
| % - [ ] ./raw-migrated-files/cloud/cloud/ec-billing-stop.html | ||
| % - [ ] ./raw-migrated-files/cloud/cloud/ec-delete-deployment.md | ||
| % - [ ] ./raw-migrated-files/docs-content/serverless/general-billing-stop-project.html | ||
| % - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md | ||
| % Notes: if you need to restore a deleted deployment ... | ||
| To delete an {{ech}} deployment: | ||
|
|
||
| ⚠️ **This page is a work in progress.** ⚠️ | ||
| 1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). | ||
| 2. On the deployment overview page, select **Actions**, then select **Delete deployment** and confirm the deletion. | ||
|
|
||
| The documentation team is working to combine content pulled from the following pages: | ||
| When you delete your deployment, billing stops immediately, rounding up to the nearest hour. | ||
|
|
||
| :::{{warning}} | ||
| When deployments are deleted, we erase all data on disk, including snapshots. Snapshots are retained for very a limited amount of time post deletion and we cannot guarantee that deleted deployments can be restored from snapshots for this reason. If you accidentally delete a deployment, please contact support as soon as possible to increase the likelihood of restoring your deployment. | ||
| ::: | ||
|
|
||
| :::{{tip}} | ||
| If you want to keep the snapshot for future purposes even after the deployment deletion, you should [use a custom snapshot repository](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md). | ||
| ::: | ||
|
|
||
| ## Serverless | ||
|
|
||
| To delete a {{serverless-full}} project: | ||
|
|
||
| 1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). | ||
| 2. Find your project on the home page in the **Serverless Projects** card and select **Manage** to access it directly. Or, select **Serverless Projects** to go to the projects page to view all of your projects. | ||
| 3. Select **Actions**, then select **Delete project** and confirm the deletion. | ||
|
|
||
| :::{warning} | ||
| All data is lost. Billing for usage is by the hour and any outstanding charges for usage before you deleted the project will still appear on your next bill. | ||
| ::: | ||
|
|
||
| ## {{ece}} | ||
|
|
||
| ### Delete a deployment | ||
|
|
||
| To delete an {{ece}} deployment: | ||
|
|
||
| 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. Terminate the deployment. | ||
| 4. Select **Delete deployment** and follow the steps to delete the deployment permanently. | ||
|
|
||
| :::{warning} | ||
| Deleting a deployment cannot be undone. | ||
| ::: | ||
|
|
||
| ### Terminate a deployment | ||
|
|
||
| Terminating a deployment stops all running instances and **deletes all data**. Only configuration information is saved so that you can restore the deployment in the future. If there is [a snapshot repository associated](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md) with the Elasticsearch cluster and at least one snapshot has been taken, you can restore the cluster with the same indices later. | ||
|
|
||
| To terminate an {{ece}} deployment, | ||
|
|
||
| 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. In the **Deployment Management** section, select **Terminate deployment**. | ||
|
|
||
|
|
||
| ### Restore a deployment | ||
|
|
||
| You can restore a deployment that was previously terminated to its original configuration. Note that the data that was in the deployment is not restored, since it is deleted as part of the termination process. If you have a snapshot, you can [restore it](/deploy-manage/tools/snapshot-and-restore/restore-snapshot.md) to recover the {{es}} indices. | ||
|
|
||
| To restore a terminated deployment, | ||
|
|
||
| 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. In the **Deployment Management** section, select **Restore** and then acknowledge the confirmation message. | ||
|
|
||
| * [/raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md](/raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md) | ||
| * [/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md) | ||
| * [/raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md) | ||
| * [/raw-migrated-files/cloud/cloud/ec-delete-deployment.md](/raw-migrated-files/cloud/cloud/ec-delete-deployment.md) | ||
| * [/raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md) |
This file was deleted.
Oops, something went wrong.
44 changes: 21 additions & 23 deletions
44
deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md
This file contains 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,41 +1,39 @@ | ||
| --- | ||
| mapped_pages: | ||
| - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-uninstall.html | ||
| applies_to: | ||
| deployment: | ||
| ece: | ||
| --- | ||
|
|
||
| # Uninstall Elastic Cloud Enterprise [ece-uninstall] | ||
| # Uninstall {{ece}} [ece-uninstall] | ||
|
|
||
| You might need to remove Elastic Cloud Enterprise for one of the following reasons: | ||
| This guide provides instructions for uninstalling {{ece}} from a specific host within an {{ece}} platform. This process removes the {{ece}} software from the host but does not uninstall the entire {{ece}} platform. | ||
|
|
||
| * If the installation process does not complete successfully and you cannot troubleshoot the issue. | ||
| * If you are de-provisioning a host and want to remove the installed Elastic Cloud Enterprise software. | ||
| You might need to remove {{ece}} for one of the following reasons: | ||
|
|
||
| You remove Elastic Cloud Enterprise by removing all containers on the host: | ||
|
|
||
| * If using Docker | ||
|
|
||
| ::::{admonition} | ||
| ```sh | ||
| docker rm -f frc-runners-runner frc-allocators-allocator $(docker ps -a -q); sudo rm -rf /mnt/data/elastic/ && docker ps -a | ||
| ``` | ||
| * The installation process does not complete successfully and you can't troubleshoot the issue. | ||
| * You are de-provisioning a host and want to remove the installed {{ece}} software. | ||
|
|
||
| ::::{important} | ||
| If the {{ece}} host you are uninstalling has the allocator role and is running instances from orchestrated deployments, all containers will be deleted, causing the instances to appear unhealthy on the Deployments page. To avoid disruptions, it is recommended to [vacate the host](/deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md) before uninstalling {{ece}}. | ||
| :::: | ||
|
|
||
| You can remove {{ece}} by removing all containers on the host: | ||
|
|
||
| * If using Podman | ||
| * If using Docker: | ||
|
|
||
| ::::{admonition} | ||
| ```sh | ||
| sudo podman rm -f frc-runners-runner frc-allocators-allocator $(sudo podman ps -a -q); sudo rm -rf /mnt/data/elastic && sudo podman ps -a | ||
| ``` | ||
| ```sh | ||
| docker rm -f frc-runners-runner frc-allocators-allocator $(docker ps -a -q); sudo rm -rf /mnt/data/elastic/ && docker ps -a | ||
| ``` | ||
|
|
||
| :::: | ||
| * If using Podman: | ||
|
|
||
| ```sh | ||
| sudo podman rm -f frc-runners-runner frc-allocators-allocator $(sudo podman ps -a -q); sudo rm -rf /mnt/data/elastic && sudo podman ps -a | ||
| ``` | ||
|
|
||
| If you plan to reinstall Elastic Cloud Enterprise on the host, make sure you [delete the host](../maintenance/ece/delete-ece-hosts.md) from the Cloud UI first. Reinstallation can fail if the host is still associated with your old Elastic Cloud Enterprise installation. | ||
| If you plan to reinstall {{ece}} on the host, make sure you [delete the host](../maintenance/ece/delete-ece-hosts.md) from the Cloud UI first. Reinstallation can fail if the host is still associated with your old {{ece}} installation. | ||
|
|
||
| ::::{warning} | ||
| During installation, the system generates secrets that are placed into the `/mnt/data/elastic/bootstrap-state/bootstrap-secrets.json` secrets file, unless you passed in a different path with the --host-storage-path parameter. Keep the information in the `bootstrap-secrets.json` file secure by removing it from its default location and placing it into a secure storage location. | ||
| During installation, the system generates secrets that are placed into the `/mnt/data/elastic/bootstrap-state/bootstrap-secrets.json` secrets file, unless you passed in a different path with the `--host-storage-path` parameter. Keep the information in the `bootstrap-secrets.json` file secure by removing it from its default location and placing it into a secure storage location. | ||
| :::: | ||
|
|
||
|
|
This file contains 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