Skip to content

Commit df6aa2e

Browse files
authored
Merge branch 'main' into 583-obs-format
2 parents 226328a + 62af413 commit df6aa2e

File tree

53 files changed

+550
-3059
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+550
-3059
lines changed

deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,24 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec
7272

7373
4. Install podman:
7474

75-
* For RHEL 8 and Rocky Linux, install version `4.*`.
75+
* Install the latest available version `4.*` using dnf.
7676

7777
```sh
7878
sudo dnf install podman-4.* podman-remote-4.*
7979
```
8080

81-
* For RHEL 9, install the latest available version `4.*` using dnf.
81+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
8282

8383
```sh
84-
sudo dnf install podman-4.* podman-remote-4.*
84+
## Install versionlock
85+
sudo dnf install 'dnf-command(versionlock)'
86+
87+
## Lock major version
88+
sudo dnf versionlock add --raw 'podman-4.*'
89+
sudo dnf versionlock add --raw 'podman-remote-4.*'
90+
91+
## Verify that podman-4.* and podman-remote-4.* appear in the output
92+
sudo dnf versionlock list
8593
```
8694

8795
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,24 @@ Verify that required traffic is allowed.
7070

7171
4. Install podman:
7272

73-
* For RHEL 8 and Rocky Linux, install version `4.*`.
73+
* Install the latest available version `4.*` using dnf.
7474

7575
```sh
7676
sudo dnf install podman-4.* podman-remote-4.*
7777
```
7878

79-
* For RHEL 9, install the latest available version `4.*` using dnf.
79+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
8080

8181
```sh
82-
sudo dnf install podman-4.* podman-remote-4.*
82+
## Install versionlock
83+
sudo dnf install 'dnf-command(versionlock)'
84+
85+
## Lock major version
86+
sudo dnf versionlock add --raw 'podman-4.*'
87+
sudo dnf versionlock add --raw 'podman-remote-4.*'
88+
89+
## Verify that podman-4.* and podman-remote-4.* appear in the output
90+
sudo dnf versionlock list
8391
```
8492

8593
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,24 @@ Otherwise, when the file content changes, the corresponding user is mentioned as
111111

112112
4. Install podman:
113113

114-
* For RHEL 8 and Rocky Linux, install version `4.*`.
114+
* Install the latest available version `4.*` using dnf.
115115

116116
```sh
117117
sudo dnf install podman-4.* podman-remote-4.*
118118
```
119119

120-
* For RHEL 9, install the latest available version `4.*` using dnf.
120+
* To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates.
121121

122122
```sh
123-
sudo dnf install podman-4.* podman-remote-4.*
123+
## Install versionlock
124+
sudo dnf install 'dnf-command(versionlock)'
125+
126+
## Lock major version
127+
sudo dnf versionlock add --raw 'podman-4.*'
128+
sudo dnf versionlock add --raw 'podman-remote-4.*'
129+
130+
## Verify that podman-4.* and podman-remote-4.* appear in the output
131+
sudo dnf versionlock list
124132
```
125133

126134
5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI:

deploy-manage/deploy/cloud-on-k8s.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@ This section outlines the supported Kubernetes and Elastic Stack versions for EC
6868
ECK is compatible with the following Kubernetes distributions and related technologies:
6969

7070
* Kubernetes 1.28-1.32
71-
* OpenShift 4.12-4.17
71+
* OpenShift 4.13-4.18
7272
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
7373
* Helm: 3.2.0+
7474

7575
ECK should work with all conformant **installers** listed in these [FAQs](https://github.com/cncf/k8s-conformance/blob/master/faq.md#what-is-a-distribution-hosted-platform-and-an-installer). Distributions include source patches and so may not work as-is with ECK.
7676

77+
Alpha, beta, and stable API versions follow the same [conventions used by Kubernetes](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning).
78+
7779
### Elastic Stack compatibility
7880

7981
ECK is compatible with the following Elastic Stack applications:

deploy-manage/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -838,5 +838,4 @@ toc:
838838
children:
839839
- file: uninstall/uninstall-elastic-cloud-enterprise.md
840840
- file: uninstall/uninstall-elastic-cloud-on-kubernetes.md
841-
- file: uninstall/uninstall-a-self-managed-cluster.md
842841
- 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+
::::

0 commit comments

Comments
 (0)