Architecture

How a request travels from a client, through the gateway, to storage.

Trace a request:

How reva fits together

Clients speak HTTP. The HTTP services turn requests into CS3 API calls to the gateway. The gateway routes each call to a gRPC service, which uses a driver for the actual back end.

Select a component to open its page, or trace a request above.

Scroll sideways to see the whole diagram.

Layers

HTTP services speak the protocols that clients already use: WebDAV, the OCS API, a Graph API, and Open Cloud Mesh. They do not hold state. Each request becomes one or more CS3 API calls to the gateway.

The gateway is the single entry point for CS3 API calls. It checks the caller’s token, asks a registry where a resource or credential belongs, and forwards the call to the right provider. Clients such as the reva CLI call it directly.

gRPC services each own one domain: authentication, users, groups, storage, shares, apps, and OCM. They implement the CS3 APIs.

Drivers connect a service to a back end. The storage provider uses a storage driver such as EOS or CephFS. The auth provider uses an auth manager such as LDAP or OIDC. A configuration file selects one driver per service.

The data path is separate. File contents do not pass through the gateway. The storage provider returns an upload or download URL with a short-lived transfer token. The client sends the bytes to the data gateway, which forwards them to the data provider next to the storage.

Tokens

The HTTP auth middleware turns a password, an OIDC token, or another credential into a reva token, which is a JWT that the gateway signs. All later calls carry this token. Services trust the token and do not see the original credential.

Processes

All services are plugins in one binary, revad. One process can run every service, as in the quick start. A large deployment runs many processes, each with some services, and scales them separately. The processes find each other through the service registry. See configuration.

Extending reva

Every service and driver registers itself by name when its package loads. To add a driver, implement the interface of its family and register it. External plugins can add drivers without changing reva.