MOSAIK

Continuous Integration Release

Modular Optimization to Service-oriented Architecture Identification Kit (MOSAIK)

MOSAIK is a toolkit for software architects and developers to convert monolithic applications into service-oriented architectures. It analyzes, extracts information, identifies suitable service candidates in monolith codebases using advanced technologies and machine learning.

Prerequisites

MOSAIK requires your application to use the Zeitwerk code loader, and to adhere to Zeitwerk's file structure and naming conventions. At the moment, only Ruby 3.3 is supported.

If you intend on visualizing the resulting graphs, you will need to have Graphviz installed on your system.

Installation

Add this line to your application's Gemfile:

gem "mosaik"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install mosaik

Generate the binstubs:

$ bundle binstubs mosaik

Usage

In the root directory of your project, create a new configuration file:

$ mosaik init

This will create a new mosaik.yml configuration file in the current directory. The mosaik.yml file tells MOSAIK which files should be included or excluded from the process.

Using MOSAIK is a three-step process:

Extract

The extract command extracts information about the application to analyze and extract services from.

$ mosaik extract --help

Identify

The identify command identifies service candidates in the monolithic application.

$ mosaik identify --help

Evaluate

The evaluate command analyzes the given service candidates, and evaluates the quality of the decomposition.

$ mosaik evaluate --help

Releasing

To release a new version, update the version number in lib/mosaik/version.rb, update the changelog, commit the files and create a git tag starting with v, and push it to the repository. Github Actions will automatically run the test suite, build the .gem file and push it to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/floriandejonckheere/mosaik.

License

The gem is available as open source under the terms of the MIT License.