ContextQMD
Back to Abp

Microservice Solution: Overview

docs/en/solution-templates/microservice/overview.md

10.4.17.4 KB
Original Source
json
//[doc-seo]
{
    "Description": "Explore the modern ABP microservice solution template, featuring React-based web apps, API gateways, and pre-installed libraries and services for development and production."
}

Microservice Solution: Overview

json
//[doc-nav]
{
  "Next": {
    "Name": "Solution Structure",
    "Path": "solution-templates/microservice/solution-structure"
  }
}

You must have an ABP Business or a higher license to be able to create a microservice solution.

In this document, you will learn what the Microservice solution template offers to you.

This page describes the current modern microservice template. In this template family, the web layer supports React or No UI.

The Big Picture

Figure: Overall Diagram of the Solution (not all associations are shown, for the sake of simplicity)

Pre-Installed Libraries & Services

All the following libraries and services are pre-installed and configured for both of development and production environments. After creating your solution, you can change to remove most of them.

Pre-Configured Features

The following features are built and pre-configured for you in the solution.

  • Authentication is fully configured based on best practices;
    • JWT Bearer Authentication for microservices and gateways.
    • OpenId Connect / authorization code flow for the React web applications (react, react-admin-console, and react-public-web when enabled).
    • Other flows (resource owner password, client credentials...) are easy to use when you need them.
  • Permission (authorization), setting, feature and the localization management systems are pre-configured and ready to use.
  • Background job system with RabbitMQ integrated.
  • BLOB storge system is installed with the database provider and a separate database.
  • On-the-fly database migration system (services automatically migrated their database schema when you deploy a new version)
  • Infrastructure dependencies are configured via docker-compose for running the solution in local environment.
  • Helm charts are included to deploy the solution to Kubernetes.
  • Swagger authentication is configured to test the authorized HTTP APIs.
  • Configured the Inbox & Outbox patterns for distributed event bus.

Fundamental Modules

The following modules are pre-installed and configured for the solution:

  • Account to authenticate users (login, register, two factor auth, etc)
  • Identity to manage roles and users
  • OpenIddict (the core part) to implement the OAuth authentication flows

In addition these, Feature Management, Permission Management and Setting Management modules are pre-installed as they are the fundamental feature modules of the ABP.

Optional Modules

The following modules are optionally included in the solution, so you can select the ones you need:

UI Theme

The LeptonX theme is pre-configured for the solution. You can select one of the color palettes (System, Light or Dark) as default, while the end-user dynamically change it on the fly.

Other Options

Microservice startup template asks for some preferences while creating your solution.

Database Providers

There are two database provider options are provided on a new microservice solution creation:

UI Frameworks

The current modern microservice template supports the following web options:

  • None: Doesn't include the React web applications.
  • React: Creates the web application set for the solution.

When you select React, ABP Studio creates:

  • apps/react as the main SPA behind the web gateway.
  • apps/react-admin-console as the dedicated administration SPA.
  • apps/react-public-web as an additional public site when the Public Website option is enabled.

The Mobile Application

If you prefer, the solution includes a mobile application with its dedicated API Gateway. The mobile application is fully integrated to the system, implements authentication (login) and other ABP features, and includes a few screens that you can use and take as example. In the current modern template, the available options are:

  • None (doesn't include a mobile application to the solution)
  • React Native

Multi-Tenancy & SaaS Module

The SaaS module is included as an option. When you select it, the multi-tenancy system is automatically configured. Otherwise, the system will not include any multi-tenancy overhead.

See Also