Updates

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 an update schedule covers the box. Point to the icon to see which schedule, and when it runs.

​

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

To set up updates that run every day, see Schedule updates.

1. In the Update window, 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. The update also installs the lager command on the box. Some boxes run tests from their own command line, such as a test runner. These boxes get the same version of the command as the Lager runtime. The page of the box shows the version under Last Update. If Stout cannot install the command, the update window shows the reason. The box continues to run. Stout does not install the command if the Python version on the box is less than 3.10. 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. An update can be a success and not do all of its work. Stout can fail to record the version of the box, or to install the lager command. The window then shows Updated, with a caveat and the reason. The box runs the new version. The page of the box keeps the same message under Last Update. 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 updates

An organization can have several update schedules. A schedule updates Lager on its boxes at the time you set. A box belongs to one schedule at a time. Only owners and admins can change schedules.

​

Manage the schedules of the organization

1. Open Settings, and then select Fleet Updates.
2. To make a schedule, select Add schedule.
3. Enter a Name.
4. Select a Version. Always the latest release installs the newest release on the day it runs. Choose a version shows the released versions, and keeps the boxes on the one you select. Choose a specific branch installs a branch from the Lager repository.
5. Set the Time and the Timezone.
6. Select a Frequency: Daily, Every few days, or Weekly on a day you choose. The line below the field shows when the schedule runs.
7. For Boxes, add the boxes. The boxes on the schedule show at the top, and you can remove one with the x. To add boxes, search by name, or filter by group and select Add these.
8. Select Create schedule.

The page shows each schedule, the time it runs, the version it installs, and how many boxes it covers. Use the … menu of a schedule to edit it, to pause it, or to delete it. A paused schedule keeps its boxes, time and version, and runs nothing. Every few days counts from the last run. A schedule that you pause for two weeks does not try to catch up when you resume it. A schedule updates the boxes that you add to it, and no others. A box that you register later is on no schedule until you add it.

​

Put one box on a schedule

1. Open the box, and then select the Settings tab.
2. In Update Schedule, select a schedule.

To make a schedule for this box, select Create a new schedule…. To remove the box, select the first option in the list. If the organization has a schedule that covers every box no other schedule covers, that schedule then covers this box. The Boxes page shows a clock icon next to the version of a box that a schedule covers.

​

Put many boxes on a schedule

1. On the Boxes page, select the check boxes of the boxes.
2. In the bar at the bottom of the page, select Update.
3. Select Add to a schedule…, select a schedule, and then select Add to schedule.

The boxes move onto that schedule, and off the schedules they were on. Boxes that you did not select do not change. Schedules do not update the stout container.