Commit b4136e17 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'update-interactive-terminals-documentation' into 'master'

Docs: follow up from "Clearly state web terminal is not supported at all on GitLab.com"

Closes #8866

See merge request gitlab-org/gitlab-ee!8866
parents b3add580 4f0c44de
...@@ -6,8 +6,9 @@ Interactive web terminals give the user access to a terminal in GitLab for ...@@ -6,8 +6,9 @@ Interactive web terminals give the user access to a terminal in GitLab for
running one-off commands for their CI pipeline. running one-off commands for their CI pipeline.
NOTE: **Note:** NOTE: **Note:**
GitLab.com does not support interactive web terminal at the moment. Please GitLab.com does not support interactive web terminal at the moment – neither
follow [this issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/52611) for using shared GitLab.com runners nor your own runners. Please follow
[this issue](https://gitlab.com/gitlab-org/gitlab-ce/issues/52611) for
progress. progress.
## Configuration ## Configuration
...@@ -50,7 +51,7 @@ close the terminal window. ...@@ -50,7 +51,7 @@ close the terminal window.
![finished job with terminal open](img/finished_job_with_terminal_open.png) ![finished job with terminal open](img/finished_job_with_terminal_open.png)
## Interactive Terminals for the Web IDE **[ULTIMATE]** ## Interactive Web Terminals for the Web IDE **[ULTIMATE ONLY]**
Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md). Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md).
...@@ -79,7 +79,7 @@ The following table depicts the various user permission levels in a project. ...@@ -79,7 +79,7 @@ The following table depicts the various user permission levels in a project.
| Use security dashboard **[ULTIMATE]** | | | ✓ | ✓ | ✓ | | Use security dashboard **[ULTIMATE]** | | | ✓ | ✓ | ✓ |
| Dismiss vulnerability **[ULTIMATE]** | | | ✓ | ✓ | ✓ | | Dismiss vulnerability **[ULTIMATE]** | | | ✓ | ✓ | ✓ |
| Use environment terminals | | | | ✓ | ✓ | | Use environment terminals | | | | ✓ | ✓ |
| Run Web IDE's Interactive Terminals **[ULTIMATE]** | | | | ✓ | ✓ | | Run Web IDE's Interactive Web Terminals **[ULTIMATE ONLY]** | | | | ✓ | ✓ |
| Add new team members | | | | ✓ | ✓ | | Add new team members | | | | ✓ | ✓ |
| Push to protected branches | | | | ✓ | ✓ | | Push to protected branches | | | | ✓ | ✓ |
| Enable/disable branch protection | | | | ✓ | ✓ | | Enable/disable branch protection | | | | ✓ | ✓ |
......
...@@ -128,23 +128,25 @@ IDE. An example `package.json` is below. ...@@ -128,23 +128,25 @@ IDE. An example `package.json` is below.
} }
``` ```
## Interactive Terminals for the Web IDE **[ULTIMATE]** ## Interactive Web Terminals for the Web IDE **[ULTIMATE ONLY]**
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5426) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/5426) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6.
[Interactive terminals](../../../ci/interactive_web_terminal/index.md) CAUTION: **Warning:**
give the user access to a terminal to interact with the Runner directly from the GitLab Interactive Web Terminals for the Web IDE is currently in **Beta**.
UI. These terminals can be also accessed via Web IDE.
[Interactive web terminals](../../../ci/interactive_web_terminal/index.md)
give the user access to a terminal to interact with the Runner directly from
GitLab, including through the Web IDE.
Only project [**maintainers**](../../permissions.md#project-members-permissions) Only project [**maintainers**](../../permissions.md#project-members-permissions)
can run Interactive Terminals through the Web IDE. can run Interactive Web Terminals through the Web IDE.
### Runner configuration CAUTION: **Warning:**
GitLab.com [does not support Interactive Web Terminals yet](https://gitlab.com/gitlab-org/gitlab-ce/issues/52611).
Shared Runners in private instances are not supported either.
Web IDE Interactive Terminals are not supported by Shared Runners. ### Runner configuration
To make use of this feature, you need to provide your
[own Runner](https://docs.gitlab.com/runner/install/) and properly
[configure it](#configuration).
Some things need to be configured in the runner for the interactive web terminal Some things need to be configured in the runner for the interactive web terminal
to work: to work:
......
...@@ -8,7 +8,7 @@ module EE ...@@ -8,7 +8,7 @@ module EE
def ide_data def ide_data
super.merge({ super.merge({
"ee-web-terminal-svg-path" => image_path('illustrations/web-ide_promotion.svg'), "ee-web-terminal-svg-path" => image_path('illustrations/web-ide_promotion.svg'),
"ee-web-terminal-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'interactive-terminals-for-the-web-ide-ultimate'), "ee-web-terminal-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'interactive-web-terminals-for-the-web-ide-ultimate-only'),
"ee-web-terminal-config-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'web-ide-configuration-file'), "ee-web-terminal-config-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'web-ide-configuration-file'),
"ee-web-terminal-runners-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'runner-configuration') "ee-web-terminal-runners-help-path" => help_page_path('user/project/web_ide/index.md', anchor: 'runner-configuration')
}) })
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment