How to integrate with COS Lite¶

It is often advisable to have a monitoring solution which will run whether the cluster itself is running or not. It may also be useful to integrate monitoring into existing setups.

To make monitoring your cluster a delightful experience, Canonical provides first-class integration between Canonical Kubernetes and COS Lite (Canonical Observability Stack). This guide will help you integrate a COS Lite deployment with a Canonical Kubernetes deployment.

This document assumes that you have a controller with an installation of Canonical Kubernetes. If you have not yet installed Canonical Kubernetes, please see Installing Canonical Kubernetes.

Preparing a platform for COS Lite¶

If you are unfamiliar with Juju models, the documentation can be found here. This section adds a new model to keep observability separate from the Kubernetes model.

First, create a new model to act as a deployment cloud for COS Lite:

juju add-model --config logging-config='<root>=DEBUG' cos-cluster

Set the logging level to DEBUG so that helpful debug information is shown when you use juju debug-log (see juju debug-log).

Next, deploy your observability cluster using the k8s charm:

juju deploy k8s --constraints="mem=8G cores=4 root-disk=30G"

Note

local-storage and load-balancer are essential features for the COS Lite to function correctly. You can enable these features using the charm configuration options.

Once the cluster is in the active/idle state, export the kubeconfig file:

juju run k8s/leader get-kubeconfig | yq eval '.kubeconfig' > kubeconfig

KUBECONFIG=./kubeconfig juju add-k8s k8s-cloud

Deploying COS Lite on the K8s cloud¶

On the K8s cloud, create a new model and deploy the cos-lite bundle. Use the –trust flag to grant the applications access to your cloud credentials.

juju add-model cos-lite k8s-cloud
juju deploy cos-lite --trust

Make the COS Lite endpoints available for cross-model integration:

juju offer grafana:grafana-dashboard
juju offer prometheus:receive-remote-write

Use juju status --relations to verify that both grafana and prometheus offerings are listed.

At this stage, you’ve set up a Kubernetes cluster, registered it as a Juju cloud, and deployed COS Lite on it. This creates two models on the same controller.

Integrating COS Lite with Canonical Kubernetes¶

Switch to your Canonical Kubernetes model (if you forgot the name of your model, you can run juju models to see a list of available models):

juju switch <canonical-kubernetes-model>

Consume the COS Lite endpoints:

juju consume cos-lite.grafana
juju consume cos-lite.prometheus

Deploy the grafana-agent:

juju deploy grafana-agent

Relate grafana-agent to k8s:

juju integrate grafana-agent:cos-agent k8s:cos-agent

Relate grafana-agent to the COS Lite offered interfaces:

juju integrate grafana-agent grafana
juju integrate grafana-agent prometheus

Get the credentials and login URL for Grafana:

juju run grafana/0 get-admin-password -m cos-lite

The above command will output:

admin-password: b9OhxF5ndUDO
url: http://10.246.154.87/cos-lite-grafana

The username for this credential is admin.

You’ve successfully gained access to a comprehensive observability stack. Visit the URL and use the credentials to log in.

Once you feel ready to dive deeper into your shiny new observability platform, you can head over to the COS Lite documentation.