CONTRIBUTING.md

Contributing to the Euphrosyne Reconciler

Thank you for your interest in contributing to the Euphrosyne Reconciler! We welcome contributions from the community to help improve the project.

Getting Started

To get started with contributing, please follow these steps:

1. Fork the repository.
2. Clone the forked repository to your local machine.
3. Install the project dependencies.
4. Make your changes and test them locally.
5. Commit your changes and push them to your forked repository.
6. Open a pull request to the main repository.

Code Style

We follow a specific code style in this project. Please make sure to adhere to the following guidelines:

• Use consistent indentation (spaces or tabs).
• Follow the naming conventions for variables, functions, and classes.
• Run the configured formatters and linters to verify the quality of your code.
• Write clear and concise comments.
• Use meaningful commit messages.

Setting up Grafana

The Reconciler responds to alerts raised by an external system. Using Grafana for this purpose is pretty straightforward. The easiest way to get started with Grafana is using the kube-prometheus project. Installing this configures Grafana along with some other services (e.g. Prometheus) and some Dashboards and Alerts already in place. In order for the installation to work seamlessly with our system, we need to make some slight modifications to the manifests before applying them. More specifically we need to expose Grafana so that the Aggregator can communicate with it. By default, Grafana is only accessible by Prometheus:

1. Clone the kube-prometheus project locally:

   git clone [email protected]:prometheus-operator/kube-prometheus.git
   cd kube-prometheus

2. Edit the Grafana service port, so that we don't need to specify it when executing HTTP requests using the Service FQDN (i.e. http://grafana.monitoring.svc.cluster.local). More specifically, edit manifests/grafana-service.yaml to set the port to 80:

   # replace the following
     ports:
     - name: http
         port: 3000
       targetPort: http
   # with
     ports:
     - name: http
         port: 80
       targetPort: http

3. Edit the Grafana network policy so that ingress traffic from any application is allowed. By default, only traffic coming from Prometheus is permitted. More specifically, edit manifests/grafana-networkPolicy to allow all ingress traffic (in a production setting we would keep this more fine-grained):

   # replace the following
     ingress:
     - from:
       - podSelector:
           matchLabels:
           app.kubernetes.io/name: prometheus
       ports:
       - port: 3000
       protocol: TCP
   # with
     ingress:
     - {}

4. Finally, apply the manifests, as shown in the upstream guide:

   kubectl apply --server-side -f manifests/setup
   kubectl wait \
       --for condition=Established \
       --all CustomResourceDefinition \
       --namespace=monitoring
   kubectl apply -f manifests/

You can make Grafana reachable from your localhost using port-forwarding:

kubectl -n monitoring port-forward svc/grafana 3000:80

Navigate to localhost:3000 and to the Alerting panel. Select Contact Points and create a new Contact Point of type Webhook. In the address, provide the incluster address of the Euphrosyne Reconciler service:

http://euphrosyne-reconciler.default.svc.cluster.local/webhook

Click Test to test the connection. This will create a test alert that will go through our entire workflow.