Merge pull request redhat-developer#1088 from olivergondza/fix-intellij-idea-integration

chore(deps): Replace k8s deps that have version 0.0.0

Author: olivergondza

Dockerfile

@@ -16,8 +16,9 @@ COPY controllers/ controllers/
 COPY common/ common/
 COPY version/ version/
 
-# Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager ./cmd/main.go
+# Build - Use TARGETARCH to build for the correct architecture
+ARG TARGETARCH
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=${TARGETARCH} go build -a -o manager ./cmd/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -65,7 +65,8 @@ IMG ?= $(IMAGE):$(VERSION)
 # Set the Operator SDK version to use.
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
 OPERATOR_SDK_VERSION ?= v1.35.0
-
+# Set the path to Operator SDK - OPERATOR_SDK_VERSION will be ignored.
+OPERATOR_SDK ?= bin/operator-sdk
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -131,19 +132,6 @@ test-e2e: manifests generate fmt vet ## Run e2e tests.
 test-metrics:
 	go test -timeout 30m ./test/e2e -ginkgo.focus="Argo CD metrics controller" -coverprofile cover.out -ginkgo.v
 
-.PHONY: operator-sdk
-OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
-operator-sdk: ## Download operator-sdk locally if necessary.
-ifeq (,$(wildcard $(OPERATOR_SDK)))
-	@{ \
-	set -e ;\
-	mkdir -p $(dir $(OPERATOR_SDK)) ;\
-	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	curl -sSLo $(OPERATOR_SDK) https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$${OS}_$${ARCH} ;\
-	chmod +x $(OPERATOR_SDK) ;\
-	}
-endif
-
 .PHONY: test-route
 test-route:
 	go test -timeout 30m ./test/e2e -ginkgo.focus="Argo CD ConsoleLink controller" -coverprofile cover.out -ginkgo.v
@@ -211,7 +199,7 @@ build: generate fmt vet ## Build manager binary.
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
-	CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES=argo-rollouts,test-rom-ns-1,rom-ns-1,openshift-gitops  ARGOCD_CLUSTER_CONFIG_NAMESPACES="openshift-gitops, argocd-e2e-cluster-config, argocd-test-impersonation-1-046, argocd-agent-principal-1-051, argocd-agent-agent-1-052, appset-argocd, appset-old-ns, appset-new-ns, ns-hosting-principal, ns-hosting-managed-agent, ns-hosting-autonomous-agent"  REDIS_CONFIG_PATH="build/redis"   go run ./cmd/main.go
+	CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES=argo-rollouts,test-rom-ns-1,rom-ns-1,openshift-gitops  ARGOCD_CLUSTER_CONFIG_NAMESPACES="openshift-gitops, argocd-e2e-cluster-config, argocd-test-impersonation-1-046, argocd-agent-principal-1-051, argocd-agent-agent-1-052, appset-argocd, appset-old-ns, appset-new-ns, ns-hosting-principal, ns-hosting-managed-agent, ns-hosting-autonomous-agent, appset-argocd-clusterrole"  REDIS_CONFIG_PATH="build/redis"   go run ./cmd/main.go
 
 .PHONY: docker-build
 docker-build: test ## Build container image with the manager.
@@ -223,27 +211,17 @@ docker-push: ## Push container image with the manager.
 
 ##@ Build Dependencies
 
-## Location to install dependencies to
-LOCALBIN ?= $(shell pwd)/bin
-$(LOCALBIN):
-	mkdir -p $(LOCALBIN)
+# Do not use OPERATOR_SDK variable not to overwrite the user provided path
+bin/operator-sdk:
+	mkdir -p bin
+	curl -sSLo bin/operator-sdk \
+		https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$(shell go env GOOS)_$(shell go env GOARCH)
+	chmod +x bin/operator-sdk
 
+# Install to bin/operator-sdk unless already there or explicit OPERATOR_SDK provided
 .PHONY: operator-sdk
-OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
-operator-sdk: ## Download operator-sdk locally if necessary.
-ifeq (,$(wildcard $(OPERATOR_SDK)))
-ifeq (,$(shell which operator-sdk 2>/dev/null))
-	@{ \
-	set -e ;\
-	mkdir -p $(dir $(OPERATOR_SDK)) ;\
-	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	curl -sSLo $(OPERATOR_SDK) https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)/operator-sdk_$${OS}_$${ARCH} ;\
-	chmod +x $(OPERATOR_SDK) ;\
-	}
-else
-OPERATOR_SDK = $(shell which operator-sdk)
-endif
-endif
+operator-sdk: $(OPERATOR_SDK)
+	@$(OPERATOR_SDK) version
 
 ifndef ignore-not-found
   ignore-not-found = false
@@ -368,7 +346,7 @@ gosec: go_sec
 .PHONY: lint
 lint: golangci_lint
 	$(GOLANGCI_LINT) --version
-	GOMAXPROCS=2 $(GOLANGCI_LINT) run --fix --verbose --timeout 300s
+	$(GOLANGCI_LINT) run --fix --verbose --timeout 300s
 
 
 GO_SEC = $(shell pwd)/bin/gosec

docs/Lightspeed BYOK Gitops configuration guide.md

@@ -0,0 +1,49 @@
+# Enhancing OpenShift Lightspeed with Custom Knowledge
+
+## Overview
+This guide explains how to extend the intelligence of OpenShift Lightspeed by integrating specialized knowledge for Argo CD, the Argo CD Operator, and the GitOps Operator. By configuring a custom Retrieval-Augmented Generation (RAG) database, you ensure the service provides precise, context-aware assistance for your GitOps queries.
+
+The OpenShift Lightspeed service leverages Large Language Models (LLMs) to provide intelligent, context-aware responses. To ensure the model has deep expertise in your specific environment, you can use the Bring Your Own (BYO) Knowledge tool to integrate a Retrieval-Augmented Generation (RAG) database.
+
+By connecting this database, you bridge the gap between general AI knowledge and specific technical documentation, ensuring more accurate troubleshooting and configuration advice.
+
+
+## Pre-packaged Knowledge for GitOps
+We have curated and optimized specialized knowledge sets for the following components:
+
+* ArgoCD
+* ArgoCD Operator
+* Red Hat OpenShift GitOps Operator
+* ArgoCD Agent
+
+This knowledge is packaged into a container [image](https://quay.io/devtools_gitops/argocd_lightspeed_byok:v0.0.4) and can be configured in Lightspeed using the instructions below.
+
+## Prerequisites
+
+* You are logged in to the OpenShift Container Platform web console as a user account that has permission to create a cluster-scoped custom resource (CR) file, such as a user with the cluster-admin role.
+* You have an LLM provider available for use with the OpenShift Lightspeed Service.
+* You have installed and configured the [OpenShift Lightspeed Operator](https://docs.redhat.com/en/documentation/red_hat_openshift_lightspeed/1.0/html/configure/ols-configuring-openshift-lightspeed).
+
+Modify the OLSconfig CR to deploy the pre-packaged RAG database alongside the existing one:
+
+* In the OpenShift Container Platform web console, click Operators  >> Installed Operators.
+* Select All Projects in the Project dropdown at the top of the screen.
+* Click OpenShift Lightspeed Operator.
+* Click OLSConfig, then click the cluster configuration instance in the list.
+* Click the YAML tab.
+* Insert the spec.ols.rag yaml code:
+  Example OLSconfig CR file
+
+```bash
+apiVersion: ols.openshift.io/v1alpha1
+kind: OLSConfig
+metadata:
+  name: cluster
+spec:
+  ols:
+    rag:
+      - image: quay.io/devtools_gitops/argocd_lightspeed_byok:v0.0.4
+```
+
+Note: Where image specifies the tag for the image that is present in the image registry so that the OpenShift Lightspeed Operator can access the custom content.
+* Click Save.

go.mod

@@ -198,6 +198,7 @@ require (
 )
 
 replace (
+	// This replace block is from Argo CD v3.3.0 go.mod
 	github.com/golang/protobuf => github.com/golang/protobuf v1.5.4
 	github.com/grpc-ecosystem/grpc-gateway => github.com/grpc-ecosystem/grpc-gateway v1.16.0
 
@@ -206,4 +207,38 @@ replace (
 
 	// Avoid CVE-2022-28948
 	gopkg.in/yaml.v3 => gopkg.in/yaml.v3 v3.0.1
+
+	// This replace block is from Argo CD v3.3.0 go.mod
+	k8s.io/api => k8s.io/api v0.34.0
+	k8s.io/apiextensions-apiserver => k8s.io/apiextensions-apiserver v0.34.0
+	k8s.io/apimachinery => k8s.io/apimachinery v0.34.0
+	k8s.io/apiserver => k8s.io/apiserver v0.34.0
+	k8s.io/cli-runtime => k8s.io/cli-runtime v0.34.0
+	k8s.io/client-go => k8s.io/client-go v0.34.0
+	k8s.io/cloud-provider => k8s.io/cloud-provider v0.34.0
+	k8s.io/cluster-bootstrap => k8s.io/cluster-bootstrap v0.34.0
+	k8s.io/code-generator => k8s.io/code-generator v0.34.0
+	k8s.io/component-base => k8s.io/component-base v0.34.0
+	k8s.io/component-helpers => k8s.io/component-helpers v0.34.0
+	k8s.io/controller-manager => k8s.io/controller-manager v0.34.0
+	k8s.io/cri-api => k8s.io/cri-api v0.34.0
+	k8s.io/cri-client => k8s.io/cri-client v0.34.0
+	k8s.io/csi-translation-lib => k8s.io/csi-translation-lib v0.34.0
+	k8s.io/dynamic-resource-allocation => k8s.io/dynamic-resource-allocation v0.34.0
+	k8s.io/endpointslice => k8s.io/endpointslice v0.34.0
+	k8s.io/externaljwt => k8s.io/externaljwt v0.34.0
+	k8s.io/kms => k8s.io/kms v0.34.0
+	k8s.io/kube-aggregator => k8s.io/kube-aggregator v0.34.0
+	k8s.io/kube-controller-manager => k8s.io/kube-controller-manager v0.34.0
+	k8s.io/kube-proxy => k8s.io/kube-proxy v0.34.0
+	k8s.io/kube-scheduler => k8s.io/kube-scheduler v0.34.0
+	k8s.io/kubectl => k8s.io/kubectl v0.34.0
+	k8s.io/kubelet => k8s.io/kubelet v0.34.0
+	k8s.io/legacy-cloud-providers => k8s.io/legacy-cloud-providers v0.34.0
+	k8s.io/metrics => k8s.io/metrics v0.34.0
+	k8s.io/mount-utils => k8s.io/mount-utils v0.34.0
+	k8s.io/pod-security-admission => k8s.io/pod-security-admission v0.34.0
+	k8s.io/sample-apiserver => k8s.io/sample-apiserver v0.34.0
+	k8s.io/sample-cli-plugin => k8s.io/sample-cli-plugin v0.34.0
+	k8s.io/sample-controller => k8s.io/sample-controller v0.34.0
 )

go.sum

@@ -654,20 +654,20 @@ gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
-k8s.io/api v0.34.1 h1:jC+153630BMdlFukegoEL8E/yT7aLyQkIVuwhmwDgJM=
-k8s.io/api v0.34.1/go.mod h1:SB80FxFtXn5/gwzCoN6QCtPD7Vbu5w2n1S0J5gFfTYk=
-k8s.io/apiextensions-apiserver v0.34.1 h1:NNPBva8FNAPt1iSVwIE0FsdrVriRXMsaWFMqJbII2CI=
-k8s.io/apiextensions-apiserver v0.34.1/go.mod h1:hP9Rld3zF5Ay2Of3BeEpLAToP+l4s5UlxiHfqRaRcMc=
-k8s.io/apimachinery v0.34.1 h1:dTlxFls/eikpJxmAC7MVE8oOeP1zryV7iRyIjB0gky4=
-k8s.io/apimachinery v0.34.1/go.mod h1:/GwIlEcWuTX9zKIg2mbw0LRFIsXwrfoVxn+ef0X13lw=
-k8s.io/apiserver v0.34.1 h1:U3JBGdgANK3dfFcyknWde1G6X1F4bg7PXuvlqt8lITA=
-k8s.io/apiserver v0.34.1/go.mod h1:eOOc9nrVqlBI1AFCvVzsob0OxtPZUCPiUJL45JOTBG0=
+k8s.io/api v0.34.0 h1:L+JtP2wDbEYPUeNGbeSa/5GwFtIA662EmT2YSLOkAVE=
+k8s.io/api v0.34.0/go.mod h1:YzgkIzOOlhl9uwWCZNqpw6RJy9L2FK4dlJeayUoydug=
+k8s.io/apiextensions-apiserver v0.34.0 h1:B3hiB32jV7BcyKcMU5fDaDxk882YrJ1KU+ZSkA9Qxoc=
+k8s.io/apiextensions-apiserver v0.34.0/go.mod h1:hLI4GxE1BDBy9adJKxUxCEHBGZtGfIg98Q+JmTD7+g0=
+k8s.io/apimachinery v0.34.0 h1:eR1WO5fo0HyoQZt1wdISpFDffnWOvFLOOeJ7MgIv4z0=
+k8s.io/apimachinery v0.34.0/go.mod h1:/GwIlEcWuTX9zKIg2mbw0LRFIsXwrfoVxn+ef0X13lw=
+k8s.io/apiserver v0.34.0 h1:Z51fw1iGMqN7uJ1kEaynf2Aec1Y774PqU+FVWCFV3Jg=
+k8s.io/apiserver v0.34.0/go.mod h1:52ti5YhxAvewmmpVRqlASvaqxt0gKJxvCeW7ZrwgazQ=
 k8s.io/cli-runtime v0.34.0 h1:N2/rUlJg6TMEBgtQ3SDRJwa8XyKUizwjlOknT1mB2Cw=
 k8s.io/cli-runtime v0.34.0/go.mod h1:t/skRecS73Piv+J+FmWIQA2N2/rDjdYSQzEE67LUUs8=
-k8s.io/client-go v0.34.1 h1:ZUPJKgXsnKwVwmKKdPfw4tB58+7/Ik3CrjOEhsiZ7mY=
-k8s.io/client-go v0.34.1/go.mod h1:kA8v0FP+tk6sZA0yKLRG67LWjqufAoSHA2xVGKw9Of8=
-k8s.io/component-base v0.34.1 h1:v7xFgG+ONhytZNFpIz5/kecwD+sUhVE6HU7qQUiRM4A=
-k8s.io/component-base v0.34.1/go.mod h1:mknCpLlTSKHzAQJJnnHVKqjxR7gBeHRv0rPXA7gdtQ0=
+k8s.io/client-go v0.34.0 h1:YoWv5r7bsBfb0Hs2jh8SOvFbKzzxyNo0nSb0zC19KZo=
+k8s.io/client-go v0.34.0/go.mod h1:ozgMnEKXkRjeMvBZdV1AijMHLTh3pbACPvK7zFR+QQY=
+k8s.io/component-base v0.34.0 h1:bS8Ua3zlJzapklsB1dZgjEJuJEeHjj8yTu1gxE2zQX8=
+k8s.io/component-base v0.34.0/go.mod h1:RSCqUdvIjjrEm81epPcjQ/DS+49fADvGSCkIP3IC6vg=
 k8s.io/component-helpers v0.34.0 h1:5T7P9XGMoUy1JDNKzHf0p/upYbeUf8ZaSf9jbx0QlIo=
 k8s.io/component-helpers v0.34.0/go.mod h1:kaOyl5tdtnymriYcVZg4uwDBe2d1wlIpXyDkt6sVnt4=
 k8s.io/controller-manager v0.34.0 h1:oCHoqS8dcFp7zDSu7HUvTpakq3isSxil3GprGGlJMsE=

test/openshift/e2e/ginkgo/fixture/application/fixture.go

@@ -1,6 +1,9 @@
 package application
 
 import (
+	"fmt"
+	"regexp"
+
 	. "github.com/onsi/gomega"
 	"github.com/redhat-developer/gitops-operator/test/openshift/e2e/ginkgo/fixture/utils"
 	"k8s.io/client-go/util/retry"
@@ -83,6 +86,40 @@ func HaveSyncStatusCode(expected appv1alpha1.SyncStatusCode) matcher.GomegaMatch
 
 }
 
+func HaveNoConditions() matcher.GomegaMatcher {
+	return expectedCondition(func(app *appv1alpha1.Application) bool {
+		count := len(app.Status.Conditions)
+		if count == 0 {
+			return true
+		}
+
+		GinkgoWriter.Printf("HaveNoConditions - have: %+v\n", app.Status.Conditions)
+		return false
+	})
+}
+
+func HaveConditionMatching(conditionType appv1alpha1.ApplicationConditionType, messagePattern string) matcher.GomegaMatcher {
+	pattern := regexp.MustCompile(messagePattern)
+
+	return expectedCondition(func(app *appv1alpha1.Application) bool {
+		conditions := app.Status.Conditions
+		var found []string
+		for _, condition := range conditions {
+			found = append(found, fmt.Sprintf("  -  %s/%s", condition.Type, condition.Message))
+
+			if condition.Type == conditionType && pattern.MatchString(condition.Message) {
+				return true
+			}
+		}
+
+		GinkgoWriter.Printf("HaveConditionMatching - expected: %s/%s; current(%d):\n", conditionType, messagePattern, len(conditions))
+		for _, f := range found {
+			GinkgoWriter.Println(f)
+		}
+		return false
+	})
+}
+
 // Update will keep trying to update object until it succeeds, or times out.
 func Update(obj *appv1alpha1.Application, modify func(*appv1alpha1.Application)) {
 	k8sClient, _ := utils.GetE2ETestKubeClient()

test/openshift/e2e/ginkgo/fixture/argocd/fixture.go

@@ -191,32 +191,33 @@ func HaveExternalAuthenticationCondition(expected metav1.Condition) matcher.Gome
 func HaveCondition(condition metav1.Condition) matcher.GomegaMatcher {
 	return fetchArgoCD(func(argocd *argov1beta1api.ArgoCD) bool {
 
-		if len(argocd.Status.Conditions) != 1 {
-			GinkgoWriter.Println("HaveCondition: length is zero")
+		length := len(argocd.Status.Conditions)
+		if length != 1 {
+			GinkgoWriter.Printf("HaveCondition: length is %d\n", length)
 			return false
 		}
 
 		instanceCondition := argocd.Status.Conditions[0]
 
-		GinkgoWriter.Println("HaveCondition - Message:", instanceCondition.Message, condition.Message)
+		GinkgoWriter.Printf("HaveCondition - Message: '%s' / actual: '%s'\n", condition.Message, instanceCondition.Message)
 		if instanceCondition.Message != condition.Message {
 			GinkgoWriter.Println("HaveCondition: message does not match")
 			return false
 		}
 
-		GinkgoWriter.Println("HaveCondition - Reason:", instanceCondition.Reason, condition.Reason)
+		GinkgoWriter.Printf("HaveCondition - Reason: '%s' / actual: '%s'\n", condition.Reason, instanceCondition.Reason)
 		if instanceCondition.Reason != condition.Reason {
 			GinkgoWriter.Println("HaveCondition: reason does not match")
 			return false
 		}
 
-		GinkgoWriter.Println("HaveCondition - Status:", instanceCondition.Status, condition.Status)
+		GinkgoWriter.Printf("HaveCondition - Status: '%s' / actual: '%s'\n", condition.Status, instanceCondition.Status)
 		if instanceCondition.Status != condition.Status {
 			GinkgoWriter.Println("HaveCondition: status does not match")
 			return false
 		}
 
-		GinkgoWriter.Println("HaveCondition - Type:", instanceCondition.Type, condition.Type)
+		GinkgoWriter.Printf("HaveCondition - Type: '%s' / actual: '%s'\n", condition.Type, instanceCondition.Type)
 		if instanceCondition.Type != condition.Type {
 			GinkgoWriter.Println("HaveCondition: type does not match")
 			return false

test/openshift/e2e/ginkgo/fixture/clusterrole/fixture.go

@@ -2,6 +2,7 @@ package clusterrole
 
 import (
 	"context"
+	"reflect"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -32,6 +33,13 @@ func Update(obj *rbacv1.ClusterRole, modify func(*rbacv1.ClusterRole)) {
 
 }
 
+func HaveRules(expectedRules []rbacv1.PolicyRule) matcher.GomegaMatcher {
+	return fetchRole(func(cr *rbacv1.ClusterRole) bool {
+		GinkgoWriter.Println("HaveRules - Expected:", expectedRules, "/ Actual:", cr.Rules)
+		return reflect.DeepEqual(expectedRules, cr.Rules)
+	})
+}
+
 // This is intentionally NOT exported, for now. Create another function in this file/package that calls this function, and export that.
 //
 //nolint:unused

test/openshift/e2e/ginkgo/fixture/k8s/fixture.go

@@ -98,15 +98,23 @@ func NotHaveLabelWithValue(key string, value string) matcher.GomegaMatcher {
 // ExistByName checks if the given k8s resource exists, when retrieving it by name/namespace.
 // - It does NOT check if the resource content matches. It only checks that a resource of that type and name exists.
 func ExistByName() matcher.GomegaMatcher {
+	return ExistByNameWithClient(nil)
+}
 
-	return WithTransform(func(k8sObject client.Object) bool {
-		k8sClient, _, err := utils.GetE2ETestKubeClientWithError()
-		if err != nil {
-			GinkgoWriter.Println(err)
-			return false
-		}
+// ExistByNameWithClient checks if the given k8s resource exists, when retrieving it by name/namespace.
+// - It does NOT check if the resource content matches. It only checks that a resource of that type and name exists.
+//
+// NOTE: you probably want to instead use ExistByName()
+func ExistByNameWithClient(k8sClient client.Client) matcher.GomegaMatcher {
+	if k8sClient == nil {
+		var err error
+		k8sClient, _, err = utils.GetE2ETestKubeClientWithError()
+		Expect(err).ToNot(HaveOccurred())
+		Expect(k8sClient).ShouldNot(BeNil())
+	}
 
-		err = k8sClient.Get(context.Background(), client.ObjectKeyFromObject(k8sObject), k8sObject)
+	return WithTransform(func(k8sObject client.Object) bool {
+		err := k8sClient.Get(context.Background(), client.ObjectKeyFromObject(k8sObject), k8sObject)
 		if err != nil {
 			GinkgoWriter.Println("Object does not exists in ExistByName:", k8sObject.GetName(), err)
 		} else {