forked from Azure/aks-periscope
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
goal vs non-goal docs for this tool.
- Loading branch information
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Goal vs Non-Goals | ||
|
||
## Goals: | ||
|
||
The goal of `AKS Periscope` is to allow `AKS` customers to run initial diagnostics and collect and export the logs (like into an Azure Blob storage account) to help them analyse and identify potential problems. AKS cluster issues are many times are caused by wrong configuration of their environment, such as networking or permission issues. This tool will allow `AKS` customers to run initial diagnostics and collect logs and custom analyses that help them identify the underlying problems. | ||
|
||
The logs does this tool collects are documented here - https://github.com/Azure/aks-periscope#overview | ||
|
||
## Non-Goals: | ||
|
||
This tool is written with `AKS` in mind and does not cover any broader k8s distros or services. In the broader OSS tool system, there are many OSS tools which provide better support for other scenarios, but this tool is `AKS` specific. | ||
|