Deployer¶
This schema defines how a deployment configuration is set up.
Deployer deployments¶
deployments¶
type |
array |
items |
deployment¶
type |
object |
||
properties |
|||
|
Name of the deployment. |
||
type |
string |
||
|
Path to clone the Git repository to. |
||
type |
string |
||
|
Location of the origin Git repository. |
||
type |
string |
||
|
Branch of the Git repository to check out. |
||
type |
string |
||
default |
master |
||
|
Job on the Jenkins server to check for stability, staleness and artifacts. |
||
type |
string |
||
|
Whether to check staleness of Jenkins build compared to Git repository. |
||
type |
boolean |
||
default |
True |
||
|
Results of builds on Jenkins to consider acceptable. |
||
type |
array |
||
default |
SUCCESS |
||
items |
type |
string |
|
pattern |
^[A-Z]+$ |
||
|
Whether to include artifacts from Jenkins job to the deployment. |
||
type |
boolean |
||
|
Whether to keep an earlier generated deploy SSH key for authenticating connections to the Git repository. |
||
type |
boolean |
||
|
Shell command to perform upon installing the deployment. |
||
type |
string |
||
|
Service names in systemctl to restart upon installing the deployment. |
||
type |
array |
||
items |
type |
string |
|
|
URL of the BigBoat instance to use when updating the compose files of the deployment. |
||
type |
string |
||
default |
|||
format |
uri |
||
|
API key of the BigBoat instance to use when updating the compose files of the deployment. |
||
type |
string |
||
|
Path in the Git repository to the compose files to update on the BigBoat instance. |
||
type |
string |
||
|
Files to add to the repository when updating the deployment. |
||
type |
object |
||
patternProperties |
|||
|
type |
string |