WildFly gRPC

Feature pack to bring gRPC support to WildFly. gRPC services are registered against a gRPC server listening, by default, to port 9555.

Only gRPC services are supported at the moment. Support for gRPC clients is coming soon.

Note: Starting with version 0.1.17, the group ID has changed from org.wildfly.extras.grpc to org.wildfly.grpc.

Get Started

To build the feature pack, simply run

mvn install

This will build everything, and run the testsuite. The build includes the ssl-gen module that generates self-signed SSL certificates used by the integration tests and examples for TLS testing.

Once built you can provision a server with gRPC support using Galleon provisioning. An example using the org.wildfly.plugins:wildfly-maven-plugin:

<plugin>
    <groupId>org.wildfly.plugins</groupId>
    <artifactId>wildfly-maven-plugin</artifactId>
    <configuration>
        <feature-packs>
            <feature-pack>
                <groupId>org.wildfly</groupId>
                <artifactId>wildfly-galleon-pack</artifactId>
                <version>${version.wildfly}</version>
            </feature-pack>
            <feature-pack>
                <groupId>org.wildfly.grpc</groupId>
                <artifactId>wildfly-grpc-feature-pack</artifactId>
                <version>${version.wildfly.grpc}</version>
            </feature-pack>
        </feature-packs>
        <layers>
            <layer>core-server</layer>
            <layer>web-server</layer>
            <layer>grpc</layer>
        </layers>
        <galleon-options>
            <jboss-fork-embedded>${galleon.fork.embedded}</jboss-fork-embedded>
        </galleon-options>
        <provisioning-dir>wildfly</provisioning-dir>
        <log-provisioning-time>${galleon.log.time}</log-provisioning-time>
        <offline>true</offline>
    </configuration>
</plugin>

You can also configure this with the Galleon CLI tool:

galleon.sh install org.wildfly:wildfly-galleon-pack:$WILDFLY_VERSION --dir=wildfly-grpc
galleon.sh install org.wildfly.grpc:wildfly-grpc-feature-pack:$GRPC_VERSION --dir=wildfly-grpc

Examples

Each example consists of three modules:

1. Proto: Contains the proto definitions
2. Service: Contains the gRPC service
3. Client: Contains a client to call the deployed gRPC service

Before running the examples, please make sure that all necessary dependencies are available in your local maven repository:

mvn install

Hello World

The helloworld example is a slightly modified version of the helloworld example from gRPC Java examples.

See examples/helloworld/README.md for instructions on building and running the service and client.

Chat

The chat example demonstrates bidirectional streaming gRPC. The client is a terminal UI (TUI) application built with TamboUI.

See examples/chat/README.md for instructions on building and running the service and client.

Feature Pack Documentation

This feature pack uses the WildFly Galleon Plugins to publish its feature pack documentation. The documentation is available using the following links:

• https://wildfly-extras.github.io/wildfly-grpc-feature-pack/ - Contains the latest documentation
• https​://wildfly-extras.github.io/wildfly-grpc-feature-pack/<sem-version> - Contains the documentation for a specific version

Licenses

This project uses the following licenses:

• Apache License 2.0