This project contains a config source for the MicroProfile Config API. It allows for dependency injection of values from Azure Key Vault into MicroProfile-based microservices.
The authentication mechanism with Azure Key Vault is by using Managed Service Identity (MSI). For more details on configuring MSI refer : Azure KeyVault with MSI
Firstly, add the dependency on this library to your project. Below are examples of how to do this in Maven and Gradle:
Maven:
<dependency>
<groupId>com.abnamro.coesd.azure</groupId>
<artifactId>microprofile-config-keyvault</artifactId>
<version>1.1.1</version>
</dependency>Gradle:
compile group: 'com.abnamro.coesd.azure', name: 'microprofile-config-keyvault', version: '1.1.1'After adding the dependency to your MicroProfile-based application, create a microprofile-config.properties file inside src/main/resources/META-INF. Inside this file, the following properties must be set based on the Azure Key Vault configuration you have created
# is the key vault name specified in step two, e.g. 'microprofile-kv'
azure.keyvault.url=https://cicd-kv.vault.azure.net
azure.keyvault.enabled=true
# NOTE that, by default azure.keyvault.enabled is always true, if for local you want to disable it, make it falseSave this file, and then we can move on to your REST endpoints.
import org.eclipse.microprofile.config.inject.ConfigProperty;
import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import static javax.ws.rs.core.MediaType.TEXT_HTML;
@ApplicationScoped
@Path("/")
public class ConfigDemo {
@Inject
org.eclipse.microprofile.config.Config config;
@Inject
@ConfigProperty(name = "demo-key", defaultValue = "Unknown")
String demoKeyValue;
@GET
@Path("config")
@Produces(TEXT_HTML)
public String info() {
return "Welcome to the server! I know that the value for the key 'demo-key' is: '" + demoKeyValue
+ "'<br/><br/>"
+ "By the way, I can also look it up in a non-DI fashion: '" + config.getValue("demo-key", String.class) + "'";
}
}This library has been tested with OpenLiberty v20.0.0.11 with the following feature added to enable microprofile
<feature>microProfile-3.3</feature>