Skip to content

Hexagonal modular pattern for agile microservices evolution

License

Notifications You must be signed in to change notification settings

tarasshablii/honeycomb-monolith

Repository files navigation

Honeycomb Monolith

Hexagonal Modular Pattern for Agile Microservices Evolution

Overview

Honeycomb Monolith is an architectural pattern that solves the problem of monolith to microservices decomposition. It proposes a hexagonal modular structure that isolates domains and data, ideal for greenfield projects that want the ability of seamless evolution into microservices. This architecture allows for flexible, maintainable, and scalable software development.

Pattern Concept

Key ideas

  • Identify domains early on
  • Separate the data from the start
  • Enclose domain model and logic in separate modules
  • Structure each module as a hexagon

The Honeycomb Monolith pattern is a forward-thinking approach in the design of monolithic applications, where Domain-Driven Design principles are integrated with the adaptable Hexagonal Architecture. This pattern distinctly identifies and separates business domains along with their associated data, organizing the application into modules, each representing an individual domain. These components are structured as hexagons to isolate the domain logic from external communication interfaces. This symbolically represents the pattern’s core philosophy: ike a honeycomb’s hexagonal cells, each module in this pattern is self-contained and poised for an effortless transition into an independent microservice.

Benefits

  • Cohesive modularity
  • Agile and smooth transition to microservices (domain and data not affected)
  • Decreased long-term maintenance cost
  • Ease of integration with external systems

Considerations

  • Requires domain modeling
  • Distributed transaction (across domains)
  • Governance effort
  • Model duplication and extensive mapping

Example implementation

This project provides an example implementation of the Opora API. The application enables managing humanitarian Initiatives to address urgent crises and provide aid to those in need. A relevant topic amid the ongoing russian invasion in Ukraine (see Support Ukraine section). Initiatives are managed by Sponsors - either individuals or organizations. Application also provides means to store and retrieve Media. All inbound requests come through the uniform API provided by API Gateway domainless module. For the sake of technological diversity Initiatives are stored in MongoDB, Media files are stored in MinIO with metadata in PostgreSQL, and Sponsors reside in a separate instance of PostgreSQL. Hexagonal Modular Diagram

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • JDK 17 (Amazon Corretto 17 recommended)
  • Docker and Docker Compose

Build

./gradlew clean build

Run application

You can run the application either as Dockerized containers (recommended) or as standalone Spring Boot services.

Run as docker containers

docker compose --profile monolith --profile microservices up -d

Run as Spring Boot services

  1. Start the required dependencies docker compose up -d
  2. Run monolith Spring Boot application ./gradlew :monolith:bootRun
  3. Run apigateway service ./gradlew :microservices:apigateway:bootRun
  4. Run initiatives service ./gradlew :microservices:initiatives:bootRun
  5. Run media service ./gradlew :microservices:media:bootRun
  6. Run sponsors service ./gradlew :microservices:sponsors:bootRun

Accessing the Application

Deployment Diagram

Stop application

  • To stop monolith and microservices applications running in a containers, use docker compose --profile monolith --profile microservices down -v
  • To stop dependencies, use docker compose down -v
  • To stop Spring Boot applications running in shell, kill each job via control+c or Ctrl+c

Support Ukraine

As Ukraine fights for its survival and for the values of freedom and self-determination we need your support! Our warriors show that the only way to stop the russian terroristic invasion is on the battlefield. Please, help us fight for our freedom and stop the spread of russian tyranny. Donate to any of these trusted funds and spread the word:

Releases

No releases published

Packages

No packages published