use CrossNamespaceSourceReference instead of CrossNamespaceDependency…

…Reference

Signed-off-by: Sanskar Jaiswal <[email protected]>

Makefile

@@ -162,7 +162,7 @@ manifests: controller-gen	## Generate manifests e.g. CRD, RBAC etc.
 	cd api; $(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role paths="./..." output:crd:artifacts:config="../config/crd/bases"
 
 api-docs: gen-crd-api-reference-docs	## Generate API reference documentation
-	$(API_REF_GEN) -api-dir=./api/v1beta1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/image-automation.md
+	$(GEN_CRD_API_REFERENCE_DOCS) -api-dir=./api/v1beta1 -config=./hack/api-docs/config.json -template-dir=./hack/api-docs/template -out-file=./docs/api/image-automation.md
 
 tidy:	## Run go mod tidy
 	cd api; rm -f go.sum; go mod tidy

api/go.mod

@@ -11,7 +11,6 @@ require (
 
 require (
 	github.com/fluxcd/pkg/apis/acl v0.0.3 // indirect
-	github.com/fluxcd/pkg/runtime v0.12.3 // indirect
 	github.com/go-logr/logr v1.2.2 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/google/go-cmp v0.5.6 // indirect

api/go.sum

@@ -125,8 +125,6 @@ github.com/fluxcd/pkg/apis/acl v0.0.3 h1:Lw0ZHdpnO4G7Zy9KjrzwwBmDZQuy4qEjaU/RvA6
 github.com/fluxcd/pkg/apis/acl v0.0.3/go.mod h1:XPts6lRJ9C9fIF9xVWofmQwftvhY25n1ps7W9xw0XLU=
 github.com/fluxcd/pkg/apis/meta v0.10.2 h1:pnDBBEvfs4HaKiVAYgz+e/AQ8dLvcgmVfSeBroZ/KKI=
 github.com/fluxcd/pkg/apis/meta v0.10.2/go.mod h1:KQ2er9xa6koy7uoPMZjIjNudB5p4tXs+w0GO6fRcy7I=
-github.com/fluxcd/pkg/runtime v0.12.3 h1:h21AZ3YG5MAP7DxFF9hfKrP+vFzys2L7CkUbPFjbP/0=
-github.com/fluxcd/pkg/runtime v0.12.3/go.mod h1:imJ2xYy/d4PbSinX2IefmZk+iS2c1P5fY0js8mCE4SM=
 github.com/fluxcd/source-controller/api v0.20.1 h1:BfYw1gNHykiCVFNtDz3atcf3Vph+arfuveKmouI98wE=
 github.com/fluxcd/source-controller/api v0.20.1/go.mod h1:Ab2qDmAUz6ZCp8UaHYLYzxyFrC1FQqEqjxiROb/Rdiw=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=

api/v1beta1/imageupdateautomation_types.go

@@ -20,7 +20,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	"github.com/fluxcd/pkg/apis/meta"
-	"github.com/fluxcd/pkg/runtime/dependency"
 )
 
 const ImageUpdateAutomationKind = "ImageUpdateAutomation"
@@ -30,7 +29,7 @@ type ImageUpdateAutomationSpec struct {
 	// SourceRef refers to the resource giving access details
 	// to a git repository.
 	// +required
-	SourceRef dependency.CrossNamespaceDependencyReference `json:"sourceRef"`
+	SourceRef CrossNamespaceSourceReference `json:"sourceRef"`
 	// GitSpec contains all the git-specific definitions. This is
 	// technically optional, but in practice mandatory until there are
 	// other kinds of source allowed.

api/v1beta1/reference.go

@@ -0,0 +1,44 @@
+/*
+Copyright 2021 The Flux authors
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import "fmt"
+
+// CrossNamespaceSourceReference contains enough information to let you locate the
+// typed Kubernetes resource object at cluster level.
+type CrossNamespaceSourceReference struct {
+	// API version of the referent.
+	// +optional
+	APIVersion string `json:"apiVersion,omitempty"`
+
+	// Kind of the referent.
+	// +kubebuilder:validation:Enum=GitRepository
+	// +required
+	Kind string `json:"kind"`
+
+	// Name of the referent.
+	// +required
+	Name string `json:"name"`
+
+	// Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.
+	// +optional
+	Namespace string `json:"namespace,omitempty"`
+}
+
+func (s *CrossNamespaceSourceReference) String() string {
+	if s.Namespace != "" {
+		return fmt.Sprintf("%s/%s/%s", s.Kind, s.Namespace, s.Name)
+	}
+	return fmt.Sprintf("%s/%s", s.Kind, s.Name)
+}

config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml

@@ -644,13 +644,23 @@ spec:
                 description: SourceRef refers to the resource giving access details
                   to a git repository.
                 properties:
+                  apiVersion:
+                    description: API version of the referent.
+                    type: string
+                  kind:
+                    description: Kind of the referent.
+                    enum:
+                    - GitRepository
+                    type: string
                   name:
-                    description: Name holds the name reference of a dependency.
+                    description: Name of the referent.
                     type: string
                   namespace:
-                    description: Namespace holds the namespace reference of a dependency.
+                    description: Namespace of the referent, defaults to the namespace
+                      of the Kubernetes resource object that contains the reference.
                     type: string
                 required:
+                - kind
                 - name
                 type: object
               suspend:

controllers/imageupdateautomation_controller.go

@@ -157,23 +157,30 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 	}
 
 	// get the git repository object so it can be checked out
+	if kind := auto.Spec.SourceRef.Kind; kind != sourcev1.GitRepositoryKind {
+		return failWithError(fmt.Errorf("source kind %q not supported", kind))
+	}
 
 	gitSpec := auto.Spec.GitSpec
 	if gitSpec == nil {
 		return failWithError(fmt.Errorf("source kind %s neccessitates field .spec.git", sourcev1.GitRepositoryKind))
 	}
 
 	var origin sourcev1.GitRepository
+	gitRepoNamespace := req.Namespace
+	if auto.Spec.SourceRef.Namespace != "" {
+		gitRepoNamespace = auto.Spec.SourceRef.Namespace
+	}
 	originName := types.NamespacedName{
 		Name:      auto.Spec.SourceRef.Name,
-		Namespace: auto.Spec.SourceRef.Namespace,
+		Namespace: gitRepoNamespace,
 	}
 	debuglog.Info("fetching git repository", "gitrepository", originName)
 
 	if err := r.Get(ctx, originName, &origin); err != nil {
 		if client.IgnoreNotFound(err) == nil {
 			imagev1.SetImageUpdateAutomationReadiness(&auto, metav1.ConditionFalse, imagev1.GitNotAvailableReason, "referenced git repository is missing")
-			log.Error(err, fmt.Sprintf("referenced git repository %s does not exist.\nPlease note that only GitRepositories can be referenced.", originName.String()))
+			log.Error(err, fmt.Sprintf("referenced git repository %s does not exist.", originName.String()))
 			if err := r.patchStatus(ctx, req, auto.Status); err != nil {
 				return ctrl.Result{Requeue: true}, err
 			}

controllers/update_test.go

@@ -50,7 +50,6 @@ import (
 	imagev1_reflect "github.com/fluxcd/image-reflector-controller/api/v1beta1"
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/gittestserver"
-	"github.com/fluxcd/pkg/runtime/dependency"
 	"github.com/fluxcd/pkg/ssh"
 	sourcev1 "github.com/fluxcd/source-controller/api/v1beta1"
 
@@ -239,7 +238,8 @@ Images:
 				},
 				Spec: imagev1.ImageUpdateAutomationSpec{
 					Interval: metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
-					SourceRef: dependency.CrossNamespaceDependencyReference{
+					SourceRef: imagev1.CrossNamespaceSourceReference{
+						Kind:      "GitRepository",
 						Name:      gitRepoKey.Name,
 						Namespace: gitRepoKey.Namespace,
 					},
@@ -381,7 +381,8 @@ Images:
 						Strategy: imagev1.UpdateStrategySetters,
 						Path:     "./yes",
 					},
-					SourceRef: dependency.CrossNamespaceDependencyReference{
+					SourceRef: imagev1.CrossNamespaceSourceReference{
+						Kind:      "GitRepository",
 						Name:      gitRepoKey.Name,
 						Namespace: gitRepoKey.Namespace,
 					},
@@ -525,7 +526,8 @@ Images:
 					Namespace: updateKey.Namespace,
 				},
 				Spec: imagev1.ImageUpdateAutomationSpec{
-					SourceRef: dependency.CrossNamespaceDependencyReference{
+					SourceRef: imagev1.CrossNamespaceSourceReference{
+						Kind:      "GitRepository",
 						Name:      gitRepoKey.Name,
 						Namespace: gitRepoKey.Namespace,
 					},
@@ -721,7 +723,8 @@ Images:
 
 					update = &imagev1.ImageUpdateAutomation{
 						Spec: imagev1.ImageUpdateAutomationSpec{
-							SourceRef: dependency.CrossNamespaceDependencyReference{
+							SourceRef: imagev1.CrossNamespaceSourceReference{
+								Kind:      "GitRepository",
 								Name:      gitRepoKey.Name,
 								Namespace: gitRepoKey.Namespace,
 							},
@@ -839,7 +842,8 @@ Images:
 						},
 						Spec: imagev1.ImageUpdateAutomationSpec{
 							Interval: metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
-							SourceRef: dependency.CrossNamespaceDependencyReference{
+							SourceRef: imagev1.CrossNamespaceSourceReference{
+								Kind:      "GitRepository",
 								Name:      gitRepoKey.Name,
 								Namespace: gitRepoKey.Namespace,
 							},
@@ -961,7 +965,8 @@ Images:
 					Namespace: key.Namespace,
 				},
 				Spec: imagev1.ImageUpdateAutomationSpec{
-					SourceRef: dependency.CrossNamespaceDependencyReference{
+					SourceRef: imagev1.CrossNamespaceSourceReference{
+						Kind:      "GitRepository",
 						Name:      "garbage",
 						Namespace: key.Namespace,
 					},

docs/api/image-automation.md

@@ -119,6 +119,74 @@ string
 </table>
 </div>
 </div>
+<h3 id="image.toolkit.fluxcd.io/v1beta1.CrossNamespaceSourceReference">CrossNamespaceSourceReference
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#image.toolkit.fluxcd.io/v1beta1.ImageUpdateAutomationSpec">ImageUpdateAutomationSpec</a>)
+</p>
+<p>CrossNamespaceSourceReference contains enough information to let you locate the
+typed Kubernetes resource object at cluster level.</p>
+<div class="md-typeset__scrollwrap">
+<div class="md-typeset__table">
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>apiVersion</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>API version of the referent.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>kind</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>Kind of the referent.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>name</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>Name of the referent.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>namespace</code><br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
 <h3 id="image.toolkit.fluxcd.io/v1beta1.GitCheckoutSpec">GitCheckoutSpec
 </h3>
 <p>
@@ -262,8 +330,8 @@ ImageUpdateAutomationSpec
 <td>
 <code>sourceRef</code><br>
 <em>
-<a href="#image.toolkit.fluxcd.io/v1beta1.SourceReference">
-SourceReference
+<a href="#image.toolkit.fluxcd.io/v1beta1.CrossNamespaceSourceReference">
+CrossNamespaceSourceReference
 </a>
 </em>
 </td>
@@ -370,8 +438,8 @@ ImageUpdateAutomationStatus
 <td>
 <code>sourceRef</code><br>
 <em>
-<a href="#image.toolkit.fluxcd.io/v1beta1.SourceReference">
-SourceReference
+<a href="#image.toolkit.fluxcd.io/v1beta1.CrossNamespaceSourceReference">
+CrossNamespaceSourceReference
 </a>
 </em>
 </td>
@@ -616,62 +684,6 @@ ImageUpdateAutomation.</p>
 </table>
 </div>
 </div>
-<h3 id="image.toolkit.fluxcd.io/v1beta1.SourceReference">SourceReference
-</h3>
-<p>
-(<em>Appears on:</em>
-<a href="#image.toolkit.fluxcd.io/v1beta1.ImageUpdateAutomationSpec">ImageUpdateAutomationSpec</a>)
-</p>
-<p>SourceReference contains enough information to let you locate the
-typed, referenced source object.</p>
-<div class="md-typeset__scrollwrap">
-<div class="md-typeset__table">
-<table>
-<thead>
-<tr>
-<th>Field</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>
-<code>apiVersion</code><br>
-<em>
-string
-</em>
-</td>
-<td>
-<em>(Optional)</em>
-<p>API version of the referent</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>kind</code><br>
-<em>
-string
-</em>
-</td>
-<td>
-<p>Kind of the referent</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>name</code><br>
-<em>
-string
-</em>
-</td>
-<td>
-<p>Name of the referent</p>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
 <h3 id="image.toolkit.fluxcd.io/v1beta1.UpdateStrategy">UpdateStrategy
 </h3>
 <p>