WildFly CLI Deployment Operations

External

• https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Deploy_with_the_Management_CLI.html

Internal

• WildFly CLI Operations
• WildFly Deployment Concepts

Overview

Deployments and upgrades are performed in CLI with deploy command. Undeployments are triggered by the undeploy command. Both commands come with in-line help:

deploy --help

undeploy --help

The concepts behind deployment operations in standalone and domain mode are explained in

Deployment Concepts

Standalone Mode

TODO

Domain Mode

Listing Artifacts in the Deployment Repository

deploy [-l]

Addition of a New Artifact to Repository and Deployment to Server Nodes

Content can be added to the deployment repository and pushed to server nodes in a single step. For new artifacts, their content is not known to the repository, so the path to the file must be specified in the "deploy" command.

deploy <file-path> <server-group-specification>

When deploying on server nodes, the server group specification is required in domain mode, and it can be either "--all-server-groups" or a comma-separated list of server group names: "--server-groups=group1, group2, ..."

deploy /tmp/servlet-example.war --all-server-groups

The command stores the content in the artifact repository and then immediately pushes content to server nodes, as explained in Domain Deployment Mechanics.

Addition of a New Artifact to Repository

Artifacts can be placed in the repository without being pushed to server nodes, with:

deploy <file-path> --disabled

This operation will upload the content in the repository, but won't push it to any server node. To do that, the content will need to be deployed with a separate command.

Deployment of New Repository Content to Server Nodes

Content that has already been added to the domain repository can be pushed to server nodes by identifying the artifact by name, and specifying the target nodes. If the content was never deployed to the server nodes, no additional deploy command options are needed:

deploy --name=<artifact-name>  <server-group-specification>

deploy --name=servlet-xexample.war --server-groups=group1

Note that the existing artifact was previously deployed on at least one of the nodes specified as target, a deployment error will occur:

[domain@localhost:9999 /] deploy --name=servlet-example.war --all-server-groups
{"JBAS014653: Composite operation failed and was rolled back. Steps that failed:" => {"Operation step-1" => "JBAS014803: Duplicate resource [
    (\"server-group\" => \"group1\"),
    (\"deployment\" => \"servlet-example.war\")
]"}}

Upgrade of an Artifact in Repository and All Server Nodes on which the Old Version was Deployed

A new version of an existing artifact can be added to the deployment repository and pushed to server nodes that are already running the current version of the artifact as part of one atomic operation. The path of the file containing the new version of the artifact must be specified in the "deploy" command.

deploy --force <file-path> 

deploy --force /tmp/servlet-example.war

This operation updates the content in the repository, by placing the content under a different location, as the hash of the artifact is different, and pushes the content to the servers nodes on which the artifact was already deployed.

It is not possible to specify a different target server group as part of an upgrade operations:

[domain@localhost:9999 /] deploy --force /tmp/servlet-example.war --all-server-groups 
--force only replaces the content in the deployment repository and can't be used in combination with any of --disabled, --server-groups or --all-server-groups.

More details on concepts behind a domain deployment are available in Domain Deployment Mechanics.

Undeployment

undeploy example.war --all-relevant-server-groups

---

Deploy Usage

deploy 
    (file_path [--script=script_name] [--name=deployment_name] 
                   [--runtime-name=deployment_runtime_name] 
                   [--force | --disabled] [--unmanaged]
    )
    | 
    --name=deployment_name  
   [--server-groups=group_name (,group_name)* | --all-server-groups] 
   [--headers={operation_header (;operation_header)*}]

deploy deploys the application designated by the file_path or enables an already existing but disabled deployment.

If executed w/o arguments, will list all the existing deployments.

Example:

deploy /tmp/test-servlet.war --name=mp-franklin.war --runtime-name=mp-franklin.war --force
deploy ??? --server-groups=active-hq-nodes

file_path

Absolute or relative. Not required if the deployment already exists in the artifact repository.

--name

The unique name of the deployment. If the file path argument is specified the name argument is optional, the file name is the default value.

--runtime-name

Optional argument. The runtime name for the deployment. This will form the basis for default Java EE application and module names. If not specified the value used for --name will be used.

There are cases when users may wish to have two deployments with the same runtime-name (two versions of application) both available in the management configuration, in which case the deployments would need to have distinct name values but would have the same runtime-name. Within an individual server, only one deployment with a given 'runtime-name' can deployed. However, multiple deployments with the same runtime-name can exist in the configuration, so long as only one is enabled.

--force

If the deployment with the specified name already exists, by default, deploy will be aborted. --force (or -f) will force the replacement.

--disabled

Indicates that the deployment has to be added to the repository disabled.

--unmanaged

If this argument is not specified, the deployment content will be copied (i.e. uploaded) to the server's deployment repository before it is deployed.

If the argument is present, the deployment content will remain at and be deployed directly from its original location specified with the file_path.Exploded deployments are supported only as unmanaged.

--server-groups|--all-server-groups

Comma separated list of server group names the deploy command should apply to. Either --server-groups or --all-server-groups is required in the domain mode. This argument does not apply to standalone mode.

The second deployment attempt will complain if the same artifact is deployed in succession, with two commands, on one server group then on another.

-l

Without arguments deploy will print all of the existing deployments in the repository. The presence of the -l switch will make the existing deployments printed one deployment per line, instead of in columns (the default).

--headers

A list of operation headers separated by a semicolon.

--script

Used only if the file_path points a CLI archive. The value is the name of the script contained in a cli archive to execute. If not specified, defaults to 'deploy.scr'. The deploy command will execute the script given by the --script argument. All paths in the scripts are relative to the root directory in the cli archive. The script is executed as a batch.

Undeploy Usage

    undeploy name [--server-groups=group_name (,group_name)* |
                   --all-relevant-server-groups] [--keep-content]
                  [--headers={operation_header (;operation_header)*}]

Undeploys the deployment with the given name and, depending on the arguments, removes its content from the repository.

If the deployment name isn't specified, prints the list of all the existing deployments.

name

The name of the deployment to undeploy.

--server-groups|--all-relevant-server-groups

Cmma separated list of server group names the undeploy command should apply to. Either --server-groups or --all-relevant-server-groups is required in the domain mode.

--keep-content

By default undeploy, besides disabling the deployment, also removes its content from the repository. The presence of --keep-content will only disable the deployment without removing its content from the repository.

-l

Same as deploy -l.

--headers

Same as deploy --headers.

--path

Same as deploy --path.

--script

Can appear only if the file_path points a cli archive. The value is the name of the script contained in a cli archive to execute. If not specified, defaults to 'undeploy.scr'. All paths in the scripts are relative to the root directory in the cli archive. The script is executed as a batch.

List Current Deployments

See deploy -l. Also, for a standalone instance, current deployments can be listed visiting the /deployment node:

[standalone@localhost:9999 deployment] cd /deployment
[standalone@localhost:9999 deployment] ls