Skip to content

Commit

Permalink
Merge pull request wildfly#17801 from jfdenise/WFLY-19021_community_doc
Browse files Browse the repository at this point in the history
WFLY-19021, community doc. Document usage of Galleon stability properties
  • Loading branch information
bstansberry authored Apr 19, 2024
2 parents 81644ba + ec53d53 commit ec5d179
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/src/main/asciidoc/Bootable_Guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,46 @@ If your project is using link:WildFly_and_WildFly_Preview{outfilesuffix}[WildFly
is ``wildfly-preview@maven(org.jboss.universe:community-universe)``.
====

[[wildfly-jar-maven-plugin-galleon-stability-level]]
=== Setting a stability level when building a Bootable JAR

In order to support xref:Admin_Guide.adoc#Feature_stability_levels[WildFly feature stability levels], Galleon defines
some http://docs.wildfly.org/galleon/#_built_in_and_product_specific_options[options] that can be used at provisioning time
to provision server features at a specific stability level.

The stability levels handling described in the xref:Galleon_Guide.adoc#WildFly_Galleon_stability[Stability levels at provisioning time]
applies when building a WildFly Bootable JAR.

For example, building a WildFly Bootable JAR that includes `preview` features and packages:

[source,xml]
----
<build>
<plugins>
<plugin>
<groupId>org.wildfly.plugins</groupId>
<artifactId>wildfly-jar-maven-plugin</artifactId>
<configuration>
<feature-pack-location>wildfly@maven(org.jboss.universe:community-universe)</feature-pack-location>
<layers>
<layer>jaxrs-server</layer>
</layers>
<plugin-options>
<stability-level>preview</stability-level>
</plugin-options>
</configuration>
<executions>
<execution>
<goals>
<goal>package</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
----

include::_galleon/Galleon_layers.adoc[]

[[wildfly-jar-maven-plugin-additional-configuration]]
Expand Down Expand Up @@ -206,6 +246,9 @@ The following arguments can be used when starting the bootable JAR:
|-secmgr
|Activate and install the `WildFlySecurityManager`.

|--stability[=value]
|Runs the server using a specific stability level. Possible values: [default, community, preview, experimental], Default = community

|-u=<value>
|Set system property jboss.default.multicast.address to the given value.

Expand Down
41 changes: 41 additions & 0 deletions docs/src/main/asciidoc/_galleon/Galleon_provisioning.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,47 @@ A default configuration is identified by _<configuration model>_/_<configuration
The _configuration name_ is the XML configuration file name (e.g.: _standalone.xml_, _domain.xml_, _standalone-ha.xml_).
====

[[WildFly_Galleon_stability]]
== Stability levels at provisioning time

In order to support xref:Admin_Guide.adoc#Feature_stability_levels[WildFly feature stability levels], Galleon defines
some http://docs.wildfly.org/galleon/#_built_in_and_product_specific_options[options] that can be used at provisioning time
to provision server features at a specific stability level.

The `stability-level` option applies to both the features present in the provisioned configuration
and the provisioned packages (mainly JBoss Modules modules). You can specify a different stability level for each of them by using
the `config-stability-level` and the `package-stability-level` options.

If no stability level is provided, the WildFly feature-pack default stability levels for both configurations (`community`)
and packages (`experimental`) apply. When provisioning WildFly with no stability level set,
the `community` and `default` features are provisioned, the `preview` and `experimental` features are ignored.
The `experimental`, `preview`, `community` and `default` packages are provisioned.

[NOTE]
====
Having JBoss Modules modules at a lower stability level present in the installation
allows you to modify a provisioned server configuration to contain extensions and subsystems
or finer grained configuration elements that are at a lower stability level than what was originally provisioned.
====

=== Galleon CLI examples

Installing a WildFly server that contains `preview` features and packages
(any feature and package at a lower stability level are not provisioned):

[source,options="nowrap"]
----
galleon.sh install wildfly:current --dir=my-wildfly-server --stability-level=preview
----

Installing a WildFly server that contains `preview` features and packages
at the WildFly feature-pack packages default stability level (`experimental`)

[source,options="nowrap"]
----
galleon.sh install wildfly:current --dir=my-wildfly-server --config-stability-level=preview
----

[[wildfly_galleon_layers]]
== WildFly Galleon layers

Expand Down

0 comments on commit ec5d179

Please sign in to comment.