MicroProfile Documentation

The MicroProfile project has several sources of information and collaboration. Since there is a large volume of activity, there is a need for important decisions to be recorded in one place for future reference. This is the aim of this repository.

Current Resources

The Microprofile project is community-focused at its heart and aims to engage and encourage lively discussion through as many channels as possible.

Umbrella Specification

This repository is used to house the top-level umbrella MicroProfile specification.

Maven bill-of-materials POM

This repository also houses the Maven bill-of-materials POM. This POM declares transitvie dependencies on all the Java EE and MicroProfile artifacts covered by the umbrella specification and can be used in one of two ways:

1. To declare a dependency on the entire MicroProfile stack:

   <dependencies>
       <dependency>
           <groupId>org.eclipse.microprofile</groupId>
           <artifactId>microprofile</artifactId>
           <version>3.0</version>
           <type>pom</type>
           <scope>provided</scope>
       </dependency>
   </dependencies>

2. To import the transitive dependencies for selective use:

   <dependencyManagement>
       <dependencies>
           <dependency>
               <groupId>org.eclipse.microprofile</groupId>
               <artifactId>microprofile</artifactId>
               <version>3.0</version>
               <scope>import</scope>
               <type>pom</type>
           </dependency>
       </dependencies>
   </dependencyManagement>
   
   <dependencies>
       <dependency>
           <groupId>org.eclipse.microprofile.health</groupId>
           <artifactId>microprofile-health-api</artifactId>
           <scope>provided</scope>
       </dependency>
   
       <dependency>
           <groupId>org.eclipse.microprofile.metrics</groupId>
           <artifactId>microprofile-metrics-api</artifactId>
           <scope>provided</scope>
       </dependency>
   
       <dependency>
           <groupId>javax.ws.rs</groupId>
           <artifactId>javax.ws.rs-api</artifactId>
           <scope>provided</scope>
       </dependency>
   </dependencies>

Code, code, code

Several Eclipse github repos exist for the development of MicroProfile features…​

MicroProfile — Top-level repo used for the umbrella MicroProfile specifications and other Microprofile-related information (this repo)
MicroProfile Config — MicroProfile application configuration
MicroProfile Health Check — MicroProfile simple health check
MicroProfile Metrics — MicroProfile metrics
MicroProfile Fault Tolerance — MicroProfile fault tolerance
MicroProfile Rest Client — MicroProfile type-safe REST client
MicroProfile Open API — MicroProfile OpenAPI and annotations
MicroProfile JWT Authentication — MicroProfile JWT authentication propagation
MicroProfile OpenTracing — MicroProfile OpenTracing integration
MicroProfile Conference App — "Architectural Application" to demonstrate MicroProfile on a variety of vendors

A complete list of MicroProfile-related repositories within the Eclipse github organization can be found via this link.

Some of the repositories are hosted under the Microprofile github organization, including the following repos:

MicroProfile.io blogs — Easy mechanism for updating the entries on the MicroProfile blog site
Microprofile.io site — source code of the application that powers the microprofile.io site

Eclipse MicroProfile and Microprofile.io

The MicroProfile community has two portals to information. The main site is the Eclipse MicroProfile project. In addition to this portal to our community at Eclipse, we will continue to maintain our external site at microprofile.io. Both sites will be maintained to promote the development and use of MicroProfile in the industry.

Wiki

The MicroProfile wiki contains up-to-date information about the project development, tools and other documentation.

Google Group

The Microprofile Google Group is the preferred place for discussions to take place.

Mailing Lists

Besides the Google Group threads (main source of communication), there is also an Eclipse microprofile-dev mailing list which should be used for conversation specific to the Eclipse way of doing things. By using this mailing list, the Eclipse team can more quickly recognize and respond to our requests.

Since the MicroProfile project is still in incubation, another useful mailing list is the incubation mailing list for asking general Eclipse process questions.

Notable Contributors

There is a very large number of people and vendors already involved in the MicroProfile project. The most complete list of contributors can be found at our microprofile.io site. Specific to our Eclipse efforts, another page is automatically maintained at Eclipse MicroProfile for the Eclipse committers and project leads.