o11y-rules-telemetry-operator

K8S controller to manage Mimir Alerting and Recording rules with dynamic tenants, based on namespace name or annotations.

Production installation

1. Follow the instructions at https://springernature.github.io/o11y-rules-telemetry-operator
2. See all available settings in the Chart: https://github.com/springernature/o11y-rules-telemetry-operator/blob/main/charts/Readme.md

Alternatively, the controller and CRDs can be installed directly with kubectl apply -f dist/install.yaml

Description

Given a MimirRules CR:

apiVersion: mimirrules.telemetry.springernature.com/v1beta1
kind: MimirRules
metadata:
  annotations:
    "telemetry.springernature.com/o11y-tenant": "jose"
  name: mimirrules-sample
spec:
  groups:
  - name: MyGroupName
    rules:
    - alert: MyAlertName
      expr: up == 0
      labels:
        severity: warning

The operator applies the rules to Mimir (Ruler) Api using the tenant defined in the annotation or namespace and it updates the status according to the results and emits events.

Getting Started developing

This repository uses GitHub pages with chart-releaser in a workflow with chart-releaser-action to automatically create an manage a Helm repository. See below for more info

Code:

• cmd/main.go: Arguments and environment variables
• api/v1beta1/mimirrules_types.go: CR definition
• internal/controller/mimirrules_controller.go: Controller logic
• internal/controller/mimirrules.go: Mimir Rule API HTTP client

More information can be found via the Kubebuilder Documentation

Cheat sheet

Run make help for more information on all potential make targets

Prerequisites

• go version v1.21.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

Make sure kubectl is pointing to the proper K8S cluster. The destination namespace is defined in config/default/kustomization.yaml.

# Creates the yaml of the CRD defined in api/v1beta1/mimirrules_types.go
# Output is int config/crd/bases
make manifests

# Install the CRD in the cluster targeted by kubectl
make install

# Compile the code, runs tests, ... to bin/manager
make

# Define the image version
TAG=test1

# Creates a docker images with the binary and pushes it to the registry
make docker-build docker-push IMG=ghcr.io/springernature/o11y-rules-telemetry-operator/mimirrules-controller:$TAG

# Deploys the kustomization to the K8s cluster (all files created in config)
make deploy IMG=ghcr.io/springernature/o11y-rules-telemetry-operator/mimirrules-controller:$TAG

# Generate a consolidated YAML with CRDs and deployment.
make build-installer

Building a new Chart and Docker image version

This repository uses GitHub pages with chart-releaser in a workflow with chart-releaser-action to automatically create an manage a Helm repository. In order to create a new version, update the versions in charts/mimirrules-controller/Chart.yam, increase both versions at the same time, each Helm Chart version will map each own image version (no need to be the same). After pushing the commit, the GH Actions workflow will generate the new packages in the GH registry.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=ghcr.io/springernature/o11y-rules-telemetry-operator/mimirrules-controller:0.0.1

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=ghcr.io/springernature/o11y-rules-telemetry-operator/mimirrules-controller:0.0.1

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Generate K8S manifests:

make build-installer

Project Distribution

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

make build-installer IMG=ghcr.io/springernature/o11y-rules-telemetry-operator/mimirrules-controller:0.0.1

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

2. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/o11y-rules-telemetry-operator/<v1 or branch>/dist/install.yaml

License

Copyright Springer Nature 2024.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.