Recently, I was talking with a friend, who is a software architect, about his upcoming new job. He asked me about how I learn a new architecture. I walked him through the process that I use during a microservices consulting engagement to understand a client’s existing architecture.
This is the first of a series of posts that explain the steps of the process. These steps also correspond to sections of an architecture document. The other articles in the series are:
I’ll use the FTGO application from my Microservices Patterns book as an example. Here is the vision statement for this application:
FTGO is a food delivery application. Consumers use FTGO to place food orders at local restaurants. FTGO coordinates a network of couriers who deliver the orders. It also pays couriers and restaurants. Restaurants use the FTGO website to edit their menus and manage orders
Since an application exists to enable ‘users’ to accomplish their goals, I like to start on the outside by learning about (and documenting) the system context.
The system context is the black box model of the application. It consists of the following elements:
The system context is documented using some combination of diagrams and text. It’s often useful to create a diagram that visualizes the system context model. For example, here is the system context diagram for the FTGO application:
See OMG are you still using Rational Rose? for an explanation of this diagram’s visual notation along with important architecture documentation concepts.
The documentation must also describe the goals of the actors and responsibilities the external services. For example, for the FTGO application, the key actors are:
The key external services/applications are:
You might find it useful to incorporate this information into the diagram. Alternatively, you might skip the diagram entirely since it’s essentially a list of actors and services/application. You could, for example, present the information in a table.
In the next article, I explain the next step: understanding/documenting key user stories and scenarios.
I provide consulting and training.
Microservices.io is brought to you by Chris Richardson. Experienced software architect, author of POJOs in Action, the creator of the original CloudFoundry.com, and the author of Microservices patterns.
Take a look at my Manning LiveProject that teaches you how to develop a service template and microservice chassis.
My virtual bootcamp, distributed data patterns in a microservice architecture, is now open for enrollment!
It covers the key distributed data management patterns including Saga, API Composition, and CQRS.
It consists of video lectures, code labs, and a weekly ask-me-anything video conference repeated in multiple timezones.
The regular price is $395/person but use coupon JUNVCEJE to sign up for $195 (valid until February 1st, 2023). There are deeper discounts for buying multiple seats.
Chris offers numerous resources for learning the microservice architecture.
Chris teaches comprehensive workshops, training classes and bootcamps for executives, architects and developers to help your organization use microservices effectively.
Avoid the pitfalls of adopting microservices and learn essential topics, such as service decomposition and design and how to refactor a monolith to microservices.
Delivered in-person and remotely.
Want to see an example? Check out Chris Richardson's example applications. See code
Engage Chris to create a microservices adoption roadmap and help you define your microservice architecture,
Use the Eventuate.io platform to tackle distributed data management challenges in your microservices architecture.
Eventuate is Chris's latest startup. It makes it easy to use the Saga pattern to manage transactions and the CQRS pattern to implement queries.
Note: tagging is work-in-process
anti-patterns · application api · application architecture · architecting · architecture documentation · dark energy and dark matter · deployment · development · devops · docker · implementing commands · implementing queries · inter-service communication · loose coupling · microservice architecture · microservice chassis · microservices adoption · microservicesio updates · multi-architecture docker images · observability · pattern · refactoring to microservices · resilience · sagas · security · service api · service collaboration · service design · service discovery · service granularity · service template · software delivery metrics · success triangle · team topologies · transaction management · transactional messaging