Skip to content

Installation Guide

Lin Gao edited this page Nov 13, 2024 · 2 revisions

To provision a WildFly instance with the vertx feature pack, you need Galleon. Download a distribution from https://github.com/wildfly/galleon/releases and add its bin directory to your path. It contains the galleon.sh (and galleon.bat) script, which is what you need to run Galleon.

Provision a WildFly instance with a provision.xml file

You can feed Galleon with a descriptor, provision.xml, which includes all the necessary information to provision a WildFly instance with the vertx layer installed. It can look like this:

<?xml version="1.0" ?>
<installation xmlns="urn:jboss:galleon:provisioning:3.0">
    <feature-pack location="wildfly@maven(org.jboss.universe:community-universe):current#34.0.0.Final">
        <default-configs inherit="false"/>
    </feature-pack>
    <feature-pack location="org.wildfly.extras.vertx:wildfly-vertx-feature-pack:1.0.0.Final">
        <default-configs inherit="false"/>
    </feature-pack>
    <config model="standalone" name="standalone.xml">
        <layers>
            <!-- The base server -->
            <include name="cloud-server"/>
            <include name="management"/>
            <include name="vertx"/>
        </layers>
    </config>
</installation>

The requested versions of WildFly and vertx feature pack are contained in the file, see the comments inline.To run the provisioning, execute:

galleon.sh provision provision.xml --dir=wildfly

After finished successfully, there will be a wildfly server including the vertx layer installed in the wildfly directory.

At the time this guide is written, the vertx feature pack is in preview stability level, so you can start the server using the following command:

wildfly/bin/standalone.sh --stability=preview

Install using Galleon commands

You can also provision a base WildFly instance first, and then install the vertx layer on top of it. Provision WildFly:

Provision a vanilla WildFly server
galleon.sh install wildfly:current --dir=wildfly              # install the latest version
galleon.sh install wildfly:current#34.0.0.Final --dir=wildfly # install a specific version

After finished successfully, there will be a vanilla WildFly server in the wildfly directory.

Then you can install the vertx layer on top of the local WildFly server:

Install vertx layer to WildFly server
galleon.sh install org.wildfly.extras.vertx:wildfly-vertx-feature-pack:1.0.0.Final --layers=vertx --dir=wildfly

after it completes, the vertx subsystem and the required bits are downloaded and installed to the existing server.

At the time this guide is written, the vertx feature pack is in preview stability level, so you can start the server using the following command:

wildfly/bin/standalone.sh --stability=preview