README

Discussions

• [](https://web.libera.chat/?channels=#clk)
• [](https://gitter.im/clk-project/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Installation

Either:

1. install clk-project and the extension with

   curl -sSL https://clk-project.org/install.sh | env CLK_EXTENSIONS=k8s bash
       

2. if you already have clk, you can simply install this extension with

   clk extension install k8s
       

Usage

clk k8s flow

Now, you have a local cluster running and ready to be used. It is that simple.

tilt extensions

This extension also provides some tilt functions. To use them, load the extension, like this

config.define_string("clk-k8s-local-path")
cfg = config.parse()

v1alpha1.extension_repo(
    name='clk-k8s',
    url=cfg.get(
        'clk-k8s-local-path',
        'https://github.com/clk-project/clk_extension_k8s',
    ),
)
v1alpha1.extension(
    name='clk-helpers',
    repo_name='clk-k8s',
    repo_path='tilt-extensions/helpers',
)
load('ext://clk-helpers', 'update_helm_chart')

observability

clk k8s flow will automatically install the opentelementry operator, so that you only have to provide open telemetry collector custom resources depending on your need.

clk does not install any observability database like prometheus, loki, tempo, pyroscope etc. This is because they consume a lot of ram and in our experience it is enough to distract us from our job.

Because of this, clk is unable to create a collector without prior knowledge on where to send the data.

The command clk k8s otel create-collector is part of the clk k8s flow but does noting by default, to make it actually create a collector, you have to add a parameter that will set the option --log-endpoint to whatever endpoint you have at hand.

So in short, something like, clk k8s otel create-collector --log-endpoint http://mydatabase:4318 will do the trick.

That collector is configured to discover pods with the annotation io.opentelemetry.discovery.logs/enabled: "true" and send their log to the otlphttp database you configured.