From 01e83471a7688bc01260a79d90c62cd24983e700 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 9 Jul 2019 15:29:56 -0700 Subject: [PATCH 1/2] Moves troubleshooting pages within Stack Overview --- docs/en/stack/ml/index.asciidoc | 2 +- docs/en/stack/ml/troubleshooting.asciidoc | 2 +- docs/en/stack/monitoring/index.asciidoc | 1 + docs/en/stack/monitoring/troubleshooting.asciidoc | 2 +- docs/en/stack/security/index.asciidoc | 2 ++ docs/en/stack/security/troubleshooting.asciidoc | 2 +- docs/en/stack/troubleshooting.asciidoc | 7 ------- 7 files changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/en/stack/ml/index.asciidoc b/docs/en/stack/ml/index.asciidoc index b8b66abcf..8acba4c66 100644 --- a/docs/en/stack/ml/index.asciidoc +++ b/docs/en/stack/ml/index.asciidoc @@ -36,4 +36,4 @@ include::api-quickref.asciidoc[] :edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ml/functions.asciidoc include::{es-repo-dir}/ml/functions.asciidoc[] - +include::troubleshooting.asciidoc[] diff --git a/docs/en/stack/ml/troubleshooting.asciidoc b/docs/en/stack/ml/troubleshooting.asciidoc index a49d7010d..40a34637c 100644 --- a/docs/en/stack/ml/troubleshooting.asciidoc +++ b/docs/en/stack/ml/troubleshooting.asciidoc @@ -2,7 +2,7 @@ [[ml-troubleshooting]] == Troubleshooting {ml} ++++ -Machine learning +Troubleshooting ++++ Use the information in this section to troubleshoot common problems and find diff --git a/docs/en/stack/monitoring/index.asciidoc b/docs/en/stack/monitoring/index.asciidoc index da045a734..50e9a7e0a 100644 --- a/docs/en/stack/monitoring/index.asciidoc +++ b/docs/en/stack/monitoring/index.asciidoc @@ -2,3 +2,4 @@ include::intro.asciidoc[] include::how-monitoring-works.asciidoc[] include::production.asciidoc[] include::esms.asciidoc[] +include::troubleshooting.asciidoc[] \ No newline at end of file diff --git a/docs/en/stack/monitoring/troubleshooting.asciidoc b/docs/en/stack/monitoring/troubleshooting.asciidoc index f4e2ccf69..f4d44fa45 100644 --- a/docs/en/stack/monitoring/troubleshooting.asciidoc +++ b/docs/en/stack/monitoring/troubleshooting.asciidoc @@ -1,7 +1,7 @@ [[monitoring-troubleshooting]] == Troubleshooting monitoring ++++ -Monitoring +Troubleshooting ++++ See also diff --git a/docs/en/stack/security/index.asciidoc b/docs/en/stack/security/index.asciidoc index 0d7d8516f..b61739a24 100644 --- a/docs/en/stack/security/index.asciidoc +++ b/docs/en/stack/security/index.asciidoc @@ -114,3 +114,5 @@ include::get-started-security.asciidoc[] :edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/security/securing-communications/tutorial-tls-internode.asciidoc include::securing-communications/tutorial-tls-intro.asciidoc[] + +include::troubleshooting.asciidoc[] diff --git a/docs/en/stack/security/troubleshooting.asciidoc b/docs/en/stack/security/troubleshooting.asciidoc index 34344b8a3..728f65893 100644 --- a/docs/en/stack/security/troubleshooting.asciidoc +++ b/docs/en/stack/security/troubleshooting.asciidoc @@ -2,7 +2,7 @@ [[security-troubleshooting]] == Troubleshooting security ++++ -Security +Troubleshooting ++++ Use the information in this section to troubleshoot common problems and find diff --git a/docs/en/stack/troubleshooting.asciidoc b/docs/en/stack/troubleshooting.asciidoc index 95c0c487c..5e1e5d51c 100644 --- a/docs/en/stack/troubleshooting.asciidoc +++ b/docs/en/stack/troubleshooting.asciidoc @@ -35,14 +35,7 @@ GET /_xpack -------------------------------------------------- // CONSOLE -:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/security/troubleshooting.asciidoc -include::security/troubleshooting.asciidoc[] :edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/watcher/troubleshooting.asciidoc include::watcher/troubleshooting.asciidoc[] -:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/monitoring/troubleshooting.asciidoc -include::monitoring/troubleshooting.asciidoc[] - -:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/ml/troubleshooting.asciidoc -include::ml/troubleshooting.asciidoc[] From 973516b5590b2691aa11e42eb730075b470f8c80 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 9 Jul 2019 15:52:37 -0700 Subject: [PATCH 2/2] Move troubleshooting pages within Stack Overview --- docs/en/stack/help.asciidoc | 9 +++ docs/en/stack/index.asciidoc | 3 - .../en/stack/ml/getting-started-next.asciidoc | 3 +- docs/en/stack/ml/troubleshooting.asciidoc | 2 +- .../stack/monitoring/troubleshooting.asciidoc | 5 +- docs/en/stack/redirects.asciidoc | 19 +++++ .../stack/security/troubleshooting.asciidoc | 2 +- docs/en/stack/troubleshooting.asciidoc | 41 ----------- .../en/stack/watcher/troubleshooting.asciidoc | 69 ------------------- 9 files changed, 35 insertions(+), 118 deletions(-) create mode 100644 docs/en/stack/help.asciidoc delete mode 100644 docs/en/stack/troubleshooting.asciidoc delete mode 100644 docs/en/stack/watcher/troubleshooting.asciidoc diff --git a/docs/en/stack/help.asciidoc b/docs/en/stack/help.asciidoc new file mode 100644 index 000000000..3b9722457 --- /dev/null +++ b/docs/en/stack/help.asciidoc @@ -0,0 +1,9 @@ +// tag::get-help[] + +For issues that you cannot fix yourself … we’re here to help. +If you are an existing Elastic customer with a support contract, please create +a ticket in the +https://support.elastic.co/customers/s/login/[Elastic Support portal]. +Or post in the https://discuss.elastic.co/[Elastic forum]. + +// end::get-help[] diff --git a/docs/en/stack/index.asciidoc b/docs/en/stack/index.asciidoc index 5f03c9fe6..87e9a2618 100644 --- a/docs/en/stack/index.asciidoc +++ b/docs/en/stack/index.asciidoc @@ -38,9 +38,6 @@ include::data-frames/index.asciidoc[] :edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/ccr/index.asciidoc include::{es-repo-dir}/ccr/index.asciidoc[] -:edit_url: -include::troubleshooting.asciidoc[] - :edit_url: include::limitations.asciidoc[] diff --git a/docs/en/stack/ml/getting-started-next.asciidoc b/docs/en/stack/ml/getting-started-next.asciidoc index 3af3e6874..cd8bcc3ca 100644 --- a/docs/en/stack/ml/getting-started-next.asciidoc +++ b/docs/en/stack/ml/getting-started-next.asciidoc @@ -52,5 +52,4 @@ multi-metric jobs and split the data or create more complex analysis functions as necessary. For examples of more complicated configuration options, see <>. -If you encounter problems, we're here to help. See <> and -<>. \ No newline at end of file +If you encounter problems, see <>. diff --git a/docs/en/stack/ml/troubleshooting.asciidoc b/docs/en/stack/ml/troubleshooting.asciidoc index 40a34637c..5cc667079 100644 --- a/docs/en/stack/ml/troubleshooting.asciidoc +++ b/docs/en/stack/ml/troubleshooting.asciidoc @@ -13,7 +13,7 @@ answers for frequently asked questions. * <> * <> -To get help, see <>. +include::{stack-repo-dir}/help.asciidoc[tag=get-help] [[ml-rollingupgrade]] === Machine learning features unavailable after rolling upgrade diff --git a/docs/en/stack/monitoring/troubleshooting.asciidoc b/docs/en/stack/monitoring/troubleshooting.asciidoc index f4d44fa45..945f03ef4 100644 --- a/docs/en/stack/monitoring/troubleshooting.asciidoc +++ b/docs/en/stack/monitoring/troubleshooting.asciidoc @@ -4,9 +4,12 @@ Troubleshooting ++++ -See also +Use the information in this section to troubleshoot common problems and find +answers for frequently asked questions. See also {logstash-ref}/monitoring-troubleshooting.html[Troubleshooting monitoring in {ls}]. +include::{stack-repo-dir}/help.asciidoc[tag=get-help] + *Symptoms*: There is no information about your cluster on the *Stack Monitoring* page in {kib}. diff --git a/docs/en/stack/redirects.asciidoc b/docs/en/stack/redirects.asciidoc index f4a70c4f1..bb7afdc08 100644 --- a/docs/en/stack/redirects.asciidoc +++ b/docs/en/stack/redirects.asciidoc @@ -32,3 +32,22 @@ See <>. === Security files See {ref}/security-files.html[Security files]. + +[role="exclude",id="troubleshooting"]] +=== Troubleshooting + +Having trouble? Here are solutions to common problems you might encounter. + +* <> + +* <> + +* <> + +* <> + +[role="exclude",id="help"]] +=== Getting help + +include::help.asciidoc[tag=get-help] + diff --git a/docs/en/stack/security/troubleshooting.asciidoc b/docs/en/stack/security/troubleshooting.asciidoc index 728f65893..b7b0f6777 100644 --- a/docs/en/stack/security/troubleshooting.asciidoc +++ b/docs/en/stack/security/troubleshooting.asciidoc @@ -22,7 +22,7 @@ answers for frequently asked questions. * <> -To get help, see <>. +include::{stack-repo-dir}/help.asciidoc[tag=get-help] [[security-trb-settings]] === Some settings are not returned via the nodes settings API diff --git a/docs/en/stack/troubleshooting.asciidoc b/docs/en/stack/troubleshooting.asciidoc deleted file mode 100644 index 5e1e5d51c..000000000 --- a/docs/en/stack/troubleshooting.asciidoc +++ /dev/null @@ -1,41 +0,0 @@ -[[troubleshooting]] -= Troubleshooting - -[partintro] --- -Having trouble? Here are solutions to common problems you might encounter. - -* <> - -* <> - -* <> - -* <> - -* <> - --- - -[[help]] -== Getting help - -For issues that you cannot fix yourself … we’re here to help. -If you are an existing Elastic customer with a support contract, please create -a ticket in the -https://support.elastic.co/customers/s/login/[Elastic Support portal]. -Or post in the https://discuss.elastic.co/[Elastic forum]. - -It might also be helpful to collect the following information, since it contains -build information and indicates which {stack} features are enabled: - -[source,js] --------------------------------------------------- -GET /_xpack --------------------------------------------------- -// CONSOLE - - -:edit_url: https://github.com/elastic/stack-docs/edit/{branch}/docs/en/stack/watcher/troubleshooting.asciidoc -include::watcher/troubleshooting.asciidoc[] - diff --git a/docs/en/stack/watcher/troubleshooting.asciidoc b/docs/en/stack/watcher/troubleshooting.asciidoc deleted file mode 100644 index 0e6be8a2e..000000000 --- a/docs/en/stack/watcher/troubleshooting.asciidoc +++ /dev/null @@ -1,69 +0,0 @@ -[role="xpack"] -[testenv="gold"] -[[watcher-troubleshooting]] -== Troubleshooting {watcher} -[subs="attributes"] -++++ -{watcher} -++++ - -[float] -=== Dynamic mapping error when trying to add a watch - -If you get the _Dynamic Mapping is Disabled_ error when you try to add a watch, -verify that the index mappings for the `.watches` index are available. You can -do that by submitting the following request: - -[source,js] --------------------------------------------------- -GET .watches/_mapping --------------------------------------------------- -// CONSOLE - -//When testing is enabled, test [setup:my_active_watch] - -If the index mappings are missing, follow these steps to restore the correct -mappings: - -. Stop the Elasticsearch node. -. Add `xpack.watcher.index.rest.direct_access : true` to `elasticsearch.yml`. -. Restart the Elasticsearch node. -. Delete the `.watches` index: -+ --- -[source,js] --------------------------------------------------- -DELETE .watches --------------------------------------------------- -// CONSOLE - -//When testing is enabled, test[skip:index deletion] --- -. Disable direct access to the `.watches` index: -.. Stop the Elasticsearch node. -.. Remove `xpack.watcher.index.rest.direct_access : true` from `elasticsearch.yml`. -.. Restart the Elasticsearch node. - -[float] -=== Unable to send email - -If you get an authentication error indicating that you need to continue the -sign-in process from a web browser when Watcher attempts to send email, you need -to configure Gmail to -https://support.google.com/accounts/answer/6010255?hl=en[Allow Less Secure Apps to access your account]. - -If you have two-step verification enabled for your email account, you must -generate and use an App Specific password to send email from {watcher}. For more -information, see: - -- Gmail: https://support.google.com/accounts/answer/185833?hl=en[Sign in using App Passwords] -- Outlook.com: http://windows.microsoft.com/en-us/windows/app-passwords-two-step-verification[App passwords and two-step verification] - -[float] -=== {watcher} not responsive - -Keep in mind that there's no built-in validation of scripts that you add to a -watch. Buggy or deliberately malicious scripts can negatively impact {watcher} -performance. For example, if you add multiple watches with buggy script -conditions in a short period of time, {watcher} might be temporarily unable to -process watches until the bad watches time out.