The deploy operation is used to deploy webMethods applications into target environment. webMethods Deployer supports 2 different deployment scenarios;
In a runtime-based deployment scenario, webMethods Deployer deploys assets into target webMethods runtimes from Source webMethods runtimes to which webMethods Deployer component is connected. Currently Plugin does not support this scenario due to version based builds management enforcement.
In a repository-based deployment scenario, webMethods Deployer deploys assets built from sources in a SCM and stored on a repository. FlexDeploy Plugin automated this scenario using webMethods ABE and Deployer components.
Deploy is also implemented with 2 options as shown in the below diagram.
The assets to target server or cluster. Targets can be a standalone Integration Server (or) a group of Integration Servers in a cluster.
This deploy operation performs the following internal activities, If ABE build found;deployment activities.
- Generate the Project Automator XML file based on the given configured environment properties and & the build version selected in FlexDeploy projectfor deployment.
- Execute webMethods Project Automator command line script to facilitate automatic Deployer project creation in webMethods Deployer.
- Execute webMethods Deployer command line script to automate the deployment for each project.
In the case of build generated by Zip Utility as part of Build operation;
- Deploy operation will UnZip the package .zip file into target Integration Server application directory <Integration server home>/packages .The changes will be activated upon the target server restart.
- Simultaneously, plugin keeps the copy of package zip file into target Integration Server dedicated directory <Integration server home>/packages/replicate/inbound so that webMethods Administrator can login into webMethods Admin UI page and click 'install from Inbound releases' button to activate the package without server restart.
The selected version of Build(webMethods package ZIP file) will be retrieved from internal artifacts repository and will be deployed into target environment. Deploy operation should be used in deploy workflows.
...
- deploy assets.
Deploy operation should be used in deploy workflows. Make sure to set the endpoint resource type to WM Deployer Server.
| Tip | ||
|---|---|---|
| ||
As a best practice, use webMethods Deployer based deployment which has efficient features such as simulation, handling clusters, detailed reports & logs, inter-dependency check etc. |
Blog Posts
- https://flexagon.com/2018/03/cicd-with-webmethods-using-flexdeploy/
- https://flexagon.com/2018/05/manage-webmethods-integrationservers-using-flexdeploy/
Environment/Instance Properties
Property Name | Property Code | Required | Description |
|---|
WmDeployer Installation Home | FDWM_DEPLOYER_HOME | Yes | Installation directory of webMethods Server hosting WmDeployer(e.g./opt/SoftwareAG) Use to connect and invoke Deployer script for deploy operation. It will likely contain the IntegrationServer folder. |
WmDeployer Hostname | FDWM_DEPLOYER_HOST | Yes |
Used to connect and navigate into webMethods Deployer server.
webMethods Deployer IS Hostname (e.g. dev-sag.company.local) | ||
WmDeployer IS InstanceName | FDWM_DEPLOYER_INSTANCE | Yes |
Used to connect Deployer IS instance and navigate into their file system.
Usually the IS Instance Name appear in <IntegrationServer Home>/instances/<INSTANCENAME>
webMethods Deployer IS InstanceName, available in the default dir 'IntegrationServer/instances/deployerInstance' (e.g.deployerInstance) | ||
WmDeployer Port | FDWM_DEPLOYER_PORT | Yes |
The primary port in which IntegrationServer instance hosting WmDeployer is running, e.g. 5555(by default). Used to connect Deployer server through HTTP. |
WmDeployer IS Username | FDWM_DEPLOYER_USER | Yes | Credentials used to connect the WmDeployer server over HTTP |
WmDeployer IS Password | FDWM_DEPLOYER_PASSWORD | Yes | Credentials used to connect the WmDeployer server over HTTP |
WM Target Home Dir
FDWM_TARGET_HOME
Yes
Used to deploy the asset into Target env by navigating into this path.
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
FDWM_TARGET_ALIAS |
No
WM Deployer use this IsAliase name to create remote HTTP connection with Target server.
WM Target Server Host
FDWM_TARGET_HOST
Yes
Used to connect Target Server over HTTP for deployment.
WM Target Server Port
FDWM_TARGET_PORT
Yes
Primary Port on which IS is running on. Used to connect Target server over HTTP for deployment
WM Target InstanceName
FDWM_TARGET_INSTANCE
Yes
Used to connect Deployer IS instance and navigate into their file system for deploying the packages.Usually the IS Instance Name appear in <IntegrationServer Home>/instances/<INSTANCENAME>
WM Target Server Username
FDWM_TARGET_USER
Yes
Credentials used to connect Target server over HTTP
WM Target Server Password
FDWM_TARGET_PASSWORD
Yes
Credentials used to connect Target server over HTTP
WM Target uses SSL conn?
FDWM_TARGET_USE_SSL
No
Check if Target Server uses SSL config to establish remote connections from the wm deployer.
Project Properties
Property Name
Required
_OR_GROUPS | Yes | Server Alias or Target Groups as defined in WmDeployer. If configuring more than one value use comma separator. You can override the value for each environment if name is different based on environment. You must configure Server Alias or Target Groups in WmDeployer to indicate the target for deployment of artifacts. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
...
This operation consumes artifacts from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the environment
...
instance which have a resource type of WM Deployer Server.
Endpoint
...
Execution
This operation will execute on
...
the
...
webMethods Server endpoint selected using the WM Deployer Server resource type and the given inputs/properties.
Special Considerations
This operation will select all available endpoints associated to the environment instance which have resource type of {WM Deployer Server}.