From 2443738598645524e8b9a3a5726a87dad0e60768 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Fri, 6 Jan 2023 15:13:39 -0800 Subject: [PATCH] Apply 280e1bf1 (PR #352) to version 2.6 docs Also add a level 2 header to existing content so headers are incremental --- .../other-troubleshooting-tips/logging.md | 2 ++ .../other-troubleshooting-tips/logging.md | 23 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/docs/troubleshooting/other-troubleshooting-tips/logging.md b/docs/troubleshooting/other-troubleshooting-tips/logging.md index 9e63944762a..1c539e92c1d 100644 --- a/docs/troubleshooting/other-troubleshooting-tips/logging.md +++ b/docs/troubleshooting/other-troubleshooting-tips/logging.md @@ -2,6 +2,8 @@ title: Logging --- +## Log levels + The following log levels are used in Rancher: | Name | Description | diff --git a/versioned_docs/version-2.6/troubleshooting/other-troubleshooting-tips/logging.md b/versioned_docs/version-2.6/troubleshooting/other-troubleshooting-tips/logging.md index 3cf2967d7e3..1c539e92c1d 100644 --- a/versioned_docs/version-2.6/troubleshooting/other-troubleshooting-tips/logging.md +++ b/versioned_docs/version-2.6/troubleshooting/other-troubleshooting-tips/logging.md @@ -2,6 +2,8 @@ title: Logging --- +## Log levels + The following log levels are used in Rancher: | Name | Description | @@ -51,3 +53,24 @@ $ docker logs -f $ docker exec -ti loglevel --set info OK ``` + +## Rancher machine debug logs +If you need to troubleshoot the creation of objects in your infrastructure provider of choice, `rancher-machine` +debug logs might be helpful to you. + +It's possible to enable debug logs for `rancher-machine` by setting environment variables when launching Rancher. + +The `CATTLE_WHITELIST_ENVVARS` environment variable allows users to whitelist specific environment variables to be +passed down to `rancher-machine` during provisioning. + +The `MACHINE_DEBUG` variable enables debug logs in `rancher-machine`. + +Thus, by setting `MACHINE_DEBUG=true` and adding `MACHINE_DEBUG` to the default list of variables in +`CATTLE_WHITELIST_ENVVARS` (e.g. `CATTLE_WHITELIST_ENVVARS=HTTP_PROXY,HTTPS_PROXY,NO_PROXY,MACHINE_DEBUG`) it is +possible to enable debug logs in `rancher-machine` when provisioning RKE1, RKE2 and k3s clusters. + +:::caution + +Just like the `trace` log level above, `rancher-machine` debug logs can contain sensitive information. + +:::