A utility to analyse linkerd check's output

command-line utility for analyse linkerd check's output.

Introduction

Why use linkerd-checker when we already have linkerd check?
While the check command in linkerd serves its purpose, it currently lacks the functionality to run checks against specific categories.

What does this mean for us? If we wish to conduct checks after installing linkerd in our environment, we're obliged to run all checks without the ability to selectively ignore certain components or categories.

linkerd does provide a means to generate test output in JSON format, and linkerd-checker takes advantage of this by allowing users to filter the output based on chosen categories.

This enables users to run or fail tests only for selected components.

While this may not be beneficial to everyone, it can certainly aid certain groups that intend to test linkerd post-installation.

Requirements

• Basic understanding of linkerd and running the checks using linkerd.

Usage

The command analyse would help in analysing the json output of linkerd check command.

# Running the below command would analyse the entire output
linkerd2 check -o json | linkerd-checker analyse --all

# Running the below command would analyse output for linkerd components linkerd-smi and linkerd-multicluster only
linkerd2 check -o json | linkerd-checker analyse --category linkerd-smi --category linkerd-multicluster

# Analysing output of linkerd viz checks
linkerd2 viz check -o json | linkerd-checker analyse --all

# Analysing output of linkerd multicluster check
linkerd multicluster check -o json | linkerd-checker analyse --all

Documentation

Updated documentation on all available commands and flags can be found here.

Installation

• Recommend installing released versions. Release binaries are available on the releases page.

Homebrew

Install latest version on linkerd-checker on macOS

brew tap nikshilsbhat/stable [email protected]:nikhilsbhat/homebrew-stable.git
# for latest version
brew install nikshilsbhat/stable/linkerd-checker
# for specific version
brew install nikshilsbhat/stable/[email protected]

Check repo for all available versions of the formula.

Docker

Latest version of docker images are published to ghcr.io, all available images can be found there.

docker pull ghcr.io/nikhilsbhat/linkerd-checker:latest
docker pull ghcr.io/nikhilsbhat/linkerd-checker:<github-release-tag>

Build from Source

1. Clone the repository:

   git clone https://github.com/nikhilsbhat/linkerd-checker.git
   cd linkerd-checker

2. Build the project:

   make local.build