Skip to main content
Version: Deploy 22.1

Create a Custom Step on a Satellite

When you want to create a custom deployment step, you can use Java to implement the Step interface. For more information, see Javadoc API documentation.

To create a custom step that is runnable by a satellite, you can implement the com.xebialabs.xlplatform.satellite.SatelliteAware interface.

To use com.xebialabs.xlplatform.satellite.SatelliteAware to extend Step by one additional method:

/**
 * @return the satellite where this step can be executed
 */
Satellite getSatellite();

You can retrieve a reference to a satellite from a host configuration item (CI) instance through its getSatellite() method. If you return null from this method, the step will execute on the Deploy server instead of a satellite.