nebo15/annon_api

•Updated over 8 years ago

Official Annon API Gateway containers, based on Alpine Linux

Image

6.8K

nebo15/annon_api repository overview

⁠Annon API Gateway

Annon is a configurable API gateway that acts as a reverse proxy with a plugin system. Plugins allow to reduce boilerplate that must be done in each service, making overall development faster. Also it stores all requests, responses and key metrics, making it easy to debug your application. Inspired by Kong⁠.

It's free. Source code is available on GitHub⁠. Docs: http://docs.annon.apiary.io/⁠

"Annon" translates from the Sindarin word for 'Great Door or Gate'. Sindarin is one of the many languages spoken by the immortal Elves.

Annon consist of multiple main parts:

Annon API Gateway⁠.
Annon Dashboard⁠ - UI that allows to manage Annon settings, review and analyze Requests.
EView⁠ - hex package that allows to receive and modify client responses from Elixir application to match Nebo #15 API Manifest⁠. So your back-ends will respond in a same way as Annon does.
Mithril⁠ - authentication and role management service.

⁠Goals of the Project

Provide single management/monitoring system for medium-to-large scale applications.
Reduce amount of work needed in other componens by orchestrating common functionalities.
Control response time and get answer "what happened" even in a single request perspective. Provide data for in-deepth service analysis.
Improve platform scalability.

⁠Environment Variables

This environment variables can be used to configure released docker container at start time. Also sample .env can be used as payload for docker run cli.

⁠General

VAR_NAME	Default Value	Description
`LOG_LEVEL`	`info`	Elixir Logger severity level. Possible values: `debug`, `info`, `warn`, `error`.

⁠Clustering

VAR_NAME	Default Value	Description
`ERLANG_COOKIE`	`03/yHifHIEl`..	Erlang [distribution cookie](http://erlang.org/doc/reference_manual/⁠
`LISTEN_DIST_MIN`	`10000`	Start of Erlang's port range to connect between nodes.
`LISTEN_DIST_MAX`	`10100`	End of Erlang's port range to connect between nodes.
`POD_IP`	`127.0.0.1`	Node IP address. (Should be correct for clustering to work.)
`SKYCLUSTER_STRATEGY`	`Cluster.Strategy.Epmd`	Which strategy to use?
`SKYCLUSTER_KUBERNETES_SELECTOR`	`app=annon,component=api`	How to select gateway pods in kubernetes
`SKYCLUSTER_KUBERNETES_NODE_BASENAME`	`gateway`	Name of a Annon's deployment

⁠HTTP Endpoints

VAR_NAME	Default Value	Description
`GATEWAY_PUBLIC_PORT`	`4000`	This is a public port that will may be available to the Internet.
`GATEWAY_PRIVATE_PORT`	`4002`	This is a port used for management API, must be protected by a firewall.
`GATEWAY_MANAGEMENT_PORT`	`4001`	This is a port that can be used by cluster services to communicate with each-other, must be protected by a firewall.

⁠Database

VAR_NAME	Default Value	Description
`DB_NAME`	`annon`	Database name.
`DB_USER`	`postgres`	Database user.
`DB_PASSWORD`	`postgres`	Database password.
`DB_HOST`	`travis`	Database host.
`DB_PORT`	`5432`	Database port.
`DB_MIGRATE`	`true`	Migrate database when container starts.

⁠Monitoring

VAR_NAME	Default Value	Description
`STATSD_HOST`	`travis`	DogStatsD server hostname.

Tag summary

Recent tags

Content type

Image

Digest

Size

60.7 MB

Last updated

over 8 years ago

docker pull nebo15/annon_api