Skip to content

Commit

Permalink
goal vs non-goal docs. (Azure#55)
Browse files Browse the repository at this point in the history
goal vs non-goal docs for this tool.
  • Loading branch information
Tatsinnit authored and shalier committed May 27, 2021
1 parent 99bcb3c commit 0995cf6
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/goalsvsnongoals.md
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.

0 comments on commit 0995cf6

Please sign in to comment.