Skip to main content

Microservice gateway using Nats

Project description

Metropolis (Python Microservice Gateway with NATS)

Simple, Scalable, Observable, Operable Service Gateway Project.

클라우드 환경(특히 Kubernetes)에서 NATS를 이용해서 쉽게 확장할 수 있는 마이크로서비스 아키텍쳐에 대한 PoC 프로젝트.

Overview

  • 보편적으로 내부 서비스들의 통신은 HTTP 프로토콜 스펙을 전부 이용하지 않는 경우가 많다.

    • NATS를 이용할 경우, 통신을 위해 HTTP 프로토콜 스펙을 지키기 위해 발생하는 오버헤드를 줄일 수 있음.
    • NATS를 이용하면서 HTTP 스펙의 기능이 필요한 경우, 별도로 만들어 붙여야 하는 문제는 있음.
  • 횡단 관심들을 분리하기 위해 API gateway를 사용하는 경우가 있는데, 이 경우 APIGW - backend간 통신 비용을 줄이는데 NATS를 사용하면 성능상 이득을 볼 수 있다.

    • API gateway를 사용하게 되면, 뒷단의 서비스들은 HTTP 스펙으로부터 자유로워 질 수 있음.
    • 이 경우 별도의 NATS 게이트웨이가 필요하게 된다.
  • NATS를 이용하는 워커와, Endpoint에 대한 HTTP 프록시를 제공하는 프레임워크를 만들어 본다.

NATS

https://nats.io/

  • Text based simple protocol
  • Light weight, Powerful performance
  • No persistency
  • Synchronized(Request), Asynchronous(Publish)

Architecture Concept

+- Node-1 --+  +- Node-2 -+  +- Node-3 --+  +- Node-4 -+
|           |  |          |  |           |  |          |
|   NATS ========= NATS ======================= NATS   | < Internal Bus >
|    |      |  |    |     |  |    |      |  |    |     |
| Worker-a  |  |    |     |  |    |      |  | Worker-d |
| Worker-b  |  | Worker-c |  | Worker-a  |  | Worker-c |
|    |      |  |    |     |  |    |      |  |    |     |
|   NATS ========= NATS ======================= NATS   | < External Bus >
|    |      |  |          |  |    |      |  |          |
| HttpProxy |  |          |  | HttpProxy |  |          |
|    |      |  |          |  |    |      |  |          |
+--- | -----+  +----------+  +--- | -----+  +----------+
     |                            |
     +--------------+-------------+
                    |
                  Ingress

Components

Nats

메시징 채널

Worker

Business Logic 수행.

HttpProxy

NATS <-> HTTP로 리퀘스트를 프록싱, API Gateway의 역할을 담당한다.

GET /foo/bar 형식의 URL pattern들을 foo.bar.GET 형식의 subject로 변환하여 Nats 스트림을 통해 메시지를 주고받게 된다.

Example

Application

구현된 간단한 수준의 워커와 http proxy 컴포넌트를 이용해서, Nats를 이용한 API 게이트웨이와 백엔드 워커를 구현하였다.

example/app/proxy.py

nats http gateway

example/app/worker.py

nats worker

example/app/settings.py

proxy와 워커의 태스크 설정등을 관리한다.

example/kubernetes

구현된 워커와 프록시, k8s nats operator를 이용해 클러스터를 전개하고 서비스 셋을 구성하기 위한 yaml definition들을 관리

Steps

# nats operator를 k8s cluster에 설치한다.
$ ./example/scripts/install_nats_operator.sh

# example application을 배포한다.
$ kubectl apply -f ./example/kubernetes

# URL test
$ curl http://example-natsgateway.mysite.local/foo?data=asdf

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for metropolis, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size metropolis-0.1.0-py3-none-any.whl (7.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size metropolis-0.1.0.tar.gz (6.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page