diff options
Diffstat (limited to 'doc/ci/environments/kubernetes_dashboard.md')
| -rw-r--r-- | doc/ci/environments/kubernetes_dashboard.md | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/doc/ci/environments/kubernetes_dashboard.md b/doc/ci/environments/kubernetes_dashboard.md index ee16294e654..98b6731e469 100644 --- a/doc/ci/environments/kubernetes_dashboard.md +++ b/doc/ci/environments/kubernetes_dashboard.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# Dashboard for Kubernetes (Beta) **(FREE)** +# Dashboard for Kubernetes (Beta) **(FREE ALL)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390769) in GitLab 16.1, with [flags](../../administration/feature_flags.md) named `environment_settings_to_graphql`, `kas_user_access`, `kas_user_access_project`, and `expose_authorized_cluster_agents`. This feature is in [Beta](../../policy/experiment-beta-support.md#beta). > - Feature flag `environment_settings_to_graphql` [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/124177) in GitLab 16.2. @@ -20,6 +20,13 @@ For Flux users, the synchronization status of a given environment is not display ## Configure a dashboard +> - Filtering resources by namespace [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/403618) in GitLab 16.2 [with a flag](../../administration/feature_flags.md) named `kubernetes_namespace_for_environment`. Disabled by default. +> - Filtering resources by namespace [enabled by default](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127043) in GitLab 16.3. Feature flag `kubernetes_namespace_for_environment` removed. +> - Selecting the related Flux resource [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128857) in GitLab 16.3 [with a flag](../../administration/feature_flags.md) named `flux_resource_for_environment`. Disabled by default. + +FLAG: +On self-managed GitLab, by default selecting a Flux resource is not available. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `flux_resource_for_environment`. On GitLab.com, this feature is not available. + 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. @@ -36,6 +43,8 @@ Prerequisites: 1. Select the environment to be associated with the Kubernetes. 1. Select **Edit**. 1. Select a GitLab agent for Kubernetes. +1. Optional. From the **Kubernetes namespace** dropdown list, select a namespace. +1. Optional. From the **Flux resource** dropdown list, select a Flux resource. 1. Select **Save**. ### The environment doesn't exist @@ -45,6 +54,8 @@ Prerequisites: 1. Select **New environment**. 1. Complete the **Name** field. 1. Select a GitLab agent for Kubernetes. +1. Optional. From the **Kubernetes namespace** dropdown list, select a namespace. +1. Optional. From the **Flux resource** dropdown list, select a Flux resource. 1. Select **Save**. ## View a dashboard @@ -56,6 +67,27 @@ To view a configured dashboard: 1. Expand the environment associated with GitLab agent for Kubernetes. 1. Expand **Kubernetes overview**. +### Flux sync status + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/391581) in GitLab 16.3. +> - Customizing the name of the Flux resource [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128857) in GitLab 16.3 [with a flag](../../administration/feature_flags.md) named `flux_resource_for_environment`. Disabled by default. + +A dashboard displays the sync status of your Flux deployments. + +| Status | Description | +|---------|-------------| +| **Reconciled** | The deployment successfully reconciled with its environment. | +| **Reconciling** | A reconciliation is in progress. | +| **Stalled** | A reconciliation is stuck because of an error that cannot be resolved without human intervention. | +| **Failed** | The deployment couldn't reconcile because of an unrecoverable error. | +| **Unknown** | The sync status of the deployment couldn't be retrieved. | +| **Unavailable** | The `Kustomization` or `HelmRelease` resource couldn't be retrieved. | + +Deployments rely on Flux `Kustomization` and `HelmRelease` resources to gather +the status of a given environment, which requires a namespace to be configured for the environment. +By default, GitLab searches the `Kustomization` and `HelmRelease` resources for the name of the project slug. +You can customize the name GitLab looks for in the environment settings. + ## Troubleshooting When working with the Dashboard for Kubernetes, you might encounter the following issues. |