Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 3.53 KB

installation.md

File metadata and controls

121 lines (80 loc) · 3.53 KB

Installing HolmesGPT

In-Cluster Installation (Recommended)

If you use Kubernetes, we recommend installing Holmes + Robusta as a unified package:

  • Forward alerts by webhook to Robusta
  • Analyze alerts in a web UI and ask follow-up questions
  • ChatGPT-like interface to query observability and K8s data in natural language
  • Built-in integrations with Prometheus alerts, Slack, and more
  • No need for an OpenAI API Key (allows bringing your own LLM if you prefer)
  • Simple installation using helm

Sign up for Robusta SaaS (Kubernetes cluster required) or contact us about on-premise options.

CLI Installation

You can install Holmes as a CLI tool and run it on your local machine:

Brew (Mac/Linux)
  1. Add our tap:
brew tap robusta-dev/homebrew-holmesgpt
  1. Install holmesgpt:
brew install holmesgpt
  1. Check that installation was successful. This will take a few seconds on the first run - wait patiently.:
holmes --help
  1. Run holmesgpt:
holmes ask "what issues do I have in my cluster"
Docker Container

Run the prebuilt Docker container docker.pkg.dev/genuine-flight-317411/devel/holmes, with extra flags to mount relevant config files (so that kubectl and other tools can access AWS/GCP resources using your local machine's credentials)

docker run -it --net=host -v ~/.holmes:/root/.holmes -v ~/.aws:/root/.aws -v ~/.config/gcloud:/root/.config/gcloud -v $HOME/.kube/config:/root/.kube/config us-central1-docker.pkg.dev/genuine-flight-317411/devel/holmes ask "what pods are unhealthy and why?"
Pip and Pipx

You can install HolmesGPT from the latest git version with pip or pipx.

We recommend using pipx because it guarantees that HolmesGPT is isolated from other python packages on your system, preventing dependency conflicts.

First Pipx (skip this step if you are using pip).

Then install HolmesGPT from git with either pip or pipx:

pipx install "https://github.com/robusta-dev/holmesgpt/archive/refs/heads/master.zip"

Verify that HolmesGPT was installed by checking the version:

holmes version

To upgrade HolmesGPT with pipx, you can run:

pipx upgrade holmesgpt
From Source (Python Poetry)

First install poetry (the python package manager)

git clone https://github.com/robusta-dev/holmesgpt.git
cd holmesgpt
poetry install --no-root
poetry run python3 holmes.py ask "what pods are unhealthy and why?"
From Source (Docker)

Clone the project from github, and then run:

cd holmesgpt
docker build -t holmes . -f Dockerfile.dev
docker run -it --net=host -v -v ~/.holmes:/root/.holmes -v ~/.aws:/root/.aws -v ~/.config/gcloud:/root/.config/gcloud -v $HOME/.kube/config:/root/.kube/config holmes ask "what pods are unhealthy and why?"
Python API

You can use Holmes as a library and pass in your own LLM implementation. This is particularly useful if LiteLLM or the default Holmes implementation does not suit you.

See an example implementation here.