Deployer

This schema defines how a deployment configuration is set up.

Deployer deployments

https://gros.liacs.nl/schema/deployer/deployment.json

deployments

deployments

type

array

items

deployment

deployment

type

object

properties

  • name

Name of the deployment.

type

string

  • git_path

Path to clone the Git repository to.

type

string

  • git_url

Location of the origin Git repository.

type

string

  • git_branch

Branch of the Git repository to check out.

type

string

default

master

  • jenkins_job

Job on the Jenkins server to check for stability, staleness and artifacts.

type

string

  • jenkins_git

Whether to check staleness of Jenkins build compared to Git repository.

type

boolean

default

True

  • jenkins_states

Results of builds on Jenkins to consider acceptable.

type

array

default

SUCCESS

items

type

string

pattern

^[A-Z]+$

  • artifacts

Whether to include artifacts from Jenkins job to the deployment.

type

boolean

  • deploy_key

Whether to keep an earlier generated deploy SSH key for authenticating connections to the Git repository.

type

boolean

  • script

Shell command to perform upon installing the deployment.

type

string

  • services

Service names in systemctl to restart upon installing the deployment.

type

array

items

type

string

  • bigboat_url

URL of the BigBoat instance to use when updating the compose files of the deployment.

type

string

default

format

uri

  • bigboat_key

API key of the BigBoat instance to use when updating the compose files of the deployment.

type

string

  • bigboat_compose

Path in the Git repository to the compose files to update on the BigBoat instance.

type

string

  • secret_files

Files to add to the repository when updating the deployment.

type

object

patternProperties

  • .+

type

string