/kgrep

Utility designed to simplify the process of searching and analyzing logs and resources in Kubernetes.

Primary LanguageJavaApache License 2.0Apache-2.0

kgrep

Overview

This utility is designed to simplify the process of searching and analyzing logs and resources in Kubernetes.

Prerequisites

  • kubectl installed and configured to connect to your Kubernetes cluster.

Usage

Type kgrep --help to check the commands.

Install

Download a release from https://github.com/hbelmiro/kgrep/releases, uncompress it, and add it to your PATH.

Building the project

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Dnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Dnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/kgrep-<version>-runner

Rename the ./target/kgrep-<version>-runner executable file to kgrep and add it to your PATH.

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.