bimawa/kourier

Connector between controllers and kourier mesh

Kubernetes-based infrastructure mesh framework
Report Bug · Request Feature

Table of Contents

• About the Project
  • What is it
  • Features
• Getting Started
  • Prerequisites
  • Installation
• Examples
• Roadmap
• Contributing
• License
• Contacts
• Acknowledgements

About The Project

What is it

There are huge amount of tools in the world of devops. Simple and complex ones. They are designed to solve problems and we use a lot of them to achieve our goals. But there is one problem beyound them - they don't know about each other (most of them).

This project allows us to connect varous environments using handles they provide. We do it by using specified controllers and describing event flows in kubernetes CRDs. Think about it as IFTTT for internal infrastructure.

Usecase sample: send notification to custom chat messenger and create annotation in grafana on succesful CI build. See examples and architecture concept for more information.

NOTE: this is ALPHA version of Kourier service mesh. After testing the concept implementation and protocol can be changed with backward compatibility.

Features

• easy extending of Kourier events mesh
• native CloudEvents support
• infrastructure as a code
• automatic validation and normalization with json schemas
• ability to create languange-agnostic controllers
• extending pipelines using jsonnet language
• ... see Roadmap

Getting Started

Installation

# add helm chart repository
helm repo add kourier https://kourier-io.github.io/helm-chart

# create default custom resource definitions
helm upgrade kourier-crd kourier/crd --install

# install basic wersion of webhook controller
# available options: https://github.com/kourier-io/helm-chart/blob/master/kourier/values.yaml
helm upgrade kourier-rest kourier/kourier --install --set controllerName=rest,service.enabled=true,image.repository=kourier/rest-controller

Examples

Basic

This is simple demonstration how to trigger remote system using event from custom webhook.

# apply webhook config
kubectl apply -f https://raw.githubusercontent.com/kourier-io/kourier/master/examples/basic/webhook.yml
# apply webhook event catcher
kubectl apply -f https://raw.githubusercontent.com/kourier-io/kourier/master/examples/basic/request.yml
# forward rest controller port
kubectl port-forward service/kourier-rest 8080
# point your browser to https://kourier.requestcatcher.com/ and execute:
curl -X POST "http://localhost:8080/test" -H "Content-Type: application/json" \
 -d '{
  "message": "hello"
 }'

Advanced

TBD

Writing controller

TBD

Roadmap

See the open issues for a list of proposed features

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

Autors:

• https://makeomatic.ca

Inspired by:

• https://stackstorm.com/
• https://github.com/argoproj/argo-events

Uses:

• https://jsonnet.org/
• https://cloudevents.io/
• https://json-schema.org/