Cluster integrations

GitLab provides several ways to integrate applications to your Kubernetes cluster.

To enable cluster integrations, first add a Kubernetes cluster to a GitLab project or group or instance.

You can install your applications manually as shown in the following sections, or use the Cluster management project template that automates the installation.

Although, the Cluster management project template still requires that you manually do the last steps of these sections, Enable Prometheus integration for your cluster or Enable Elastic Stack integration for your cluster depending on which application you are installing. An issue exists to automate this step.

Prometheus cluster integration

Introduced in GitLab 13.11.

You can integrate your Kubernetes cluster with Prometheus for monitoring key metrics of your apps directly from the GitLab UI.

Once enabled, you can see metrics from services available in the metrics library.

Prometheus Prerequisites

To use this integration:

  1. Prometheus must be installed in your cluster in the gitlab-managed-apps namespace.
  2. The Service resource for Prometheus must be named prometheus-prometheus-server.

You can manage your Prometheus however you like, but as an example, you can set it up using Helm as follows:

# Create the required Kubernetes namespace
kubectl create ns gitlab-managed-apps

# Download Helm chart values that is compatible with the requirements above.
# 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

# Add the Prometheus community Helm chart repository
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:
  2. Select the Integrations tab.
  3. Check the Enable Prometheus integration checkbox.
  4. Click Save changes.
  5. Go to the Health tab to see your cluster’s metrics.

Elastic Stack cluster integration

Introduced in GitLab 13.12.

You can integrate your cluster with Elastic Stack to index and query your pod logs.

Elastic Stack Prerequisites

To use this integration:

  1. Elasticsearch 7.x or must be installed in your cluster in the gitlab-managed-apps namespace.
  2. The Service resource must be called elastic-stack-elasticsearch-master and expose the Elasticsearch API on port 9200.
  3. The logs are expected to be Filebeat container logs following the 7.x log structure and include Kubernetes metadata.

You can manage your Elastic Stack however you like, but as an example, you can use this Elastic Stack chart to get up and running:

# Create the required Kubernetes namespace
kubectl create namespace gitlab-managed-apps

# Download Helm chart values that is compatible with the requirements above.
# These are included in the Cluster Management project template.
wget https://gitlab.com/gitlab-org/project-templates/cluster-management/-/raw/master/applications/elastic-stack/values.yaml

# Add the GitLab Helm chart repository
helm repo add gitlab https://charts.gitlab.io

# Install Elastic Stack
helm install elastic-stack gitlab/elastic-stack -n gitlab-managed-apps --values values.yaml

Enable Elastic Stack integration for your cluster

To enable the Elastic Stack integration for your cluster:

  1. Go to the cluster’s page:
  2. Select the Integrations tab.
  3. Check the Enable Elastic Stack integration checkbox.
  4. Click Save changes.
  5. Go to the Health tab to see your cluster’s metrics.