Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.11 KB

HACKING.adoc

File metadata and controls

84 lines (57 loc) · 2.11 KB
Raw

Hacker’s guide to Korrel8r

Table of Contents

Tips for contributing to or hacking on the Korrel8r project.

Tip
 make help will list make targets with brief explanation.

Building

Build and install korrel8r using go install.
make install
Build and publish a korrel8r image using your public image repository.
make image REGISTRY_BASE=quay.io/myaccount
Tip
 Set REGISTRY_BASE or IMG to the repository where you want to push images.
Important
 you need a public image repository for your cluster to pull images. Some registry services create private repositories by default, make sure your repository is public.

Running korrel8r

Cluster Set-up

For korrel8r to work, you need some observability data to look at.

Log into your cluster as kubeadmin or other admin user.

Running outside the cluster

You can run korrel8r on your local host, it can observe your cluster from the outside. You need to be logged-in as kubeadmin to your cluster:

Run korrel8r service outside the cluster.
korrel8r web -c etc/korrel8r/openshift-route.yaml -http :8080

Browse the interactive API page: xdg-open http://localhost:8080/api

Use korrel8r --help for more commands and options.

Deploy to Cluster

Build a new image and deploy it to a cluster.
make deploy
Tip
 Set REGISTRY_BASE or IMG to the repository where you want to push images.
Browse the interactive REST API:
xdg-open $(oc get route/korrel8r -n korrel8r -o 'template=https://{{.spec.host}}')

Contributing to documentation

  1. Fork and clone the repository

  2. Install Go

  3. Install make

  4. Run the following command to install required tools:

    make tools

  5. Make changes to the docs, then run the following command to generate the local _site directory:

    make _site

Preview _site with your web browser.