Merge pull request #1925 from justinsb/projectref_should_not_use_kind

LoggingLogMetric - kind should not be require in projectRef
GoogleCloudPlatform · Jun 4, 2024 · 8b55156 · 8b55156
2 parents b85741c + 7e4d7f1
commit 8b55156
Show file tree

Hide file tree

Showing 17 changed files with 100 additions and 56 deletions.
diff --git a/apis/monitoring/v1beta1/monitoringdashboard_types.go b/apis/monitoring/v1beta1/monitoringdashboard_types.go
@@ -17,6 +17,7 @@ package v1beta1
 import (
 	"reflect"
 
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -812,7 +813,7 @@ type LogsPanel struct {
 // +kcc:proto=google.monitoring.dashboard.v1.Dashboard
 type MonitoringDashboardSpec struct {
 	/* Immutable. The Project that this resource belongs to. */
-	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`
+	ProjectRef refs.ProjectRef `json:"projectRef"`
 
 	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
 	// +optional

diff --git a/apis/refs/v1beta1/projectref.go b/apis/refs/v1beta1/projectref.go
@@ -14,11 +14,15 @@
 
 package v1beta1
 
+// The Project that this resource belongs to.
 type ProjectRef struct {
 	/* The `projectID` field of a project, when not managed by KCC. */
 	External string `json:"external,omitempty"`
 	/* The `name` field of a `Project` resource. */
 	Name string `json:"name,omitempty"`
-	/* The `namespcae` field of a `Project` resource. */
+	/* The `namespace` field of a `Project` resource. */
 	Namespace string `json:"namespace,omitempty"`
+	// The kind of the Project resource; optional but must be `Project` if provided.
+	// +optional
+	Kind string `json:"kind,omitempty"`
 }
diff --git a/apis/resources/logging/v1beta1/logmetric_types.go b/apis/resources/logging/v1beta1/logmetric_types.go
@@ -15,6 +15,7 @@
 package v1beta1
 
 import (
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -176,7 +177,7 @@ type LoggingLogMetricSpec struct {
 	MetricDescriptor *LogmetricMetricDescriptor `json:"metricDescriptor,omitempty"`
 
 	/* Immutable. The Project that this resource belongs to. */
-	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`
+	ProjectRef refs.ProjectRef `json:"projectRef"`
 
 	/* Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
 	// +optional

diff --git a/...ensions.k8s.io_v1_customresourcedefinition_apikeyskeys.apikeys.cnrm.cloud.google.com.yaml b/...ensions.k8s.io_v1_customresourcedefinition_apikeyskeys.apikeys.cnrm.cloud.google.com.yaml
@@ -85,11 +85,15 @@ spec:
                     description: The `projectID` field of a project, when not managed
                       by KCC.
                     type: string
+                  kind:
+                    description: The kind of the Project resource; optional but must
+                      be `Project` if provided.
+                    type: string
                   name:
                     description: The `name` field of a `Project` resource.
                     type: string
                   namespace:
-                    description: The `namespcae` field of a `Project` resource.
+                    description: The `namespace` field of a `Project` resource.
                     type: string
                 type: object
               resourceID:

diff --git a/...s.k8s.io_v1_customresourcedefinition_logginglogmetrics.logging.cnrm.cloud.google.com.yaml b/...s.k8s.io_v1_customresourcedefinition_logginglogmetrics.logging.cnrm.cloud.google.com.yaml
@@ -324,29 +324,28 @@ spec:
                     - external
                   required:
                   - name
-                  - kind
                 - not:
                     anyOf:
                     - required:
                       - name
                     - required:
                       - namespace
-                    - required:
-                      - kind
                   required:
                   - external
                 properties:
                   external:
-                    description: The external name of the referenced resource
+                    description: The `projectID` field of a project, when not managed
+                      by KCC.
                     type: string
                   kind:
-                    description: Kind of the referent.
+                    description: The kind of the Project resource; optional but must
+                      be `Project` if provided.
                     type: string
                   name:
-                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                    description: The `name` field of a `Project` resource.
                     type: string
                   namespace:
-                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+                    description: The `namespace` field of a `Project` resource.
                     type: string
                 type: object
               resourceID:

diff --git a/...io_v1_customresourcedefinition_monitoringdashboards.monitoring.cnrm.cloud.google.com.yaml b/...io_v1_customresourcedefinition_monitoringdashboards.monitoring.cnrm.cloud.google.com.yaml
@@ -4372,29 +4372,28 @@ spec:
                     - external
                   required:
                   - name
-                  - kind
                 - not:
                     anyOf:
                     - required:
                       - name
                     - required:
                       - namespace
-                    - required:
-                      - kind
                   required:
                   - external
                 properties:
                   external:
-                    description: The external name of the referenced resource
+                    description: The `projectID` field of a project, when not managed
+                      by KCC.
                     type: string
                   kind:
-                    description: Kind of the referent.
+                    description: The kind of the Project resource; optional but must
+                      be `Project` if provided.
                     type: string
                   name:
-                    description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                    description: The `name` field of a `Project` resource.
                     type: string
                   namespace:
-                    description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+                    description: The `namespace` field of a `Project` resource.
                     type: string
                 type: object
               resourceID:

diff --git a/pkg/controller/direct/gkehub/featuremembership_controller.go b/pkg/controller/direct/gkehub/featuremembership_controller.go
@@ -25,6 +25,7 @@ import (
 	"k8s.io/klog/v2"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	krm "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/gkehub/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/directbase"
@@ -77,11 +78,16 @@ func (m *gkeHubModel) AdapterForObject(ctx context.Context, reader client.Reader
 	if err := runtime.DefaultUnstructuredConverter.FromUnstructured(u.Object, &obj); err != nil {
 		return nil, fmt.Errorf("error converting to %T: %w", obj, err)
 	}
-	projectRef, err := references.ResolveProject(ctx, reader, obj, &obj.Spec.ProjectRef)
+	projectRef := &refs.ProjectRef{
+		Name:      obj.Spec.ProjectRef.Name,
+		Namespace: obj.Spec.ProjectRef.Namespace,
+		External:  obj.Spec.ProjectRef.External,
+	}
+	project, err := references.ResolveProject(ctx, reader, obj, projectRef)
 	if err != nil {
 		return nil, err
 	}
-	projectID := projectRef.ProjectID
+	projectID := project.ProjectID
 	if projectID == "" {
 		return nil, fmt.Errorf("cannot resolve project")
 	}

diff --git a/pkg/controller/direct/logging/logbucketref.go b/pkg/controller/direct/logging/logbucketref.go
@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"strings"
 
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/logging/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/references"
@@ -94,7 +95,12 @@ func LogBucketRef_ConvertToExternal(ctx context.Context, reader client.Reader, s
 	if err := runtime.DefaultUnstructuredConverter.FromUnstructured(loggingLogBucket.Object, &obj); err != nil {
 		return fmt.Errorf("error converting LoggingLogBucket %v: %w", key, err)
 	}
-	project, err := references.ResolveProject(ctx, reader, loggingLogBucket, obj.Spec.ProjectRef)
+	projectRef := &refs.ProjectRef{
+		Name:      obj.Spec.ProjectRef.Name,
+		Namespace: obj.Spec.ProjectRef.Namespace,
+		External:  obj.Spec.ProjectRef.External,
+	}
+	project, err := references.ResolveProject(ctx, reader, loggingLogBucket, projectRef)
 	if err != nil {
 		return fmt.Errorf("cannot get project for referenced LoggingLogBucket %v: %w", key, err)
 	}

diff --git a/pkg/controller/direct/logging/utils.go b/pkg/controller/direct/logging/utils.go
@@ -20,6 +20,7 @@ import (
 	"reflect"
 	"sort"
 
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	krm "github.com/GoogleCloudPlatform/k8s-config-connector/apis/resources/logging/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/util"
@@ -148,7 +149,7 @@ func convertAPItoKRM_LoggingLogMetric(projectID string, in *api.LogMetric) (*uns
 		}
 	}
 
-	lm.Spec.ProjectRef = v1alpha1.ResourceRef{
+	lm.Spec.ProjectRef = refs.ProjectRef{
 		External: projectID,
 	}
 

diff --git a/pkg/controller/direct/references/projectref.go b/pkg/controller/direct/references/projectref.go
@@ -19,7 +19,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
+	refs "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -31,11 +31,17 @@ type Project struct {
 	ProjectID string
 }
 
-func ResolveProject(ctx context.Context, reader client.Reader, src client.Object, ref *v1alpha1.ResourceRef) (*Project, error) {
+func ResolveProject(ctx context.Context, reader client.Reader, src client.Object, ref *refs.ProjectRef) (*Project, error) {
 	if ref == nil {
 		return nil, nil
 	}
 
+	if ref.Kind != "" {
+		if ref.Kind != "Project" {
+			return nil, fmt.Errorf("kind is optional on project reference, but must be \"Project\" if provided")
+		}
+	}
+
 	if ref.External != "" {
 		if ref.Name != "" {
 			return nil, fmt.Errorf("cannot specify both name and external on project reference")

diff --git a/...ngdashboard/monitoringdashboardrefs/_generated_object_monitoringdashboardrefs.golden.yaml b/...ngdashboard/monitoringdashboardrefs/_generated_object_monitoringdashboardrefs.golden.yaml
@@ -54,7 +54,7 @@ spec:
         title: Widget 4
   displayName: monitoringdashboard-${uniqueId}
   projectRef:
-    external: ${projectId}
+    name: otherproject
   resourceID: monitoringdashboard-${uniqueId}
 status:
   conditions:

diff --git a/...e/testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/_http.log b/...e/testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/_http.log
@@ -1,6 +1,5 @@
 GET https://cloudresourcemanager.googleapis.com/v1/projects/other${uniqueId}?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 403 Forbidden
 Cache-Control: private
@@ -26,7 +25,6 @@ X-Xss-Protection: 0
 POST https://cloudresourcemanager.googleapis.com/v1/projects?alt=json&prettyPrint=false
 Content-Type: application/json
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 {
   "labels": {
@@ -99,7 +97,6 @@ X-Xss-Protection: 0
 
 GET https://cloudresourcemanager.googleapis.com/v1/projects/other${uniqueId}?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 200 OK
 Cache-Control: private
@@ -132,7 +129,6 @@ X-Xss-Protection: 0
 
 GET https://cloudbilling.googleapis.com/v1/projects/other${uniqueId}/billingInfo?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 200 OK
 Cache-Control: private
@@ -154,7 +150,7 @@ X-Xss-Protection: 0
 
 ---
 
-GET https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+GET https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -179,7 +175,7 @@ X-Xss-Protection: 0
 
 ---
 
-POST https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards?alt=json
+POST https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -257,7 +253,7 @@ User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
     ]
   },
   "displayName": "monitoringdashboard-sample",
-  "name": "projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}"
+  "name": "projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}"
 }
 
 200 OK
@@ -354,7 +350,7 @@ X-Xss-Protection: 0
 
 ---
 
-GET https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+GET https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -452,7 +448,7 @@ X-Xss-Protection: 0
 
 ---
 
-PATCH https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+PATCH https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -624,7 +620,7 @@ X-Xss-Protection: 0
 
 ---
 
-GET https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+GET https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -719,7 +715,7 @@ X-Xss-Protection: 0
 
 ---
 
-DELETE https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+DELETE https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -738,7 +734,7 @@ X-Xss-Protection: 0
 
 ---
 
-GET https://monitoring.googleapis.com/v1/projects/${projectId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
+GET https://monitoring.googleapis.com/v1/projects/other${uniqueId}/dashboards/monitoringdashboard-${uniqueId}?alt=json
 Content-Type: application/json
 User-Agent: kcc/controller-manager DeclarativeClientLib/0.0.1
 
@@ -765,7 +761,6 @@ X-Xss-Protection: 0
 
 GET https://cloudresourcemanager.googleapis.com/v1/projects/other${uniqueId}?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 200 OK
 Cache-Control: private
@@ -798,7 +793,6 @@ X-Xss-Protection: 0
 
 GET https://cloudbilling.googleapis.com/v1/projects/other${uniqueId}/billingInfo?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 200 OK
 Cache-Control: private
@@ -822,7 +816,6 @@ X-Xss-Protection: 0
 
 DELETE https://cloudresourcemanager.googleapis.com/v1/projects/other${uniqueId}?alt=json&prettyPrint=false
 User-Agent: google-api-go-client/0.5 Terraform/ (+https://www.terraform.io) Terraform-Plugin-SDK/2.10.1 terraform-provider-google-beta/kcc/controller-manager
-X-Goog-Api-Client: gl-go/1.22.3 gdcl/0.177.0
 
 200 OK
 Cache-Control: private

diff --git a/...testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/create.yaml b/...testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/create.yaml
@@ -18,7 +18,7 @@ metadata:
   name: monitoringdashboard-${uniqueId}
 spec:
   projectRef:
-    external: ${projectId}
+    name: otherproject
   displayName: "monitoringdashboard-sample"
   columnLayout:
     columns:

diff --git a/...testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/update.yaml b/...testdata/basic/monitoring/v1beta1/monitoringdashboard/monitoringdashboardrefs/update.yaml
@@ -17,6 +17,8 @@ kind: MonitoringDashboard
 metadata:
   name: monitoringdashboard-${uniqueId}
 spec:
+  projectRef:
+    name: otherproject
   displayName: "monitoringdashboard-${uniqueId}"
   columnLayout:
     columns: