From 280e1bf12f02a72aa39861c5216e7637e7742104 Mon Sep 17 00:00:00 2001 From: Simon Bernier St-Pierre Date: Thu, 29 Dec 2022 19:19:44 -0500 Subject: [PATCH] Document rancher-machine debug logs --- .../other-troubleshooting-tips/logging.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/troubleshooting/other-troubleshooting-tips/logging.md b/docs/troubleshooting/other-troubleshooting-tips/logging.md index 3cf2967d7e3..9e63944762a 100644 --- a/docs/troubleshooting/other-troubleshooting-tips/logging.md +++ b/docs/troubleshooting/other-troubleshooting-tips/logging.md @@ -51,3 +51,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. + +:::