hybrid mergy (#581)

* so it begins

* add clarification to /dequeue, change response to list to future proof

* Specify that runner endpoints are also under /v1

* Add a flag to choose operation mode (node type).

This is specified using the `FN_NODE_TYPE` environment variable. The
default is the existing behaviour, where the server supports all
operations (full API plus asynchronous and synchronous runners).

The additional modes are:
* API - the full API is available, but no functions are executed by the
  node. Async calls are placed into a message queue, and synchronous
  calls are not supported (invoking them results in an API error).
* Runner - only the invocation/route API is present. Asynchronous and
  synchronous invocation requests are supported, but asynchronous
  requests are placed onto the message queue, so might be handled by
  another runner.

* Add agent type and checks on Submit

* Sketch of a factored out data access abstraction for api/runner agents

* Fix tests, adding node/agent types to constructors

* Add tests for full, API, and runner server modes.

* Added atomic UpdateCall to datastore

* adds in server side endpoints

* Made ServerNodeType public because tests use it

* Made ServerNodeType public because tests use it

* fix test build

* add hybrid runner client

pretty simple go api client that covers surface area needed for hybrid,
returning structs from models that the agent can use directly. not exactly
sure where to put this, so put it in `/clients/hybrid` but maybe we should
make `/api/runner/client` or something and shove it in there. want to get
integration tests set up and use the real endpoints next and then wrap this up
in the DataAccessLayer stuff.

* gracefully handles errors from fn
* handles backoff & retry on 500s
* will add to existing spans for debuggo action

* minor fixes

* meh
This commit is contained in:
Reed Allman
2017-12-11 10:43:19 -08:00
committed by GitHub
parent 1df4b46c56
commit 2ebc9c7480
26 changed files with 1157 additions and 94 deletions

126
docs/developers/hybrid.md Normal file
View File

@@ -0,0 +1,126 @@
# Hybrid API Proposal
TODO fill in auth information herein (possibly do w/o first?)
Hybrid API will consist of a few endpoints that encapsulate all functionality
required for `fn` to run tasks using split API and 'runner' nodes. These
endpoints exist under the `/v1/runner/` endpoints. In addition to these
endpoints, the runner has access to any `/v1/` endpoints it needs as well
(namely, `GetApp` and `GetRoute`).
API nodes are responsible for interacting with an MQ and DB [on behalf of the
runner], as well as handling all requests under the `/v1/` routes.
Runner nodes are responsible for receiving requests under the `/r/` endpoints
from the fnlb and sending requests to the `/v1/runner/` endpoints to API nodes,
its duties are:
* enqueueing async calls
* dequeueing async calls when there is spare capacity
* executing calls (both sync and async)
* management of message lifecycle
* reporting call status & logs
## Endpoints
All functionality listed here will be implemented in the API nodes under the
given endpoint. The runner is responsible for calling each of these endpoints
with the given input.
##### POST /v1/runner/async
this is called when a runner receives a request for an async route. the
request contains an entire constructed `models.Call` object, as well as an
identifier for this runner node to queue this call to a specific partition in
kafka [mapping to the runner node]`***`. returns success/fail.
* enqueue an async call to an MQ
* insert a call to the DB with 'queued' state
special cases:
* if enqueue to MQ fails, the request fails and the runner will
reply with a 500 error to the client as if this call never existed
* if insert fails, we ignore this error, which will be handled in Start
##### GET /v1/runner/async
the runner long polls for a call to run. the request contains an identifier for
this runner node to pull from the partition in kafka for this runner node`***`.
the response contains a list of {app_name, route_name} (the runner will cache apps
and routes, otherwise looking this up at respective API call positions),
possibly an empty list. This call will timeout and return an empty list after
30 seconds if no messages are found. For now, it should return the first
message it finds immediately.
* dequeue a message from the MQ if there is some capacity
##### POST /v1/runner/start
the runner calls this endpoint immediately before starting a task, only
starting the task if this endpoint returns a success. the request contains the
app name and the call id. the response returns success/fail code. this
transition _could_ be done in the dequeue portion of the call lifecycle since
it's only for async, however this exists because the time between dequeueing
and being prepared to execute a task may be long (or even succeed).
sync:
* noop, the runner will not call this endpoint.
async:
* update call in db to status=running, conditionally. if the status is already
running, set the status to error as this means that the task has been
started successfully previously and we don't want to run it twice, and after
successfully setting the status to error, delete the mq message, and return
a failure status code. if the status is a final state (error | timeout |
success), delete the mq message and return a failure status code. if the
update to status=running succeeds, return a success status code.
##### POST /v1/runner/finish
the runner calls this endpoint after a call has completed, either because of
an error, a timeout, or because it ran successfully. the request must contain
an entire completed call object as well as its log (multipart?). it will
always return a success code as the call is completed at this point, the
runner may retry this endpoint if it fails (timeout, etc).
sync:
* insert the call model into the db (ignore error, retry)
* insert the log into the log store (ignore error, retry)
async:
* insert the call model into the db (ignore error, retry)
* insert the log into the log store (ignore error, retry)
* delete the MQ message (ignore error, retry, failure is handled in start)
## Additional notes & changes required
* All runner requests and responses will contain a header `XXX-RUNNER-LOAD`
that API server nodes and FNLB nodes can use to determine how to distribute
load to that node. This will keep a relatively up to date view of each of
the runner nodes to the API and FNLB, assuming that each of those are small
sets of nodes. The API nodes can use this to determine whether to distribute
messages for async nodes to runner nodes as well as fnlb for routing async
or sync requests.
* Each runner node will have a partition in Kafka that maps to messages that
it enqueues. This will allow us to use distribution information, based off
load, from the load balancer, since the load balancer will send requests to
queue async tasks optimistically to runner nodes. The runner then only
processes messages on its partition. This is likely fraught with some
danger, however, kafka messaging semantics have no idea of timeouts and we
make no real SLAs about time between enqueue and start, so its somewhat sexy
to think that runners don't have to think about maneuvering timeouts. This
likely needs further fleshing out, as noted in`***`.
`***` current understanding of kafka consumer groups semantics is largely
incomplete and this is making the assumption that if a runner fails, consumer
groups will allow another runner node to cover for this one as well as its
own. distribution should also be considered, and sending in partition ids is
important so that FNLB will dictate the distribution of async functions across
nodes as their load increases, this is also why `XXX-RUNNER-LOAD` is required,
since async tasks aren't returning wait information up stack to the lb. this
likely requires further thought, but is possibly correct as proposed (1% odds)