CodePipeline Plugin Reference
Requirements
XL Deploy requirements
- XL Deploy: Version 5.0.0+
Infrastructural requirements
- User credentials for accessing AWS CodePipeline service.
Refer to the documentation for AWS CodePipeline for information about configuring and managing pipelines.
For more information about the CodePipeline plugin, refer to Introduction to the XL Deploy Codepipeline plugin.
Limitations
- This plugin is written in Java, so knowledge of Java is required to extend it.
- Plugin currently works when XLD runs without SSL.
- Failed tasks are left as-is and not rolled back. User has to go to XLD GUI and decide what to do.
- Deployments are executed sequentially by a single job worker. Configure multiple job workers if you want more deployment tasks to be run in parallel.
CI Reference
Configuration Item Overview
Other Configuration Items
| CI | Description |
|---|---|
| aws.CodePipelineJobWorker | AWS CodePipeline Job Worker |
Configuration Item Details
aws.CodePipelineJobWorker
| Type Hierarchy | schedule.StepJob >> schedule.CronJob >> schedule.ScheduledJob >> schedule.Job >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ConfigurationItem, schedule.ControlTaskInvokable |
AWS CodePipeline Job Worker
| Public Properties | ||
|---|---|---|
|
|
|
accessSecret
:
STRING
|
|
The access secret to connect with AWS CodePipeline
|
||
|
|
|
accesskey
:
STRING
|
|
The access key to connect with AWS CodePipeline
|
||
|
|
|
codePipelineUrl
:
STRING
= https://codepipeline.us-east-1.amazonaws.com
|
|
The URL on which AWS CodePipeline would be accessible i.e. https://codepipeline.us-east-1.amazonaws.com
|
||
|
|
|
schedule
:
STRING
= 0 */1 * * * *
|
|
The pattern is a list of six single space-separated fields: representing second, minute, hour, day, month, weekday. Month and weekday names can be given as the first three letters of the English names.Example patterns: '0 0 * * * *' = the top of every hour of every day, '0 0 14 * * SAT,SUN' = 14 o'clock on each weekend day, '0 0 9-17 * * MON-FRI' = on the hour nine-to-five weekdays, '0 0 0 1 * *' = every 1st of month at midnight.
|
||
|
|
|
xlDeployServerKey
:
STRING
|
|
A key used to identify an XL Deploy server. Multiple CodePipeline jobs can use the same key so that an XLD server can process jobs with same key.
|
||
|
|
|
enabled
:
BOOLEAN
= true
|
|
Enables or disables triggering of the administration job
|
| Hidden Properties | ||
|---|---|---|
|
|
|
controlTaskParams
:
MAP_STRING_STRING
|
|
Optional map of parameters to pass to the steps
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| executeJob |
no description |