...
| Code Block |
|---|
"agentUpgradePolicy": {
"atLeastVersion": "<version> | current", // Specify the minimum agent version these nodes should have, default "current"
"start": "<RFC3339 timestamp> | now", // When to start an upgrade, default "now"
"duration": seconds // Enable agents to randomize upgrade start time within start + duration, default 0
}, |
The autoUpgrade flag instructs the agent whether or not to actively (periodically) check for new updates. Checking for new updates is performed based on the node's heartbeat configuration.The atLeastVersion field indicates the minimum version the agents should upgrade to when instructed.Enabling autoUpgrade implies that toVersion is set to current, therefore any value other than current is invalid. The toVersion field may be omitted when autoUpgrade == true. When When atLeastVersion is set to current, the agent will periodically check for new versions and automatically upgrade to the newest version.
The start field contains an RFC3339 timestamp indicating when the upgrade should start. The timestamp is in UTC format so that affected nodes anywhere in the world are acting at approximately based on the same time. When autoUpgrade == true, the start field is ignoredclock.
The duration field is specified in seconds, and is added to the start time to form a window of time within which the agent will initiate an update. Each agent will randomly select a point within that window to begin the upgrade process. This prevents all affected agents from upgrading at the same time, possibly overwhelming the management hub. The combination of selecting nodes based on properties and constraints plus the start time and duration is intended to enable org administrators sufficient control over mass upgrades to prevent overwhelming the management hub. The duration field is ignored when autoUpgrade == truethe management hub.
If an agent is instructed to upgrade to a version which it is already running, it will not perform the upgrade.
...
In the absence of any enabled NMPs, an agent never checks for an update.
Agent Version Status
The agent will maintain it's version in the exchange, in its /status resource. Following is the JSON encoded pseudo-schema for the new version status:
| Code Block |
|---|
"agentVersion": { |
...
"package":{}, // The version(s) of the most recent package installed on the agent |
...
"failed":"<version>", // The last version upgrade failed on this version, or empty |
...
"upgradeStart":"<RFC3339 timestamp>", // The time (in UTC) when the last upgrade started |
...
"upgradeEnd":"<RFC3339 timestamp>", // The time (in UTC) when the last upgrade ended |
...
The package field contains the JSON object from the package manifest of the most recently successful agent install. See the "Agent package" section.
...