Skip to content

Commit 4a86f2c

Browse files
Merge branch 'main' into autoscale-migration-344
2 parents bf5fee8 + 62af413 commit 4a86f2c

10 files changed

+155
-100
lines changed

deploy-manage/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,5 +827,4 @@ toc:
827827
children:
828828
- file: uninstall/uninstall-elastic-cloud-enterprise.md
829829
- file: uninstall/uninstall-elastic-cloud-on-kubernetes.md
830-
- file: uninstall/uninstall-a-self-managed-cluster.md
831830
- file: uninstall/delete-a-cloud-deployment.md

deploy-manage/uninstall.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1+
---
2+
applies_to:
3+
deployment:
4+
eck:
5+
ess:
6+
ece:
7+
self:
8+
serverless:
9+
---
10+
111
# Uninstall
212

3-
% What needs to be done: Write from scratch
13+
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.
14+
15+
Different Elastic environments require different uninstallation steps. Choose the guide that matches your setup:
16+
17+
* Uninstall an orchestrator:
18+
* [Uninstall an {{ece}} host](/deploy-manage/uninstall/uninstall-elastic-cloud-enterprise.md)
19+
* [Uninstall {{eck}} operator](/deploy-manage/uninstall/uninstall-elastic-cloud-on-kubernetes.md)
20+
21+
* Delete an orchestrated deployment:
22+
* [{{ech}} deployments](/deploy-manage/uninstall/delete-a-cloud-deployment.md#elastic-cloud-hosted)
23+
* [Serverless projects](/deploy-manage/uninstall/delete-a-cloud-deployment.md#serverless)
24+
* [{{ece}} deployments](/deploy-manage/uninstall/delete-a-cloud-deployment.md#ece)
425

5-
% GitHub issue: https://github.com/elastic/docs-projects/issues/362
26+
:::{note}
27+
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).
28+
:::
629

7-
⚠️ **This page is a work in progress.** ⚠️

deploy-manage/uninstall/delete-a-cloud-deployment.md

Lines changed: 76 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,85 @@
11
---
2-
mapped_urls:
3-
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-delete-deployment.html
4-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-delete-deployment.html
5-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-terminate-deployment.html
6-
- https://www.elastic.co/guide/en/cloud/current/ec-delete-deployment.html
7-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-restore-deployment.html
8-
- https://www.elastic.co/guide/en/cloud/current/ec-billing-stop.html
9-
- https://www.elastic.co/guide/en/serverless/current/general-billing-stop-project.html
2+
navigation_title: "Delete a cloud deployment"
3+
applies_to:
4+
deployment:
5+
ess:
6+
ece:
7+
serverless:
108
---
119

12-
# Delete a cloud deployment
10+
# Delete an Enterprise or Hosted deployment or a Serverless project
1311

14-
% What needs to be done: Refine
12+
This page provides instructions for deleting several types of cloud deployments, and outlines key considerations before proceeding.
1513

16-
% Use migrated content from existing pages that map to this page:
14+
## {{ech}} [elastic-cloud-hosted]
1715

18-
% - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md
19-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md
20-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md
21-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-billing-stop.html
22-
% - [ ] ./raw-migrated-files/cloud/cloud/ec-delete-deployment.md
23-
% - [ ] ./raw-migrated-files/docs-content/serverless/general-billing-stop-project.html
24-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md
25-
% Notes: if you need to restore a deleted deployment ...
16+
To delete an {{ech}} deployment:
2617

27-
⚠️ **This page is a work in progress.** ⚠️
18+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
19+
2. On the deployment overview page, select **Actions**, then select **Delete deployment** and confirm the deletion.
2820

29-
The documentation team is working to combine content pulled from the following pages:
21+
When you delete your deployment, billing stops immediately, rounding up to the nearest hour.
22+
23+
:::{{warning}}
24+
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.
25+
:::
26+
27+
:::{{tip}}
28+
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).
29+
:::
30+
31+
## Serverless
32+
33+
To delete a {{serverless-full}} project:
34+
35+
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
36+
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.
37+
3. Select **Actions**, then select **Delete project** and confirm the deletion.
38+
39+
:::{warning}
40+
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.
41+
:::
42+
43+
## {{ece}}
44+
45+
### Delete a deployment
46+
47+
To delete an {{ece}} deployment:
48+
49+
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
50+
2. On the **Deployments** page, select your deployment.
51+
52+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
53+
54+
3. Terminate the deployment.
55+
4. Select **Delete deployment** and follow the steps to delete the deployment permanently.
56+
57+
:::{warning}
58+
Deleting a deployment cannot be undone.
59+
:::
60+
61+
### Terminate a deployment
62+
63+
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.
64+
65+
To terminate an {{ece}} deployment,
66+
67+
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
68+
2. On the **Deployments** page, select your deployment.
69+
70+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
71+
72+
3. In the **Deployment Management** section, select **Terminate deployment**.
73+
74+
75+
### Restore a deployment
76+
77+
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.
78+
79+
To restore a terminated deployment,
80+
81+
1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md).
82+
2. On the **Deployments** page, select your deployment.
83+
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
84+
3. In the **Deployment Management** section, select **Restore** and then acknowledge the confirmation message.
3085

31-
* [/raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md](/raw-migrated-files/cloud/cloud-heroku/ech-delete-deployment.md)
32-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md)
33-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-terminate-deployment.md)
34-
* [/raw-migrated-files/cloud/cloud/ec-delete-deployment.md](/raw-migrated-files/cloud/cloud/ec-delete-deployment.md)
35-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-restore-deployment.md)

deploy-manage/uninstall/uninstall-a-self-managed-cluster.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,39 @@
11
---
2-
mapped_pages:
3-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-uninstall.html
2+
applies_to:
3+
deployment:
4+
ece:
45
---
56

6-
# Uninstall Elastic Cloud Enterprise [ece-uninstall]
7+
# Uninstall {{ece}} [ece-uninstall]
78

8-
You might need to remove Elastic Cloud Enterprise for one of the following reasons:
9+
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.
910

10-
* If the installation process does not complete successfully and you cannot troubleshoot the issue.
11-
* If you are de-provisioning a host and want to remove the installed Elastic Cloud Enterprise software.
11+
You might need to remove {{ece}} for one of the following reasons:
1212

13-
You remove Elastic Cloud Enterprise by removing all containers on the host:
14-
15-
* If using Docker
16-
17-
::::{admonition}
18-
```sh
19-
docker rm -f frc-runners-runner frc-allocators-allocator $(docker ps -a -q); sudo rm -rf /mnt/data/elastic/ && docker ps -a
20-
```
13+
* The installation process does not complete successfully and you can't troubleshoot the issue.
14+
* You are de-provisioning a host and want to remove the installed {{ece}} software.
2115

16+
::::{important}
17+
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}}.
2218
::::
2319

20+
You can remove {{ece}} by removing all containers on the host:
2421

25-
* If using Podman
22+
* If using Docker:
2623

27-
::::{admonition}
28-
```sh
29-
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
30-
```
24+
```sh
25+
docker rm -f frc-runners-runner frc-allocators-allocator $(docker ps -a -q); sudo rm -rf /mnt/data/elastic/ && docker ps -a
26+
```
3127

32-
::::
28+
* If using Podman:
3329

30+
```sh
31+
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
32+
```
3433

35-
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.
34+
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.
3635

3736
::::{warning}
38-
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.
37+
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.
3938
::::
4039

41-

deploy-manage/uninstall/uninstall-elastic-cloud-on-kubernetes.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
2-
mapped_pages:
3-
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-uninstalling-eck.html
2+
applies_to:
3+
deployment:
4+
eck:
45
---
56

6-
# Uninstall Elastic Cloud on Kubernetes [k8s-uninstalling-eck]
7+
# Uninstall {{eck}} [k8s-uninstalling-eck]
8+
9+
This page provides instructions for uninstalling {{eck}}, including removing all Elastic resources and the {{eck}} operator from your cluster.
710

811
To uninstall the operator:
912

@@ -23,4 +26,6 @@ To uninstall the operator:
2326
kubectl delete -f https://download.elastic.co/downloads/eck/2.16.1/crds.yaml
2427
```
2528

26-
29+
::::{warning}
30+
Deleting CRDs will trigger deletion of all custom resources (Elasticsearch, Kibana, APM Server, Beats, Elastic Agent, Elastic Maps Server, and Logstash) in all namespaces of the cluster, regardless of whether they are managed by a single operator or multiple operators.
31+
::::

solutions/observability/cloud/monitor-amazon-web-services-aws-with-amazon-data-firehose.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ For advanced use cases, source records can be transformed by invoking a custom L
4848

4949
## Step 3: Specify the destination settings for your Firehose stream [firehose-step-three]
5050

51-
1. From the **Destination settings** panel, specify the following settings:
51+
From the **Destination settings** panel, specify the following settings:
5252

53-
* **Elastic endpoint URL**: Enter the Elastic endpoint URL of your Elasticsearch cluster. To find the Elasticsearch endpoint, go to the {{ecloud}} Console and select **Connection details**. Here is an example of how it looks like: `https://my-deployment.es.us-east-1.aws.elastic-cloud.com`.
54-
* **API key**: Enter the encoded Elastic API key. To create an API key, go to the {{ecloud}} Console, select **Connection details** and click **Create and manage API keys**. If you are using an API key with **Restrict privileges**, make sure to review the Indices privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this delivery stream.
55-
* **Content encoding**: For a better network efficiency, leave content encoding set to GZIP.
56-
* **Retry duration**: Determines how long Firehose continues retrying the request in the event of an error. A duration of 60-300s should be suitable for most use cases.
57-
* **Parameters**:
53+
* **Elastic endpoint URL**: Enter the Elastic endpoint URL of your Elasticsearch cluster. To find the Elasticsearch endpoint, go to the {{ecloud}} Console and select **Connection details**. Make sure the endpoint is in the following format: `https://<deployment_name>.es.<region>.<csp>.elastic-cloud.com`.
54+
* **API key**: Enter the encoded Elastic API key. This can be created in Kibana by following the instructions under [API Keys](../../../deploy-manage/api-keys.md). If you are using an API key with **Restrict privileges**, make sure to review the Indices privileges to provide at least "auto_configure" & "write" permissions for the indices you will be using with this delivery stream.
55+
* **Content encoding**: To reduce the data transfer costs, use GZIP encoding.
56+
* **Retry duration**: Determines how long Firehose continues retrying the request in the event of an error. A duration between 60 and 300 seconds should be suitable for most use cases.
57+
* **Parameters**:
5858

59-
* `es_datastream_name`: This parameter is optional and can be used to set which data stream documents will be stored. If this parameter is not specified, data is sent to the `logs-awsfirehose-default` data stream by default.
60-
* `include_cw_extracted_fields`: This parameter is optional and can be set when using a CloudWatch logs subscription filter as the Firehose data source. When set to true, extracted fields generated by the filter pattern in the subscription filter will be collected. Setting this parameter can add many fields into each record and may significantly increase data volume in Elasticsearch. As such, use of this parameter should be carefully considered and used only when the extracted fields are required for specific filtering and/or aggregation.
61-
* `set_es_document_id`: This parameter is optional and can be set to allow Elasticsearch to assign each document a random ID or use a calculated unique ID for each document. Default is true. When set to false, a random ID will be used for each document which will help indexing performance.
59+
* `es_datastream_name`: This parameter is optional and can be used to set which data stream documents will be stored. If not specified, logs are stored in `logs-awsfirehose-default` data stream and metrics are stored in `metrics-aws.cloudwatch-default` data stream.
60+
* `include_cw_extracted_fields`: This parameter is optional and can be set when using a CloudWatch logs subscription filter as the Firehose data source. When set to true, extracted fields generated by the filter pattern in the subscription filter will be collected. Setting this parameter can add many fields to each record and may significantly increase data volume in Elasticsearch. Therefore, use this parameter carefully and only when the extracted fields are required for specific filtering and/or aggregation.
61+
* `set_es_document_id`: This parameter is optional and can be set to allow Elasticsearch to assign each document a random ID or use a calculated unique ID for each document. The default is true. When set to false, a random ID is used for each document, which helps indexing performance.
6262

63-
1. In the **Backup settings** panel, it is recommended to configure S3 backup for failed records. It’s then possible to configure workflows to automatically retry failed records, for example by using [Elastic Serverless Forwarder](asciidocalypse://docs/elastic-serverless-forwarder/docs/reference/index.md).
63+
* **Backup settings**: It is recommended to configure S3 backup for failed records. These backups can be used to restore data losses caused by unforeseen service outages.
6464

6565

6666

solutions/observability/cloud/monitor-aws-network-firewall-logs.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ Creating a Network Firewall is not trivial and is beyond the scope of this guide
6565
1. Go to the [Elastic Cloud](https://cloud.elastic.co/) console
6666
2. Find your deployment in the **Hosted deployments** card and select **Manage**.
6767
3. Under **Applications** click **Copy endpoint** next to **Elasticsearch**.
68+
4. Make sure the endpoint is in the following format: `https://<deployment_name>.es.<region>.<csp>.elastic-cloud.com`.
6869

6970
* **To create the API key**:
7071

@@ -74,17 +75,11 @@ Creating a Network Firewall is not trivial and is beyond the scope of this guide
7475

7576
4. Set up the delivery stream by specifying the following data:
7677

77-
* Elastic endpoint URL
78-
* API key
79-
* Content encoding: gzip
80-
* Retry duration: 60 (default)
81-
* Parameter **es_datastream_name** = `logs-aws.firewall_logs-default`
82-
* Backup settings: failed data only to S3 bucket
83-
84-
85-
::::{important}
86-
Verify that your **Elasticsearch endpoint URL** includes `.es.` between the **deployment name** and **region**. Example: `https://my-deployment.es.us-east-1.aws.elastic-cloud.com`
87-
::::
78+
* Elastic endpoint URL: The URL that you copied in the previous step.
79+
* API key: The API key that you created in the previous step.
80+
* Content encoding: To reduce the data transfer costs, use GZIP encoding.
81+
* Retry duration: A duration between 60 and 300 seconds should be suitable for most use cases.
82+
* Backup settings: It is recommended to configure S3 backup for failed records. These backups can then be used to restore failed data ingestion caused by unforeseen service outages.
8883

8984

9085
The Firehose stream is ready to send logs to our Elastic Cloud deployment.

0 commit comments

Comments
 (0)