Deployment

The intent of this page is to start to describe what a production deployment of API Umbrella looks like.

It consists of three types of nodes:

• api-umbrella-router (including a gatekeeper and optionally a static website and/or admin portal)
• MongoDB nodes for storing configuration and operational data
• ElasticSearch nodes for gathering usage analytics

The embedded MongoDB and ElasticSearch servers included in the all-in-one package should not be used in a production deployment. Instead, these two services should each be configured independently according to their respective best practices.

The /etc/api-umbrella/api-umbrella.yml configuration file for the router nodes should look something like the following:

services:
  - router
  - web
web:
  admin:
    initial_superusers:
      - <insert email of admin here>
mongodb:
  url: "mongodb://<user>:<password>@<host1>:<port1>,<host2>:<port2>[,...]/<database>"
elasticsearch:
  hosts:
    - "http://<server1>:<port1>"
    - "http://<server2>:<port2>"
    ...