- Guideline
- Goal
- Development usage
- Schema
- what is Kong?
- what is grpc?
- what is protobuf?
- Hamravesh Deployment
- License
- Bugs
This project is meant to be a guidance of how to setup grpc server and use it in other apis communications
You'll need to have Docker installed. It's available on Windows, macOS and most distros of Linux.
If you're using Windows, it will be expected that you're following along inside of WSL or WSL 2.
That's because we're going to be running shell commands. You can always modify these commands for PowerShell if you want.
Clone this repo anywhere you want and move into the directory:
git clone https://github.com/erfanmo/FastApi-GRPC-Todo-Microservice-App.gitthe config file includes 4 services:
- kong : as the api gateway which is declarative
- postgres-db : as the database to handle data storage
- todo_grpc : grpc server to serve the crud
- todo_api : fastapi application to handle requests through kong gateway
version: '3.9'
services:
# defining the name of the service
kong:
# defining the image we want to use as base
image: kong:3.1.1-alpine
# defingin container name
container_name: kong
# implementing the config for db less configs
volumes:
- ./kong/kong.yml:/usr/local/kong/declarative/kong.yml
# declaring the environment variables
environment:
- KONG_DATABASE=off
- KONG_DECLARATIVE_CONFIG=/usr/local/kong/declarative/kong.yml
- KONG_PROXY_ACCESS_LOG=/dev/stdout
- KONG_ADMIN_ACCESS_LOG=/dev/stdout
- KONG_PROXY_ERROR_LOG=/dev/stderr
- KONG_ADMIN_ERROR_LOG=/dev/stderr
- KONG_ADMIN_LISTEN=0.0.0.0:8001
# outer ports
ports:
- "80:8000"
- "8001:8001"
postgres-db:
container_name: postgres-db
image: postgres:15-alpine
volumes:
- ./postgre/data:/var/lib/postgresql/data
expose:
- 5432
environment:
- POSTGRES_DB=postgres
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=postgres
restart: always
todo_api:
build:
context: ./services/todo-api
dockerfile: ./Dockerfile
container_name: todo_api
command: sh -c "uvicorn main:app --host 0.0.0.0 --port 8000"
volumes:
- ./services/todo-api/main.py:/user/src/main.py
expose:
- 8000
environment:
- DATABASE_URL=postgresql://postgres:postgres@postgres-db/postgres
depends_on:
- postgres-db
restart: on-failure
todo_grpc:
container_name: todo_grpc
build:
context: ./services/todo-grpc
dockerfile: ./Dockerfile
expose:
- 50051
environment:
- DATABASE_URL=postgresql://postgres:postgres@postgres-db/postgres
depends_on:
- postgres-db
restart: on-failure
The first time you run this it's going to take 5-10 minutes depending on your internet connection speed and computer's hardware specs. That's because it's going to download a few Docker images and build the Python + requirements dependencies.
docker compose up --buildNow that everything is built and running we can treat it like any other FastAPI app. Visit http://localhost/todo/swagger in your favorite browser.
Note: If you receive an error about a port being in use? Chances are it's because something on your machine is already running on port 8000. then you have to change the docker-compose.yml file according to your needs.
Kong is an open-source API gateway and service mesh that was built to manage, secure, and scale microservices and APIs. It was created by Kong Inc. and is available under the Apache 2.0 license.
API gateways are tools that sit between client applications and the backend services that they rely on, providing an additional layer of security, control, and management. Kong provides a range of features that help to simplify and streamline the process of building and managing APIs. Some of the key features of Kong include:
-
Routing and Load Balancing: Kong can route incoming requests to the appropriate backend service and distribute traffic across multiple instances of the service for load balancing purposes.
-
Authentication and Authorization: Kong supports a variety of authentication and authorization mechanisms, including OAuth2, JWT, and API keys, to ensure that only authorized clients can access the API.
-
Traffic Control and Rate Limiting: Kong provides fine-grained control over the amount of traffic that can be handled by the API, allowing administrators to set limits on the number of requests that can be made per second or per minute.
-
Analytics and Monitoring: Kong provides detailed analytics and monitoring capabilities, allowing administrators to track API usage and performance in real-time.
-
Plugin Architecture: Kong supports a wide range of plugins that can be used to extend its functionality, including plugins for logging, caching, transformations, and more.
Overall, Kong provides a powerful set of tools for managing APIs and microservices, offering a range of features that can help to improve security, scalability, and performance.
gRPC (gRPC Remote Procedure Calls) is an open-source framework for building high-performance, language-agnostic, and platform-independent RPC (Remote Procedure Call) systems. It was developed by Google and is part of the Cloud Native Computing Foundation (CNCF).
gRPC allows developers to define the structure of their APIs using Protocol Buffers, a language-agnostic binary serialization format. It supports multiple programming languages, including C++, Java, Python, Ruby, Go, Node.js, and many others. With gRPC, developers can define their service interfaces once and generate client and server-side code for multiple languages automatically.
gRPC uses HTTP/2 as its transport protocol, which provides several benefits over HTTP/1.1, such as multiplexing multiple requests over a single connection, header compression, and server push. It also supports bi-directional streaming and flow control, making it ideal for building real-time communication systems, such as chat applications and live streaming services.
Overall, gRPC simplifies the process of building distributed systems by providing developers with a high-performance, scalable, and efficient RPC framework that works across multiple languages and platforms.
Protocol Buffers, or protobuf for short, is a language-agnostic binary serialization format created by Google. It is used to serialize structured data for communication between different services or for storing data in a compact manner.
Protocol Buffers define a language- and platform-neutral format for exchanging structured data. It allows data to be serialized to a compact binary format, making it easy to transmit over a network or store in a file. Protobuf messages are defined using a simple language called the Protocol Buffer Language, which is used to describe the structure of the data being serialized. The language is designed to be easy to read and write, and the resulting serialized data is both compact and efficient to parse.
One of the key advantages of using Protocol Buffers is that it allows for backwards compatibility when evolving the structure of data over time. This is because Protocol Buffers are designed to be extensible and allow for the addition of new fields without breaking existing clients. It also makes it easy to generate code for multiple programming languages, as the protobuf specification can be used as input to code generators that produce language-specific classes or structures for representing the data.
Overall, Protocol Buffers offer a lightweight, efficient, and flexible way to serialize structured data, making them a popular choice for use in distributed systems and other applications where data exchange and storage are critical.
if you are interested in how you can deploy it in hamravesh service provider you can use the following document:
MIT.
Feel free to let me know if something needs to be fixed. or even any features seems to be needed in this repo.