Skip to content

jgroups-extras/jgroups-azure

JGroups Azure

CI

Implementation of Azure ping protocol using Azure Storage blobs for JGroups project using official Microsoft Azure Java SDK.

See the design document for architecture and implementation details.

Configuration

Properties

Attribute Name
Environment variable
Default Description

container
Environment variable: JGROUPS_AZURE_CONTAINER

required

Container to store ping information in. Must be a valid DNS name as it becomes part of the Azure blob storage URL.

storage_account_name
Environment variable: JGROUPS_AZURE_STORAGE_ACCOUNT_NAME

required (unless connection_string is set)

The name of the storage account.

storage_access_key
Environment variable: JGROUPS_AZURE_STORAGE_ACCESS_KEY

The secret account access key. If not specified, DefaultAzureCredential is used instead.

use_https
Environment variable: JGROUPS_AZURE_USE_HTTPS

true

Whether or not to use HTTPS to connect to Azure.

endpoint_suffix
Environment variable: JGROUPS_AZURE_ENDPOINT_SUFFIX

core.windows.net

The endpointSuffix to use.

blob_storage_uri
Environment variable: JGROUPS_AZURE_BLOB_STORAGE_URI

The full blob service endpoint URI. When set, overrides use_https and endpoint_suffix.

connection_string
Environment variable: JGROUPS_AZURE_CONNECTION_STRING

Azure Storage connection string. When set, overrides storage_account_name, storage_access_key, use_https, endpoint_suffix, and blob_storage_uri.

WildFly 10.1 or later / JBoss EAP 7.0 or later

Using a preconfigured profile

Since WildFly 10.1 the required modules are bundled with the distribution. Users can directly use server profile located at wildfly-<version>/docs/examples/configs/standalone-azure-ha.xml or replace the discovery protocol in their existing server profiles with the following configuration (no need to specify module name):

<protocol type="azure.AZURE_PING">
     <property name="storage_account_name">
         ${jboss.jgroups.azure_ping.storage_account_name}
     </property>
     <property name="storage_access_key">
         ${jboss.jgroups.azure_ping.storage_access_key}
     </property>
     <property name="container">
         ${jboss.jgroups.azure_ping.container}
     </property>
</protocol>

Upgrading an existing profile via CLI

To upgrade an existing profile to use TCP stack by default and AZURE_PING protocol via CLI, start ./bin/jboss-cli.sh (or corresponding script on Windows) and run the following batch followed by a reload:

batch
/subsystem=jgroups/channel=ee:write-attribute(name=stack, value=tcp)
/subsystem=jgroups/stack=tcp/protocol=MPING:remove
/subsystem=jgroups/stack=tcp/protocol=azure.AZURE_PING:add(add-index=0, properties=[storage_account_name=${jboss.jgroups.azure_ping.storage_account_name:}, storage_access_key=${jboss.jgroups.azure_ping.storage_access_key:}, container=${jboss.jgroups.azure_ping.container:}])
run-batch
reload

Directly in JGroups

You can bring in all dependencies via Maven:

<dependency>
    <groupId>org.jgroups.azure</groupId>
    <artifactId>jgroups-azure</artifactId>
    <version>${version.org.jgroups.azure}</version>
</dependency>

Then add or replace an existing discovery protocol in the stack:

<azure.AZURE_PING
	storage_account_name="${jboss.jgroups.azure_ping.storage_account_name}"
	storage_access_key="${jboss.jgroups.azure_ping.storage_access_key}"
	container="${jboss.jgroups.azure_ping.container:ping}"
/>

Building

Use Maven to build:

mvn clean install

Or use Maven wrapper for convenience:

./mvnw clean install

Testing

To run all tests, credentials for Azure are expected. These can be supplied either using individual properties for tests:

export account_name=foo
export access_key=bar
mvn test -Dazure.account_name="${account_name}" -Dazure.access_key="${access_key}" -Djava.net.preferIPv4Stack=true

or a connection string can be used:

mvn test -Dazure.connection_string="DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...;EndpointSuffix=core.windows.net"

If valid credentials are not provided, tests that require them are skipped (using org.junit.Assume).

There are also variants of the tests that run against a mock Blob service running in a container. To run those tests, a valid podman/Docker environment is required.

Support Matrix

Version (branch) JGroups version Azure Storage version Java version

3.x

5.5.x

12.x

17

2.x

5.1.x - 5.4.x

8.6.6

11

1.3.x

4.2.x

8.6.6

8

1.2.x

4.0.x

6.1.0

8

1.1.x

3.6.13.Final

5.0.0

8

1.0.x

3.6.7.Final

4.0.0

7

0.9.x

3.2.16.Final

5.0.0

6

License

Copyright 2026 Red Hat Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

Implementation of AZURE_PING discovery protocol using Azure storage blobs leveraging the official Azure SDK

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages