Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.61 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.61 KB
Raw

Skywoker

Description

Skywoker is an extremely opinionated day-to-day tool I created while working within @Skyscrapers.

It does a quick scan to your cluster, notes out the workloads (Currently supports Deployments only soon enough Statefulsets and Cronjobs will be there), lists out the compliance within our @Skyscrapers Well Architected Framework.

Main reason it exists, is to check whether or not a workload is compatible with Karpenter

In the future I want to make this tool act as a swiss-army knife, use it to ensure we have set the right resource requests / limits on a workload, ensure we adhere to all best-practices as far as we can get by doing simple scans.

Commands

  • best-practices (alias: bp)
    • This is the real reason this tool was created for
    • It creates a report of your workloads in your selected namespace (default: all namespaces and all types of workloads)
    • Report includes how compliant the workloads are with the @Skyscrapers Well Architected FrameworkWell Architected Framework.
    • Simply put, checkes whether your workload has pdb's, hpa's, vpa's, resource requests & limits set.
  • TBC

Usage

Installation is simple, clone this repo, then run make. You will have your binary ready under ./bin/skywoker

Run a quick scan using

./bin/skywoker bp --namespace=<yournamespace, default is all> --workload-type=<all,deployment,statefulset,cronjob> -v(log verbosity boolean)

An Example:

Demo