Skip to main content
A box runs two parts that you can update from Stout: the Lager runtime and the stout container. Only owners and admins can start updates and set the schedule.

Find boxes that need an update

On the Boxes page, the Lager Version column shows a green version when the box runs the latest Lager release. It shows an amber version with an arrow when a newer release exists. Select the amber version to update the box. A clock icon next to the version means that the daily update schedule covers the box.

Update one box

  1. Open the box, and then open the menu in the header.
  2. Select Update.
  3. In the Update window, select Lager, Stout, or both. Stout selects each part that is out of date before you start.
  4. Select Continue.
Each option shows the current version and whether a newer version exists. If you select both, Lager updates first, and the Stout update starts when the Lager update succeeds. If the Lager update fails, Stout does not start the Stout update. If you close the Lager update window before it succeeds, Stout does not start the Stout update. Select Update again after the Lager update finishes. On the Boxes page, Update in the menu of a row opens only the Lager update window.

Update Lager

The Lager update window has two tabs: Update Now and Schedule. For Schedule, see Schedule a daily update.
  1. On Update Now, select a Version. The newest release shows (latest).
  2. Select Start Update.
The window shows the progress of the update. To see the full log, select Verbose mode. Run in Background closes the window. The update continues on the box, and the window shows the progress again when you open it again. To test a pre-release build, select Custom branch… in Version, and then enter the branch name. This option installs a branch from the Lager repository. It is available only when you update one box.
If the box runs production tests, select a released version. Use Custom branch… only to test pre-release builds.
If the update fails with an SSH authentication error, select Sync SSH Key, and then try the update again. If that does not help, select Re-authorize with this Control Plane. This option runs the Stout install on the box again. Any other Stout control plane that manages the box loses access to it.

Update Stout

The Update Stout daemon window updates the stout container. It does not change Lager.
  1. To install the default image, leave Image tag (optional) empty. To test a pre-release build, paste a full image reference.
  2. Select Start Update.
The window shows the log. Run in Background closes the window, and the update continues on the box.

Update many boxes

  1. On the Boxes page or on the page of a group, select the check boxes of the boxes.
  2. In the bar at the bottom of the page, select Update.
  3. On Update Now, select a Version.
  4. Select Start Update.
A bulk update updates Lager only. It skips every locked box, and the window says how many boxes it skips. A bulk update cannot use a custom branch. The window shows each box with its progress. To see the output of a box, select Log next to it. When you select a released version, a box shows Done as soon as it reports that version. The window watches the boxes for 20 minutes. After that, a box that did not finish shows Unconfirmed. The update continues on the box. Select Check again, or watch the Lager Version column. To close the window while the updates continue, select Close (updates continue).

Schedule a daily update

An organization has one daily update schedule. The schedule updates Lager on every box in the organization that has an IP address and no lock.
  1. Open the Lager update window of a box, or the bulk update window.
  2. Select the Schedule tab.
  3. Select a Version. Latest (auto-detect) installs the newest Lager release at the time of each run.
  4. Set the Time. The default time is 03:00.
  5. Select the Timezone. The default timezone is Pacific (America/Los_Angeles).
  6. Select Save Schedule.
After you save, the tab shows the schedule, the version, and the time of the last run. To change the schedule, edit the fields, and then select Update Schedule. To stop the scheduled updates, select Remove Schedule. The schedule does not update the stout container.

Locks

Keep a box out of bulk and scheduled updates while you work on it.

Boxes

Find the boxes that need an update.