Subshell Docs

Node maintenance

Take a node out of service before performing disruptive maintenance.

Before you start

Review the subshells on the machine and notify their owners. Maintenance blocks new launches and tries to stop existing sessions. Some may keep running if they can't be stopped.

Enter maintenance

In the server dashboard's sidebar, choose Settings → Nodes, select the machine, and open Overview. At the bottom of the page, select Start maintenance in the Maintenance card. Review the subshell count and consequences, then select Start maintenance in the confirmation dialog.

On the node itself:

subshell maintenance on

If subshells are running, the CLI lists them and refuses without changing state. To accept stopping them:

subshell maintenance on --yes

Sessions stop

Entering maintenance tries to stop all subshells on this node, including other people's sessions. Save any work that depends on a running process before proceeding.

Check the result before working on the machine. If Subshell reports that a session couldn't be stopped, check whether it's still running.

Return to service

After completing the work, return to the Maintenance card, select End maintenance, and confirm the action. From the node's CLI:

subshell maintenance off
subshell maintenance status

The daemon continues answering management commands while maintenance is enabled. Ending maintenance allows new launches. Subshells that stopped won't restart automatically.

Next steps

Use Node updates or Unenroll a node.

Edit on GitHub

Last updated on

On this page