Restructure Troubleshoot > Elasticsearch section (#390)

marciw · web-flow · commit f65747a8fece · 2025-02-12T12:49:03.000-05:00
* First pass at restructuring ES section

* More tweaks
diff --git a/troubleshoot/elasticsearch/add-tier.md b/troubleshoot/elasticsearch/add-tier.md
@@ -1,5 +1,5 @@
 ---
-navigation_title: Index allocation data tier
+navigation_title: Preferred data tier
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/add-tier.html
 ---
diff --git a/troubleshoot/elasticsearch/capacity.md b/troubleshoot/elasticsearch/capacity.md
@@ -0,0 +1,7 @@
+---
+navigation_title: Capacity
+---
+
+# Troubleshoot Elasticsearch capacity issues
+
+% What needs to be done: Write from scratch
diff --git a/troubleshoot/elasticsearch/clusters.md b/troubleshoot/elasticsearch/clusters.md
@@ -0,0 +1,7 @@
+---
+navigation_title: Clusters
+---
+
+# Troubleshoot Elasticsearch clusters
+
+% What needs to be done: Write from scratch
diff --git a/troubleshoot/elasticsearch/data.md b/troubleshoot/elasticsearch/data.md
@@ -0,0 +1,9 @@
+---
+navigation_title: Data
+---
+
+# Troubleshoot Elasticsearch data issues
+
+% What needs to be done: Write from scratch
+
+% see also fix-watermark-errors.md
diff --git a/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md b/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md
@@ -4,7 +4,7 @@ mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-error-handling.html
 ---
 
-% marciw move so this is with other ILM topics
+% marciw consolidate ILM topics
 
 # Fix index lifecycle management errors [index-lifecycle-error-handling]
 
diff --git a/troubleshoot/elasticsearch/fix-common-cluster-issues.md b/troubleshoot/elasticsearch/fix-common-cluster-issues.md
@@ -4,6 +4,9 @@ mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html
 ---
 
+% add other cluster topics if it makes sense (already in toc)
+% or keep a "common issues" page and create new cluster section index page
+
 # Fix common cluster issues [fix-common-cluster-issues]
 
 This guide describes how to fix common errors and problems with {{es}} clusters.
diff --git a/troubleshoot/elasticsearch/lifecycle-management.md b/troubleshoot/elasticsearch/lifecycle-management.md
@@ -0,0 +1,9 @@
+---
+navigation_title: Lifecycle management
+---
+
+% temporary: remove how-to content, then trim to one page
+
+# Troubleshoot lifecycle management
+
+% see also fix-watermark-errors.md
diff --git a/troubleshoot/elasticsearch/more-topics.md b/troubleshoot/elasticsearch/more-topics.md
@@ -0,0 +1,7 @@
+---
+navigation_title: More topics
+---
+
+# More Elasticsearch troubleshooting topics
+
+% What needs to be done: Write from scratch
diff --git a/troubleshoot/elasticsearch/security/security-trb-extraargs.md b/troubleshoot/elasticsearch/security/security-trb-extraargs.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: "Users command error: extra arguments" 
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-trb-extraargs.html
 ---
 
-# Users command fails due to extra arguments [security-trb-extraargs]
+# Error: Extra arguments were provided [security-trb-extraargs]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/security/security-trb-settings.md b/troubleshoot/elasticsearch/security/security-trb-settings.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: Nodes info API response
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-trb-settings.html
 ---
 
-# Some settings are not returned via the nodes settings API [security-trb-settings]
+# Troubleshoot a nodes info API response [security-trb-settings]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/security/trb-security-internalserver.md b/troubleshoot/elasticsearch/security/trb-security-internalserver.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: Kibana internal server error
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-internalserver.html
 ---
 
-# Internal Server Error in Kibana [trb-security-internalserver]
+# Internal server error in Kibana [trb-security-internalserver]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/security/trb-security-kerberos.md b/troubleshoot/elasticsearch/security/trb-security-kerberos.md
@@ -1,4 +1,5 @@
 ---
+navigation_title: Kerberos
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-kerberos.html
 ---
diff --git a/troubleshoot/elasticsearch/security/trb-security-maccurl.md b/troubleshoot/elasticsearch/security/trb-security-maccurl.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: Certificate verification with curl on Mac
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-maccurl.html
 ---
 
-# Certificate verification fails for curl on Mac [trb-security-maccurl]
+# Troubleshoot failed certificate verification with curl on Mac [trb-security-maccurl]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/security/trb-security-path.md b/troubleshoot/elasticsearch/security/trb-security-path.md
@@ -1,4 +1,5 @@
 ---
+navigation_title: Configuration file relocation
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-path.html
 ---
diff --git a/troubleshoot/elasticsearch/security/trb-security-saml.md b/troubleshoot/elasticsearch/security/trb-security-saml.md
@@ -1,4 +1,5 @@
 ---
+navigation_title: SAML
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-saml.html
 ---
diff --git a/troubleshoot/elasticsearch/security/trb-security-setup.md b/troubleshoot/elasticsearch/security/trb-security-setup.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: Password setup connection failures
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-setup.html
 ---
 
-# Setup-passwords command fails due to connection failure [trb-security-setup]
+# Troubleshoot connection failures with elasticsearch-setup-passwords [trb-security-setup]
 
 The [elasticsearch-setup-passwords command](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-passwords.html) sets passwords for the built-in users by sending user management API requests. If your cluster uses SSL/TLS for the HTTP (REST) interface, the command attempts to establish a connection with the HTTPS protocol. If the connection attempt fails, the command fails.
 
diff --git a/troubleshoot/elasticsearch/security/trb-security-ssl.md b/troubleshoot/elasticsearch/security/trb-security-ssl.md
@@ -1,4 +1,5 @@
 ---
+navigation_title: SSL/TLS exceptions
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-ssl.html
 ---
diff --git a/troubleshoot/elasticsearch/security/trb-security-sslhandshake.md b/troubleshoot/elasticsearch/security/trb-security-sslhandshake.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: SSLHandshakeException
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-sslhandshake.html
 ---
 
-# SSLHandshakeException causes connections to fail [trb-security-sslhandshake]
+# Troubleshoot SSLHandshakeException and failed node connections [trb-security-sslhandshake]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/security/trouble-shoot-active-directory.md b/troubleshoot/elasticsearch/security/trouble-shoot-active-directory.md
@@ -1,9 +1,10 @@
 ---
+navigation_title: Active Directory
 mapped_pages:
   - https://www.elastic.co/guide/en/elasticsearch/reference/current/trouble-shoot-active-directory.html
 ---
 
-# Users are frequently locked out of Active Directory [trouble-shoot-active-directory]
+# Troubleshoot Active Directory lockouts [trouble-shoot-active-directory]
 
 **Symptoms:**
 
diff --git a/troubleshoot/elasticsearch/snapshot-and-restore.md b/troubleshoot/elasticsearch/snapshot-and-restore.md
@@ -0,0 +1,7 @@
+---
+navigation_title: Snapshot and restore
+---
+
+# Troubleshoot snapshot and restore
+
+% What needs to be done: Write from scratch
diff --git a/troubleshoot/toc.yml b/troubleshoot/toc.yml
@@ -3,50 +3,58 @@ toc:
   - file: troubleshoot/index.md
   - file: elasticsearch/elasticsearch-reference.md
     children:
-      - file: elasticsearch/fix-common-cluster-issues.md
+      - file: elasticsearch/clusters.md
         children:
-          - file: elasticsearch/fix-watermark-errors.md
-          - file: elasticsearch/circuit-breaker-errors.md
-          - file: elasticsearch/high-cpu-usage.md
-          - file: elasticsearch/high-jvm-memory-pressure.md
-          - file: elasticsearch/red-yellow-cluster-status.md
-          - file: elasticsearch/rejected-requests.md
-          - file: elasticsearch/task-queue-backlog.md
-          - file: elasticsearch/mapping-explosion.md
-          - file: elasticsearch/hotspotting.md
-      - file: elasticsearch/diagnose-unassigned-shards.md
-      - file: elasticsearch/allow-all-cluster-allocation.md
-      - file: elasticsearch/allow-all-index-allocation.md
-      - file: elasticsearch/add-tier.md
-      - file: elasticsearch/troubleshoot-migrate-to-tiers.md
-      - file: elasticsearch/increase-tier-capacity.md
-      - file: elasticsearch/increase-shard-limit.md
-      - file: elasticsearch/increase-cluster-shard-limit.md
-      - file: elasticsearch/corruption-troubleshooting.md
-      - file: elasticsearch/fix-data-node-out-of-disk.md
+          - file: elasticsearch/fix-common-cluster-issues.md
+            children:
+              - file: elasticsearch/fix-watermark-errors.md
+              - file: elasticsearch/circuit-breaker-errors.md
+              - file: elasticsearch/high-cpu-usage.md
+              - file: elasticsearch/high-jvm-memory-pressure.md
+              - file: elasticsearch/red-yellow-cluster-status.md
+              - file: elasticsearch/rejected-requests.md
+              - file: elasticsearch/task-queue-backlog.md
+              - file: elasticsearch/mapping-explosion.md
+              - file: elasticsearch/hotspotting.md
+          - file: elasticsearch/troubleshooting-unstable-cluster.md
+          - file: elasticsearch/troubleshooting-unbalanced-cluster.md
+          - file: elasticsearch/elasticsearch-reference/remote-clusters.md
+          - file: elasticsearch/diagnose-unassigned-shards.md
+          - file: elasticsearch/troubleshooting-shards-capacity-issues.md
+      - file: elasticsearch/data.md
         children:
-          - file: elasticsearch/increase-capacity-data-node.md
-          - file: elasticsearch/decrease-disk-usage-data-node.md
-      - file: elasticsearch/fix-master-node-out-of-disk.md
-      - file: elasticsearch/fix-other-node-out-of-disk.md
-      - file: elasticsearch/start-ilm.md
-      - file: elasticsearch/start-slm.md
-      - file: elasticsearch/restore-from-snapshot.md
-      - file: elasticsearch/add-repository.md
+          - file: elasticsearch/allow-all-cluster-allocation.md
+          - file: elasticsearch/allow-all-index-allocation.md
+          - file: elasticsearch/add-tier.md
+          - file: elasticsearch/troubleshoot-migrate-to-tiers.md
+          - file: elasticsearch/increase-tier-capacity.md
+          - file: elasticsearch/increase-shard-limit.md
+          - file: elasticsearch/increase-cluster-shard-limit.md
+          - file: elasticsearch/corruption-troubleshooting.md
+      - file: elasticsearch/capacity.md
+        children:  
+        - file: elasticsearch/fix-data-node-out-of-disk.md
+          children:
+            - file: elasticsearch/increase-capacity-data-node.md
+            - file: elasticsearch/decrease-disk-usage-data-node.md
+        - file: elasticsearch/fix-master-node-out-of-disk.md
+        - file: elasticsearch/fix-other-node-out-of-disk.md
+      - file: elasticsearch/snapshot-and-restore.md
         children:
-          - file: elasticsearch/diagnosing-corrupted-repositories.md
-          - file: elasticsearch/diagnosing-unknown-repositories.md
-          - file: elasticsearch/diagnosing-invalid-repositories.md
-      - file: elasticsearch/repeated-snapshot-failures.md
-      - file: elasticsearch/troubleshooting-unstable-cluster.md
-      - file: elasticsearch/discovery-troubleshooting.md
-      - file: elasticsearch/monitoring-troubleshooting.md
-      - file: elasticsearch/transform-troubleshooting.md
-      - file: elasticsearch/watcher-troubleshooting.md
+          - file: elasticsearch/restore-from-snapshot.md
+          - file: elasticsearch/add-repository.md
+            children:
+              - file: elasticsearch/diagnosing-corrupted-repositories.md
+              - file: elasticsearch/diagnosing-unknown-repositories.md
+              - file: elasticsearch/diagnosing-invalid-repositories.md
+          - file: elasticsearch/repeated-snapshot-failures.md
       - file: elasticsearch/troubleshooting-searches.md
-      - file: elasticsearch/troubleshooting-shards-capacity-issues.md
-      - file: elasticsearch/troubleshooting-unbalanced-cluster.md
-      - file: elasticsearch/diagnostic.md
+
+      - file: elasticsearch/lifecycle-management.md
+        children: 
+        - file: elasticsearch/start-ilm.md
+        - file: elasticsearch/start-slm.md
+        - file: elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md
       - file: elasticsearch/elasticsearch-reference/security.md
         children:
           - file: elasticsearch/security/security-trb-settings.md
@@ -61,8 +69,6 @@ toc:
           - file: elasticsearch/security/trb-security-internalserver.md
           - file: elasticsearch/security/trb-security-setup.md
           - file: elasticsearch/security/trb-security-path.md
-      - file: elasticsearch/elasticsearch-reference/remote-clusters.md
-      - file: elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md
       - file: elasticsearch/clients.md
         children:
           - file: elasticsearch/elasticsearch-client-java-api-client/java.md
@@ -83,7 +89,14 @@ toc:
                   - file: elasticsearch/elasticsearch-client-net-api/debug-mode.md
           - file: elasticsearch/elasticsearch-client-javascript-api/nodejs.md
           - file: elasticsearch/elasticsearch-client-ruby-api/ruby.md
-      - file: elasticsearch/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md
+      - file: elasticsearch/diagnostic.md
+      - file: elasticsearch/more-topics.md
+        children:
+          - file: elasticsearch/discovery-troubleshooting.md
+          - file: elasticsearch/monitoring-troubleshooting.md
+          - file: elasticsearch/transform-troubleshooting.md
+          - file: elasticsearch/watcher-troubleshooting.md
+          - file: elasticsearch/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md
   - file: kibana.md
     children:
       - file: kibana/using-kibana-server-logs.md
