https://github.com/scilifelabdatacentre/serve-event-listener
This repository contains the code for the serve event listener functionality
https://github.com/scilifelabdatacentre/serve-event-listener
Last synced: 3 months ago
JSON representation
This repository contains the code for the serve event listener functionality
- Host: GitHub
- URL: https://github.com/scilifelabdatacentre/serve-event-listener
- Owner: ScilifelabDataCentre
- License: apache-2.0
- Created: 2024-01-22T14:03:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-05T06:24:10.000Z (3 months ago)
- Last Synced: 2025-09-05T08:28:04.519Z (3 months ago)
- Language: Python
- Size: 147 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Kubernetes Event Listener by Serve
The Kubernetes Event Listener by Serve is a service designed to monitor changes in Kubernetes and automatically send the latest information to another application for processing. This README provides detailed instructions on how to run the service on both a host machine and within a Docker container.
## Development
In this repo, we work [Trunk based](https://www.toptal.com/software/trunk-based-development-git-flow), which means that we bypass the dev branch.
Create short-lived branches from main:
```bash
git checkout main
git pull
git checkout -b feature/xyz
```
Keep your branch fresh:
```bash
git fetch
git rebase origin/main
```
Verify that the code adheres to the style guidelines and code analysis rules:
```bash
flake8 .
black . --check
hadolint Dockerfile
```
When the work is ready to be merged to main, create a PR to merge your feature branch into the main branch.
To release a new version of the event-listener, first tag the latest commit. When the tag is pushed to origin, a github action is run automatically and publishes a new package which is a docker image called event-listener.
## Host Machine Setup
### Prerequisites
Make sure you have the following prerequisites installed on your host machine:
- Python 3.x
- Kubernetes cluster configuration file (`cluster.conf`)
### Configuration
Set the `KUBECONFIG` environment variable to point to your Kubernetes cluster configuration:
```bash
export KUBECONFIG=/path/to/cluster.conf
export BASE_URL=
export TOKEN_API_ENDPOINT= (optional, is set to BASE_URL + "/api/v1/token-auth/" if not defined)
export APP_STATUS_API_ENDPOINT= (optional, is set to BASE_URL + "/api/v1/app-status/" if not defined)
export USERNAME=
export PASSWORD=
```
To retrieve additional log messages, set:
```bash
export DEBUG=True
export TEST_LOG_STREAM=sys.stdout
```
### Running the Service
Navigate to the project directory and execute the following command to run the service:
```bash
python3 ./serve_event_listener/main.py --namespace --label-selector
```
### Running the unit tests
```bash
python -m unittest discover -s tests
```
## Docker Container Setup
### Build the Docker Image
Build the Docker container image using the following command. Replace `` and `` with your desired values.
```bash
docker build -t : .
```
### Running the Docker Container
Run the Docker container with the mounted `cluster.conf` file and provide necessary environment variables:
```bash
docker run --rm -v $PWD/cluster.conf:/home/serve/cluster.conf \
--env KUBECONFIG=/home/serve/cluster.conf \
--env USERNAME=admin@test.com \
...(set all env from above) \
: \
--namespace \
--label-selector
```
## Program Arguments
The following are the main function arguments that can be passed to run the program:
- `--namespace`: Kubernetes namespace to watch (default: `default`).
- `--label-selector`: Label selector for filtering pods (default: `type=app`).