Chapter 8. Capability trimming in JBoss EAP for OpenShift

Procedure

1. Create a new Maven project by runing the following command:

   mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=pom-root -DgroupId=org.jboss.eap.demo -DartifactId=mariadb-galleon-pack -DinteractiveMode=false

2. Navigate to mariadb-galleon-pack directory and update the pom.xml file to include the Red Hat Maven repository:

   <repositories>
     <repository>
       <id>redhat-ga</id>
       <name>Redhat GA</name>
       <url>https://maven.repository.redhat.com/ga/</url>
     </repository>
   </repositories>

3. Update the pom.xml file to add dependencies on the JBoss EAP Galleon feature-pack and the MariaDB driver:

   <dependencies>
     <dependency>
       <groupId>org.jboss.eap</groupId>
       <artifactId>wildfly-ee-galleon-pack</artifactId>
       <version>8.0.0.GA-redhat-00010</version>
       <type>zip</type>
     </dependency>
     <dependency>
       <groupId>org.mariadb.jdbc</groupId>
       <artifactId>mariadb-java-client</artifactId>
       <version>2.7.2</version>
     </dependency>
   </dependencies>

   Note
   • <version>A.B.C-redhat-XXXXX</version> Where A.B.C is the release number and XXXXX is build number of your JBoss EAP instance. See the Red Hat Maven repository for version details about JBoss EAP releases. The release and build numbers are available for all JBoss EAP releases. https://maven.repository.redhat.com/earlyaccess/all/org/jboss/eap/wildfly-ee-galleon-pack/.

4. Update the pom.xml file to include the Maven plugin that is used to build the Galleon feature-pack:

   <build>
     <plugins>
       <plugin>
         <groupId>org.wildfly.galleon-plugins</groupId>
         <artifactId>wildfly-galleon-maven-plugin</artifactId>
         <version>6.4.8.Final-redhat-00001</version>
         <executions>
           <execution>
             <id>mariadb-galleon-pack-build</id>
             <goals>
               <goal>build-user-feature-pack</goal>
             </goals>
             <phase>compile</phase>
           </execution>
         </executions>
       </plugin>
     </plugins>
   </build>

Procedure

1. Create the directory, src/main/resources, within a custom feature-pack Maven project, for example, see Preparing the Maven project. This directory is the root directory containing the feature-pack content.
2. Create the directory src/main/resources/modules/org/mariadb/jdbc/main.

3. In the main directory, create a file named module.xml with the following content:

   <?xml version="1.0" encoding="UTF-8"?>
   <module name="org.mariadb.jdbc" xmlns="urn:jboss:module:1.8">
     <resources>
       <artifact name="${org.mariadb.jdbc:mariadb-java-client}"/> 1
     </resources>
     <dependencies> 2
       <module name="java.se"/>
       <module name="jakarta.transaction.api"/>
       <module name="jdk.net"/>
     </dependencies>
   </module>

   1

   The MariaDB driver groupId and artifactId. At provisioning time, the actual driver JAR file gets installed. The version of the driver is referenced from the pom.xml file.

   2

   The JBoss Modules modules dependencies for the MariaDB driver.

4. Create the directory src/main/resources/layers/standalone/. This is the root directory of all the layers that the Galleon feature-pack is defining.
5. Create the directory src/main/resources/layers/standalone/mariadb-driver.

6. In the mariadb-driver directory, create the layer-spec.xml file with the following content:

   <?xml version="1.0" ?>
   <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="mariadb-driver">
     <feature spec="subsystem.datasources"> 1
       <feature spec="subsystem.datasources.jdbc-driver">
         <param name="driver-name" value="mariadb"/>
         <param name="jdbc-driver" value="mariadb"/>
         <param name="driver-xa-datasource-class-name" value="org.mariadb.jdbc.MariaDbDataSource"/>
         <param name="driver-module-name" value="org.mariadb.jdbc"/>
       </feature>
     </feature>
     <packages> 2
       <package name="org.mariadb.jdbc"/>
     </packages>
   </layer-spec>

   1

   Update the datasources subsystem configuration with a JDBC driver named MariaDB, implemented by the module org.mariadb.jdbc.

   2

   The JBoss Modules module containing the driver classes that are installed when the layer is provisioned.

   The mariadb-driver layer updates the datasources subsystem with the configuration of a JDBC driver, implemented by the JBoss Modules module.

7. Create the directory src/main/resources/layers/standalone/mariadb-datasource.

8. In the mariadb-datasource directory, create the layer-spec.xml file with the following content:

   <?xml version="1.0" ?>
   <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="mariadb-datasource">
     <dependencies>
       <layer name="mariadb-driver"/> 1
     </dependencies>
     <feature spec="subsystem.datasources.data-source"> 2
       <param name="data-source" value="MariaDBDS"/>
       <param name="jndi-name" value="java:jboss/datasources/${env.MARIADB_DATASOURCE:MariaDBDS}"/>
       <param name="connection-url" value="jdbc:mariadb://${env.MARIADB_HOST:localhost}:${env.MARIADB_PORT:3306}/${env.MARIADB_DATABASE}"/> 3
       <param name="driver-name" value="mariadb"/>
       <param name="user-name" value="${env.MARIADB_USER}"/> 4
       <param name="password" value="${env.MARIADB_PASSWORD}"/>
     </feature>
   </layer-spec>

   1

   This dependency enforces the provisioning of the MariaDB driver when the data source is provisioned. All the layers a layer depends on are automatically provisioned when that layer is provisioned.

   2

   Update the datasources subsystem configuration with a data source named MariaDBDS.

   3

   Datasource’s name, host, port, and database values are resolved from the environment variables MARIADB_DATASOURCE, MARIADB_HOST, MARIADB_PORT, and MARIADB_DATABASE, which are set when the server is started.

   4

   User name and password values are resolved from the environment variables MARIADB_USER and MARIADB_PASSWORD.

9. Build the Galleon feature-pack by running the following command:

   mvn clean install

   The file target/mariadb-galleon-pack-1.0-SNAPSHOT.zip is created.

Procedure

1. Start the MariaDB database by running the following command. This example uses the MariaDB image mariadb-105-rhel7. You must use the latest supported version of MariaDB image. See Red Hat Ecosystem Catalog to get more information about MariaDB images.

   oc new-app -e MYSQL_USER=admin -e MYSQL_PASSWORD=admin -e MYSQL_DATABASE=mariadb registry.redhat.io/rhscl/mariadb-105-rhel7

   The OpenShift service mariadb-101-rhel7 is created and started.

2. Create a secret from the feature-pack archive, generated by the custom feature-pack Maven build, by running the following command within the Maven project directory mariadb-galleon-pack:

   oc create secret generic mariadb-galleon-pack --from-file=target/mariadb-galleon-pack-1.0-SNAPSHOT.zip

   The secret mariadb-galleon-pack is created. When initiating the S2I build, this secret is used to mount the feature-pack .zip file in the pod, making the file available during the server provisioning phase.

Procedure

1. Import the JBoss EAP 8.0 image stream:

   oc import-image jboss-eap-8/eap8-openjdk17-builder-openshift-rhel8:latest --from=registry.redhat.io/jboss-eap-8/eap8-openjdk17-builder-openshift-rhel8:latest
   --confirm