Add image source

Author: ciarams87

Makefile

@@ -45,7 +45,7 @@ build-images-with-plus: build-ngf-image build-nginx-plus-image ## Build the NGF
 
 .PHONY: build-ngf-image
 build-ngf-image: check-for-docker build ## Build the NGF docker image
-	docker build --platform linux/$(GOARCH) --target $(strip $(TARGET)) -f build/Dockerfile -t $(strip $(PREFIX)):$(strip $(TAG)) .
+	docker build --platform linux/$(GOARCH) --build-arg BUILD_AGENT=$(BUILD_AGENT) --target $(strip $(TARGET)) -f build/Dockerfile -t $(strip $(PREFIX)):$(strip $(TAG)) .
 
 .PHONY: build-nginx-image
 build-nginx-image: check-for-docker ## Build the custom nginx image

build/Dockerfile

@@ -27,6 +27,8 @@ RUN setcap 'cap_kill=+ep' /usr/bin/gateway
 
 FROM scratch as common
 USER 102:1001
+ARG BUILD_AGENT
+ENV BUILD_AGENT=${BUILD_AGENT}
 ENTRYPOINT [ "/usr/bin/gateway" ]
 
 FROM common as container

internal/mode/static/telemetry/collector.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
@@ -51,8 +52,9 @@ type ProjectMetadata struct {
 type Data struct {
 	ProjectMetadata   ProjectMetadata
 	ClusterID         string
-	NodeCount         int
+	ImageSource       string
 	NGFResourceCounts NGFResourceCounts
+	NodeCount         int
 	NGFReplicaCount   int
 }
 
@@ -106,6 +108,8 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 		return Data{}, fmt.Errorf("failed to collect clusterID: %w", err)
 	}
 
+	imageSource := CollectImageSource()
+
 	data := Data{
 		NodeCount:         nodeCount,
 		NGFResourceCounts: graphResourceCount,
@@ -115,6 +119,7 @@ func (c DataCollectorImpl) Collect(ctx context.Context) (Data, error) {
 		},
 		NGFReplicaCount: ngfReplicaCount,
 		ClusterID:       clusterID,
+		ImageSource:     imageSource,
 	}
 
 	return data, nil
@@ -214,3 +219,14 @@ func CollectClusterID(ctx context.Context, k8sClient client.Reader) (string, err
 	}
 	return string(kubeNamespace.GetUID()), nil
 }
+
+// CollectImageSource gets the source of the NGF image. This is done by inspecting the BUILD_AGENT environment variable.
+// Valid sources are: "gha" for images built using GitHub Actions in the pipeline, or "local".
+// If the environment variable is not set to one of these, the source is "unknown"
+func CollectImageSource() string {
+	buildAgent := os.Getenv("BUILD_AGENT")
+	if buildAgent != "gha" && buildAgent != "local" {
+		buildAgent = "unknown"
+	}
+	return buildAgent
+}

internal/mode/static/telemetry/collector_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"reflect"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -63,6 +64,10 @@ func createGetCallsFunc(objects ...client.Object) getCallsFunc {
 	}
 }
 
+func setEnvVar(key, value string) {
+	os.Setenv(key, value)
+}
+
 var _ = Describe("Collector", Ordered, func() {
 	var (
 		k8sClientReader         *eventsfakes.FakeReader
@@ -123,6 +128,7 @@ var _ = Describe("Collector", Ordered, func() {
 			NGFResourceCounts: telemetry.NGFResourceCounts{},
 			NGFReplicaCount:   1,
 			ClusterID:         string(kubeNamespace.GetUID()),
+			ImageSource:       "unknown",
 		}
 
 		k8sClientReader = &eventsfakes.FakeReader{}
@@ -475,6 +481,48 @@ var _ = Describe("Collector", Ordered, func() {
 		})
 	})
 
+	Describe("Image source collector", func() {
+		When("collecting image source", func() {
+			When("the NGF pod's build agent env var is set to gha", func() {
+				It("collects the image source as gha", func() {
+					setEnvVar("BUILD_AGENT", "gha")
+					expData.ImageSource = "gha"
+
+					data, err := dataCollector.Collect(ctx)
+
+					Expect(err).To(BeNil())
+					Expect(expData).To(Equal(data))
+				})
+			})
+		})
+		When("collecting image source", func() {
+			When("the NGF pod's build agent env var is set to local", func() {
+				It("collects the image source as local", func() {
+					setEnvVar("BUILD_AGENT", "local")
+					expData.ImageSource = "local"
+
+					data, err := dataCollector.Collect(ctx)
+
+					Expect(err).To(BeNil())
+					Expect(expData).To(Equal(data))
+				})
+			})
+		})
+		When("collecting image source", func() {
+			When("the NGF pod's build agent env var is set to anything else", func() {
+				It("collects the image source as unknown", func() {
+					setEnvVar("BUILD_AGENT", "something-else")
+					expData.ImageSource = "unknown"
+
+					data, err := dataCollector.Collect(ctx)
+
+					Expect(err).To(BeNil())
+					Expect(expData).To(Equal(data))
+				})
+			})
+		})
+	})
+
 	Describe("NGF replica count collector", func() {
 		When("collecting NGF replica count", func() {
 			When("it encounters an error while collecting data", func() {