package wire.federator

Get desktop application:
View/edit binary Protocol Buffers messages

'Inward' is exposed to the public internet (via nginx) and serves as a forwarding service within its own private network Example: 'federator' will use Inward.call on federator.another-domain to talk to a component inside the group of servers of another-domain which is not directly accessible.

• rpc call (Request, InwardResponse)

  router.proto:103

  message InwardResponse

  router.proto:19

  • oneof response

    • InwardError err = 1

    • bytes body = 2

The federator actually listens on two ports and exposes two services: 'Outward' is only accessible from within the private network and serves as a forwarding service to other backends. Example: 'brig' will use Outward.call on an internal server on 127.0.0.1:8097 to (indirectly) talk to the federated world.

• rpc call (FederatedRequest, OutwardResponse)

  router.proto:93

  message FederatedRequest

  router.proto:67

  The envelope message which is sent from brig to the Outward service of a local federator

  • string domain = 1

  • optional Request request = 2

  message OutwardResponse

  router.proto:26

  • oneof response

    • OutwardError outErr = 1

    • InwardError inErr = 2

    • bytes body = 3

Used in: Request

• Brig = 0

• Galley = 1

Used in: InwardResponse, OutwardResponse

• InwardError.ErrorType type = 1

• string msg = 2

Used in: InwardError

• IOther = 0

• IAuthenticationFailed = 1

• IFederationDeniedByRemote = 2

• IInvalidEndpoint = 3

• IForbiddenEndpoint = 4

• IDiscoveryFailed = 5

Used in: OutwardResponse

• OutwardError.ErrorType type = 1

• string msg = 2

Used in: OutwardError

• RemoteNotFound = 0

• DiscoveryFailed = 1

• ConnectionRefused = 2

• TLSFailure = 3

• VersionMismatch = 4

• FederationDeniedByRemote = 5

• FederationDeniedLocally = 6

• TooMuchConcurrency = 7

• GrpcError = 8

• InvalidRequest = 9

The request message is not a high-level protocol of federation. Instead, it allows encoding more-or-less arbitrary HTTP requests. The idea is to separate the concern of discovery and routing (federator's domain) from the concern of actual API routes available in a federated context (those are currently specified within each component. This may change in the future, however). FUTUREWORK(Akshay): detail the design thoughts behind this type a bit more

Used as request type in: Inward.call

Used as field type in: FederatedRequest

• Component component = 1

• bytes path = 2

  Maybe this can be made into a 'function name'

• bytes body = 3

• string originDomain = 4