Skip to content

Design: GitLab Kubernetes Agent details page - Initial explorations

Problem to solve

As a Platform Engineer in order to manage my GitLab attached clusters, I would like to see details about my cluster linked to GitLab with an agent.

Intended users

User experience goal

Get information on

  • the configuration used in the agent
    • list the projects
    • list other capabilities of the agent
  • show the information provided by the enabled/configured capabilities

Proposal

Agent_details-Access_tokens

Agent_details-Manifest_projects

Agent_details-Configuration

Iteration 1

Information to show:

  • title
  • agent status indicator
    • grey: the agent never connected with its token
    • green: the connection between the agent and GitLab is set up
    • red: the connection between the agent and GitLab is broken
  • agent setup page with a listing of projects and instructions to add new projects
    • the project list should not contain the last related deployment details
  • agent version

Iteration 2

  • agent setup page with a listing of projects and details about the last activity related
  • token management
  • activity list
    • When I create a new agent, I receive a warning message when the agent is set up on the GitLab side
    • When I create a new agent, I receive a success message when the agent first authenticates with GitLab
    • When the agent receives a new config file, I receive a warning message that the agent config changed
    • When my config file is missing, I receive error messages
    • When my config file is invalid, I receive error messages
    • When my token is invalid, I receive error messages - Discussion in: #230571 (comment 397619734)
    • The agent does not have permissions to enable feature X
    • Resource manifests received - <link to commit>
    • Failed applying manifests - <link to commit>

Iteration 3

  • agent setup instructions to set up Prometheus and/or container security scanning

Further details

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / reference

Edited by Maria Vrachni