duwab / open-source-gateway

A complete open-source stack for microservices and API Gateway

Open Source µservices with API Gateway

                        VueJS
                          |
                     -------------
                     |           |
  postgre  -----  Keycloak      Kong  -----  postgre
                 (+adminer)  (+adminer)
                                 |
                          ------------------------------------------
                          |            |            |              |
                        nodeJS        mock         go1  <-gRPC->  go2

Base projects

• Kong/Keycloak Tutorial: a tutorial with a complete backend stack Kong/Konga/Keycloak/postgre_x2/mockbin
• vue-keycloak plugin: based on keycloack§js adapter, with examples
• keycloak containers examples: official repositoryfor Keycloak containers
• Kong integrations samples: Kong with multiple integrations (keycloak, elk, InfluxDB)

Dependencies

Service	Dependencies
VueJS	url API (kong) url OpenID server Callback for standard Code Flow (keycloak adds guard then read+send code to get token)
Keycloak	1 realm (per site), with multiple providers Client for VueJS Client for Kong Build with custom theme Seed: demo user, admin user
Kong	oidc plugin plugin "instance" with Keycloak url + token (should be same as front) Routings to µservices
µservices	network aliases between each other handle possible access by API Gateway

This should give the big picture (maybe think adding nginx to "mock" VPC entry point)

Then other µservices are supposed to be added grouped by projects into submodules (they should work independently of all of this)

Use cases

• Projects bootstraping
• Day-to-day Development
• Testing (e2e) and QA environments setup
• Production recovery/re-install

Getting started

docker compose up    # details to init in start.sh
cd apps/vuejs-demo
npm run serve

• Keycloack admin: http://localhost:8180/admin/master/console
• Konga: http://localhost:1337/#!/plugins
• Kong API Gateway: http://localhost:8000
• Kong Admin API: http://localhost:8001
• VueJS: http://localhost:8080

Objectives

• Project init made simple: git clone && docker compose up && curl http://localhost:8080
• Project update made simple:
  • git pull && migrate
  • git pull && restore
• Submodules as solutions containing multiple µservices
  • Demo gRPC with 2 go services
  • Doc to add another service
  • Update made simple (project/submodule level):
    • migrate
    • restore
• Structure by solutions (Gateway, solution1(go1, go2), solution2(submodule))