Eventing Manager

Status

GitHub tag checks state

Overview

Eventing Manager is a standard Kubernetes operator that observes the state of Eventing resources and reconciles their state according to the desired state. It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached in the cluster.

This project is scaffolded using Kubebuilder, and all the Kubebuilder makefile helpers mentioned here can be used.

Get Started

You need a Kubernetes cluster to run against. You can use k3d to get a local cluster for testing, or run against a remote cluster.

[!NOTE] Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster kubectl cluster-info shows.

Install

To install the latest version of the Eventing Manager in your cluster, run:

kubectl apply -f https://github.com/kyma-project/eventing-manager/releases/latest/download/eventing-manager.yaml

To install the latest version of the default Eventing custom resource (CR) in your cluster, run:

kubectl apply -f https://github.com/kyma-project/eventing-manager/releases/latest/download/eventing-default-cr.yaml

Development

Prerequisites

Go
Docker
kubectl
kubebuilder
kustomize
Access to Kubernetes cluster (k3d / k8s)

Run Eventing Manager Locally

Install the CRDs into the cluster:
```
make install
```
Run Eventing Manager. It runs in the foreground, so if you want to leave it running, switch to a new terminal.
```
make run
```

[!NOTE] You can also run this in one step with the command: make install run.

Run Tests

Run the unit and integration tests:

make generate-and-test

Linting

Fix common lint issues:
```
make imports
make fmt
make lint
```

Modify the API Definitions

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

make manifests

[!NOTE] Run make --help for more information on all potential make targets.

For more information, see the Kubebuilder documentation.

Build Container Images

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

make docker-build docker-push IMG=<container-registry>/eventing-manager:<tag> # If using docker, <container-registry> is your username.

NOTE: For MacBook M1 devices, run:

make docker-buildx IMG=<container-registry>/eventing-manager:<tag>

Deployment

You need a Kubernetes cluster to run against. You can use k3d to get a local cluster for testing, or run against a remote cluster.

[!NOTE] Your controller automatically uses the current context in your kubeconfig file, that is, whatever cluster kubectl cluster-info shows.

Deploy in the Cluster

Download Go packages:
```
go mod vendor && go mod tidy
```
Install the CRDs to the cluster:
```
make install
```

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

make docker-build docker-push IMG=<container-registry>/eventing-manager:<tag>

Deploy the eventing-manager controller to the cluster:

make deploy IMG=<container-registry>/eventing-manager:<tag>

[Optional] Install Eventing Custom Resource:

kubectl apply -f config/samples/default.yaml

For EventMesh backend, if the Kyma Kubernetes cluster is managed by Gardener, then the Eventing Manager reads the cluster public domain from the ConfigMap kube-system/shoot-info. Otherwise, set the spec.backend.config.domain to the cluster public domain in the eventing custom resource; for example:
```
spec:
 backend:
   type: "EventMesh"
   config:
     domain: "example.domain.com"
     eventMeshSecret: "kyma-system/eventing-backend"
     eventTypePrefix: "sap.kyma.custom"
```

Undeploy Eventing Manager

Undeploy Eventing Manager from the cluster:

   make undeploy

Uninstall CRDs

To delete the CRDs from the cluster:

   make uninstall

End-to-End Tests

See hack/e2e/README.md

Contributing

See CONTRIBUTING.md

Code of Conduct

See CODE_OF_CONDUCT.md

Licensing

See the License file

kyma-project / eventing-manager

readme