Architecture
This section describes Memphis' architecture
Key components
Memphis platform is comprised of three main components:
Memphis. The broker itself which acts as the data storage layer. That is the component that stores and controls the ingested messages and their entire lifecycle management.
Metadata store. Responsible for storing the platform metadata only, such as general information, monitoring, GUI state, and pointers to dead-letter messages. The metadata store uses Postgres.
REST Gateway. Responsible for exposing Memphis management and data ingestion through REST requests.
Connectivity Diagram
Ports list
| Name | Port | TCP/UDP | Inter/External | Description |
|---|---|---|---|---|
Dashboard/CLI | 9000 | TCP | External | External port that serve CLI clients and Web UI dashboard |
Client connections | 6666 | TCP | Internal/External | Port for TCP-based client connections with memphis SDKs |
REST Gateway | 4444 | TCP | External | REST gateway endpoint |
Websocket | 7770 | TCP | External | Websocket port |
Metrics | 8222 | TCP | Internal | Memphis monitor port |
Cluster connectivity | 6222 | TCP | Internal | Internal port for connectiovity between brokers in the cluster |
Exporter | 7777 | TCP | Internal | Memphis metrics exporter port for Prometheus |
Meta-data | 5432 | TCP | Internal | Meta-data storage port |
Network architecture diagram
The diagram below depicts a full Kubernetes-based deployment.
Topology and ordering
Producers and consumers are the main entities in Memphis. The role of the producers is to produce data into a Memphis station, and the consumers to consume the ingested data or messages.
A single client or application can run multiple producers and consumers, and connect them to various stations. Within the context of a single station, consumer groups encapsulate multiple consumers. Each consumer group will consume all of the stored and unconsumed messages within the station and split the consumed messages within its internal members, similar to thread pool behavior. That means that a single produced message will be consumed by all of the consumer groups, but within the consumer group itself, it will only be read by a single consumer.
Each consumer is bound to a unique consumer group, and cannot be shared across multiple CGs.
The stored messages within the stations are ordered based on First-In-First-Out (Fifo) manner and will be consumed in the same order as they are produced.
Mirroring and Replications
Memphis is designed to run as a distributed cluster for a highly available and scalable system. The consensus algorithm responsible for atomicity within Memphis is called RAFT and does not require a witness or a standalom Qorum, unlike others such as Apache ZooKeeper which is widely used by projects like Kafka. RAFT is also equivalent to Paxos in fault tolerance and performance.
Memphis brokers should run on different nodes to ensure data consistency and zero loss within complete broker’s reboots. To comply with RAFT requirements which are ½ cluster size + 1 an odd number of Memphis brokers shall be deployed. The minimum number of brokers is one, and the next scale would be 3, 5, and so forth.
Communication types
Deployment sequence
Self-hosted requirements
Minimum Requirements (Without high availability)
| Resource | Quantity |
|---|---|
K8S Nodes | 1 |
CPU | 2 CPU |
Memory | 4GB RAM |
Storage | 12GB PVC |
Recommended Requirements for production (With high availability)
| Resource | Minimum Quantity |
|---|---|
K8S Nodes | 3 |
CPU | 4 CPU |
Memory | 8GB RAM |
Storage | 12GB PVC Per node |
Delivery Guarantee
At least once
This is achieved by the combination of published messages being persisted to the station as well as the consumer tracking delivery and acknowledgment of each message as clients receive and process them.
Searched terms: connectivity, cluster, ordering, mirror, mirroring, deployment, protocols, requirements, delivery guarantee
Last updated
