camel-monitor-operator

README

Camel Monitor Operator

The Camel Dashboard Monitoring for Kubernetes

The Camel Monitor Operator is a project created to simplify the management of any Camel application on a Kubernetes cluster. The tool is in charge to monitor any Camel application and provide a set of basic information, useful to learn how your fleet of Camel (a caravan!?) is behaving.

The project is designed to be as simple and low resource consumption as possible. It only collects the most important Camel application KPI in order to quickly identify what's going on across your Camel applications.

NOTE: as the project is still in an experimental phase, the metrics collected can be changed at each development iteration.

The Camel custom resource

The operator uses a simple custom resource known as CamelMonitor or cmon which stores certain metrics around your running applications. The operator detects the Camel applications you're deploying to the cluster, identifying them in a given namespace or a given metadata label that need to be included when deploying your applications (all configurable on the operator side).

Install the operator

To install the Camel Monitor Operator please see the installation documentation.

Configure a Camel application

To create a new Camel Application or modify an existing Camel Application to be monitored by the Camel Monitor Operator please see the Camel Application configuration documentation

Tuning configuration

To review the several configuration you can apply separately to each of your Camel application please see the tuning documentation

Openshift plugin

This operator can work standalone and you can use the data exposed in the CamelMonitor custom resource accordingly. However it has a great fit with the Camel Dashboard Console, which is a visual representation of the services exposed by the operator.

Development

In order to build the project, you need Go (version 1.24+) needed. Refer to the Go website for the installation.

In order to deploy the project to an actual kubernetes cluster you need:

• helm
• docker and the buildx plugin
• a Kubernetes/Openshift cluster

To build the whole project you now need to run:

NOTEST=1 make

After a successful build, if you’re connected to a Docker daemon, you can build the operator Docker image by running:

NOTEST=1 make images

You might need to produce camel-monitor-operator images that need to be pushed to the custom repository e.g. docker.io/myrepo/camel-monitor-operator, to do that you can pass a parameter CUSTOM_IMAGE to make as shown below:

NOTEST=1 make CUSTOM_IMAGE='docker.io/myrepo/camel-monitor-operator' images

NOTE: The image quay.io/camel-tooling/camel-monitor-operator:latest-amd64 is published so it can be pulled instead.

Deploy using helm:

helm upgrade -i camel-monitor-operator helm/camel-monitor --namespace camel-monitor --set operator.image=quay.io/camel-tooling/camel-monitor-operator:latest-amd64