Configure satellite communication

Enable communication with satellites

In XL Deploy, communication with satellites is disabled by default. To enable it:

  1. Locate the satellite section in the xl-deploy.conf file.
  2. Set enabled to yes:

    satellite {
    	enabled = yes
    	}
  3. Restart XL Deploy. The server will be enabled to connect to satellites.

Configure hostname and port

The default settings in the xl-deploy.conf file are:

satellite {
     hostname = ""
		 bind-hostname = "0.0.0.0"
     port = 8180
  }

Set hostname to an IP address or a host name where XL Deploy can connect. XL Deploy send this value to the satellites. The hostname must be visible from the network(s) where the satellites are located.

Satellites use this value to re-establish connection with XL Deploy if the initial connection breaks. If you do not provide a value, XL Deploy assign a value from a network interface that is available, or to a loopback address if no interfaces are available.

Set bind-hostname to an IP address or a host name to listen on. The default setting listens on all network interfaces.

Set port to the port that XL Deploy connects to. The port must also be accessible from the satellites. The default port is set to 8180.

Note: You cannot connect multiple XL Deploy server instances to the same satellite. In XL Deploy, you can assign the same satellite to multiple hosts from the same XL Deploy instance.

Configure the ping timeout

To configure the ping timeout while reaching a satellite, change the satellite.timeout.ping property in the xl-deploy.conf file:

satellite {
   timeout {
     ping = "<timeout>"
   }
 }

You can specify the ping timeout in milliseconds, seconds, or minutes. For example: 100 ms or 10 seconds.

Configure the upload idle timeout

The upload idle timeout occurs when a satellite has accepted an incoming streaming connection but does not need to accept the uploaded file. This prevents unused TCP connections from remaining open. To configure the upload idle timeout, change the satellite.timeout.upload.idle property in the xl-deploy.conf file:

satellite {
  timeout {
    upload.idle = "<timeout>"
  }
}

You can specify the ping timeout in milliseconds, seconds, or minutes. For example, 100 ms or 10 seconds.

Configure the file streaming timeout

This timeout occurs when XL Deploy attempts to connect to satellites for file transfer. To configure this value, change the satellite.timeout.streaming property in the xl-deploy.conf file:

satellite {
  timeout {
    streaming = "<timeout>"
  }
}

The default timeout is 10 seconds.

Configure the maximum upload threads per task

To configure the maximum threads per upload task, change the satellite.streaming.max-uploads property in the xl-deploy.conf file:

satellite {
    streaming {
        max-uploads = 5
    }
}

Configure secure communication

XL Deploy communicates with satellite servers over a secure communication channel using TLS/SSL technology to encrypt data. For more information about configuring SSL, see Configure secure communication between XL Deploy and satellites.