Replaced tuned hard-included repo with a git submodule (#1029)

Until now tuned repo was hard included in the NTO repo.
This design could lead to developers mistakenly contribute to assets/tuned.
Instead of https://github.com/redhat-performance/tuned, as it is hard to realize it is an external repo.
Therefore, we chose to change this design by including the tuned repo as a git submodule, preventing mistakes as I described and better informing tuned is an external repo.

Signed-off-by: Ronny Baturov <[email protected]>

Author: rbaturov

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "assets/tuned/tuned"]
+	path = assets/tuned/tuned
+	url = https://github.com/redhat-performance/tuned.git

Dockerfile

@@ -1,6 +1,7 @@
 FROM registry.ci.openshift.org/openshift/release:golang-1.20 AS builder
 WORKDIR /go/src/github.com/openshift/cluster-node-tuning-operator
 COPY . .
+RUN make update-tuned-submodule
 RUN make build
 
 FROM quay.io/centos/centos:stream9 as tuned
@@ -10,7 +11,7 @@ RUN INSTALL_PKGS=" \
       gcc git rpm-build make desktop-file-utils patch dnf-plugins-core \
       " && \
     dnf install --setopt=tsflags=nodocs -y $INSTALL_PKGS && \
-    cd assets/tuned/daemon && \
+    cd assets/tuned/tuned && \
     LC_COLLATE=C cat ../patches/*.diff | patch -Np1 && \
     dnf build-dep tuned.spec -y && \
     make rpm PYTHON=/usr/bin/python3 && \

Makefile

@@ -13,9 +13,7 @@ GOFMT_CHECK=$(shell find . -not \( \( -wholename './.*' -o -wholename '*/vendor/
 REV=$(shell git describe --long --tags --match='v*' --always --dirty)
 
 # Upstream tuned daemon variables
-TUNED_REPO:=https://github.com/redhat-performance/tuned.git
-TUNED_COMMIT:=954bc4624db8fb345e9fb264ee2ac09d1736105a
-TUNED_DIR:=daemon
+TUNED_COMMIT:=HEAD
 
 # API-related variables
 API_TYPES_DIR:=pkg/apis
@@ -54,12 +52,13 @@ include $(addprefix ./vendor/github.com/openshift/build-machinery-go/make/, \
     targets/openshift/crd-schema-gen.mk \
 )
 
-clone-tuned:
-	(cd assets/tuned && \
-	  rm -rf $(TUNED_DIR) && \
-	  git clone -n $(TUNED_REPO) $(TUNED_DIR) && \
-	  cd $(TUNED_DIR) && git checkout $(TUNED_COMMIT) && cd .. && \
-	  rm -rf $(TUNED_DIR)/.git)
+# This target will be run in the Dockerfile to initialize the tuned submodule by cloning it.
+# Moreover, this can be used to update the tuned repo to a specific commit.
+update-tuned-submodule:
+	(git submodule update --init --force && \
+	  cd assets/tuned/tuned && \
+	  git pull origin master && \
+	  git checkout $(TUNED_COMMIT))
 
 build: $(BINDATA) pkg/generated build-performance-profile-creator build-gather-sysinfo
 	$(GO_BUILD_RECIPE)