ContextQMD
Back to Gitlabhq

Dashboard for Kubernetes

doc/ci/environments/kubernetes_dashboard.md

18.11.212.4 KB
Original Source

{{< details >}}

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
  • Status: Beta

{{< /details >}}

{{< history >}}

  • Introduced in GitLab 16.1, with flags named environment_settings_to_graphql, kas_user_access, kas_user_access_project, and expose_authorized_cluster_agents. This feature is in beta.
  • Feature flag environment_settings_to_graphql removed in GitLab 16.2.
  • Feature flags kas_user_access, kas_user_access_project, and expose_authorized_cluster_agents removed in GitLab 16.2.
  • Moved to the environment details page in 16.10.

{{< /history >}}

Use the dashboard for Kubernetes to understand the status of your clusters with an intuitive visual interface. The dashboard works with every connected Kubernetes cluster, whether you deployed them with CI/CD or GitOps.

Configure a dashboard

{{< history >}}

  • Filtering resources by namespace introduced in GitLab 16.2 with a flag named kubernetes_namespace_for_environment. Disabled by default.
  • Filtering resources by namespace enabled by default in GitLab 16.3. Feature flag kubernetes_namespace_for_environment removed.
  • Selecting the related Flux resource introduced in GitLab 16.3 with a flag named flux_resource_for_environment.
  • Selecting the related Flux resource generally available in GitLab 16.4. Feature flag flux_resource_for_environment removed.

{{< /history >}}

Configure a dashboard to use it for a given environment. You can configure dashboard for an environment that already exists, or add one when you create an environment.

Prerequisites:

  • A GitLab agent for Kubernetes is installed and user_access is configured for the environment's project or its parent group.

{{< tabs >}}

{{< tab title="The environment already exists" >}}

  1. In the top bar, select Search or go to and find your project.
  2. Select Operate > Environments.
  3. Select the environment to be associated with the agent for Kubernetes.
  4. Select Edit.
  5. Select a GitLab agent for Kubernetes.
  6. Optional. From the Kubernetes namespace dropdown list, select a namespace.
  7. Optional. From the Flux resource dropdown list, select a Flux resource.
  8. Select Save.

{{< /tab >}}

{{< tab title="The environment doesn't exist" >}}

  1. In the top bar, select Search or go to and find your project.
  2. Select Operate > Environments.
  3. Select New environment.
  4. Complete the Name field.
  5. Select a GitLab agent for Kubernetes.
  6. Optional. From the Kubernetes namespace dropdown list, select a namespace.
  7. Optional. From the Flux resource dropdown list, select a Flux resource.
  8. Select Save.

{{< /tab >}}

{{< /tabs >}}

Configure a dashboard for a dynamic environment

{{< history >}}

{{< /history >}}

To configure a dashboard for a dynamic environment:

  • Specify the agent in your .gitlab-ci.yml file. You must specify the full path to the agent configuration project, followed by a colon and the name of the agent.

For example:

yaml
deploy_review_app:
  stage: deploy
  script: make deploy
  environment:
    name: review/$CI_COMMIT_REF_SLUG
    kubernetes:
      agent: path/to/agent/project:agent-name

For more information, see the CI/CD YAML syntax reference.

View a dashboard

{{< history >}}

{{< /history >}}

View a dashboard to see the status of connected clusters. The status of your Kubernetes resources and Flux reconciliation updates in real time.

To view a configured dashboard:

  1. In the top bar, select Search or go to and find your project.
  2. Select Operate > Environments.
  3. Select the environment associated with the agent for Kubernetes.
  4. Select the Kubernetes overview tab.

A list of pods is displayed. Select a pod to view its details.

Flux sync status

{{< history >}}

  • Introduced in GitLab 16.3.
  • Customizing the name of the Flux resource introduced in GitLab 16.3 with a flag named flux_resource_for_environment.
  • Customizing the name of the Flux resource generally available in GitLab 16.4. Feature flag flux_resource_for_environment removed.

{{< /history >}}

You can review the sync status of your Flux deployments from a dashboard. To display the deployment status, your dashboard must be able to retrieve the Kustomization and HelmRelease resources, which requires a namespace to be configured for the environment.

GitLab searches the Kustomization and HelmRelease resources specified by the Flux resource dropdown list in the environment settings.

A dashboard displays one of the following status badges:

StatusDescription
ReconciledThe deployment successfully reconciled with its environment.
ReconcilingA reconciliation is in progress.
StalledA reconciliation is stuck because of an error that cannot be resolved without human intervention.
FailedThe deployment couldn't reconcile because of an unrecoverable error.
UnknownThe sync status of the deployment couldn't be retrieved.
UnavailableThe Kustomization or HelmRelease resource couldn't be retrieved.

Trigger Flux reconciliation

{{< history >}}

{{< /history >}}

You can manually reconcile your deployment with its Flux resources.

To trigger a reconciliation:

  1. On a dashboard, select the sync status badge of a Flux deployment.
  2. Select Actions ({{< icon name="ellipsis_v" >}}) > Trigger reconciliation ({{< icon name="retry" >}}).

Suspend or resume Flux reconciliation

{{< history >}}

{{< /history >}}

You can manually suspend or resume your Flux reconciliation from the UI.

To suspend or resume reconciliation:

  1. On a dashboard, select the sync status badge of a Flux deployment.
  2. Select Actions ({{< icon name="ellipsis_v" >}}), then choose one of the following:
    • Suspend reconciliation ({{< icon name="stop" >}}) to pause the Flux reconciliation.
    • Resume reconciliation ({{< icon name="play" >}}) to restart the Flux reconciliation.

View pod logs

{{< history >}}

{{< /history >}}

View pod logs when you want to quickly understand and troubleshoot issues across your environments from a configured dashboard. You can view logs for each container in a pod.

  • Select View logs, then select the container you want to view logs for.

You can also view pod logs from the pod details.

Delete a pod

{{< history >}}

{{< /history >}}

To restart a failed pod, delete it from the Kubernetes dashboard.

To delete a pod:

  1. On the Kubernetes overview tab, find the pod you want to delete.
  2. Select Actions ({{< icon name="ellipsis_v" >}}) > Delete pod ({{< icon name="remove" >}}).

You can also delete a pod from the pod details.

Detailed dashboard

{{< history >}}

{{< /history >}}

[!flag] The availability of this feature is controlled by a feature flag. For more information, see the history. This feature is available for testing, but not ready for production use.

The detailed dashboard provides information about the following Kubernetes resources:

  • Pods
  • Services
  • Deployments
  • ReplicaSets
  • StatefulSets
  • DaemonSets
  • Jobs
  • CronJobs

Each dashboard displays a list of resources with their statuses, namespaces, and age. You can select a resource to open a drawer with more information, including labels and YAML-formatted status, annotations, and spec.

Because of the focus shift described in this issue, work on the detailed dashboard is paused.

To provide feedback on the detailed dashboard, see issue 460279.

View a detailed dashboard

Prerequisites:

  • A GitLab agent for Kubernetes is configured and shared with the environment's project, or its parent group, using the user_access keyword.

The detailed dashboard is not linked from the sidebar navigation. To view a detailed dashboard:

  1. Find your agent for Kubernetes ID:

    1. In the top bar, select Search or go to and find your project.
    2. Select Operate > Kubernetes clusters.
    3. Copy the numerical ID of the agent you want to access.

  2. Go to one of the following URLs, replacing <agent_id> with your agent ID:

    Resource typeURL
    Podshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/pods
    Serviceshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/services
    Deploymentshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/deployments
    ReplicaSetshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/replicaSets
    StatefulSetshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/statefulSets
    DaemonSetshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/daemonSets
    Jobshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/jobs
    CronJobshttps://myinstance.gitlab.com/-/kubernetes/<agent_id>/cronJobs

Troubleshooting

When working with the dashboard for Kubernetes, you might encounter the following issues.

User cannot list resource in API group

You might get an error that states Error: services is forbidden: User "gitlab:user:<user-name>" cannot list resource "<resource-name>" in API group "" at the cluster scope.

This error happens when a user is not allowed to do the specified operation in the Kubernetes RBAC.

To resolve, check your RBAC configuration. If the RBAC is properly configured, contact your Kubernetes administrator.

GitLab agent dropdown list is empty

When you configure a new environment, the GitLab agent dropdown list might be empty, even if you have configured Kubernetes clusters.

To populate the GitLab agent dropdown list, grant an agent Kubernetes access with the user_access keyword.