Coralogix Operator

Overview

The Coralogix Operator provides Kubernetes native deployment and management of Coralogix and related components. The purpose of this project is to simplify and automate the configuration of a Coralogix APIs for Kubernetes clusters.

The Coralogix operator includes, but is not limited to, the following features:

Kubernetes Custom Resources: Use Kubernetes custom resources to deploy and manage Alerts, RecordingRuleGroupSets, RuleGroups and related components.

Guides

• Contributing

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

1. Install the CRDs into the cluster:

make install

2. Add the api key and region as environment variables (or later as flags):

$ export CORALOGIX_API_KEY="<api-key>"
$ export CORALOGIX_REGION="<region>"

For private domain the domain field or the environment variable CORALOGIX_DOMAIN have to be defined.

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

make docker-build docker-push IMG=<some-registry>/coralogix-operator:tag

4. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/coralogix-operator:tag

5. Install custom resources samples into the cluster:

kubectl apply -R -f config/samples/

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

Please refer to CONTRIBUTING.md

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the Desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

make install

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2023.

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.