Skip to content

Rollouts ​

A rollout takes an approved plugin release to the servers that run the plugin, safely: first one canary server, then a wait (soak), then the other servers one at a time. It lives in the Rollout block of each plugin's page (Plugin catalog). Capability: operations.

Policy ​

SettingMeaning
Updates: manual (Roll out button)Approving or uploading a release does not move any server. Staff click Roll out latest.
Updates: auto (roll out on approval)Approving or uploading a release starts a rollout at once.

Roll out latest starts a rollout of the latest approved release (disabled while one is active).

Stages ​

A rollout shows four steps.

StepWhat happens
CanaryThe release is installed on the canary server and the plugin is verified as loaded.
SoakThe canary must stay healthy for the soak time (default 30 minutes; shown as a countdown): the plugin loaded, the server online and fewer than 5 exception lines from the plugin.
FleetThe other servers follow one at a time, each verified.
DoneEvery target finished.

The canary server is the server set in settings (platform or community level), else a server with the website on, else the first online server by name. Only online servers qualify. The soak time is the setting Canary soak time (0 to 1440 minutes). See Platform settings.

Each target row gives the server, its role (canary or fleet) and the result with a reason. A server is skipped when it is offline or unreachable, the plugin is disabled there, the install is Pinned, or it already runs the release ("up-to-date").

When something fails ​

  • A canary or soak failure reverts the canary to its previous release and halts the rollout.
  • A fleet failure reverts that server only (servers already updated keep the new release) and halts the rollout. The rest of the fleet is untouched.
  • A halted rollout shows "Rollout halted on server." with the reason and a link to the job log (see Jobs).
ButtonEffect
HaltPauses an active rollout.
ResumeContinues a halted rollout.
CancelEnds an active or halted rollout.

If the server's agent cannot check logs, the soak shows "agent has no log gate: exceptions are not checked". A Log (expandable) and the last rollouts ("Earlier: ...") are listed under the block.

Community side ​

Communities see the effect as the plugin's version changing on their servers, with the canary settings in their own Settings. A community can set its own canary server and soak time.

Troubleshooting ​

ProblemFix
A server did not get the releaseIts target row says why: pinned, disabled, offline.
Rollout haltedRead the reason and the job log, fix or upload a new release, then Resume or start a new rollout.
No canary foundNo server running the plugin is online.