From 19446c58d60c1cc8ae1f034534bde2837afca6a4 Mon Sep 17 00:00:00 2001 From: chrisjlin <36452239+chrisjlin@users.noreply.github.com> Date: Tue, 3 Dec 2024 11:20:27 -0800 Subject: [PATCH] Adding instructions for generating diagnostic support bundle to troubleshooting page --- .../deployment/do/mcc-ent-troubleshooting.md | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/windows/deployment/do/mcc-ent-troubleshooting.md b/windows/deployment/do/mcc-ent-troubleshooting.md index e9dee50493..5b8182d820 100644 --- a/windows/deployment/do/mcc-ent-troubleshooting.md +++ b/windows/deployment/do/mcc-ent-troubleshooting.md @@ -130,20 +130,27 @@ You can also reboot the IoT Edge runtime using `sudo systemctl restart iotedge`. ## Generating cache node diagnostic support bundle -You can generate a support bundle with detailed diagnostic information by running the `collectMccDiagnostics.sh` script found in the MCC diagnostics folder. +You can generate a support bundle with detailed diagnostic information by running the `collectMccDiagnostics.sh` script included in the installation package. For Windows host machines, you will need to do the following: 1. Launch a PowerShell process as the account specified as the runtime account during the Connected Cache install -1. Run `wsl -d Ubuntu-22.04-Mcc-Base` to access the Linux distribution that hosts the Connected Cache container -1. Change directory to `path/to/collectMccDiagnostics.sh` -1. Run the script -1. Extract the generated support bundle from `path/to/support/bundle` to `path/to/windows/host` +1. Change directory to the "MccScripts" directory within the extracted installation package and verify the presence of `collectmccdiagnostics.sh` +1. Run `wsl bash collectmccdiagnostics.sh` to generate the diagnostic support bundle +1. Once the script has completed, note the console output describing the location of the diagnostic support bundle + + For example, "Successfully zipped package, please send file created at /etc/mccdiagnostics/support_bundle_2024_12_03__11_05_39__AM.tar.gz" +1. Run the `wsl cp` command to copy the support bundle from the location within the Ubuntu distribution to the Windows host OS + + For example, `wsl cp /etc/mccdiagnostics/support_bundle_2024_12_03__11_05_39__AM.tar.gz /mnt/c/mccwsl01/SupportBundles` For Linux host machines, you will need to do the following: -1. Change directory to `path/to/collectMccDiagnostics.sh` -1. Run the script +1. Change directory to the "MccScripts" directory within the extracted installation package and verify the presence of `collectmccdiagnostics.sh` +1. Run `collectmccdiagnostics.sh` to generate the diagnostic support bundle +1. Once the script has completed, note the console output describing the location of the diagnostic support bundle + + For example, "Successfully zipped package, please send file created at /etc/mccdiagnostics/support_bundle_2024_12_03__11_05_39__AM.tar.gz" ## Troubleshooting cache node monitoring