Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 2.68 KB

README.md

File metadata and controls

90 lines (62 loc) · 2.68 KB
Raw

KumuluzEE Version

Build Status

KumuluzEE Version provides mechanisms to expose version details of your microservices.

Usage

You can enable KumuluzEE Version by adding the following dependency to the project:

<dependency>
    <groupId>com.kumuluz.ee.version</groupId>
    <artifactId>kumuluzee-version</artifactId>
    <version>${kumuluzee-version.version}</version>
</dependency>

KumuluzEE Version configuration

KumuluzEE Version will have disabled endpoint by default. You can change this with the KumuluzEE configuration framework by setting the following key where version information will be exposed:

kumuluzee:
    version-info:
      endpoint: /myCustomEndpoint

KumuluzEE Version will look for values to expose in a json file inside of the resources folder, the filepath is VERSION.json by default.

The default filepath for this file can be changed with the KumuluzEE configuration framework by setting the following key:

kumuluzee:
    version-info:
      file-path: test/MY_CUSTOM_.json

We can also specify our own custom values that will then be exposed on the servlet. Use the key kumuluzee.version-info.values.\<your key\>.

The following is an example of how to set the docker-image-name configuration value:

kumuluzee:
    version-info:
      values:
        docker-image-name: myDockerImageName

The easiest way to set this is as an environment variable KUMULUZEE_VERSION_VALUES_DOCKERIMAGENAME, which takes priority over the yaml configuration.

Example of VERSION.json

The following is an example of such a file:

{
  "maven_group_id": "${project.groupId}",
  "maven_artifact_id": "${project.parent.artifactId}",
  "maven_version": "${project.version}",
  "project_artifactId": "${project.artifactId}",
  "git_commit_id": "${buildNumber}"
}

KumuluzEE Version expects the fields to be like ${...} and to get filled by some external plugin. If a field remains unfilled then a warning gets logged. A warning also gets logged if the field is filled with "".

Changelog

Recent changes can be viewed on Github on the Releases Page

Contribute

See the contributing docs

When submitting an issue, please follow the guidelines.

When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.

License

MIT