Skip to content

Commit

Permalink
Fix for Issue #74, Document the WildFly stability support
Browse files Browse the repository at this point in the history
  • Loading branch information
jfdenise committed May 22, 2024
1 parent ebbd17a commit 26e6e0d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
6 changes: 3 additions & 3 deletions cli/src/main/resources/UsageMessages.properties
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ build-env-file = The path to a file that contains environment variables (in the
channels= Path to a yaml file containing one or more channels.
cli-script = The path to a CLI script file that only contains CLI commands in order to fine tune the server on OpenShift deployment. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
cloud = When deploying your application to the cloud. It will fine tune the WildFly server for the cloud. N.B.: Building a Bootable JAR is not supported for the cloud.
config-stability-level = Specify a stability to be used when provisioning the server configuration. The stability is also used to identify server features that would be not enabled by the specified stability. The stability is by default the minimum stability of each Galleon feature-packs. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
config-stability-level = Specify a stability to be used when provisioning the server configuration. WildFly Glow can identify server features that would be not provisioned if no stability level were specified. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
deployments = List of path to war|jar|ear files to scan.
disable-deployers = A comma separated list of deployer names to disable. To retrieve all the deployer names call the @|fg(yellow) show-configuration|@ operation. To disable them all, use @|fg(yellow) ALL|@ value. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
docker-image-name = Name of the docker image when --provision=DOCKER is specified. By default an image name is computed based on the WildFly server version.
Expand All @@ -27,11 +27,11 @@ ha = High Availability profile. Set this option when deploying an application in
init-script = The path to a script that contains commands (JBoss CLI, add-user, ...) to fine tune the server on OpenShift deployment. Can only be used with @|fg(yellow) OPENSHIFT|@ kind of provisioning.
input-feature-packs-file = Galleon feature-packs used by wildfly-glow are retrieved from an online registry. To override the set of feature-packs you can specify a path to a Galleon provisioning XML file containing the set of Galleon feature-packs to be used by wildfly-glow.
output-dir = If specifying to provision, the directory where the result will be output.
package-stability-level = Specify a stability to be used when provisioning server packages. The stability is also used to identify server packages that would be not provisioned by the specified stability. The stability is by default the minimum stability of each Galleon feature-packs. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
package-stability-level = Specify a stability to be used when provisioning server packages. WildFly Glow can identify server packages that would be not provisioned if no stability level were specified. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
properties = A space separated list of Java system properties. When multiple system properties are set, the list must be enclosed in double quotes. For example: "-Dfoo=bar -DmyProp"
provision = The kind of provisioning to produce based on what has been discovered. Can be @|fg(yellow) SERVER|@: a provisioned WildFly server, @|fg(yellow) BOOTABLE_JAR|@: a WildFly Bootable JAR, @|fg(yellow) DOCKER_IMAGE|@: a Docker image, @|fg(yellow) OPENSHIFT|@: a server built and deploy on OpenShift, you must be logged to a cluster, or @|fg(yellow) PROVISIONING_XML|@: a Galleon provisioning.xml file.
server-version = The WildFly server version to deploy the deployment to. By default the latest WildFly version is used.
stability-level = Specify a stability to be used when provisioning a server. This is an option to set both config-stability-level and package-stability-level options with a single option. The stability is also used to identify server features and packages that would be not enabled by the specified stability. The stability is by default the minimum stability of each Galleon feature-packs. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
stability-level = Specify a stability to be used when provisioning a server. This is an option to set both config-stability-level and package-stability-level options with a single option. The stability can be @|fg(yellow) default|@, @|fg(yellow) community|@, @|fg(yellow) preview|@, @|fg(yellow) experimental|@.
suggest = WildFly Glow will suggest additional add-ons and environment variables that are usable with your deployment.
usage.commandListHeading = %nCommands:%n
usage.optionListHeading = %nOptions:%n
Expand Down
17 changes: 17 additions & 0 deletions docs/guide/intro/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,20 @@ Feature-packs and Layers.
* A Maven plugin to scan Arquillian deployments in your tests and produce a `provisioning.xml` file that can be consumed by WildFly provisioning tooling.
### Support for WildFly Stability

WildFly Glow CLI has a support
for link:http://docs.wildfly.org/32/Admin_Guide.html#Feature_stability_levels[WildFly Stability].

WildFly Glow can detect and report that some of the discovered Galleon layers contain
content that are only available at a given stability and advise you to enable this stability level
(by using the `--config-stability-level=<stability level>` option.

When provisioning a server, if a stability level has been specified, WildFly Glow will display how
a WildFly server must be started to enable the stability level. For example: `standalone.sh --stability=preview`

When provisioning for OpenShift, if a stability level has been specified, WildFly Glow will configure the generated OpenShift Deployment
to start the server with the required stability level.

To list the options related to the WildFly stability feature, call `wildfly-glow scan --help` and look for `--*stability-level` options.

0 comments on commit 26e6e0d

Please sign in to comment.