mp-config-consul

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

mp-config-consul

★ 8 Open GitHub ↗

Eclipse microprofile config consul extension

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Action Status](https://github.com/rikcarve/mp-config-consul/workflows/ci/badge.svg)](https://github.com/rikcarve/mp-config-consul/actions)
[![codecov](https://codecov.io/gh/rikcarve/mp-config-consul/branch/master/graph/badge.svg)](https://codecov.io/gh/rikcarve/mp-config-consul)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ch.carve/mp-config-consul/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/ch.carve/mp-config-consul/)

# mp-config-consul
A eclipse microprofile config extension which uses [Consul](https://www.consul.io/) as source.

> This project has been integrated in https://github.com/microprofile-extensions/config-ext
>
> Currently under discussion to be integrated in [smallrye-config](https://github.com/smallrye/smallrye-config/issues/187)
>
> Nevertheless, this project will be maintained until further notice.

## Versions
0.10 -> Microprofile config 1.4 \
0.11 -> Microprofile config 2.0

## Overview
The eclipse microprofile config framework is a simple yet powerful configuration framework for Jakarta EE. But most implementations only provide the system/env properties or property files as configuration source. Consuls key/value store is a widely used configuration source, so this small library provides an ConfigSource implementation which takes the values from consul. For performance reasons, the config values are cached.

## Add dependency
```xml
        <dependency>
            <groupId>ch.carve</groupId>
            <artifactId>mp-config-consul</artifactId>
            <version>0.15</version>
        </dependency>
```

## Configuration
Currently there are 6 values you can configure, either through Java system properties or environment variables:
* **configsource.consul.host** url of your (local) consul agent instance, e.g. "192.168.99.100", default empty, variable substitution available.
* **configsource.consul.hosts** list of consul servers, e.g. "192.168.99.100,192.168.99.101", default empty, variable substitution available.
* **configsource.consul.port** port of consul, e.g. "8500", default value is "8500", variable substitution available.
* **configsource.consul.validity** how long to cache values (in seconds), default is 30s
* **configsource.consul.prefix** key prefix to search value in consul, variable substitution available
* **configsource.consul.list-all** whether getProperties() should query consul for all kv pairs, default is false
* **configsource.consul.token** token that will be used to retrieve key/values from consul. Default is empty and retrieval is done without token.

> Note: Since mp-config-consul 0.11 (mp-config 2.0) variable substitution is now part of microprofile-config (property expressions)

> Note: these config values cannot be set in Quarkus application.properties, you need to pass them as JVM arguments like this `-Dconfigsource.consul.host=consul.mycompany.com` or through environment variables.

> Note: if both host and hosts are empty, this configsource is disabled!

## Ordinal
Config sources have priorities called ordinal. This config source has ordinal 550, but can be overriden with setting 'config_ordinal' in this source (including prefix if defined)

## Links
* https://microprofile.io/project/eclipse/microprofile-config
* https://github.com/rikcarve/consulkv-maven-plugin
* https://github.com/rikcarve/mp-config-db

mp-config-consul

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README