Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gaol committed Sep 12, 2024
1 parent 4016c5e commit 0547957
Showing 1 changed file with 10 additions and 45 deletions.
55 changes: 10 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,20 @@

[![CI Tests](https://github.com/gaol/wildfly-vertx-extension/actions/workflows/ci.yml/badge.svg)](https://github.com/gaol/wildfly-vertx-extension/actions/workflows/ci.yml)

[![Doc Site Generator](https://github.com/gaol/wildfly-vertx-extension/actions/workflows/docs-ci.yml/badge.svg)](https://github.com/gaol/wildfly-vertx-extension/actions/workflows/docs-ci.yml)

This is the Vertx extension for [WildFly Application Server](https://www.wildfly.org/).

[Eclipse Vert.x](https://vertx.io/) is a toolkit to build reactive applications on the JVM, integrating it adds more reactive power to WildFly.

It allows you to define Vertx instances using WildFly management model, and they can be accessed using JNDI lookup or CDI injection in your enterprise or web applications.

You can access Vertx core APIs and some component APIs in your applications.

You can package the verticle classes with the application, the extension will deploy the verticles to the associated Vertx instances managed by the WildFly server if there is a `META-INF/vertx.json` or `WEB-INF/vertx.json` file in the application archive.

In case of clustering vertx instance, this extension uses [vertx-infinispan](https://github.com/vert-x3/vertx-infinispan/) as the cluster manager to be able to talk with remote Vertx instances. You can specify the necessary JGroups settings for Vertx using standard WildFly configuration.

## Roadmap

Please see https://github.com/gaol/wildfly-vertx-extension/wiki/Roadmap for the Roadmap

## To Build the extension

It requires:
* Java 11+
* Maven 3.2.5+

to build the extension.

Run the following command to build:

> mvn clean install
After that, there will be 2 servers and 1 Galleon feature pack produced in the separated subdirectories:

* `build/target/wildfly-vertx-build-${version}/`
* `dist/target/wildfly-vertx-dist-${version}/`
* `galleon-feature-pack/wildfly-feature-pack/target/wildfly-vertx-feature-pack-${version}.zip`

## Start the server

The generated servers can be started the same way as how WildFly server is started:
> $SERVER_HOME/bin/standalone.sh

## Installation to existing server
WildFly subsystem and Galleon feature pack for integrating the [Eclipse Vertx.](https://vertx.io/) into a WildFly installation.

The produced Galleon feature pack can be installed to an existing WildFly server using Galleon CLI.
It allows you to define Vertx instance using WildFly management model, and they can be accessed using CDI injection in your enterprise or web applications.

> NOTE: To have `galleon.sh` work, please check the [Galleon Provisioning Guide](https://docs.wildfly.org/21/Galleon_Guide.html#download-and-installation-of-the-galleon-command-line-tool) on how to download and install the Gallon CLI tool.
## Project Structure
This project provides the following modules:

## Documentation
* **subsystem** -- A WildFly `Extension` implementation that provides an `vertx` subsystem for integrating Eclipse Vert.x into a WildFly deployment. This module's artifact can be used with the feature pack produced from this repository, or it can be incorporated in other feature packs (e.g. WildFly's `wildfly-preview` feature pack).
* **galleon-feature-pack/galleon-content** -- Provides source material for inclusion in a Galleon feature pack. This includes the definition of an `vertx` Galleon layer. This module's content can be used with the feature pack produced from this repository.
* **galleon-feature-pack/galleon-local** -- Provides source material for inclusion in a Galleon feature pack. This module's content is only meant to be used with the feature pack produced from this repository.
* **galleon-feature-pack/wildfly-feature-pack** -- Produces a feature pack that can be used to integrate Eclipse Vert.x into standard WildFly.
* **testsuite/shared/** -- Some shared test utils can be used in the test cases.
* **testsuite/integration/basic/** -- Some testcases to test manipulate Eclipse VertxOptions against a WildFly installation that includes the subsystem.

For more information about this extension, please visit the documentation: https://gaol.github.io/wildfly-vertx-extension/

0 comments on commit 0547957

Please sign in to comment.