From 7e8c8c69b911e139698b06512f4b5ae7da5ef026 Mon Sep 17 00:00:00 2001 From: Nolan Brubaker Date: Fri, 13 Jul 2018 17:34:39 -0400 Subject: [PATCH] Add some basic troubleshooting commands These commands are intended to be general, and give users some context for where they can look to get more information about Ark's behaviors. Signed-off-by: Nolan Brubaker --- docs/troubleshooting.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 7a9d1472d..c6d770ba9 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -2,6 +2,35 @@ These tips can help you troubleshoot known issues. If they don't help, you can [file an issue][4], or talk to us on the [#ark-dr channel][25] on the Kubernetes Slack server. +Some general commands for troubleshooting that may be helpful: + +* `ark backup describe ` - describe the details of a backup +* `ark backup logs ` - fetch the logs for this specific backup. Useful for viewing failures and warnings, including resources that could not be backed up. +* `ark restore describe ` - describe the details of a restore +* `ark restore logs ` - fetch the logs for this specific restore. Useful for viewing failures and warnings, including resources that could not be restored. +* `kubectl logs deployment/ark -n heptio-ark` - fetch the logs of the Ark server pod. This provides the output of the Ark server processes. + +## Getting ark debug logs + +You can increase the verbosity of the Ark server by editing your Ark deployment to look like this: + + +``` +kubectl edit deployment/ark -n heptio-ark +... + containers: + - name: ark + image: gcr.io/heptio-images/ark:latest + command: + - /ark + args: + - server + - --log-level # Add this line + - debug # Add this line +... +``` + + * [Debug installation/setup issues][2] * [Debug restores][1] @@ -9,4 +38,4 @@ These tips can help you troubleshoot known issues. If they don't help, you can [ [1]: debugging-restores.md [2]: debugging-install.md [4]: https://github.com/heptio/ark/issues -[25]: https://kubernetes.slack.com/messages/ark-dr \ No newline at end of file +[25]: https://kubernetes.slack.com/messages/ark-dr