Skip to content

Provide connect command for agent cluster

Anna Vovchenko requested to merge 463769-provide-connect-command-for-agent-cluster into master

What does this MR do and why?

This MR adds a modal to show glab command to connect to the Kubernetes cluster via the configured agent. The modal is available from:

  • the individual agent page (connect button at the top)
  • the list agents page (dropdown actions menu with the connect action)
    Note: we already had a delete agent button here, which was moved under the same actions dropdown
  • the Kubernetes overview section on the environment page (dropdown actions menu with the connect action)

The modal shows different content for the cases where the user_access feature was set up for the agent vs not set up. Because of this requirement, we request userAccessConfig.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

  1. Individual agent page

    Before After
    Screenshot_2024-07-30_at_12.21.17 Screenshot_2024-07-29_at_23.41.26

  2. Agents list page

    Before After
    Screenshot_2024-07-30_at_12.20.24 Screenshot_2024-07-29_at_23.42.05

  3. Kubernetes overview page

    Before After
    Screenshot_2024-07-30_at_12.19.33 Screenshot_2024-07-29_at_23.41.16

  4. Modal when the user_access is configured

    Screenshot_2024-07-29_at_23.42.16

  5. Modal when the user_acess is not configured

    Screenshot_2024-07-29_at_23.42.30

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Prerequisites:

  1. Visit the Project -> Operate -> Kubernetes clusters page and create an agent following the instructions from the modal.

    • Select the "Connect a cluster" button
    • The modal should pop up
    • In the modal select "Select an agent or enter a name to create new"
    • You probably won't have any configured agents to show up in the list, create a new one by typing the name of your choice
    • The button should appear at the bottom of the list saying "Create agent: <your-agent-name>"
    • Select the button and click "Register" in the next view.
    • Save the token to use it in the next point.

  2. Visit Project -> Operate -> Kubernetes clusters page and check out the actions menu

  3. Click on an agent name to navigate to individual agent page

  4. Verify Connect to agent button at the top

  5. Add the following configuration inside your project in .gitlab/agents/<your-agent-name>/config.yaml for the user_access agent:

    user_access:
  access_as: 
    agent: {}
  projects:
  - id: <your-group>/<your-project-to-share-agent-with>

  6. Revisit cluster page or individual agent page and verify the modal content changed.

To verify the change on the Environment page:

  1. Note that the shared agents should be connected to the cluster in order to appear in the list. Please follow points 3-8 from the guide and then the Deploy the GitLab Agent (agentk) with k3d section to create a local cluster and connect your agent with the cluster.
  2. Follow this guide to setup internal events logging locally
  3. Visit Project -> Operate -> Environments
  4. Create/Edit an environment using the UI
  5. Select an agent from the dropdown in the Environments settings page and save the change.
  6. Visit the Environments page and visit the environment details page for the environment that has an associated agent.
  7. Verify the actions menu and the connect action

Review progress:

Related to #463769 (closed)

Edited by Anna Vovchenko

Merge request reports