Qubership Kube Event Generator

This document provides information for developers to start working with k8s-event-generator and implementing features and fixing issues.

Table of Content

• Qubership Kube Event Generator
  • Table of Content
  • Repository structure
  • How to start
    • Deploy
      • Deploy with helm
    • How to debug
    • How to troubleshoot
  • CI/CD
  • Evergreen strategy

Repository structure

• ./charts - helm folder
• ./main.go - application entrypoint

Files for build:

• ./Dockerfile - to build Docker image

How to start

Deploy with helm

This microservice can be deployed by helm. Use next command from service root folder:

helm install qubership-kube-events-generator --namespace=logging --create-namespace charts/kube-events-generator -f 
<path_to_root_folder>/charts/kube-events-generator/values.yaml

To uninstall helm you need to delete it manually.

helm uninstall qubership-kube-events-generator

How to debug

You can debug k8s-event-generator locally with default or custom parameters in your IDE. The only thing that you need to do before run/debug service locally you need to login and set context to the cloud. k8s-event-generator requires connection to cloud to create Kubernetes events.

How to troubleshoot

There are no well-defined rules for troubleshooting, as each task is unique, but there are some tips that can do:

• See deployment parameters and cli flags
• See logs of the service

CI/CD

There is no CI/CD pipeline.

Evergreen strategy

To keep the component up to date, the following activities should be performed regularly:

• Vulnerabilities fixing, dependencies update
• Bug-fixing, improvement and feature implementation