Skip to main content
Version: Deploy 22.3

How satellites affect the deployment plan

This topic covers how satellite servers affect a deployment plan.

In Deploy, each block at the root level of a deployment plan is called a phase. If your deployment plan does not require any satellite servers, it will probably have one phase. If Deploy requires at least one satellite server to complete the deployment, the plan will contain additional phases to prepare and clean up the satellite servers.

Satellite preparation​

Satellite preparation occurs at the beginning of the deployment plan. It contains steps that will:

  1. Verify that the required satellites are running.
  2. Verify that all plugins are synchronized between Deploy and the required satellites.
  3. Transfer the required files (artifacts), once per satellite.

Satellite setup is completed in parallel.

Deployment plan with satellite setup phase expanded

Deployment phase​

Just before deployment, Deploy will verify the connection with the satellites. In the deployment plan, you can see the blocks of steps that are executed from a satellite.

In the following example, the deployment to the env environment will be executed with satellite satellite.xebialabs.uk. After Deploy checks the connection, it will deploy the test.war file from satellite.xebialabs.uk to localhost.

Deployment plan with steps executed on satellite

Satellite cleanup phase​

The final phase of the deployment ensures that temporary files are removed from working directories on the satellite servers.

Deployment plan with satellite cleanup phase

Deploy will always try to execute the cleanup phase when you cancel a task, this is because the clean up of temporary files is not related to a successful or failed deployment.