Merge pull request GoogleCloudPlatform#3790 from jasonvigil/apigeeenvgroupattachment

feat: Add ApigeeEnvgroupAttachment v1alpha1 reconciler

Author: google-oss-prow[bot]

apis/apigee/v1alpha1/environmentgroup_identity.go

@@ -26,8 +26,8 @@ import (
 )
 
 const (
-	EnvgroupIDToken  = "envgroups"
-	EnvgroupIDFormat = apigeev1beta1.ApigeeOrganizationIDFormat + "/" + EnvgroupIDToken + "/{{envgroupID}}"
+	ApigeeEnvgroupIDToken  = "envgroups"
+	ApigeeEnvgroupIDFormat = apigeev1beta1.ApigeeOrganizationIDFormat + "/" + ApigeeEnvgroupIDToken + "/{{envgroupID}}"
 )
 
 var _ identity.Identity = &ApigeeEnvgroupIdentity{}
@@ -38,20 +38,20 @@ type ApigeeEnvgroupIdentity struct {
 }
 
 func (i *ApigeeEnvgroupIdentity) String() string {
-	return i.ParentID.String() + "/" + EnvgroupIDToken + "/" + i.ResourceID
+	return i.ParentID.String() + "/" + ApigeeEnvgroupIDToken + "/" + i.ResourceID
 }
 
 func (i *ApigeeEnvgroupIdentity) FromExternal(ref string) error {
-	requiredTokens := len(strings.Split(EnvgroupIDFormat, "/"))
+	requiredTokens := len(strings.Split(ApigeeEnvgroupIDFormat, "/"))
 
 	tokens := strings.Split(ref, "/")
-	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != EnvgroupIDToken {
-		return fmt.Errorf("format of ApigeeEnvgroup ref=%q was not known (use %q)", ref, EnvgroupIDFormat)
+	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != ApigeeEnvgroupIDToken {
+		return fmt.Errorf("format of ApigeeEnvgroup ref=%q was not known (use %q)", ref, ApigeeEnvgroupIDFormat)
 	}
 
 	parentID := &apigeev1beta1.ApigeeOrganizationIdentity{}
 	if err := parentID.FromExternal(strings.Join(tokens[:len(tokens)-2], "/")); err != nil {
-		return fmt.Errorf("format of ApigeeEnvgroup ref=%q was not known (use %q)", ref, EnvgroupIDFormat)
+		return fmt.Errorf("format of ApigeeEnvgroup ref=%q was not known (use %q)", ref, ApigeeEnvgroupIDFormat)
 	}
 
 	resourceID := tokens[len(tokens)-1]

apis/apigee/v1alpha1/envgroupattachment_identity.go apis/apigee/v1alpha1/environmentgroupattachment_identity.go

@@ -19,16 +19,14 @@ import (
 	"fmt"
 	"strings"
 
-	apigeev1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/apigee/v1beta1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/apis/common"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/apis/common/identity"
-
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 const (
-	EnvgroupAttachmentIDToken  = "attachments"
-	EnvgroupAttachmentIDFormat = apigeev1beta1.EnvgroupIDFormat + "/" + EnvgroupAttachmentIDToken + "/{{attachmentID}}"
+	ApigeeEnvgroupAttachmentIDToken  = "attachments"
+	ApigeeEnvgroupAttachmentIDFormat = ApigeeEnvgroupIDFormat + "/" + ApigeeEnvgroupAttachmentIDToken + "/{{attachmentID}}"
 )
 
 var _ identity.Identity = &ApigeeEnvgroupAttachmentIdentity{}
@@ -39,20 +37,25 @@ type ApigeeEnvgroupAttachmentIdentity struct {
 }
 
 func (i *ApigeeEnvgroupAttachmentIdentity) String() string {
-	return i.ParentID.String() + "/" + EnvgroupAttachmentIDToken + "/" + i.ResourceID
+	if i.ResourceID == "" {
+		// Initially, the identity of the ApigeeEnvgroupAttachment is unknown, until it is acquired or created.
+		// This is because the resource uses a service-generated ID.
+		return ""
+	}
+	return i.ParentID.String() + "/" + ApigeeEnvgroupAttachmentIDToken + "/" + i.ResourceID
 }
 
 func (i *ApigeeEnvgroupAttachmentIdentity) FromExternal(ref string) error {
-	requiredTokens := len(strings.Split(EnvgroupAttachmentIDFormat, "/"))
+	requiredTokens := len(strings.Split(ApigeeEnvgroupAttachmentIDFormat, "/"))
 
 	tokens := strings.Split(ref, "/")
-	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != EnvgroupAttachmentIDToken {
-		return fmt.Errorf("format of ApigeeEnvgroupAttachment ref=%q was not known (use %q)", ref, EnvgroupAttachmentIDFormat)
+	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != ApigeeEnvgroupAttachmentIDToken {
+		return fmt.Errorf("format of ApigeeEnvgroupAttachment ref=%q was not known (use %q)", ref, ApigeeEnvgroupAttachmentIDFormat)
 	}
 
 	parentID := &ApigeeEnvgroupIdentity{}
 	if err := parentID.FromExternal(strings.Join(tokens[:len(tokens)-2], "/")); err != nil {
-		return fmt.Errorf("format of ApigeeEnvgroupAttachment ref=%q was not known (use %q)", ref, EnvgroupAttachmentIDFormat)
+		return fmt.Errorf("format of ApigeeEnvgroupAttachment ref=%q was not known (use %q)", ref, ApigeeEnvgroupAttachmentIDFormat)
 	}
 
 	resourceID := tokens[len(tokens)-1]
@@ -72,13 +75,14 @@ func (obj *ApigeeEnvgroupAttachment) GetIdentity(ctx context.Context, reader cli
 		return nil, err
 	}
 
-	// Get desired ID
+	// Get service-generated resource ID
 	resourceID := common.ValueOf(obj.Spec.ResourceID)
-	if resourceID == "" {
-		resourceID = obj.GetName()
-	}
-	if resourceID == "" {
-		return nil, fmt.Errorf("cannot resolve resource ID")
+	if resourceID == "" && obj.Status.ExternalRef != nil {
+		savedID := &ApigeeEnvgroupAttachmentIdentity{}
+		if err := savedID.FromExternal(common.ValueOf(obj.Status.ExternalRef)); err != nil {
+			return nil, err
+		}
+		resourceID = savedID.ResourceID
 	}
 
 	id := &ApigeeEnvgroupAttachmentIdentity{
@@ -89,7 +93,7 @@ func (obj *ApigeeEnvgroupAttachment) GetIdentity(ctx context.Context, reader cli
 	// Attempt to ensure ID is immutable, by verifying against previously-set `status.externalRef`.
 	externalRef := common.ValueOf(obj.Status.ExternalRef)
 	if externalRef != "" {
-		previousID := &ApigeeEnvgroupIdentity{}
+		previousID := &ApigeeEnvgroupAttachmentIdentity{}
 		if err := previousID.FromExternal(externalRef); err != nil {
 			return nil, err
 		}

apis/apigee/v1alpha1/envgroupattachment_reference.go apis/apigee/v1alpha1/environmentgroupattachment_reference.go

@@ -18,23 +18,24 @@ import (
 	"context"
 
 	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 var _ refsv1beta1.Ref = &ApigeeEnvgroupAttachmentRef{}
 
-// ApigeeEnvgroupAttachmentRef is a reference to a ApigeeEnvgroup resource.
+// ApigeeEnvgroupAttachmentRef is a reference to a ApigeeEnvgroupAttachment resource.
 type ApigeeEnvgroupAttachmentRef struct {
-	// A reference to an externally managed EnvgroupAttachment resource.
+	// A reference to an externally managed ApigeeEnvgroupAttachment resource.
 	// Should be in the format "organizations/{{organizationID}}/envgroups/{{envgroupID}}/attachments/{{attachmentID}}".
 	External string `json:"external,omitempty"`
 
-	// The name of a EnvgroupAttachment resource.
+	// The name of a ApigeeEnvgroupAttachment resource.
 	Name string `json:"name,omitempty"`
 
-	// The namespace of a EnvgroupAttachment resource.
+	// The namespace of a ApigeeEnvgroupAttachment resource.
 	Namespace string `json:"namespace,omitempty"`
 }
 

apis/apigee/v1alpha1/envgroupattachment_types.go apis/apigee/v1alpha1/environmentgroupattachment_types.go

@@ -1,11 +1,11 @@
-// Copyright 2025 Google LLC.
-
+// Copyright 2025 Google LLC
+//
 // 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.
@@ -23,69 +23,69 @@ import (
 
 var ApigeeEnvgroupAttachmentGVK = GroupVersion.WithKind("ApigeeEnvgroupAttachment")
 
-// ApigeeEnvgroupAttachmentSpec defines the desired state of EnvgroupAttachment
+// ApigeeEnvgroupAttachmentSpec defines the desired state of ApigeeEnvgroupAttachment
+// +kcc:proto=mockgcp.cloud.apigee.v1.GoogleCloudApigeeV1EnvironmentGroupAttachment
 type ApigeeEnvgroupAttachmentSpec struct {
-	// Reference to parent ApigeeEnvgroup.
+	// Reference to parent Environment Group
 	// +required
-	EnvgroupRef *ApigeeEnvgroupRef `json:"envgroupRef"`
+	EnvgroupRef *ApigeeEnvgroupRef `json:"envgroupRef,omitempty"`
 
-	// The Apigee environment to attach to.
-	// +required
-	EnvironmentRef *apigeev1beta1.ApigeeEnvironmentRef `json:"environmentRef"`
+	// Required. ID of the attached environment.
+	// +kcc:proto:field=mockgcp.cloud.apigee.v1.GoogleCloudApigeeV1EnvironmentGroupAttachment.environment
+	EnvironmentRef *apigeev1beta1.ApigeeEnvironmentRef `json:"environmentRef,omitempty"`
 
-	// The EnvgroupAttachment name. If not given, the metadata.name will be used.
+	// The ApigeeEnvgroupAttachment name. If not given, the metadata.name will be used.
 	ResourceID *string `json:"resourceID,omitempty"`
 }
 
-// ApigeeEnvgroupAttachmentStatus defines the observed state of EnvgroupAttachment
+// ApigeeEnvgroupAttachmentStatus defines the config connector machine state of ApigeeEnvgroupAttachment
 type ApigeeEnvgroupAttachmentStatus struct {
-	// Conditions represent the latest available observations of the
-	//   EnvgroupAttachment's current state.
+	/* Conditions represent the latest available observations of the
+	   object's current state. */
 	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
 
-	// ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller.
-	// If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
-	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+	// ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
+	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
 
-	// A unique specifier for the EnvgroupAttachment resource.
-	// +optional
+	// A unique specifier for the ApigeeEnvgroupAttachment resource in GCP.
 	ExternalRef *string `json:"externalRef,omitempty"`
 
 	// ObservedState is the state of the resource as most recently observed in GCP.
-	ObservedState *EnvgroupAttachmentObservedState `json:"observedState,omitempty"`
+	ObservedState *ApigeeEnvgroupAttachmentObservedState `json:"observedState,omitempty"`
 }
 
-// EnvgroupAttachmentObservedState defines the desired state of ApigeeEnvgroupAttachment
-type EnvgroupAttachmentObservedState struct {
-	// Output only. The time at which the environment group attachment
-	// was created as milliseconds since epoch.
+// ApigeeEnvgroupAttachmentObservedState is the state of the ApigeeEnvgroupAttachment resource as most recently observed in GCP.
+// +kcc:proto=mockgcp.cloud.apigee.v1.GoogleCloudApigeeV1EnvironmentGroupAttachment
+type ApigeeEnvgroupAttachmentObservedState struct {
+	// Output only. The time at which the environment group attachment was created as milliseconds since epoch.
+	// +kcc:proto:field=mockgcp.cloud.apigee.v1.GoogleCloudApigeeV1EnvironmentGroupAttachment.created_at
 	CreatedAt *string `json:"createdAt,omitempty"`
 }
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-
-// ApigeeEnvgroupAttachment is the Schema for the EnvgroupAttachments API
-// +genclient
-// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// TODO(user): make sure the pluralizaiton below is correct
 // +kubebuilder:resource:categories=gcp,shortName=gcpapigeeenvgroupattachment;gcpapigeeenvgroupattachments
 // +kubebuilder:subresource:status
-// +kubebuilder:metadata:labels="cnrm.cloud.google.com/managed-by-kcc=true";"cnrm.cloud.google.com/system=true";"cnrm.cloud.google.com/stability-level=alpha"
+// +kubebuilder:metadata:labels="cnrm.cloud.google.com/managed-by-kcc=true";"cnrm.cloud.google.com/system=true"
 // +kubebuilder:printcolumn:name="Age",JSONPath=".metadata.creationTimestamp",type="date"
 // +kubebuilder:printcolumn:name="Ready",JSONPath=".status.conditions[?(@.type=='Ready')].status",type="string",description="When 'True', the most recent reconcile of the resource succeeded"
 // +kubebuilder:printcolumn:name="Status",JSONPath=".status.conditions[?(@.type=='Ready')].reason",type="string",description="The reason for the value in 'Ready'"
 // +kubebuilder:printcolumn:name="Status Age",JSONPath=".status.conditions[?(@.type=='Ready')].lastTransitionTime",type="date",description="The last transition time for the value in 'Status'"
+
+// ApigeeEnvgroupAttachment is the Schema for the ApigeeEnvgroupAttachment API
+// +k8s:openapi-gen=true
 type ApigeeEnvgroupAttachment struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// +required
 	Spec   ApigeeEnvgroupAttachmentSpec   `json:"spec,omitempty"`
 	Status ApigeeEnvgroupAttachmentStatus `json:"status,omitempty"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
-
-// ApigeeEnvgroupAttachmentList contains a list of EnvgroupAttachment
+// ApigeeEnvgroupAttachmentList contains a list of ApigeeEnvgroupAttachment
 type ApigeeEnvgroupAttachmentList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

apis/apigee/v1alpha1/zz_generated.deepcopy.go

@@ -25,8 +25,8 @@ import (
 )
 
 const (
-	EnvironmentIDToken  = "environments"
-	EnvironmentIDFormat = ApigeeOrganizationIDFormat + "/" + EnvironmentIDToken + "/{{environmentID}}"
+	ApigeeEnvironmentIDToken  = "environments"
+	ApigeeEnvironmentIDFormat = ApigeeOrganizationIDFormat + "/" + ApigeeEnvironmentIDToken + "/{{environmentID}}"
 )
 
 var _ identity.Identity = &ApigeeEnvironmentIdentity{}
@@ -37,20 +37,20 @@ type ApigeeEnvironmentIdentity struct {
 }
 
 func (i *ApigeeEnvironmentIdentity) String() string {
-	return i.ParentID.String() + "/" + EnvironmentIDToken + "/" + i.ResourceID
+	return i.ParentID.String() + "/" + ApigeeEnvironmentIDToken + "/" + i.ResourceID
 }
 
 func (i *ApigeeEnvironmentIdentity) FromExternal(ref string) error {
-	requiredTokens := len(strings.Split(EnvironmentIDFormat, "/"))
+	requiredTokens := len(strings.Split(ApigeeEnvironmentIDFormat, "/"))
 
 	tokens := strings.Split(ref, "/")
-	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != EnvironmentIDToken {
-		return fmt.Errorf("format of ApigeeEnvironment ref=%q was not known (use %q)", ref, EnvironmentIDFormat)
+	if len(tokens) != requiredTokens || tokens[len(tokens)-2] != ApigeeEnvironmentIDToken {
+		return fmt.Errorf("format of ApigeeEnvironment ref=%q was not known (use %q)", ref, ApigeeEnvironmentIDFormat)
 	}
 
 	parentID := &ApigeeOrganizationIdentity{}
 	if err := parentID.FromExternal(strings.Join(tokens[:len(tokens)-2], "/")); err != nil {
-		return fmt.Errorf("format of ApigeeEnvironment ref=%q was not known (use %q)", ref, EnvironmentIDFormat)
+		return fmt.Errorf("format of ApigeeEnvironment ref=%q was not known (use %q)", ref, ApigeeEnvironmentIDFormat)
 	}
 
 	resourceID := tokens[len(tokens)-1]

apis/apigee/v1beta1/environment_identity.go

@@ -126,7 +126,7 @@ func (r *ApigeeEnvironmentRef) Normalize(ctx context.Context, reader client.Read
 		if envID == "" {
 			return k8s.NewReferenceNotReadyError(u.GroupVersionKind(), key)
 		}
-		r.SetExternal(orgRef.External + "/" + EnvironmentIDToken + "/" + envID)
+		r.SetExternal(orgRef.External + "/" + ApigeeEnvironmentIDToken + "/" + envID)
 	}
 
 	id := &ApigeeEnvironmentIdentity{}