Getting started with interactive web terminals

Introduced in GitLab 11.3.

Interactive web terminals give the user access to a terminal in GitLab for running one-of commands for their CI pipeline.

Note: This is not available for the shared Runners on GitLab.com. To make use of this feature, you need to provide your own Runner and properly configure it.

Configuration

Two things need to be configured for the interactive web terminal to work:

Debugging a running job

Note: Not all executors are supported.

Sometimes, when a job is running, things don't go as you would expect, and it would be helpful if one can have a shell to aid debugging. When a job is running, on the right panel you can see a button debug that will open the terminal for the current job.

Example of job running with terminal
available

When clicked, a new tab will open to the terminal page where you can access the terminal and type commands like a normal shell.

terminal of the job

If you have the terminal open and the job has finished with its tasks, the terminal will block the job from finishing for the duration configured in [session_server].terminal_max_retention_time until you close the terminal window.

finished job with terminal open