Giter Club home page Giter Club logo

bifrost's Introduction

bifrost

A protobuf router and reverse proxy for services, with input validation capabilities

About

This project is still in alpha: APIs should be considered unstable and likely to change.

Bifrost is a reflective protobuf router and reverse proxy. It uses your protobuf definitions for dynamically generating the gateway and is able to check input based on user-defined rules (see protoc-gen-cel-validate for more details regarding rules).

It features :

  • gRPC, gRPC-web and connect protocols (binding and proxying)
  • protoc-gen-cel-validate validation rules
  • supports Go plugin for loading your custom rules

Installation

For installing bifrost, you can simply run the go install:

$ go install github.com/nlachfr/bifrost/cmd/bifrost

The binary will be placed in your $GOBIN location.

Configuration file

In order to use the gateway, you must provided a configuration file. It will allows you to :

  • define listening address and upstreams
  • specify proto files location
  • configure validation

All the configuration fields are specified in the bifrost.gateway.Configuration message specification.

Example

  1. Create your configuration file
servers:
  - listen:
      - 127.0.0.1:8888
    upstreams:
      '*':
        address: https://demo.connect.build    
        protocol: grpc
files:
  sources:
    - proto/*.proto
  imports:
    - "."
validate:
  rule:
    servicerules:
      buf.connect.demo.eliza.v1.ElizaService:
        rule:
          programs:
            - expr: 'attribute_context.request.headers["ok"] == "ok"'      
      connect.ping.v1.PingService:
        rule:
          programs:
            - expr: 'attribute_context.request.headers["ok"] == "ok"'
  1. Call bifrost with your newly created configuration
$ bifrost -config ./config.yml

bifrost's People

Contributors

nlachfr avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.