-
Notifications
You must be signed in to change notification settings - Fork 156
Uninstall section refinements #592
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
Changes from 21 commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
338e4cc
Uninstall section update
kosabogi a994d5d
Fixes applies-tag
kosabogi 7b12d53
Fixes links
kosabogi 463d5af
Link fix
kosabogi f8b971b
Adds applies tag to Kubernetes
kosabogi 6ee4dfd
Update deploy-manage/uninstall.md
kosabogi b2b0d8b
Update deploy-manage/uninstall.md
kosabogi a64e536
Merge branch 'main' into uninstall
kosabogi 23bce0b
Resolving comments
kosabogi a597ff7
Fixing links
kosabogi 093dbe6
Merge branch 'main' into uninstall
kosabogi 6b20645
Update deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md
kosabogi ecf859e
Update deploy-manage/uninstall.md
kosabogi 3f907ca
Update deploy-manage/uninstall.md
kosabogi 53e7e9f
Update deploy-manage/uninstall.md
kosabogi 600e04d
Update deploy-manage/uninstall.md
kosabogi 8416e8a
Update deploy-manage/uninstall.md
kosabogi 99f23b8
Moves note in ECE page
kosabogi 773bfc2
Update deploy-manage/uninstall.md
kosabogi ec3991e
Update deploy-manage/uninstall.md
kosabogi 0890681
Merge branch 'main' into uninstall
kosabogi dd40880
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 4cb4354
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 4934dee
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 543289a
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi e4fa712
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 0374f2a
Update deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md
kosabogi ff8605f
Update deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md
kosabogi 086e824
Update deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md
kosabogi 13a3c26
Merge branch 'main' into uninstall
kosabogi e79aed0
Resolving comments
kosabogi 2c42ca8
Merge branch 'main' into uninstall
kosabogi 89a5a94
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 06123af
Update deploy-manage/uninstall/delete-a-cloud-deployment.md
kosabogi 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
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,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 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,35 +1,93 @@ | ||
--- | ||
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 | ||
applies_to: | ||
deployment: | ||
ess: | ||
ece: | ||
serverless: | ||
--- | ||
|
||
# Delete a cloud deployment | ||
|
||
% What needs to be done: Refine | ||
This page provides instructions for deleting a cloud deployment and outlines key considerations before proceeding. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
% 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, | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
⚠️ **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. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
* [/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) | ||
:::{{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). | ||
::: | ||
|
||
Billing restarts as soon as the deployment is restored. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Serverless | ||
|
||
To delete a severless project, | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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}} | ||
|
||
:::::{{tab-set}} | ||
::::{{tab-item}} Delete a deployment | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
To delete an {{ece}} deployment, | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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. | ||
::: | ||
|
||
:::: | ||
|
||
::::{{tab-item}} 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**. | ||
|
||
:::: | ||
|
||
::::{{tab-item}} 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 Elasticsearch indices. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
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. | ||
|
||
:::: | ||
|
||
::::: |
This file was deleted.
Oops, something went wrong.
42 changes: 20 additions & 22 deletions
42
deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.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
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 | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
::::{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 | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```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. | ||
kosabogi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
:::: | ||
|
||
|
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
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.