This page covers the process by which gateways become aware of new versions, and self-apply those updates. On this page, “gateways” refers to both gateways and relays.
Notification
When gateways start, they start a regular job asking for any update. We use a combination of Organization ID and release channel to notify a gateway of a new version.
Application
If the gateway finds an update to download, it will download and apply the update immediately. But the update won’t take effect until the gateway restarts. Until that happens, the gateway will show a state of Awaiting Restart.
Restart
The gateway will restart when:
-
it has no more active connections, OR
-
the current time is within the node’s maintenance window
Maintenance window
By default, a gateway’s window starts at 7 UTC. Customers can set a custom window per-gateway:
-
using the environment variable
SDM_MAINTENANCE_WINDOW_START
(in 35.87.0 or later) -
using this flag with the
sdm relay
command on startup:
--maintenance-window-start value, --mw value
hour of the day (0-23 UTC) when relays can terminate connections and restart (default: 7)
User sessions
Gateways will accept new sessions while Awaiting Restart.
They will NOT start “shedding” sessions as they approach the window, and there is no gradual sloughing off when the window is reached.
Active streams will be cut off as soon as the maintenance window begins.