From fab736647507d1231147f9c1ed4bf812980363ca Mon Sep 17 00:00:00 2001 From: Alexandr Tanayno Date: Mon, 14 Oct 2024 10:38:37 +0000 Subject: [PATCH 1/5] Adds clarifications to workspaces docs --- doc/user/workspace/configuration.md | 7 ++++--- ...tlab_agent.md => set_up_gitlab_agent_for_workspaces.md} | 2 +- doc/user/workspace/set_up_workspaces_proxy.md | 1 + 3 files changed, 6 insertions(+), 4 deletions(-) rename doc/user/workspace/{set_up_gitlab_agent.md => set_up_gitlab_agent_for_workspaces.md} (98%) diff --git a/doc/user/workspace/configuration.md b/doc/user/workspace/configuration.md index 04406c1a9614c1..2ff2f9d1cc3100 100644 --- a/doc/user/workspace/configuration.md +++ b/doc/user/workspace/configuration.md @@ -133,11 +133,12 @@ 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). +- Images that you specify in your [devfile](index.md#devfile) must have SSH enabled. See [example](#update-your-workspace-container-image) below. +- You must have a TCP load balancer that points to the [GitLab workspaces proxy](set_up_workspaces_proxy.md). See [Update your DNS records](set_up_workspaces_proxy.html#update-your-dns-records). To connect to a workspace with an SSH client: +1. Get an external IP address of your `gitlab-workspaces-proxy-ssh` service via `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 +149,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_for_workspaces.md similarity index 98% rename from doc/user/workspace/set_up_gitlab_agent.md rename to doc/user/workspace/set_up_gitlab_agent_for_workspaces.md index 9ab32ff7b36d0e..11ce551c295af4 100644 --- a/doc/user/workspace/set_up_gitlab_agent.md +++ b/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md @@ -5,7 +5,7 @@ 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. diff --git a/doc/user/workspace/set_up_workspaces_proxy.md b/doc/user/workspace/set_up_workspaces_proxy.md index 0e260b61c3b32f..b5a0b14cabfdeb 100644 --- a/doc/user/workspace/set_up_workspaces_proxy.md +++ b/doc/user/workspace/set_up_workspaces_proxy.md @@ -9,6 +9,7 @@ description: "Create a GitLab workspaces proxy to authenticate and authorize wor In this tutorial, you'll learn how to set up the GitLab workspaces proxy to authenticate and authorize [workspaces](index.md) in your cluster. +This tutorial assumes that GitLab Agent has already been [set up]() To set up `gitlab-workspaces-proxy`, you're going to: -- GitLab From 2fe86896df5282061f0dd65f48543830265f6829 Mon Sep 17 00:00:00 2001 From: Alexandr Tanayno Date: Mon, 14 Oct 2024 10:46:51 +0000 Subject: [PATCH 2/5] Clarifies how the page should be used --- doc/user/workspace/set_up_gitlab_agent_for_workspaces.md | 3 ++- doc/user/workspace/set_up_workspaces_proxy.md | 1 - 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md b/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md index 11ce551c295af4..64ef899d2fc9fe 100644 --- a/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md +++ b/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md @@ -8,7 +8,8 @@ description: "Set up the GitLab agent to create and manage workspaces in a proje # 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. +can create and manage workspaces in a project. It assumes that +GitLab Agent has already been [installed](../clusters/agent/install/index.md) and [configured](gitlab_agent_configuration.md). For this tutorial, the following hierarchy is used: ```mermaid diff --git a/doc/user/workspace/set_up_workspaces_proxy.md b/doc/user/workspace/set_up_workspaces_proxy.md index b5a0b14cabfdeb..0e260b61c3b32f 100644 --- a/doc/user/workspace/set_up_workspaces_proxy.md +++ b/doc/user/workspace/set_up_workspaces_proxy.md @@ -9,7 +9,6 @@ description: "Create a GitLab workspaces proxy to authenticate and authorize wor In this tutorial, you'll learn how to set up the GitLab workspaces proxy to authenticate and authorize [workspaces](index.md) in your cluster. -This tutorial assumes that GitLab Agent has already been [set up]() To set up `gitlab-workspaces-proxy`, you're going to: -- GitLab From f9505627b042f86dde33eac755299c212ac6d568 Mon Sep 17 00:00:00 2001 From: Alexandr Tanayno Date: Mon, 14 Oct 2024 10:54:20 +0000 Subject: [PATCH 3/5] Fix docslint errors --- doc/user/workspace/configuration.md | 2 +- ...up_gitlab_agent_for_workspaces.md => set_up_gitlab_agent.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename doc/user/workspace/{set_up_gitlab_agent_for_workspaces.md => set_up_gitlab_agent.md} (100%) diff --git a/doc/user/workspace/configuration.md b/doc/user/workspace/configuration.md index 2ff2f9d1cc3100..6d1c0a42c999c6 100644 --- a/doc/user/workspace/configuration.md +++ b/doc/user/workspace/configuration.md @@ -134,7 +134,7 @@ To configure your workspace to use the user namespaces feature in Kubernetes: Prerequisites: - Images that you specify in your [devfile](index.md#devfile) must have SSH enabled. See [example](#update-your-workspace-container-image) below. -- You must have a TCP load balancer that points to the [GitLab workspaces proxy](set_up_workspaces_proxy.md). See [Update your DNS records](set_up_workspaces_proxy.html#update-your-dns-records). +- You must have a TCP load balancer that points to the [GitLab workspaces proxy](set_up_workspaces_proxy.md). See [Update your DNS records](set_up_workspaces_proxy.md#update-your-dns-records). To connect to a workspace with an SSH client: diff --git a/doc/user/workspace/set_up_gitlab_agent_for_workspaces.md b/doc/user/workspace/set_up_gitlab_agent.md similarity index 100% rename from doc/user/workspace/set_up_gitlab_agent_for_workspaces.md rename to doc/user/workspace/set_up_gitlab_agent.md -- GitLab From 84a51310b694026d76dad96a44feb18f00db69e0 Mon Sep 17 00:00:00 2001 From: Alexandr Tanayno Date: Mon, 14 Oct 2024 13:57:10 +0000 Subject: [PATCH 4/5] Apply 2 suggestion(s) to 1 file(s) Co-authored-by: Brendan Lynch --- doc/user/workspace/configuration.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/user/workspace/configuration.md b/doc/user/workspace/configuration.md index 6d1c0a42c999c6..f377df3e700656 100644 --- a/doc/user/workspace/configuration.md +++ b/doc/user/workspace/configuration.md @@ -133,12 +133,19 @@ To configure your workspace to use the user namespaces feature in Kubernetes: Prerequisites: -- Images that you specify in your [devfile](index.md#devfile) must have SSH enabled. See [example](#update-your-workspace-container-image) below. -- You must have a TCP load balancer that points to the [GitLab workspaces proxy](set_up_workspaces_proxy.md). See [Update your DNS records](set_up_workspaces_proxy.md#update-your-dns-records). +- 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 an external IP address of your `gitlab-workspaces-proxy-ssh` service via `kubectl -n gitlab-workspaces get service gitlab-workspaces-proxy-ssh`. +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**. -- GitLab From 6bf07e17a3c4f534f8053e4d6f05216c76f18827 Mon Sep 17 00:00:00 2001 From: Alexandr Tanayno Date: Mon, 14 Oct 2024 14:28:46 +0000 Subject: [PATCH 5/5] Apply 2 suggestion(s) to 1 file(s) Co-authored-by: Brendan Lynch --- doc/user/workspace/set_up_gitlab_agent.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/user/workspace/set_up_gitlab_agent.md b/doc/user/workspace/set_up_gitlab_agent.md index 64ef899d2fc9fe..91b4f95b6e73f4 100644 --- a/doc/user/workspace/set_up_gitlab_agent.md +++ b/doc/user/workspace/set_up_gitlab_agent.md @@ -8,9 +8,7 @@ description: "Set up the GitLab agent to create and manage workspaces in a proje # 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. It assumes that -GitLab Agent has already been [installed](../clusters/agent/install/index.md) and [configured](gitlab_agent_configuration.md). -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'}}%% @@ -40,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. -- GitLab