Skip to content

Commit c9e0732

Browse files
authored
[WIP] Clean up Troubleshoot (docs freeze MVP) (#485)
[Preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/485/troubleshoot/) Get things into a reasonable state for the docs thaw: - Make titles and nav titles consistent - Reflect the order of other sections and the overall IA - NOTE: I moved topics in the TOC but not files in the directories -- coming in separate PR 😓 - Add landing page / roundup topics - Add entrypoint skeleton / template - Sprinkle WIP notes 🧂 - Change generic `{adomonition}`s to `{tip}`s part of elastic/docs-projects#434
1 parent d21caf7 commit c9e0732

Some content is hidden

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

55 files changed

+286
-198
lines changed

troubleshoot/deployments.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

troubleshoot/deployments/cloud-enterprise/ask-for-help.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ mapped_pages:
55

66
# Ask for help [ece-getting-help]
77

8+
:::{admonition} WIP
9+
⚠️ **This page is a work in progress.** ⚠️
10+
11+
The documentation team is working on moving this content to the [Troubleshooting overview](/troubleshoot/index.md).
12+
:::
13+
814
For issues with Elastic Cloud Enterprise that you cannot fix yourself …​ we’re here to help!
915

1016
If you are an existing Elastic customer with a support contract, please create a ticket in the [Elastic Support Portal](https://support.elastic.co) and provide an ECE [diagnostics package and log files](../../../deploy-manage/monitor/orchestrators/ece-monitoring-ece-access.md). By providing a diagnostics package, you make it easier for us to help you.

troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
---
2+
navigation_title: "Elastic Cloud Enterprise"
23
mapped_urls:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-troubleshooting.html
45
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-find.html
56
---
67

7-
# Elastic Cloud Enterprise
8+
# Troubleshoot Elastic Cloud Enterprise
9+
10+
:::{admonition} WIP
11+
⚠️ **This page is a work in progress.** ⚠️
12+
13+
The documentation team is working on restructuring this section. It currently reflects a legacy product-centric structure.
14+
:::
815

916
## Finding deployments [ts-ece-find]
1017

troubleshoot/deployments/cloud-enterprise/rebuilding-broken-zookeeper-quorum.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: "Zookeeper quorum"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-troubleshooting-zookeeper-quorum.html
45
---

troubleshoot/deployments/cloud-enterprise/remove-cloud-enterprise.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2+
navigation_title: "Removing containers"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-uninstall.html
45
---
56

6-
# Remove Elastic Cloud Enterprise [ece-uninstall]
7+
# Remove Elastic Cloud Enterprise containers [ece-uninstall]
78

89
You might need to remove Elastic Cloud Enterprise for one of the following reasons:
910

@@ -14,23 +15,18 @@ You remove Elastic Cloud Enterprise by removing all containers on the host:
1415

1516
* If using Docker
1617

17-
::::{admonition}
18+
1819
```sh
1920
docker rm -f frc-runners-runner frc-allocators-allocator $(docker ps -a -q); sudo rm -rf /mnt/data/elastic/ && docker ps -a
2021
```
2122

22-
::::
23-
2423

2524
* If using Podman
2625

27-
::::{admonition}
2826
```sh
2927
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
3028
```
3129

32-
::::
33-
3430

3531
If you plan to reinstall Elastic Cloud Enterprise on the host, make sure you [delete the host](../../../deploy-manage/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.
3632

troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: "Diagnostics"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-run-ece-diagnostics.html
45
---

troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2+
navigation_title: "Container engines"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-troubleshooting-containers.html
45
---
56

6-
# Troubleshooting container engines [ece-troubleshooting-containers]
7+
# Troubleshoot container engines [ece-troubleshooting-containers]
78

89
This article describes how to troubleshoot container engine services in Elastic Cloud Enterprise. We refer to [Docker](https://www.docker.com/) by default, as it’s the most common container engine, but these steps are also valid for [Podman](https://podman.io/). You can simply replace `docker` in the commands with `podman` as needed.
910

troubleshoot/deployments/cloud-enterprise/use-emergency-roles-token.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: "Emergency roles token"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-troubleshooting-emergency.html
45
---

troubleshoot/deployments/cloud-enterprise/verify-zookeeper-sync-status.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2+
navigation_title: "ZooKeeper sync status"
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-zookeeper-sync.html
45
---
56

6-
# Verify ZooKeeper Sync Status [ece-zookeeper-sync]
7+
# Verify ZooKeeper sync status [ece-zookeeper-sync]
78

89
It is recommended to check the ZooKeeper sync status before starting any maintenance on your Director nodes. This helps you prevent the following scenarios:
910

troubleshoot/deployments/cloud-on-k8s/common-problems.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
2+
navigation_title: "Common issues"
3+
applies:
4+
eck: all
25
mapped_pages:
36
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-common-problems.html
47
---
58

6-
# Common problems [k8s-common-problems]
9+
# Troubleshoot common Elastic Cloud on Kubernetes issues [k8s-common-problems]
710

811

912
## Operator crashes on startup with `OOMKilled` [k8s-common-problems-operator-oom]

0 commit comments

Comments
 (0)