Skip to content

Latest commit

 

History

History
141 lines (104 loc) · 6.9 KB

README.md

File metadata and controls

141 lines (104 loc) · 6.9 KB
Raw

Open Runtimes Proxy 🚦

open-runtimes-box-bg-cover

Discord Build Status Twitter Account Docker Pulls

Proxy server for Open Runtimes, a runtime environments for serverless cloud computing for multiple coding languages.

The proxy is responsible for checking health of executors, and proxying requests between them based on selected strategy, such as round-robin. Proxy is stateless and can be scaled horizontally when a load balancer is introduced in front of it. You could use this proxy with any HTTP services but we highly recommend using it with Open Runtimes Executor.

Features

  • Flexibility - Adapter-driven approach allows switching between proxying strategies. You can even implement your own.
  • Performance - Coroutine-style HTTP servers allows asynchronous operations without blocking. We. Run. Fast! ⚡
  • Open Source - Released under the MIT license, free to use and extend.

Getting Started

  1. Pull Open Runtimes Proxy image:
docker pull openruntimes/proxy
  1. Pull whoami image:
docker pull containous/whoami
  1. Create docker-compose.yml file:
version: '3'
services:
  openruntimes-proxy:
    image: openruntimes/proxy
    ports:
      - 9800:80
    environment:
      - OPR_PROXY_ALGORITHM
      - OPR_PROXY_WORKER_PER_CORE
      - OPR_PROXY_EXECUTORS
      - OPR_PROXY_HEALTHCHECK_INTERVAL
      - OPR_PROXY_MAX_TIMEOUT
      - OPR_PROXY_ENV
      - OPR_PROXY_EXECUTOR_SECRET
      - OPR_PROXY_SECRET
      - OPR_PROXY_LOGGING_PROVIDER
      - OPR_PROXY_LOGGING_CONFIG
      - OPR_PROXY_HEALTHCHECK
      - OPR_PROXY_HEALTHCHECK_URL
  whoami1:
    hostname: whoami1
    image: containous/whoami
  whoami2:
    hostname: whoami2
    image: containous/whoami

We are adding 1 proxy and 2 HTTP servers. Notice only proxy is exported, on a port 9800.

  1. Create .env file:
OPR_PROXY_ALGORITHM=random
OPR_PROXY_WORKER_PER_CORE=6
OPR_PROXY_EXECUTORS=whoami1,whoami2
OPR_PROXY_HEALTHCHECK=disabled
OPR_PROXY_SECRET=proxy-secret-key
OPR_PROXY_HEALTHCHECK_INTERVAL=5000
OPR_PROXY_HEALTHCHECK_URL=
OPR_PROXY_ENV=development
OPR_PROXY_EXECUTOR_SECRET=executor-secret-key
OPR_PROXY_LOGGING_PROVIDER=
OPR_PROXY_LOGGING_CONFIG=

Notice we disabled health check. We recommend keeping it enabled and implementing proper health check endpoint

  1. Start Docker containers:
docker compose up -d
  1. Send a HTTP request to proxy server:
curl -H "authorization: Bearer proxy-secret-key" -X GET http://localhost:9800/

Run the command multiple times to see request being proxied between both whoami servers. You can see Hostname changing the value.

Noitce we provided authorization header as configured in .env in OPR_PROXY_SECRET.

  1. Stop Docker containers:
docker compose down

Environment variables

Variable name Description
OPR_PROXY_ALGORITHM Proxying algorithm. Supports round-robin, random, first, last.
OPR_PROXY_WORKER_PER_CORE How many concurrent requests can proxy handle per each CPU core.
OPR_PROXY_EXECUTORS Comma-separated hostnames of servers under the proxy.
OPR_PROXY_HEALTHCHECK Health check by HTTP request to /v1/health. 'enabled' by default. To disable, set to 'disabled'.
OPR_PROXY_HEALTHCHECK_INTERVAL Delay in milliseconds between health checks. 10000 by default. Only relevant if OPR_PROXY_HEALTHCHECK is 'enabled'.
OPR_PROXY_HEALTHCHECK_URL URL to send health check request to. Only relevant if OPR_PROXY_HEALTHCHECK is 'enabled'.
OPR_PROXY_MAX_TIMEOUT Maximum timeout in seconds for communication between proxy and executor. Default is 600 seconds.
OPR_PROXY_ENV Runtime environment. 'production' or 'development'. Development may expose debug information and is not recommended on production server.
OPR_PROXY_SECRET Secret that needs to be provided in Authroization header when communicating with the to proxy.
OPR_PROXY_EXECUTOR_SECRET String provided as authorization header by proxy when sending request to executor.
OPR_PROXY_LOGGING_PROVIDER Logging provider. Supports sentry, appsignal, raygun, logowl. Leave empty for no cloud logging.
OPR_PROXY_LOGGING_CONFIG Logging configuration as requested by utopia-php/logger.

Contributing

All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at [email protected] instead of posting a public issue on GitHub.

Follow Us

Join our growing community around the world! See our official Blog. Follow us on Twitter, Facebook Page, Facebook Group , Dev Community or join our live Discord server for more help, ideas, and discussions.

License

This repository is available under the MIT License.