unctl 0.6.1

A health check and RCA tool for kubernetes

unctl

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Development
   • Release
3. Usage
4. Roadmap
5. Contact

About The Project

unctl is a versatile command-line tool designed to perform a wide range of checks and inspections on various components of your infrastructure. It provides a unified interface to assess the health and performance of different services and platforms, and goes beyond mere diagnosis. With built-in AI capabilities, it guides you seamlessly from system diagnostic to remediation, offering intelligent solutions to address any issues it detects.

This addition emphasizes the tool's capacity to not only identify problems but also provide AI-driven recommendations and solutions for resolving those issues, making it even more valuable for infrastructure management and maintenance.

Provider	Checks
Kubernetes	19
Elastic Search	TBA
Postgres	TBA
AWS	TBA
GCP	TBA

Built With

Getting Started

Prerequisites

• Python >= 3.10
• OpenAI API Key - to have AI based functionality enabled

Installation

1. Get distibution on your machine:
   • Run pip command to install unctl from PyPI

     pip install unctl
     

2. (optional) Set OpenAI API key to be able to use --explain (-e) option

   export OPENAI_API_KEY=<your api key>
   

3. (optional) Set KUBECONFIG variable to specific location other than default

   export KUBECONFIG=<path to kube config file>
   

Usage

% unctl -h
usage: unctl [-h] [-s] [-f] [-d] [-e] [-r] [--no-interactive NO_INTERACTIVE] [--sort-by {object,check}] [-c CHECKS [CHECKS ...]]
             [--categories CATEGORIES [CATEGORIES ...]] [--services SERVICES [SERVICES ...]] [-l] [--list-categories] [--list-services] [-v]

Welcome to unSkript CLI Interface

options:
  -h, --help            show this help message and exit
  -s, --scan            Run a k8s scan
  -f, --failing-only    Show only failing checks
  -d, --diagnose        Run fixed diagnosis
  -e, --explain         Explain failures using AI
  -r, --remediate       Create remediation plan
  --no-interactive NO_INTERACTIVE
                        Interactive mode is not allowed. Prompts will be skipped
  --sort-by {object,check}
                        Sort results by 'object' (default) or 'check'
  -c CHECKS [CHECKS ...], --checks CHECKS [CHECKS ...]
                        Filter checks by IDs
  --categories CATEGORIES [CATEGORIES ...]
                        Filter checks by category
  --services SERVICES [SERVICES ...]
                        Filter checks by services
  -l, --list-checks     List available checks
  --list-categories     List available categories
  --list-services       List available services
  -v, --version         show program's version number and exit

Roadmap

• K8s checks - in progress
• Elastic Search checks
• Postgres checks
• AWS checks
• GCP checks

Contact

Abhishek Saxena: [e-mail]

Official website: https://unskript.com/