Configure satellite communication
This topic covers how to configure communication between Deploy satellites and the Deploy master to ensure secure and effective operations.
Enable communication with satellites
In Deploy, communication with satellites is disabled by default. To enable it:
- Locate the
satellite
section in thedeploy-satellite.yaml
file. - Set
enabled
toyes
:
deploy.satellite: enabled: true
1. Restart Deploy. The server will be enabled to connect to satellites.
## Configure hostname and port
The default settings in the `deploy-server.yaml ` file are:
hostname: "" bind-hostname: "0.0.0.0" port: 8180
Set `hostname` to an IP address or a host name where Deploy can connect. 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 Deploy if the initial connection breaks. If you do not provide a value, 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 Deploy connects to. The port must also be accessible from the satellites. The default port is set to `8180`.
**Note:** You cannot connect multiple Deploy server instances to the same satellite. In Deploy, you can assign the same satellite to multiple hosts from the same Deploy instance.
## Configure the ping timeout
To configure the ping timeout while reaching a satellite, change the `satellite.timeout.ping` property in the `deploy-satellite.yaml` file:
```js
satellite {
timeout {
ping = "<timeout>"
}
}
hostname: ""
bind-hostname: "0.0.0.0"
port: 8180
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 deploy-satellite.yaml
file:
deploy.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 Deploy attempts to connect to satellites for file transfer. To configure this value, change the satellite.timeout.streaming
property in the deploy-satellite.yaml
file:
deploy.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 deploy-satellite.yaml
file:
deploy.satellite:
streaming:
max-uploads: 5
Configure secure communication
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 Deploy and satellites.