Merge branch 'ee-k8s_new_deployment_labels' into 'master'

Update dashboards to additionally use new environment selector

Closes #10135

See merge request gitlab-org/gitlab-ee!9759

app/models/clusters/platforms/kubernetes.rb

@@ -110,7 +110,7 @@ module Clusters
       # short time later
       def terminals(environment)
         with_reactive_cache do |data|
-          pods = filter_by_label(data[:pods], app: environment.slug)
+          pods = filter_by_project_environment(data[:pods], project.full_path_slug, environment.slug)
           terminals = pods.flat_map { |pod| terminals_for_pod(api_url, actual_namespace, pod) }.compact
           terminals.each { |terminal| add_terminal_auth(terminal, terminal_auth) }
         end

app/models/project_services/kubernetes_service.rb

@@ -131,8 +131,8 @@ class KubernetesService < DeploymentService
   # short time later
   def terminals(environment)
     with_reactive_cache do |data|
-      pods = filter_by_label(data[:pods], app: environment.slug)
-      terminals = pods.flat_map { |pod| terminals_for_pod(api_url, actual_namespace, pod) }
+      pods = filter_by_project_environment(data[:pods], project.full_path_slug, environment.slug)
+      terminals = pods.flat_map { |pod| terminals_for_pod(api_url, actual_namespace, pod) }.compact
       terminals.each { |terminal| add_terminal_auth(terminal, terminal_auth) }
     end
   end

changelogs/unreleased/k8s_new_deployment_labels.yml

+---
+title: Update deploy boards to additionally select on "app.gitlab.com" annotations
+merge_request: 25623
+author:
+type: changed

doc/user/project/deploy_boards.md

@@ -73,15 +73,21 @@ To display the Deploy Boards for a specific [environment] you should:
 1. Configure the [Kubernetes service][kube-service] in your project for the
    cluster. The Kubernetes namespace is of particular note as you will need it
    for your deployment scripts (exposed by the `KUBE_NAMESPACE` env variable).
-1. Ensure a Kubernetes label of `app: $CI_ENVIRONMENT_SLUG` is applied to the
-   deployments, replica sets, and pods, where `$CI_ENVIRONMENT_SLUG` the value
-   of the CI variable. This is so we can lookup the proper environment in a
-   cluster/namespace which may have more than one. These resources should be
-   contained in the namespace defined in the Kubernetes service setting.
-   You can use an [Autodeploy] `.gitlab-ci.yml` template which has predefined
-   stages and commands to use, and automatically applies the labeling.
-   Each project will need to have a unique namespace in Kubernetes as well.
-   The image below demonstrates how this is shown inside Kubernetes.
+1. Ensure Kubernetes annotations of `app.gitlab.com/env: $CI_ENVIRONMENT_SLUG`
+   and `app.gitlab.com/app: $CI_PROJECT_PATH_SLUG` are applied to the
+   deployments, replica sets, and pods, where `$CI_ENVIRONMENT_SLUG` and
+   `$CI_PROJECT_PATH_SLUG` are the values of the CI variables. This is so we can
+   lookup the proper environment in a cluster/namespace which may have more
+   than one. These resources should be contained in the namespace defined in
+   the Kubernetes service setting. You can use an [Autodeploy] `.gitlab-ci.yml`
+   template which has predefined stages and commands to use, and automatically
+   applies the annotations. Each project will need to have a unique namespace in
+   Kubernetes as well. The image below demonstrates how this is shown inside
+   Kubernetes.
+
+   NOTE: **Note:**
+   The Kubernetes label of `app` is deprecated and will not be used for deploy
+   boards in the future.
 
     ![Deploy Boards Kubernetes Label](img/deploy_boards_kubernetes_label.png)
 

ee/app/models/concerns/ee/kubernetes_service.rb

@@ -8,8 +8,8 @@ module EE
 
     def rollout_status(environment)
       result = with_reactive_cache do |data|
-        deployments = filter_by_label(data[:deployments], app: environment.slug)
-        pods = filter_by_label(data[:pods], app: environment.slug) if data[:pods]&.any?
+        deployments = filter_by_project_environment(data[:deployments], project.full_path_slug, environment.slug)
+        pods = filter_by_project_environment(data[:pods], project.full_path_slug, environment.slug) if data[:pods]&.any?
 
         ::Gitlab::Kubernetes::RolloutStatus.from_deployments(*deployments, pods: pods)
       end

ee/lib/gitlab/kubernetes/deployment.rb

@@ -20,6 +20,10 @@ module Gitlab
         metadata.fetch('labels', {})
       end
 
+      def annotations
+        metadata.fetch('annotations', {})
+      end
+
       def track
         labels.fetch('track', STABLE_TRACK_VALUE)
       end

ee/spec/models/project_services/kubernetes_service_spec.rb

@@ -13,17 +13,24 @@ describe KubernetesService, models: true, use_clean_rails_memory_store_caching:
       subject(:rollout_status) { service.rollout_status(environment) }
 
       context 'with valid deployments' do
+        let(:matched_deployment) { kube_deployment(environment_slug: environment.slug, project_slug: project.full_path_slug) }
+        let(:unmatched_deployment) { kube_deployment }
+        let(:matched_pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug) }
+        let(:unmatched_pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug, status: 'Pending') }
+
         before do
           stub_reactive_cache(
             service,
-            deployments: [kube_deployment(app: environment.slug), kube_deployment],
-            pods: [kube_pod(app: environment.slug), kube_pod(app: environment.slug, status: 'Pending')]
+            deployments: [matched_deployment, unmatched_deployment],
+            pods: [matched_pod, unmatched_pod]
           )
         end
 
         it 'creates a matching RolloutStatus' do
           expect(rollout_status).to be_kind_of(::Gitlab::Kubernetes::RolloutStatus)
-          expect(rollout_status.deployments.map(&:labels)).to eq([{ 'app' => 'env-000000' }])
+          expect(rollout_status.deployments.map(&:annotations)).to eq([
+            { 'app.gitlab.com/app' => project.full_path_slug, 'app.gitlab.com/env' => 'env-000000' }
+          ])
         end
       end
 

lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml

@@ -697,6 +697,8 @@ rollout 100%:
       helm upgrade --install \
         --wait \
         --set service.enabled="$service_enabled" \
+        --set gitlab.app="$CI_PROJECT_PATH_SLUG" \
+        --set gitlab.env="$CI_ENVIRONMENT_SLUG" \
         --set releaseOverride="$CI_ENVIRONMENT_SLUG" \
         --set image.repository="$CI_APPLICATION_REPOSITORY" \
         --set image.tag="$CI_APPLICATION_TAG" \
@@ -734,6 +736,8 @@ rollout 100%:
       helm upgrade --install \
         --wait \
         --set service.enabled="$service_enabled" \
+        --set gitlab.app="$CI_PROJECT_PATH_SLUG" \
+        --set gitlab.env="$CI_ENVIRONMENT_SLUG" \
         --set releaseOverride="$CI_ENVIRONMENT_SLUG" \
         --set image.repository="$CI_APPLICATION_REPOSITORY" \
         --set image.tag="$CI_APPLICATION_TAG" \

lib/gitlab/kubernetes.rb

@@ -24,6 +24,30 @@ module Gitlab
       end
     end
 
+    # Filters an array of pods (as returned by the kubernetes API) by their annotations
+    def filter_by_annotation(items, annotations = {})
+      items.select do |item|
+        metadata = item.fetch("metadata", {})
+        item_annotations = metadata.fetch("annotations", nil)
+        next unless item_annotations
+
+        annotations.all? { |k, v| item_annotations[k.to_s] == v }
+      end
+    end
+
+    # Filters an array of pods (as returned by the kubernetes API) by their project and environment
+    def filter_by_project_environment(items, app, env)
+      pods = filter_by_annotation(items, {
+        'app.gitlab.com/app' => app,
+        'app.gitlab.com/env' => env
+      })
+      return pods unless pods.empty?
+
+      filter_by_label(items, {
+        'app' => env, # deprecated: replaced by app.gitlab.com/env
+      })
+    end
+
     # Converts a pod (as returned by the kubernetes API) into a terminal
     def terminals_for_pod(api_url, namespace, pod)
       metadata = pod.fetch("metadata", {})

spec/lib/gitlab/kubernetes_spec.rb

@@ -40,10 +40,40 @@ describe Gitlab::Kubernetes do
 
   describe '#filter_by_label' do
     it 'returns matching labels' do
-      matching_items = [kube_pod(app: 'foo'), kube_deployment(app: 'foo')]
+      matching_items = [kube_pod(track: 'foo'), kube_deployment(track: 'foo')]
       items = matching_items + [kube_pod, kube_deployment]
 
-      expect(filter_by_label(items, app: 'foo')).to eq(matching_items)
+      expect(filter_by_label(items, 'track' => 'foo')).to eq(matching_items)
+    end
+  end
+
+  describe '#filter_by_annotation' do
+    it 'returns matching labels' do
+      matching_items = [kube_pod(environment_slug: 'foo'), kube_deployment(environment_slug: 'foo')]
+      items = matching_items + [kube_pod, kube_deployment]
+
+      expect(filter_by_annotation(items, 'app.gitlab.com/env' => 'foo')).to eq(matching_items)
+    end
+  end
+
+  describe '#filter_by_project_environment' do
+    let(:matching_pod) { kube_pod(environment_slug: 'production', project_slug: 'my-cool-app') }
+
+    it 'returns matching legacy env label' do
+      matching_pod['metadata']['annotations'].delete('app.gitlab.com/app')
+      matching_pod['metadata']['annotations'].delete('app.gitlab.com/env')
+      matching_pod['metadata']['labels']['app'] = 'production'
+      matching_items = [matching_pod]
+      items = matching_items + [kube_pod]
+
+      expect(filter_by_project_environment(items, 'my-cool-app', 'production')).to eq(matching_items)
+    end
+
+    it 'returns matching env label' do
+      matching_items = [matching_pod]
+      items = matching_items + [kube_pod]
+
+      expect(filter_by_project_environment(items, 'my-cool-app', 'production')).to eq(matching_items)
     end
   end
 

spec/models/clusters/platforms/kubernetes_spec.rb

@@ -375,14 +375,14 @@ describe Clusters::Platforms::Kubernetes, :use_clean_rails_memory_store_caching
     end
 
     context 'with valid pods' do
-      let(:pod) { kube_pod(app: environment.slug) }
-      let(:pod_with_no_terminal) { kube_pod(app: environment.slug, status: "Pending") }
+      let(:pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug) }
+      let(:pod_with_no_terminal) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug, status: "Pending") }
       let(:terminals) { kube_terminals(service, pod) }
 
       before do
         stub_reactive_cache(
           service,
-          pods: [pod, pod, pod_with_no_terminal, kube_pod(app: "should-be-filtered-out")]
+          pods: [pod, pod, pod_with_no_terminal, kube_pod(environment_slug: "should-be-filtered-out")]
         )
       end
 

spec/models/project_services/kubernetes_service_spec.rb

@@ -323,13 +323,14 @@ describe KubernetesService, :use_clean_rails_memory_store_caching do
     end
 
     context 'with valid pods' do
-      let(:pod) { kube_pod(app: environment.slug) }
+      let(:pod) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug) }
+      let(:pod_with_no_terminal) { kube_pod(environment_slug: environment.slug, project_slug: project.full_path_slug, status: "Pending") }
       let(:terminals) { kube_terminals(service, pod) }
 
       before do
         stub_reactive_cache(
           service,
-          pods: [pod, pod, kube_pod(app: "should-be-filtered-out")]
+          pods: [pod, pod, pod_with_no_terminal, kube_pod(environment_slug: "should-be-filtered-out")]
         )
       end
 

spec/support/helpers/kubernetes_helpers.rb

@@ -250,16 +250,19 @@ module KubernetesHelpers
 
   # This is a partial response, it will have many more elements in reality but
   # these are the ones we care about at the moment
-  def kube_pod(name: "kube-pod", app: "valid-pod-label", status: "Running", track: nil)
+  def kube_pod(name: "kube-pod", environment_slug: "production", project_slug: "project-path-slug", status: "Running", track: nil)
     {
       "metadata" => {
         "name" => name,
         "generate_name" => "generated-name-with-suffix",
         "creationTimestamp" => "2016-11-25T19:55:19Z",
+        "annotations" => {
+          "app.gitlab.com/env" => environment_slug,
+          "app.gitlab.com/app" => project_slug
+        },
         "labels" => {
-          "app" => app,
           "track" => track
-        }
+        }.compact
       },
       "spec" => {
         "containers" => [
@@ -293,13 +296,16 @@ module KubernetesHelpers
     }
   end
 
-  def kube_deployment(name: "kube-deployment", app: "valid-deployment-label", track: nil)
+  def kube_deployment(name: "kube-deployment", environment_slug: "production", project_slug: "project-path-slug", track: nil)
     {
       "metadata" => {
         "name" => name,
         "generation" => 4,
+        "annotations" => {
+          "app.gitlab.com/env" => environment_slug,
+          "app.gitlab.com/app" => project_slug
+        },
         "labels" => {
-          "app" => app,
           "track" => track
         }.compact
       },