The Deploy Applications Tool uses a model, the archive, and WLST to deploy applications and resources into an existing WebLogic Server domain in either WLST online or offline mode. When deploying applications and resources from a model, the Deploy Applications Tool focuses primarily on the
appDeployments sections of the model. There are exceptions for the
topology sections, where those configuration elements are deemed to be “application-related.” For example, the servers'
ServerStart folder has an
Arguments and a
ClassPath attribute that change the server environment (when started by the Node Manager) that applications may rely on to function properly. Likewise, the
domainInfo section contains a list of JAR files that are to be placed in
<DOMAIN_HOME>/lib which are relevant to applications for a similar reason.
The Deploy Applications Tool will only add or update elements in the specified model. It will not attempt to remove any missing elements that were present in a previous model.
In WLST online mode, the tool tries to minimize the need to redeploy the applications and shared libraries, and the need to restart the server. It does this in a few ways:
The goal is to make the tool both able to support iterative deployment and able to minimize service disruption while doing its work when working against a running domain.
Running the Deploy Applications Tool in WLST offline mode is very similar to running the Create Domain Tool; simply provide the domain location and archive file, and separate model and variable files, if needed. For example:
$ weblogic-deploy\bin\deployApps.cmd -oracle_home c:\wls12213 -domain_home domains\DemoDomain -archive_file DemoDomain.zip -model_file DemoDomain.yaml -variable_file DemoDomain.properties
You can use online mode either on the admin server or from a remote machine. If you are running from the admin server, you can specify domain home directory
If you are running from a remote machine with
-remote option, then you do not need to specify the domain home directory
To run the tool in online mode, add the
-admin_user arguments with the necessary values to connect to the WebLogic Server Administration Server. For example:
$ weblogic-deploy\bin\deployApps.cmd -oracle_home c:\wls12213 -domain_home domains\DemoDomain -archive_file DemoDomain.zip -model_file DemoDomain.yaml -variable_file DemoDomain.properties -admin_url t3://127.0.0.1:7001 -admin_user weblogic
or if running from a remote machine
$ weblogic-deploy\bin\deployApps.cmd -oracle_home c:\wls12213 -remote -archive_file DemoDomain.zip -model_file DemoDomain.yaml -variable_file DemoDomain.properties -admin_url t3://127.0.0.1:7001 -admin_user weblogic
If you are running from a remote machine, then you do not need to specify the domain home directory
-domain_home option, but there are limitations:
wlsdeploy/sharedLibrarieswill result in an error, as the tool cannot remotely create such directory or file. For example, if you specify a
domainBin: [ wlsdeploy/domainBin/setUserOverrides.sh]which references a file entry in the archive file
wlsdeploy/domainBin/setUserOverrides.sh, the tool will fail with an error.
As usual, the tool will prompt for the password (it can also be supplied by piping it to standard input of the tool). To bypass the prompt, you can use one of two options. Store the password in an environment variable, and use the variable name with command-line option
-admin_pass_env. Store the password in a file. Provide the file name with command-line option
When running the tool in WLST online mode, the deploy operation may require server restarts or a domain restart to pick up the changes. The deploy operation can also encounter situations where it cannot complete its operation until the domain is restarted. To communicate these conditions to scripts that may be calling the Deploy Applications Tool, the shell scripts have three special, non-zero exit codes to communicate these states:
103- The entire domain needs to be restarted.
104- The domain changes have been canceled because the changes in the model requires a domain restart and
-output_dir command-line argument is specified, the tool will generate output files that provide information about servers and resources that need to be restarted. These files are only applicable for online deployments.
For more information about these files, see Using output files for the Update Domain Tool.
If the model or variables file contains passwords encrypted with the WDT Encryption tool, decrypt the passwords during create with the
-use_encryption flag on the command line to tell the Deploy Applications Tool that encryption is being used and to prompt for the encryption passphrase. As with the database passwords, the tool can also read the passphrase from standard input (for example,
stdin) to allow the tool to run without any user input. You can bypass the stdin prompt with two other options. Store the passphrase in an environment variable, and use the environment variable name with command-line option
-passphrase_env. Another option is to create a file containing the passphrase value. Pass this filename using the command-line option
The Deploy Applications Tool supports the use of multiple models, as described in Using multiple models.
||An alternative to entering the admin password at a prompt. The value is an environment variable name that WDT will use to retrieve the password.|
||An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password.|
||The admin server URL used for online deploy.|
||The admin user name used for online deploy.|
||The path to the archive file. If the
||Cancel the changes if the update requires a domain restart.|
||Discard all current domain edits before starting the update.|
||(Required). The location of the existing domain home.|
||The type of domain. (for example,
||The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones.|
||Home directory of the Oracle WebLogic installation. Required if the
||If specified, files containing restart information are written to this directory, including
||An alternative to entering the encryption passphrase at a prompt. The value is an environment variable name that WDT will use to retrieve the passphrase.|
||An alternative to entering the encryption passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase.|
||One or more of the passwords in the model or variables file(s) are encrypted and must be decrypted. Java 8 or later is required for this feature.|
||The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones.|
||Skip checks for active edit sessions and pending changes before trying to acquire the WLST online edit lock to modify domain configuration.|
||Deploy main from a remote machine.|