Add documentation for interactive web terminals
Create a new page for the interactive web terminals since it doesn't fit in any other place. Add link in CI home page.
This commit is contained in:
parent
ce18246c24
commit
b7fa2e0beb
|
|
@ -76,6 +76,8 @@ learn how to leverage its potential even more.
|
|||
- [Trigger pipelines on a schedule](../user/project/pipelines/schedules.md)
|
||||
- [Kubernetes clusters](../user/project/clusters/index.md) - Integrate one or
|
||||
more Kubernetes clusters to your project
|
||||
- [Interactive web terminal](interactive_web_terminal/index.md) - Open an interactive
|
||||
web terminal to debug the running jobs
|
||||
|
||||
## GitLab CI/CD for Docker
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
|
|
@ -0,0 +1,48 @@
|
|||
# Getting started with interactive web terminals
|
||||
|
||||
> Introduced in GitLab 11.2.
|
||||
|
||||
Interactive web terminals give the user access to a terminal in GitLab for
|
||||
running one-of commands for their CI pipeline.
|
||||
|
||||
NOTE: **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](https://docs.gitlab.com/runner/install/) and properly
|
||||
[configure it](#configuration).
|
||||
|
||||
## Configuration
|
||||
|
||||
Two things need to be configured for the interactive web terminal to work:
|
||||
|
||||
- The Runner needs to have [`[session_server]` configured
|
||||
properly][session-server]
|
||||
- Web terminals need to be
|
||||
[enabled](../../administration/integration/terminal.md#enabling-and-disabling-terminal-support)
|
||||
|
||||
## Debugging a running job
|
||||
|
||||
NOTE: **Note:** Not all executors are
|
||||
[supported](https://docs.gitlab.com/runner/executors/#compatibility-chart).
|
||||
|
||||
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 that will open the terminal
|
||||
for the current job.
|
||||
|
||||

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

|
||||
|
||||
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`][session-server] until you
|
||||
close the terminal window.
|
||||
|
||||

|
||||
|
||||
[session-server]: https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-session_server-section
|
||||
Loading…
Reference in New Issue