adpatch
Executes the adpatch command line interface to perform 12.1.3 EBS patches.
As all workflow operations, if this fails, the server will remain in its current state, which may mean that some services will not be running.
A webhook may be advisable to notify a team if it fails if automating adpatching.
Target Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
EBS Source Script |
| Yes | Source Script with full path. If you are adding more than one endpoint for an Target, this file must be same location for all endpoints. If necessary you should create symbolic links on each endpoint, so location of environment file is same. |
EBS Database Password |
| Yes | Password to connect for EBS Database User. |
EBS System Password |
| Yes | SYSTEM Password for running adpatch. |
EBS Database SID |
| Yes | Database SID for the EBS install. |
Inputs
Input Name | Input Code | Required | Description |
---|---|---|---|
Patch Top |
| Yes | Patch top to be used when applying a patch via adpatch. This should be the parent folder of the driver file. e.g. Use groovy and set to “/path/to/patches/” + PATCH_NUMBER Make a workflow input or get the PATCH_NUMBER from an artifact (echo > file in build, cat file in deploy) |
Driver Name |
| Yes | The driver to execute as part of the patch. This must only be the driver file, specifying a relative path to the driver will not work. e.g. Use groovy and set to “u” + PATCH_NUMBER + “.drv” |
Number of Workers |
| Yes | The number of workers to use when applying the patch. The default is 8 but it should be configured based on the number of servers in your cluster. |
Abandon Session |
| No | If the previous session failed or was interrupted should this execution resume where the previously halted session stopped? |
Test Mode |
| No | Setting this to true will only output the steps that would be applied if applying the patch outside of Test Mode. You can run this first to verify the patch steps. |
Hot Patch |
| No | Setting this to true will result in a hot patch being applied. When hot patching, the EBS server will not be put in maintenance mode. If unchecked, the server will enter maintenance mode (adsetmmd.sql ENABLE) before and exit it after applying the patch. |
EBS Patch Notification |
| No | Should a notification email be sent on failure? |
EBS Patch Notification Email |
| No | Email to use in the case of FDEBS_INP_PATCH_NOTIFICATION being true. |
Defaults Override |
| No | This plugin makes use of a defaults file to provide silent input to the adpatch command. If you wish to use your own defaults file to apply the patch you can specify that here. |
Artifacts
This operation doesn’t consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Target which have resource type of EBS Web Server
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Running in Test Mode
Before applying a patch, it is recommended to run with TestMode enabled. This behavior will test the patch application without not putting the server in maintenance mode.
Our Defaults File
This operation makes use of a defaults file to pass parameters to the adpatch command. This file is only here for reference if you wish to specify the path to your own defaults file via the FDEBS_INP_ADPATCH_DEFAULTS_FILE input. All defaults files will have FlexDeploy property replacement performed on them.
Defaults File
## Start of Defaults Record
%%START_OF_TOKEN%%
MATCH_APPL_TOP
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
Yes
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
LOG_FNAME
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
adpatch.log
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
DEF_ACTIVATE_EMAIL
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
${{FDEBS_INP_PATCH_NOTIFICATION}}
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
DEF_EMAIL_LIST
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
${{FDEBS_INP_PATCH_NOTIFICATION_EMAIL}}
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
DEF_BATCH_SIZE
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
1000
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
CORRECT_DBENV
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
Yes
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
DEF_SYSTEM_PWD
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
${{FDEBS_SYSTEM_PASSWORD}}
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
ORACLE_username_Application_Object_Library
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
APPLSYS
%%END_OF_VALUE%%
## End of Defaults Record
## Start of Defaults Record
%%START_OF_TOKEN%%
ORACLE_password_Application_Object_Library
%%END_OF_TOKEN%%
%%START_OF_VALUE%%
${{FDEBS_DB_PASSWORD}}
%%END_OF_VALUE%%
## End of Defaults Record
- style