XL Satellite Reference 23.3.x

    The XL Deploy satellite module lets you to execute deployments on remote data centers. It includes:

    • An efficient system for transferring files
    • Executing deployment tasks transparently on satellite servers
    • Light process execution on data centers
    • Secure communication between XL Deploy and satellite servers based on Transport Layer Security (TLS)

    This document provides information that is specific to this version of the satellite module. For general information, refer to Getting started with the satellite module.

    CI Reference

    Configuration Item Overview

    Containers

    CIDescription
    xl.Satellite XL satellite configuration item.
    xl.SatelliteGroup XL satellite group configuration item.

    Other Configuration Items

    CIDescription
    xl.Satellite_restartSatellite Generated type for method restartSatellite.
    xl.Satellite_syncPlugins Generated type for method syncPlugins.

    Configuration Item Details

    xl.Satellite

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.Taggable

    XL satellite configuration item.

      Public properties
     
     
    address: STRING
    Address where the satellite can be reached.
     
     
    protocolPort: INTEGER
    Port where the satellite is listening.
     
     
    allowConcurrentDeployments: BOOLEAN = true
    If set, multiple deployments at the same time can be executed, and a 'collision avoidance' check will not be executed
     
     
    deploymentGroup: INTEGER
    If the group-orchestrator is enabled, all containers with the same deployment group number will be deployed to at the same time. The groups are ordered by this number.
     
     
    deploymentSubGroup: INTEGER
    If the sub-group-orchestrator is enabled, all containers with the same deployment SubGroup number will be deployed to at the same time. The groups are ordered by this number.
     
     
    deploymentSubSubGroup: INTEGER
    If the sub-sub-group-orchestrator is enabled, all containers with the same deployment SubSubGroup number will be deployed to at the same time. The groups are ordered by this number.
     
     
    encrypted: BOOLEAN
    Enable encrypted communication.
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
    Control taskParameter CIAttributesDescription
    pingSatellite

    delegate = pingSatellite

    Pings the satellite for its availability. A custom command is sent to the satellite and it responds.

    restartSatellite xl.Satellite_restartSatellite

    delegate = restartSatellite

    Satellite restart method that can be executed when the tasks running on a satellite are not responsive.

    syncPlugins xl.Satellite_syncPlugins

    delegate = syncPlugins

    Copies contents of the ./hotfix/plugins, ./hotfix/satellite-lib, ./plugins, and ./ext directories from XL Deploy to satellites.


    xl.SatelliteGroup

    Type Hierarchy xl.Satellite >> udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.Taggable

    XL satellite group configuration item.

      Public properties
     
     
    allowConcurrentDeployments: BOOLEAN = true
    If set, multiple deployments at the same time can be executed, and a 'collision avoidance' check will not be executed
     
     
    deploymentGroup: INTEGER
    If the group-orchestrator is enabled, all containers with the same deployment group number will be deployed to at the same time. The groups are ordered by this number.
     
     
    deploymentSubGroup: INTEGER
    If the sub-group-orchestrator is enabled, all containers with the same deployment SubGroup number will be deployed to at the same time. The groups are ordered by this number.
     
     
    deploymentSubSubGroup: INTEGER
    If the sub-sub-group-orchestrator is enabled, all containers with the same deployment SubSubGroup number will be deployed to at the same time. The groups are ordered by this number.
     
     
    satellites: SET_OF_CI<xl.Satellite>
    Satellites
     
     
    tags: SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.
      Hidden properties
     
     
    address: STRING = none
    Address where the satellite can be reached.
     
     
    protocolPort: INTEGER
    Port where the satellite is listening.
     
     
    encrypted: BOOLEAN
    Enable encrypted communication.
    Control taskParameter CIAttributesDescription
    pingSatellite

    delegate = pingSatellite

    Pings the satellite for its availability. A custom command is sent to the satellite and it responds.

    restartSatellite xl.Satellite_restartSatellite

    delegate = restartSatellite

    Satellite restart method that can be executed when the tasks running on a satellite are not responsive.

    syncPlugins xl.Satellite_syncPlugins

    delegate = syncPlugins

    Copies contents of the ./hotfix/plugins, ./hotfix/satellite-lib, ./plugins, and ./ext directories from XL Deploy to satellites.


    xl.Satellite_restartSatellite

    Type Hierarchy udm.Parameters >> udm.BaseConfigurationItem

    Generated type for method restartSatellite.

      Public properties
     
     
    delay: INTEGER = 10
    Delay between each attempt, in seconds.
     
     
    maxAttempts: INTEGER = 10
    Number of attempts to reach the satellite after restart.
     
     
    force: BOOLEAN
    Modifies the restart behavior, so that running tasks are forcibly terminated. Should only be used when a satellite appears to be hanging, because it will cause active tasks to fail.

    xl.Satellite_syncPlugins

    Type Hierarchy udm.Parameters >> udm.BaseConfigurationItem

    Generated type for method syncPlugins.

      Public properties
     
     
    delay: INTEGER = 10
    Delay between each attempt, in seconds.
     
     
    maxAttempts: INTEGER = 10
    Number of attempts to reach the satellite after restart.