Overview

High level concepts

Inversion of state management

In a traditional n-tier architecture, one tier (an application tier) will invoke another tier (a database tier) to retrieve and manipulate its state. This architectural approach has some challenges that grate with the serverless philosophy:

  • The application must be aware of the location of the datastore, what technology is being used, how to talk to it etc.
  • The application is responsible for handling errors associated with managing state, both infrastructure level failures, as well as domain level errors such as concurrent updates and transactions.

CloudState inverts this model. The application code does not call out to the state management system, the state management system calls out to the application code. How to access the data, what technology is being used, etc, becomes 100% the domain of the state management system. Data access errors also become the domain of the state management system - user code never has to concern itself with that. Transactional concerns, such as managing concurrent updates, caching, sharding, routing all become a concern of the state management system, not the user code.

In moving state management concerns out of the domain of user code and into the domain of the infrastructure, we can simplify the code that users need to write, allowing more to be automated, and allowing more in depth monitoring to be achieved out of the box.

To put it another way, when inverting state management, application code does not talk to the database, it’s more correct to think of it as the database (or rather, the state management system) talks to the application code. The application code does not make a connection or any calls to the database, the state management system connects to the application code as necessary. The application code does not issue queries for the state it needs, the state management system passes state to the application code as needed to handle commands.

Glossary of terms

The following diagram illustrates how the different components of a CloudState system fit together.

Diagram showing how different CloudState concepts fit together

Stateful service

A stateful service is a deployable unit. It is represented in Kubernetes as a StatefulService resource. It contains a User function, and may reference a Stateful store. When the CloudState operator handles it, it will transform it to a Kubernetes Deployment resource with an associated Kubernetes Service for accessing it. The deployment will be injected with the CloudState Proxy.

Stateful store

A stateful store is an abstraction over a datastore, typically a database. It is represented in Kubernetes as a StatefulStore resource. A single store may be used by multiple Stateful services to store their data, but a stateful service may not necessarily have any store configured - if the stateful service does not have any durable state then it doesn’t need a stateful store.

User function

A user function is the code that the user writes, packaged as a Docker image, and deployed as a Stateful service. The user function exposes a gRPC interface that speaks the CloudState Protocol. The injected CloudState Proxy speaks to the user function using this protocol. While the user function does implement this protocol, this implementation is not generally provided by end user developers themselves, rather, a CloudState Support library is used, specific to the language that the user function is implemented in, to implement the protocol, providing a language specific idiomatic API for developers to code to.

Protocol

The CloudState protocol is an open specification of a protocol for CloudState state management proxies to speak to CloudState user functions. The CloudState project itself provides a Reference implementation of this protocol. The protocol is built on and specified using gRPC, and provides support for multiple different Entity types. CloudState provides a TCK that can be used to verify any permutation of Proxy and Support Library available.

Proxy

The CloudState proxy is injected as a sidecar into the deployment of each Stateful service. It is responsible for state management, and exposing the Entity service’s implemented by the use User function as both gRPC and REST services to the rest of the system, translating the incoming calls to Commands that are sent to the user function using the CloudState Protocol. The proxy will typically form a cluster with other nodes in the same stateful service, allowing advanced state management features such as sharding, replication and addressed communication between nodes of a single stateful service.

Reference implementation

The CloudState reference implementation implements the CloudState Protocol. It is implemented using Akka, taking advantage of Akka’s cluster features to provide scalable and resilient implementations of CloudState’s stateful features.

Support library

While User functions can be implemented simply by implementing the gRPC interfaces in the CloudState Protocol, this protocol is somewhat low level, and not particularly well suited for expressing the business logic that typically will reside in a user function. Instead, developers are encouraged to use a CloudState support library for their language of choice, if available.

Command

A command is a message received by user function. Commands may come from outside of the Stateful service, perhaps from other stateful services, other non CloudState services, or the outside world, or they may come from within the service, invoked as a side effect or to forward command handling from another command.

Entity

A User function implements one or more entities. An entity is conceptually equivalent to a class, or a type of state. An entity will have multiple instances of it which can handle commands. For example, a user function may implement a chat room entity, encompassing the logic associated with chat rooms, and a particular chat room may be an instance of that entity, containing a list of the users currently in the room and a history of the messages sent to it. Each entity has a particular Entity type, which defines how the entities state is persisted, shared, and what its capabilities are.

Entity instance

An instance of an Entity. Entity instances are identified by an Entity key, which is unique to a given entity. An entity holds state in the User function, and depending on Entity type this state is held within the context of a gRPC stream. When a command for a particular entity instance is received, the Proxy will make a new streamed gRPC call for that entity instance to the User function. All subsequent commands received for that entity instance will be sent through that streamed call.

Entity service

An entity service is a gRPC service that allows interacting with an Entity. The Proxy makes this service available for other Kubernetes services and ingreses to consume, while the User function provides the implementation of it. Note that the service is not implemented directly, by the user function like a normal gRPC service, rather, it is implemented through the CloudState Protocol, which enriches the incoming and outgoing gRPC messages with state management capabilities, such as the ability to receive and update state.

Entity type

The type of state management that an Entity uses. Available types include Event sourced and Conflict-free replicated data type. Each type has its own sub protocol as part of the CloudState Protocol that it uses for state management, to convey state and updates specific to that type.

Entity key

A key used to identify instances of an Entity. All Commands must contain the entity key so that the command can be routed to the right instance of the entity that the command is from. The gRPC descriptor for the Entity service annotates the incoming message types for the entity to indicate which field(s) contain the entity key.

Event sourced

A type of Entity that stores its state using a journal of events, and restores its state by replaying that journal. These are discussed in more detail in Event sourcing.

Conflict-free replicated data type

A type of Entity that stores its state using a Conflict-free Replicated Data Type (CRDT), which is replicated across different nodes of the service. These are discussed in more detail in Conflict-free Replicated Data Types.

The source code for this page can be found here.