libraryDeploy
Deploy a library (EAR, WAR, or JAR) to Partition, Resource Group, Resource Group Template or WebLogic Cluster/Server. You must have built archive files as part of build workflow execution prior to running deploy.
The following properties are used to specify the location to deploy.
- FDWLS_SERVER_OR_CLUSTER_NAMES or
- FDWLS_PARTITION, FDWLS_RESOURCE_GROUP or
- FDWLS_RESOURCE_GROUP_TEMPLATE.
If all values are specified, they are used in order indicated above.
Prior to WebLogic 12.2.1, only FDWLS_SERVER_OR_CLUSTER_NAMES is used. Read about the deployment options of 12.2.1 at https://blogs.oracle.com/WebLogicServer/entry/domain_partitions_for_multi_tenancy.
Property Replacement on Deploy
Let's say you want to override adf connections.xml file for specific environment instance deployment.
- Create a file called something like connections-overrides.xml and source control it along with your application. This file should be in same folder as connections.xml. In this file you can use properties where you need to replace environment instance or project specific values. Enter properties in the following notation: ${{PROPERTY_NAME}}. See Property Replacement Support.
- Define the required properties on your deploy workflow, and set the scope to either Environment Instance or Project as appropriate.
- Edit your deploy instance and associate your deploy workflow to it, if not already done.
- Your workflow properties will now appear on either the environment instances or projects depending on the scope, and you can provide values for them.
- In your deploy workflow, edit the deploy step and set the FDWLS_INP_OVERRIDE_FILE_PATTERN. The value is in format actual_file=override_file. For example, connection.xml=connections-overrides.xml.
- At deploy time, the WebLogic deploy step will run property replacement against the override file using the properties you have defined, and then replace the original file prior to deploying artifact to WebLogic domain.
This can be done for any other files as well. For example, you can override web.xml, weblogic.xml, weblogic-application.xml file similarly. Alternatively, you can create separate override files for each environment as well and define FDWLS_INP_OVERRIDE_FILE_PATTERN as expression to control which override file is used based on current environment from workflow execution.
Environment/Instance Properties
Property Name | Required | Description |
|---|---|---|
FDWLS_WEBLOGIC_HOME | Yes | WebLogic Home Directory. (e.g. /u01/oracle/products/fmw/wlserver) |
FDWLS_DOMAIN_NAME | Yes | WebLogic Domain Name. |
FDWLS_ADMIN_LISTEN_ADDRESS | Yes | The listener address of the WLS admin server. (e.g. localhost) |
FDWLS_ADMIN_LISTEN_PORT | Yes | The port of the WLS admin server. (e.g. 7001) |
FDWLS_ADMIN_USE_SSL | No | Indicates whether the admin server is using SSL. |
FDWLS_ADMIN_USER | Yes | The user name for the WLS admin server. |
FDWLS_ADMIN_PASSWORD | Yes | The password for FDWLS_ADMIN_USER. |
FDWLS_BASE_INSTALL_DIRECTORY | No | Base directory to install the WebLogic deployments from. Files will be copied here on Admin Server endpoint by WebLogic plugin prior to installation. For example: /oracle/middleware/product/user_projects/applications |
FDWLS_STAGE_MODE | Yes | Staging mode for the application you are deploying. Valid values are stage, nostage, and external_stage. Recommended and default option is stage, in which case deployment archive files are only needed to be accessible by Admin Server and then Admin Server copies files to target managed server. |
Project Properties
Property Name | Required | Description |
|---|---|---|
FDWLS_LIBRARY_NAME | Yes | The name of the library to be deployed. |
FDWLS_SERVER_OR_CLUSTER_NAMES | No | WebLogic Server or Cluster name to deploy the library to. It is assumed that you are using a managed server or cluster of same name in various environments. |
FDWLS_PARTITION | No | WLS Partition - used in WLS 12.2.1+ |
FDWLS_RESOURCE_GROUP | No | WLS Resource Group - used in WLS 12.2.1+ |
FDWLS_RESOURCE_GROUP_TEMPLATE | No | WLS Resource Group Template - used in WLS 12.2.1+ |
FDWLS_USE_VERSIONS | No | Determines whether the plugin will deploy the artifact with a version label. If FDWLS_USE_VERSIONS is true, the FD_PROJECT_VERSION will be used as the version. This allows multiple archives to be deployed at the same time. Plugin will modify the MANIFEST.MF file if necessary. |
FDWLS_DEPLOY_TIMEOUT | No | Time in milliseconds that the plugin operation will wait for the server to respond. Plugin operation will return as soon as the server responds, but if the deploy doesn't complete before the timeout specified, the plugin operation will fail. If not defined, 300000 will be the value. |
Inputs
Input Name | Required | Description |
|---|---|---|
FDWLS_INP_SERVER_OR_CLUSTER_NAMES | No | WebLogic Server or Cluster name for deploy operation. Overrides the FDWLS_SERVER_OR_CLUSTER_NAMES property. |
| FDWLS_INP_OVERRIDE_FILE_PATTERN | No | Specify FileName=OverrideFileName pattern. Matching files will be replaced by override files and Property replacement logic will be executed. For example, web.xml=fd-web.xml. |
Outputs
Output Name | Required | Description |
|---|---|---|
|
|
|
Artifacts
This operation consumes an application EAR, WAR, or JAR file artifact from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the environment instance which have a resource type of WLS Admin Server. Since the admin server only runs on one server, it is expected that for a given domain, there will only be one endpoint with a resource type set to WLS Admin Server.
Endpoint Execution
This operation will execute on the Admin Server endpoint selected using the WLS Admin Server resource type.
Special Considerations
Locking occurs on the endpoint to ensure multiple configuration change are not concurrently being deployed at the same time for a domain. The lock files are located in {Base Working Directory for the endpoint}/locks with a file name of {Environment Code}_{WebLogic Domain Name>}.
- style