Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #710

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions internal/scripts/troubleshoot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@ You can use the troubleshooting script provided [here](https://raw.githubusercon

Steps:
- Open powershell using the [cloudshell](https://docs.microsoft.com/en-us/azure/cloud-shell/overview) in the azure portal.
> Note: This script supported on any Powershell supported environment: Windows and Non-Windows.

> Note: This script supported on any Powershell supported environment: Windows and Non-Windows.
For Linux, refer [Install-Powershell-On-Linux](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-7) and
For Mac OS, refer [install-powershell-core-on-mac](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-macos?view=powershell-7) how to install powershell
- Make sure that you're using powershell (selected by default)
- Run the following command to change home directory - `cd ~`
- Run the following command to download the script - `curl -LO https://raw.githubusercontent.com/Azure/prometheus-collector/kaveesh/troubleshoot/internal/scripts/troubleshoot/TroubleshootError.ps1`
> Note: In some versions of Powershell above CURL command may not work in such cases, you can try `curl https://raw.githubusercontent.com/Azure/prometheus-collector/kaveesh/troubleshoot/internal/scripts/troubleshoot/TroubleshootError.ps1 -O TroubleshootError.ps1`
- Run the following command to download the script - `curl -LO https://raw.githubusercontent.com/Azure/prometheus-collector/main/internal/scripts/troubleshoot/TroubleshootError.ps1`

> Note: In some versions of Powershell above CURL command may not work in such cases, you can try `curl https://raw.githubusercontent.com/Azure/prometheus-collector/main/internal/scripts/troubleshoot/TroubleshootError.ps1`


- Run the following command to execute the script - `./TroubleshootError.ps1 -ClusterResourceId <resourceIdoftheCluster>`
> Note: For AKS, resourceIdoftheCluster should be in this format `/subscriptions/<subId>/resourceGroups/<rgName>/providers/Microsoft.ContainerService/managedClusters/<clusterName>`.
- This script will generate a TroubleshootDump.txt and a ZIP file called debugLogs.zip which collects detailed information about container health onboarding.
Expand Down