Use the object reference type from fluxcd/pkg/meta

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
fluxcd · Jan 21, 2021 · 62a764a · 62a764a
1 parent 9a7185e
commit 62a764a
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 130 deletions.
diff --git a/api/v1beta1/kustomization_types.go b/api/v1beta1/kustomization_types.go
@@ -19,7 +19,6 @@ package v1beta1
 import (
 	"time"
 
-	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 
@@ -66,7 +65,7 @@ type KustomizationSpec struct {
 
 	// A list of resources to be included in the health assessment.
 	// +optional
-	HealthChecks []CrossNamespaceObjectReference `json:"healthChecks,omitempty"`
+	HealthChecks []meta.NamespacedObjectKindReference `json:"healthChecks,omitempty"`
 
 	// A list of images used to override or set the name and tag for container images.
 	// +optional
@@ -115,7 +114,7 @@ type Decryption struct {
 
 	// The secret name containing the private OpenPGP keys used for decryption.
 	// +optional
-	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
+	SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
 }
 
 // Image contains the name, new name and new tag that will replace the original container image.
@@ -144,7 +143,7 @@ type KubeConfig struct {
 	// binaries and credentials to the Pod that is responsible for reconciling
 	// the Kustomization.
 	// +required
-	SecretRef corev1.LocalObjectReference `json:"secretRef,omitempty"`
+	SecretRef meta.LocalObjectReference `json:"secretRef,omitempty"`
 }
 
 // KustomizationStatus defines the observed state of a kustomization.

diff --git a/api/v1beta1/reference_types.go b/api/v1beta1/reference_types.go
@@ -16,26 +16,6 @@ limitations under the License.
 
 package v1beta1
 
-// CrossNamespaceObjectReference contains enough information to let you locate the
-// typed referenced object at cluster level
-type CrossNamespaceObjectReference struct {
-	// API version of the referent, defaults to 'apps/v1'
-	// +optional
-	APIVersion string `json:"apiVersion,omitempty"`
-
-	// Kind of the referent
-	// +required
-	Kind string `json:"kind"`
-
-	// Name of the referent
-	// +required
-	Name string `json:"name"`
-
-	// Namespace of the referent
-	// +optional
-	Namespace string `json:"namespace,omitempty"`
-}
-
 // CrossNamespaceSourceReference contains enough information to let you locate the
 // typed referenced object at cluster level
 type CrossNamespaceSourceReference struct {

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml b/config/crd/bases/kustomize.toolkit.fluxcd.io_kustomizations.yaml
@@ -62,9 +62,10 @@ spec:
                       used for decryption.
                     properties:
                       name:
-                        description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-                          TODO: Add other useful fields. apiVersion, kind, uid?'
+                        description: Name of the referent
                         type: string
+                    required:
+                    - name
                     type: object
                 required:
                 - provider
@@ -90,11 +91,12 @@ spec:
               healthChecks:
                 description: A list of resources to be included in the health assessment.
                 items:
-                  description: CrossNamespaceObjectReference contains enough information
-                    to let you locate the typed referenced object at cluster level
+                  description: NamespacedObjectKindReference contains enough information
+                    to let you locate the typed referenced object in any namespace
                   properties:
                     apiVersion:
-                      description: API version of the referent, defaults to 'apps/v1'
+                      description: API version of the referent, if not specified the
+                        Kubernetes preferred version will be used
                       type: string
                     kind:
                       description: Kind of the referent
@@ -103,7 +105,8 @@ spec:
                       description: Name of the referent
                       type: string
                     namespace:
-                      description: Namespace of the referent
+                      description: Namespace of the referent, when not specified it
+                        acts as LocalObjectReference
                       type: string
                   required:
                   - kind
@@ -153,9 +156,10 @@ spec:
                       for reconciling the Kustomization.
                     properties:
                       name:
-                        description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-                          TODO: Add other useful fields. apiVersion, kind, uid?'
+                        description: Name of the referent
                         type: string
+                    required:
+                    - name
                     type: object
                 type: object
               path:

diff --git a/controllers/kustomization_healthcheck.go b/controllers/kustomization_healthcheck.go
@@ -22,6 +22,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/fluxcd/pkg/apis/meta"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/cli-utils/pkg/kstatus/polling"
 	"sigs.k8s.io/cli-utils/pkg/kstatus/polling/aggregator"
@@ -93,7 +94,7 @@ func (hc *KustomizeHealthCheck) Assess(pollInterval time.Duration) error {
 	return nil
 }
 
-func (hc *KustomizeHealthCheck) toObjMetadata(cr []kustomizev1.CrossNamespaceObjectReference) ([]object.ObjMetadata, error) {
+func (hc *KustomizeHealthCheck) toObjMetadata(cr []meta.NamespacedObjectKindReference) ([]object.ObjMetadata, error) {
 	oo := []object.ObjMetadata{}
 	for _, c := range cr {
 		// For backwards compatibility

diff --git a/docs/api/kustomize.md b/docs/api/kustomize.md
@@ -155,8 +155,8 @@ bool
 <td>
 <code>healthChecks</code><br>
 <em>
-<a href="#kustomize.toolkit.fluxcd.io/v1beta1.CrossNamespaceObjectReference">
-[]CrossNamespaceObjectReference
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectKindReference">
+[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
 </a>
 </em>
 </td>
@@ -278,74 +278,6 @@ KustomizationStatus
 </table>
 </div>
 </div>
-<h3 id="kustomize.toolkit.fluxcd.io/v1beta1.CrossNamespaceObjectReference">CrossNamespaceObjectReference
-</h3>
-<p>
-(<em>Appears on:</em>
-<a href="#kustomize.toolkit.fluxcd.io/v1beta1.KustomizationSpec">KustomizationSpec</a>)
-</p>
-<p>CrossNamespaceObjectReference contains enough information to let you locate the
-typed referenced 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, defaults to &lsquo;apps/v1&rsquo;</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</p>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
 <h3 id="kustomize.toolkit.fluxcd.io/v1beta1.CrossNamespaceSourceReference">CrossNamespaceSourceReference
 </h3>
 <p>
@@ -446,8 +378,8 @@ string
 <td>
 <code>secretRef</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core">
-Kubernetes core/v1.LocalObjectReference
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#LocalObjectReference">
+github.com/fluxcd/pkg/apis/meta.LocalObjectReference
 </a>
 </em>
 </td>
@@ -535,8 +467,8 @@ string
 <td>
 <code>secretRef</code><br>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core">
-Kubernetes core/v1.LocalObjectReference
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#LocalObjectReference">
+github.com/fluxcd/pkg/apis/meta.LocalObjectReference
 </a>
 </em>
 </td>
@@ -659,8 +591,8 @@ bool
 <td>
 <code>healthChecks</code><br>
 <em>
-<a href="#kustomize.toolkit.fluxcd.io/v1beta1.CrossNamespaceObjectReference">
-[]CrossNamespaceObjectReference
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectKindReference">
+[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
 </a>
 </em>
 </td>

diff --git a/docs/spec/v1beta1/kustomization.md b/docs/spec/v1beta1/kustomization.md
@@ -42,7 +42,7 @@ type KustomizationSpec struct {
 
 	// A list of resources to be included in the health assessment.
 	// +optional
-	HealthChecks []CrossNamespaceObjectReference `json:"healthChecks,omitempty"`
+	HealthChecks []meta.NamespacedObjectKindReference `json:"healthChecks,omitempty"`
 
     // A list of images used to override or set the name and tag for container images.
     // +optional
@@ -91,7 +91,7 @@ type Decryption struct {
 
 	// The secret name containing the private OpenPGP keys used for decryption.
 	// +optional
-	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
+	SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
 }
 ```
 
@@ -109,7 +109,7 @@ type KubeConfig struct {
 	// binaries and credentials to the Pod that is responsible for reconciling
 	// the Kustomization.
 	// +required
-	SecretRef corev1.LocalObjectReference `json:"secretRef,omitempty"`
+	SecretRef meta.LocalObjectReference `json:"secretRef,omitempty"`
 }
 ```