Using JBoss EAP XP 5.0

Procedure

1. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory.

2. Install JBoss EAP XP by running the following command from the jboss-eap-installation-manager directory :

   ./bin/jboss-eap-installation-manager.sh install --profile eap-xp-5.0 --dir eap-xp-5

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory.

2. Run this script from the jboss-eap-installation-manager directory to subscribe the server to the JBoss EAP XP channel by executing:

   ./bin/jboss-eap-installation-manager.sh channel add \
    --channel-name eap-xp-5.0 \
    --repositories=mrrc-ga::https://maven.repository.redhat.com/ga \
    --manifest org.jboss.eap.channels:eap-xp-5.0 \
    --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap

3. Install JBoss EAP XP extension by executing:

   ./bin/jboss-eap-installation-manager.sh feature-pack add \
    --fpl org.jboss.eap.xp:wildfly-galleon-pack \
    --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory.
2. Run this script from the jboss-eap-installation-manager directory to subscribe the server to the JBoss EAP XP channel by executing:

1. Install JBoss EAP XP and use the --repositories parameter to specify the offline repositories:

Procedure

1. Extract the jboss-eap-installation-manager you have downloaded.
2. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory you have extracted.

3. Run this script from the jboss-eap-installation-manager directory to check for available updates:

   ./bin/jboss-eap-installation-manager.sh update list --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap

4. Update JBoss EAP by running the following command:

   Syntax

   ./bin/jboss-eap-installation-manager.sh update perform --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap

   Example

   ./bin/jboss-eap-installation-manager.sh update perform --dir eap-xp-5.0
   Updates found:
     org.wildfly.galleon-plugins:wildfly-galleon-plugins    6.3.1.Final-redhat-00001 ==>  6.3.2.Final-redhat-00001
     org.wildfly.wildfly-http-client:wildfly-http-transaction-client    2.0.1.Final-redhat-00001 ==>  2.0.2.Final-redhat-00001

   Copy to Clipboard Toggle word wrap

Procedure

1. Stop the JBoss EAP server.
2. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory.

3. Run this script from the jboss-eap-installation-manager directory to update the server components:

   ./bin/jboss-eap-installation-manager.sh update perform \
    --dir eap-xp-5.0  \
    --repositories <JBOSS_EAP_XP_OFFLINE_REPO_PATH>,<FEATURE_PACK_OFFLINE_REPO>,<JBOSS_EAP_8.0_OFFLINE_REPO_PATH>

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the terminal emulator and navigate to the jboss-eap-installation-manager directory.

2. Run this script from the jboss-eap-installation-manager directory to investigate the history of all feature packs added to your JBoss EAP XP server:

   ./bin/jboss-eap-installation-manager.sh history --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap
3. Stop the JBoss EAP XP server.

4. Revert your to a version before JBoss EAP XP extension has been added:

   ./bin/jboss-eap-installation-manager.sh revert perform \
    --revision <REVISION_HASH> \
    --dir eap-xp-5.0

   Copy to Clipboard Toggle word wrap

Procedure

1. Set up a Maven project by using the mvn command. The command creates the directory structure for the project and the pom.xml configuration file.

   $ mvn archetype:generate                       \
   -DgroupId=<group_id>                           \

   1

   
   -DartifactId=<artifact_id>                     \

   2

   
   -DarchetypeGroupId=org.apache.maven.archetypes \

   3

   
   -DarchetypeArtifactId=maven-archetype-webapp   \

   4

   
   -DinteractiveMode=false                         

   5

   Copy to Clipboard Toggle word wrap

   1

   groupID uniquely identifies the project.

   2

   artifactID is the name for the generated jar archive.

   3

   archetypeGroupID is the unique ID for maven-archetype-webapp.

   4

   archetypeArtifactId is the artifact ID for maven-archetype-webapp.

   5

   InteractiveMode instructs Maven to use the supplied parameters rather than starting in interactive mode.

2. Navigate to the generated directory.
3. Open the generated pom.xml configuration file in a text editor.

4. Remove the content inside the <project> section of the pom.xml configuration file after the <name>helloworld Maven Webapp</name> line.

   Ensure that the file looks like this:

   <?xml version="1.0" encoding="UTF-8"?>
   
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
   
       <groupId>${group_id}</groupId>
       <artifactId>${artifact_id}</artifactId>
       <version>1.0-SNAPSHOT</version>
       <packaging>war</packaging>
       <name>${artifact_id} Maven Webapp</name>
   
   </project>

   Copy to Clipboard Toggle word wrap

   The content was removed because it is not required for the application.

Procedure

1. Define the artifacts repository.

   <project>
       ...
       <repositories>
           <repository>                                                                

   1

   
               <id>jboss-public-maven-repository</id>
               <name>JBoss Public Maven Repository</name>
               <url>https://repository.jboss.org/nexus/content/groups/public/</url>
               <releases>
                   <enabled>true</enabled>
                   <updatePolicy>never</updatePolicy>
               </releases>
               <snapshots>
                   <enabled>true</enabled>
                   <updatePolicy>never</updatePolicy>
               </snapshots>
               <layout>default</layout>
           </repository>
           <repository>                                                                

   2

   
               <id>redhat-ga-maven-repository</id>
               <name>Red Hat GA Maven Repository</name>
               <url>https://maven.repository.redhat.com/ga/</url>
               <releases>
                   <enabled>true</enabled>
                   <updatePolicy>never</updatePolicy>
               </releases>
               <snapshots>
                   <enabled>true</enabled>
                   <updatePolicy>never</updatePolicy>
               </snapshots>
               <layout>default</layout>
           </repository>
       </repositories>
   </project>

   Copy to Clipboard Toggle word wrap

   1

   The Red Hat GA Maven repository provides all the productized JBoss EAP and other Red Hat artifacts.

   2

   The JBoss Public Maven Repository provides artifacts such as WildFly Maven plug-ins

2. Define the plug-ins repository.

   <project>
       ...
       <pluginRepositories>
           <pluginRepository>
               <id>jboss-public-maven-repository</id>
               <name>JBoss Public Maven Repository</name>
               <url>https://repository.jboss.org/nexus/content/groups/public/</url>
               <releases>
                  <enabled>true</enabled>
               </releases>
               <snapshots>
                   <enabled>true</enabled>
               </snapshots>
           </pluginRepository>
           <pluginRepository>
               <id>redhat-ga-maven-repository</id>
               <name>Red Hat GA Maven Repository</name>
               <url>https://maven.repository.redhat.com/ga/</url>
               <releases>
                   <enabled>true</enabled>
               </releases>
               <snapshots>
                   <enabled>true</enabled>
               </snapshots>
           </pluginRepository>
       </pluginRepositories>
   </project>

   Copy to Clipboard Toggle word wrap

Procedure

1. Add a property for the BOM version in the properties section of the pom.xml configuration file.

   <properties>
       ...
       <version.bom.microprofile>5.0.0.GA-redhat-00009</version.bom.microprofile>
   </properties>

   Copy to Clipboard Toggle word wrap

   The value defined in the property <version.bom.microprofile> is used as the value for the BOM version.

2. Import the JBoss EAP BOMs dependency management.

   <project>
       ...
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>org.jboss.bom</groupId>                   

   1

   
                   <artifactId>jboss-eap-xp-microprofile</artifactId> 

   2

   
                   <version>${version.bom.microprofile}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
   </project>

   Copy to Clipboard Toggle word wrap

   1

   groupID of the JBoss EAP-provided BOM.

   2

   artifactID of the JBoss EAP-provided BOM that provides supported JBoss EAP MicroProfile APIs.

Procedure

1. Add a property for the BOM version in the properties section of the pom.xml configuration file.

   <properties>
       ....
       <version.bom.ee>8.0.0.GA-redhat-00009</version.bom.ee>
   </properties>

   Copy to Clipboard Toggle word wrap

2. Import the JBoss EAP BOMs dependency management.

   <project>
       ...
       <dependencyManagement>
           <dependencies>
               <dependency>
                   <groupId>org.jboss.bom</groupId>                 

   1

   
                   <artifactId>jboss-eap-ee-with-tools</artifactId> 

   2

   
                   <version>${version.bom.ee}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
           </dependencies>
       </dependencyManagement>
   </project>

   Copy to Clipboard Toggle word wrap

   1

   groupID of the JBoss EAP-provided BOM.

   2

   artifactID of the JBoss EAP-provided BOM that provides supported JBoss EAP Java EE APIs plus additional JBoss EAP API JARs and client BOMs, and development tools such as Arquillian.

Procedure

1. Define the versions for wildfly-maven-plugin and maven-war-plugin, in the <properties> section.

   <properties>
       ...
       <version.plugin.wildfly>4.2.1.Final</version.plugin.wildfly>
       <version.plugin.war>3.3.2</version.plugin.war>
   </properties>

   Copy to Clipboard Toggle word wrap

2. Add <pluginManagement> in <build> section inside the <project> section.

   <project>
       ...
       <build>
           <pluginManagement>
               <plugins>
                   <plugin>    

   1

   
                       <groupId>org.wildfly.plugins</groupId>
                       <artifactId>wildfly-maven-plugin</artifactId>
                       <version>${version.plugin.wildfly}</version>
                   </plugin>
                   <plugin>                                  

   2

   
                       <groupId>org.apache.maven.plugins</groupId>
                       <artifactId>maven-war-plugin</artifactId>
                       <version>${version.plugin.war}</version>
                   </plugin>
               </plugins>
           </pluginManagement>
       </build>
   </project>

   Copy to Clipboard Toggle word wrap

   1

   You can use the wildfly-maven-plugin to deploy an application to JBoss EAP using the wildfly:deploy command.

   2

   You need to manage the war plugin version to ensure compatibility with JDK17+.

Procedure

1. Open your terminal.

2. Connect to the server by running the following command:

   ./jboss-cli.sh --connect

   Copy to Clipboard Toggle word wrap

3. Check if the Micrometer extension is already added to the configuration by running the following command:

   [standalone@localhost:9990 /] /extension=org.wildfly.extension.micrometer:read-resource

   Copy to Clipboard Toggle word wrap

4. If the Micrometer extension is not available, add it by running the following command:

   [standalone@localhost:9990 /] /extension=org.wildfly.extension.micrometer:add

   Copy to Clipboard Toggle word wrap

5. Add the Micrometer subsystem with the required configuration. For example, specify the endpoint URL of the metrics collector by running the following command:

   [standalone@localhost:9990 /] /subsystem=micrometer:add(endpoint="http://localhost:4318/v1/metrics")

   Copy to Clipboard Toggle word wrap

6. Reload the server to apply the changes:

   [standalone@localhost:9990 /] reload

   Copy to Clipboard Toggle word wrap

Procedure

1. Open a terminal.

2. Start JBoss EAP as a standalone server by using the following script:

   $ <EAP_HOME>/bin/standalone.sh -c standalone-microprofile.xml

   Copy to Clipboard Toggle word wrap
   Note

   For Windows server, use the <EAP_HOME>\bin\standalone.bat script.

3. Open a new terminal.
4. Navigate to the application root directory.

5. Run the following command to configure the server:

   $ <EAP_HOME>/bin/jboss-cli.sh --connect --file=configure-micrometer.cli

   Copy to Clipboard Toggle word wrap
   Note

   For Windows server, use the <EAP_HOME>\bin\jboss-cli.bat script.

   Replace <EAP_HOME> with the path to your server.

   Expected output:

   The batch executed successfully
   process-state: reload-required

   Copy to Clipboard Toggle word wrap

6. Reload the server with the following management command:

   $ <EAP_HOME>/bin/jboss-cli.sh --connect --commands=reload

   Copy to Clipboard Toggle word wrap

7. Create a configuration file named docker-compose.yaml with the following content:

   version: "3"
   
   services:
     otel-collector:
       image: otel/opentelemetry-collector
       command: [--config=/etc/otel-collector-config.yaml]
       volumes:
         - ./otel-collector-config.yaml:/etc/otel-collector-config.yaml:Z
       ports:
         - 1888:1888 # pprof extension
         - 8888:8888 # Prometheus metrics exposed by the collector
         - 8889:8889 # Prometheus exporter metrics
         - 13133:13133 # health_check extension
         - 4317:4317 # OTLP gRPC receiver
         - 4318:4318 # OTLP http receiver
         - 55679:55679 # zpages extension
         - 1234:1234 # /metrics endpoint

   Copy to Clipboard Toggle word wrap

8. Create a configuration file named otel-collector-config.yaml with the following content:

   extensions:
     health_check:
     pprof:
       endpoint: 0.0.0.0:1777
     zpages:
       endpoint: 0.0.0.0:55679
   
   receivers:
     otlp:
       protocols:
         grpc:
         http:
   
   processors:
     batch:
   
   exporters:
     prometheus:
       endpoint: "0.0.0.0:1234"
   
   service:
     pipelines:
       metrics:
         receivers: [otlp]
         processors: [batch]
         exporters: [prometheus]
   
     extensions: [health_check, pprof, zpages]

   Copy to Clipboard Toggle word wrap

9. Start the collector server instance by running the following command:

   $ docker-compose up

   Copy to Clipboard Toggle word wrap
   Note

   You can also use Podman instead of Docker. If you choose Podman, then use the $ podman-compose up command instead of $ docker-compose up. If Docker or Podman is not supported in your environment, then see Otel Collector documentation for guidance on installing and running the OpenTelemetry Collector.

10. In the RootResource class, see how the MeterRegistry is injected into your class to ensure proper setup before registering the meters.

    @Path("/")
    @ApplicationScoped
    public class RootResource {
        // ...
        @Inject
        private MeterRegistry registry;
    
        private Counter performCheckCounter;
        private Counter originalCounter;
        private Counter duplicatedCounter;
    
        @PostConstruct
        private void createMeters() {
            Gauge.builder("prime.highestSoFar", () -> highestPrimeNumberSoFar)
                    .description("Highest prime number so far.")
                    .register(registry);
            performCheckCounter = Counter
                    .builder("prime.performedChecks")
                    .description("How many prime checks have been performed.")
                    .register(registry);
            originalCounter = Counter
                    .builder("prime.duplicatedCounter")
                    .tags(List.of(Tag.of("type", "original")))
                    .register(registry);
            duplicatedCounter = Counter
                    .builder("prime.duplicatedCounter")
                    .tags(List.of(Tag.of("type", "copy")))
                    .register(registry);
        }
        // ...
    }

    Copy to Clipboard Toggle word wrap

11. Inspect the checkIfPrime() method body to see how to use the registered meters within your application logic. For example:

    @GET
    @Path("/prime/{number}")
    public String checkIfPrime(@PathParam("number") long number) throws Exception {
        performCheckCounter.increment();
    
        Timer timer = registry.timer("prime.timer");
    
        return timer.recordCallable(() -> {
    
            if (number < 1) {
                return "Only natural numbers can be prime numbers.";
            }
    
            if (number == 1) {
                return "1 is not prime.";
            }
    
            if (number == 2) {
                return "2 is prime.";
            }
    
            if (number % 2 == 0) {
                return number + " is not prime, it is divisible by 2.";
            }
    
            for (int i = 3; i < Math.floor(Math.sqrt(number)) + 1; i = i + 2) {
                try {
                    Thread.sleep(10);
                } catch (InterruptedException e) {
                    //
                }
                if (number % i == 0) {
                    return number + " is not prime, is divisible by " + i + ".";
                }
            }
    
            if (number > highestPrimeNumberSoFar) {
                highestPrimeNumberSoFar = number;
            }
    
            return number + " is prime.";
        });
    }

    Copy to Clipboard Toggle word wrap

12. Navigate to the application root directory.

    Syntax

    $ cd <path_to_application_root>/<application_root>

    Copy to Clipboard Toggle word wrap

    Example, in reference to the Micrometer Quickstart:

    $ cd ~/quickstarts/micrometer

    Copy to Clipboard Toggle word wrap

13. Compile and deploy the application with the following command:

    $ mvn clean package wildfly:deploy

    Copy to Clipboard Toggle word wrap

Verification

1. Access the application by using a web browser or you can run the following command.

   $ curl http://localhost:8080/micrometer/prime/13

   Copy to Clipboard Toggle word wrap

   Expected output:

   13 is prime.

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to your OpenShift instance using the oc login command.

2. Create a new project in OpenShift.

   A project allows a group of users to organize and manage content separately from other groups. You can create a project in OpenShift using the following command.

   $ oc new-project PROJECT_NAME

   Copy to Clipboard Toggle word wrap

   For example, for the microprofile-config quickstart, create a new project named eap-demo using the following command.

   $ oc new-project eap-demo

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a file named helm.yaml using the following YAML content:

   build:
     uri: https://github.com/jboss-developer/jboss-eap-quickstarts.git
     ref: XP_5.0.0.GA
     contextDir: microprofile-config
     mode: s2i
   deploy:
     replicas: 1

   Copy to Clipboard Toggle word wrap

2. Use the following command to deploy your JBoss EAP XP application on Openshift.

   $ helm install microprofile-config -f helm.yaml jboss-eap/eap-xp5

   Copy to Clipboard Toggle word wrap

Procedure

1. Get the service name of your application using the following command.

   $ oc get service

   Copy to Clipboard Toggle word wrap

2. Optional: Expose the main service as a route so you can access your application from outside of OpenShift. For example, for the microprofile-config quickstart, use the following command to expose the required service and port.

   $ oc expose service/microprofile-config --port=8080

   Copy to Clipboard Toggle word wrap

3. Get the URL of the route.

   $ oc get route

   Copy to Clipboard Toggle word wrap

4. Access the application in your web browser using the URL. The URL is the value of the HOST/PORT field from previous command’s output.

   Note

   For JBoss EAP XP 5.0.0 GA distribution, the Microprofile Config quickstart does not reply to HTTPS GET requests to the application’s root context. This enhancement is only available in the {JBossXPShortName101} GA distribution.

   For example, to interact with the Microprofile Config application, the URL might be http://HOST_PORT_Value/config/value in your browser.

   If your application does not use the JBoss EAP root context, append the context of the application to the URL. For example, for the microprofile-config quickstart, the URL might be http://HOST_PORT_VALUE/microprofile-config/.

5. Optionally, you can scale up the application instance by running the following command. This command increases the number of replicas to 3.

   $ oc scale deploymentconfig DEPLOYMENTCONFIG_NAME --replicas=3

   Copy to Clipboard Toggle word wrap

   For example, for the microprofile-config quickstart, use the following command to scale up the application.

   $ oc scale deployment/microprofile-config --replicas=3

   Copy to Clipboard Toggle word wrap

Procedure

1. Set up the new server on the New Server dialog box.

   1. In the Select server type list, select Red Hat JBoss Enterprise Application Platform 8.0.
   2. In the Server’s host name field, enter localhost.
   3. In the Server name field, enter JBoss EAP 8.0 XP.
   4. Click Next.

2. Configure the new server.

   1. In the Home directory field, if you do not want to use the default setting, specify a new directory; for example: home/myname/dev/microprofile/runtimes/jboss-eap-7.4.
   2. Make sure the Execution Environment is set to JavaSE-1.8.
   3. Optional: Change the values in the Server base directory and Configuration file fields.
   4. Click Finish.

Procedure

1. Import the pom.xml file from the Quickstart Parent Artifact.

2. If you are using a quickstart that requires environment variables, configure those variables on the launch configuration on the server Overview dialog box.

   For example, the opentelemetry-tracing quickstart uses the following environment variable:

   • OTEL_COLLECTOR_HOST

Procedure

1. Identify the supported JBoss EAP Galleon layers that provide the capabilities that you need to run your application.

2. Reference a JBoss EAP feature pack location in the <plugin> element of the Maven project pom.xml file. The following example displays the inclusion of a single feature-pack, which includes the jaxrs-server base layer and the jpa-distributed layer . The jaxrs-server base layer provides additional support for the server.

   <plugins>
   	<plugin>
   		<groupId>org.wildfly.plugins</groupId>
   		<artifactId>wildfly-jar-maven-plugin</artifactId>
   		<version>${bootable.jar.maven.plugin.version}</version>
   		<configuration>
   			<channels>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-8.0</artifactId>
   					</manifest>
   				</channel>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-xp-5.0</artifactId>
   					</manifest>
   				</channel>
   			</channels>
   			<feature-pack-location>org.jboss.eap.xp:wildfly-galleon-pack</feature-pack-location>
   			<layers>
   				<layer>jaxrs-server</layer>
   				<layer>jpa-distributed</layer>
   			</layers>
   			<excluded-layers>
   				<layer>jpa</layer>
   			</excluded-layers>
                    ...
   		</configuration>
   	</plugin>
   </plugins>

   Copy to Clipboard Toggle word wrap

   This example also shows the exclusion of the jpa layer from the project.

   Note

   If you include the jpa-distributed layer in your project, you must exclude the jpa layer from the jaxrs-server layer. The jpa layer configures a local infinispan hibernate cache, while the jpa-distributed layer configures a remote infinispan hibernate cache.

Procedure

1. Add the following content to the <build> element of the pom.xml file. For example:

   <plugins>
   	<plugin>
   		<groupId>org.wildfly.plugins</groupId>
   		<artifactId>wildfly-jar-maven-plugin</artifactId>
   		<version>${bootable.jar.maven.plugin.version}</version>
   		<configuration>
   			<channels>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-8.0</artifactId>
   					</manifest>
   				</channel>
   				<channel>
   					<manifest>
   						<groupId>org.jboss.eap.channels</groupId>
   						<artifactId>eap-xp-5.0</artifactId>
   					</manifest>
   				</channel>
   			</channels>
   			<feature-pack-location>org.jboss.eap.xp:wildfly-galleon-pack</feature-pack-location>
   			<layers>
   				<layer>jaxrs-server</layer>
   				<layer>microprofile-platform</layer>
   			</layers>
   		</configuration>
   		<executions>
   			<execution>
   				<goals>
   					<goal>package</goal>
   				</goals>
   			</execution>
   		</executions>
   	</plugin>
   </plugins>

   Copy to Clipboard Toggle word wrap
   Note

   If you do not specify Galleon layers in your pom.xml file then the bootable JAR server contains a configuration that is identical to a standalone-microprofile.xml configuration.

2. Package the application as a bootable JAR:

   $ mvn package

   Copy to Clipboard Toggle word wrap

3. Start the application:

   $ NAME="foo" java -jar target/microprofile-config-bootable.jar

   Copy to Clipboard Toggle word wrap
   Note

   The example uses NAME as the environment variable, but you can choose to use jim, which is the default value.

   Note

   To view a list of supported bootable JAR arguments, append --help to the end of the java -jar target/microprofile-config-bootable.jar command.

4. Specify the following URL in your web browser to access the MicroProfile Config application:

   http://localhost:8080/config/json

   Copy to Clipboard Toggle word wrap

5. Verification: Test the application behaves properly by issuing the following command in your terminal:

   curl http://localhost:8080/config/json

   Copy to Clipboard Toggle word wrap

   The following is the expected output:

   {"result":"Hello foo"}

   Copy to Clipboard Toggle word wrap

Procedure

1. To build a hollow bootable JAR, you must set the <hollow-jar> plug-in configuration element to true in the project pom.xml file. For example:

1. Build the hollow bootable JAR:

   $ mvn clean package

   Copy to Clipboard Toggle word wrap

2. Run the hollow bootable JAR:

   $ java -jar target/microprofile-config-bootable.jar --deployment=target/microprofile-config.war

   Copy to Clipboard Toggle word wrap
   Important

   To specify the path to the WAR file that you want to deploy on the server, use the following argument, where <PATH_NAME> is the path to your deployment.

   --deployment=<PATH_NAME>

   Copy to Clipboard Toggle word wrap

3. Access the application:

   $ curl http://localhost:8080/microprofile-config/config/json

   Copy to Clipboard Toggle word wrap
   Note

   To register your web application in the root directory, name the application ROOT.war.

Procedure

1. Create a directory named scripts at the root directory of your project. For example:

   $ mkdir scripts

   Copy to Clipboard Toggle word wrap

2. Create a cli.properties file and save the file in the /scripts directory. Define the config.path and the config.ordinal system properties in this file. For example:

   config.path=/etc/config
   config.ordinal=200

   Copy to Clipboard Toggle word wrap

3. Create a CLI script, such as mp-config.cli, and save it in an accessible directory in the bootable JAR, such as the /scripts directory. The following example shows the contents of the mp-config.cli script:

   # config map
   
   /subsystem=microprofile-config-smallrye/config-source=os-map:add(dir={path=${config.path}}, ordinal=${config.ordinal})

   Copy to Clipboard Toggle word wrap

   The mp-config.cli CLI script creates a new ConfigSource, to which ordinal and path values are retrieved from a properties file.

4. Save the script in the /scripts directory, which is located at the root directory of the project.

5. Add the following configuration extract to the existing plug-in <configuration> element:

   <cli-sessions>
       <cli-session>
           <properties-file>
               scripts/cli.properties
           </properties-file>
           <script-files>
               <script>scripts/mp-config.cli</script>
           </script-files>
       </cli-session>
   </cli-sessions>

   Copy to Clipboard Toggle word wrap

6. Package the application:

   $ mvn package

   Copy to Clipboard Toggle word wrap
7. Log in to your OpenShift instance using the oc login command.

8. Optional: If you have not previously created a target/openshift subdirectory, you must create the suddirectory by issuing the following command:

   $ mkdir target/openshift

   Copy to Clipboard Toggle word wrap

9. Copy the packaged application into the created subdirectory.

   $ cp target/microprofile-config-bootable.jar target/openshift

   Copy to Clipboard Toggle word wrap

10. Use the target/openshift subdirectory as the binary input to build the application:

    $ oc start-build microprofile-config-app --from-dir target/openshift

    Copy to Clipboard Toggle word wrap
    Note

    OpenShift applies a set of CLI script commands to the bootable JAR configuration file to enable it for the cloud environment. You can access this script by opening the bootable-jar-build-artifacts/generated-cli-script.txt file in the Maven project /target directory.

11. Create a ConfigMap. For example:

    $ oc create configmap microprofile-config-map --from-literal=name="Name comes from Openshift ConfigMap"

    Copy to Clipboard Toggle word wrap

12. Mount the ConfigMap into the application with the dc. For example:

    $ oc set volume deployments/microprofile-config-app --add --name=config-volume \
    --mount-path=/etc/config \
    --type=configmap \
    --configmap-name=microprofile-config-map

    Copy to Clipboard Toggle word wrap

    After executing the oc set volume command, the application is re-deployed with the new configuration settings.

13. Test the output:

    $ curl http://$(oc get route microprofile-config-app --template='{{ .spec.host }}')/config/json

    Copy to Clipboard Toggle word wrap

    The following is the expected output:

    {"result":"Hello Name comes from Openshift ConfigMap"}

    Copy to Clipboard Toggle word wrap