diff --git a/doc/user/workspace/configuration.md b/doc/user/workspace/configuration.md index 04406c1a9614c18769cd449f4dd0bde8b42f9bf7..f377df3e700656e1c520150269f0dbd3b5d1ec57 100644 --- a/doc/user/workspace/configuration.md +++ b/doc/user/workspace/configuration.md @@ -133,11 +133,19 @@ To configure your workspace to use the user namespaces feature in Kubernetes: Prerequisites: -- SSH must be enabled for the workspace. -- You must have a TCP load balancer that points to the [GitLab workspaces proxy](set_up_workspaces_proxy.md). +- SSH access must be enabled for the images specified in your [`devfile`](index.md#devfile). + For more information, see [update your workspace container image](#update-your-workspace-container-image). +- A TCP load balancer must be configured that points to the GitLab workspaces proxy. + For more information, see [update your DNS records](set_up_workspaces_proxy.md#update-your-dns-records). To connect to a workspace with an SSH client: +1. Get your `gitlab-workspaces-proxy-ssh` service external IP address: + + ```shell + kubectl -n gitlab-workspaces get service gitlab-workspaces-proxy-ssh + ``` + 1. Get the name of the workspace: 1. On the left sidebar, select **Search or go to**. @@ -148,7 +156,7 @@ To connect to a workspace with an SSH client: 1. Run this command: ```shell - ssh @ + ssh @ ``` 1. For the password, enter your personal access token with at least the `read_api` scope. diff --git a/doc/user/workspace/set_up_gitlab_agent.md b/doc/user/workspace/set_up_gitlab_agent.md index 9ab32ff7b36d0e92993779bf74a3991c0ffa50d1..91b4f95b6e73f4b47fa4ef12545f1f742db3597b 100644 --- a/doc/user/workspace/set_up_gitlab_agent.md +++ b/doc/user/workspace/set_up_gitlab_agent.md @@ -5,11 +5,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w description: "Set up the GitLab agent to create and manage workspaces in a project." --- -# Tutorial: Set up the GitLab agent +# Tutorial: Set up the GitLab agent for workspaces This tutorial shows you how to set up the GitLab agent so users -can create and manage workspaces in a project. -For this tutorial, the following hierarchy is used: +can create and manage workspaces in a project. For this tutorial, the following hierarchy is used: ```mermaid %%{init: {'theme':'neutral'}}%% @@ -39,6 +38,7 @@ To set up the GitLab agent, you're going to: ## Prerequisites +- GitLab agent must be [installed](../clusters/agent/install/index.md) and [configured](gitlab_agent_configuration.md). - You must [set up workspace infrastructure](configuration.md#set-up-workspace-infrastructure). - You must have administrator access to the instance or the Owner role for the group.