2021-04-07 00:09:26 +00:00
---
stage: Configure
group: Configure
2022-09-21 21:13:33 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-04-07 00:09:26 +00:00
---
2021-10-27 21:11:33 +00:00
# Cluster integrations (DEPRECATED) **(FREE)**
2022-05-14 03:09:09 +00:00
> - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
> - [Disabled on self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/353410) in GitLab 15.0.
2021-10-27 21:11:33 +00:00
WARNING:
This feature was [deprecated ](https://gitlab.com/groups/gitlab-org/configure/-/epics/8 ) in GitLab 14.5.
2021-04-07 00:09:26 +00:00
2022-05-14 03:09:09 +00:00
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag ](../../administration/feature_flags.md ) named `certificate_based_clusters` .
2021-04-07 00:09:26 +00:00
GitLab provides several ways to integrate applications to your
Kubernetes cluster.
To enable cluster integrations, first add a Kubernetes cluster to a GitLab
2022-05-05 12:08:03 +00:00
[project ](../project/clusters/index.md ) or
2021-10-27 21:11:33 +00:00
[group ](../group/clusters/index.md ) or
2021-05-14 03:10:11 +00:00
[instance ](../instance/clusters/index.md ).
2021-04-07 00:09:26 +00:00
2021-06-10 21:10:02 +00:00
You can install your applications manually as shown in the following sections, or use the
[Cluster management project template ](management_project_template.md ) that automates the
installation.
Although, the [Cluster management project template ](management_project_template.md ) still
2022-06-22 12:08:59 +00:00
requires that you manually do the last steps of this section,
[Enable Prometheus integration for your cluster ](#enable-prometheus-integration-for-your-cluster ). [An issue exists ](https://gitlab.com/gitlab-org/gitlab/-/issues/326565 )
2021-08-03 00:10:34 +00:00
to automate this step.
2021-06-10 21:10:02 +00:00
2022-06-22 12:08:59 +00:00
Prometheus cluster integrations can only be enabled for clusters [connected through cluster certificates ](../project/clusters/add_existing_cluster.md ).
2021-10-20 18:12:31 +00:00
2022-02-22 00:14:20 +00:00
To enable Prometheus for your cluster connected through the [GitLab agent ](agent/index.md ), you can [integrate it manually ](../project/integrations/prometheus.md#manual-configuration-of-prometheus ).
2021-10-20 18:12:31 +00:00
2022-02-22 00:14:20 +00:00
There is no option to enable Elastic Stack for your cluster if it is connected with the GitLab agent.
2021-10-20 18:12:31 +00:00
Follow this [issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/300230 ) for updates.
2021-04-07 00:09:26 +00:00
## Prometheus cluster integration
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55244) in GitLab 13.11.
2021-10-27 21:11:33 +00:00
WARNING:
This feature was [deprecated ](https://gitlab.com/groups/gitlab-org/configure/-/epics/8 ) in GitLab 14.5. However, you can **still use** Prometheus
for Kubernetes clusters connected to GitLab through the
2022-02-22 00:14:20 +00:00
[agent ](agent/index.md ) by [enabling Prometheus manually ](../project/integrations/prometheus.md#manual-configuration-of-prometheus ).
2021-10-27 21:11:33 +00:00
2021-04-07 00:09:26 +00:00
You can integrate your Kubernetes cluster with
[Prometheus ](https://prometheus.io/ ) for monitoring key metrics of your
apps directly from the GitLab UI.
2021-05-14 03:10:11 +00:00
Once enabled, you can see metrics from services available in the
2021-04-07 00:09:26 +00:00
[metrics library ](../project/integrations/prometheus_library/index.md ).
2021-05-14 03:10:11 +00:00
### Prometheus Prerequisites
2021-04-07 00:09:26 +00:00
2021-05-14 03:10:11 +00:00
To use this integration:
2021-04-07 00:09:26 +00:00
2021-05-14 03:10:11 +00:00
1. Prometheus must be installed in your cluster in the `gitlab-managed-apps` namespace.
2021-04-07 00:09:26 +00:00
1. The `Service` resource for Prometheus must be named `prometheus-prometheus-server` .
2021-05-14 03:10:11 +00:00
You can manage your Prometheus however you like, but as an example, you can set
it up using [Helm ](https://helm.sh/ ) as follows:
2021-04-07 00:09:26 +00:00
```shell
2021-05-14 03:10:11 +00:00
# Create the required Kubernetes namespace
2021-04-07 00:09:26 +00:00
kubectl create ns gitlab-managed-apps
# Download Helm chart values that is compatible with the requirements above.
2021-06-10 21:10:02 +00:00
# These are included in the Cluster Management project template.
wget https://gitlab.com/gitlab-org/project-templates/cluster-management/-/raw/master/applications/prometheus/values.yaml
2021-04-07 00:09:26 +00:00
2021-05-14 03:10:11 +00:00
# Add the Prometheus community Helm chart repository
2021-04-07 00:09:26 +00:00
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
# Install Prometheus
helm install prometheus prometheus-community/prometheus -n gitlab-managed-apps --values values.yaml
```
Alternatively, you can use your preferred installation method to install
Prometheus as long as you meet the requirements above.
### Enable Prometheus integration for your cluster
To enable the Prometheus integration for your cluster:
1. Go to the cluster's page:
- For a [project-level cluster ](../project/clusters/index.md ), navigate to your project's
2021-06-16 00:10:15 +00:00
**Infrastructure > Kubernetes clusters** .
2021-04-07 00:09:26 +00:00
- For a [group-level cluster ](../group/clusters/index.md ), navigate to your group's
**Kubernetes** page.
2021-05-14 03:10:11 +00:00
- For an [instance-level cluster ](../instance/clusters/index.md ), navigate to your instance's
**Kubernetes** page.
1. Select the **Integrations** tab.
1. Check the **Enable Prometheus integration** checkbox.
2022-05-24 21:09:08 +00:00
1. Select **Save changes** .
2021-05-14 03:10:11 +00:00
1. Go to the **Health** tab to see your cluster's metrics.