Merge pull request #3702 from xiaoweim/vertexai-metadatastore-api-mapper

Add API and mapper and controller for Vertex AI Metadatastore

Author: google-oss-prow[bot]

apis/vertexai/v1alpha1/metadatastore_identity.go

@@ -0,0 +1,117 @@
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/GoogleCloudPlatform/k8s-config-connector/apis/common"
+	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+// MetadataStoreIdentity defines the resource reference to VertexAIMetadataStore, which "External" field
+// holds the GCP identifier for the KRM object.
+type MetadataStoreIdentity struct {
+	parent *MetadataStoreParent
+	id     string
+}
+
+func (i *MetadataStoreIdentity) String() string {
+	return i.parent.String() + "/metadataStores/" + i.id
+}
+
+func (i *MetadataStoreIdentity) ID() string {
+	return i.id
+}
+
+func (i *MetadataStoreIdentity) Parent() *MetadataStoreParent {
+	return i.parent
+}
+
+type MetadataStoreParent struct {
+	ProjectID string
+	Location  string
+}
+
+func (p *MetadataStoreParent) String() string {
+	return "projects/" + p.ProjectID + "/locations/" + p.Location
+}
+
+// New builds a MetadataStoreIdentity from the Config Connector MetadataStore object.
+func NewMetadataStoreIdentity(ctx context.Context, reader client.Reader, obj *VertexAIMetadataStore) (*MetadataStoreIdentity, error) {
+
+	// Get Parent
+	projectRef, err := refsv1beta1.ResolveProject(ctx, reader, obj.GetNamespace(), obj.Spec.ProjectRef)
+	if err != nil {
+		return nil, err
+	}
+	projectID := projectRef.ProjectID
+	if projectID == "" {
+		return nil, fmt.Errorf("cannot resolve project")
+	}
+	location := obj.Spec.Region
+
+	// Get desired ID
+	resourceID := common.ValueOf(obj.Spec.ResourceID)
+	if resourceID == "" {
+		resourceID = obj.GetName()
+	}
+	if resourceID == "" {
+		return nil, fmt.Errorf("cannot resolve resource ID")
+	}
+
+	// Use approved External
+	externalRef := common.ValueOf(obj.Status.ExternalRef)
+	if externalRef != "" {
+		// Validate desired with actual
+		actualParent, actualResourceID, err := ParseMetadataStoreExternal(externalRef)
+		if err != nil {
+			return nil, err
+		}
+		if actualParent.ProjectID != projectID {
+			return nil, fmt.Errorf("spec.projectRef changed, expect %s, got %s", actualParent.ProjectID, projectID)
+		}
+		if actualParent.Location != location {
+			return nil, fmt.Errorf("spec.location changed, expect %s, got %s", actualParent.Location, location)
+		}
+		if actualResourceID != resourceID {
+			return nil, fmt.Errorf("cannot reset `metadata.name` or `spec.resourceID` to %s, since it has already assigned to %s",
+				resourceID, actualResourceID)
+		}
+	}
+	return &MetadataStoreIdentity{
+		parent: &MetadataStoreParent{
+			ProjectID: projectID,
+			Location:  location,
+		},
+		id: resourceID,
+	}, nil
+}
+
+func ParseMetadataStoreExternal(external string) (parent *MetadataStoreParent, resourceID string, err error) {
+	tokens := strings.Split(external, "/")
+	if len(tokens) != 6 || tokens[0] != "projects" || tokens[2] != "locations" || tokens[4] != "metadataStores" {
+		return nil, "", fmt.Errorf("format of VertexAIMetadataStore external=%q was not known (use projects/{{projectID}}/locations/{{location}}/metadataStores/{{metadatastoreID}})", external)
+	}
+	parent = &MetadataStoreParent{
+		ProjectID: tokens[1],
+		Location:  tokens[3],
+	}
+	resourceID = tokens[5]
+	return parent, resourceID, nil
+}

apis/vertexai/v1alpha1/metadatastore_reference.go

@@ -0,0 +1,83 @@
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
+
+import (
+	"context"
+	"fmt"
+
+	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ refsv1beta1.ExternalNormalizer = &MetadataStoreRef{}
+
+// MetadataStoreRef defines the resource reference to VertexAIMetadataStore, which "External" field
+// holds the GCP identifier for the KRM object.
+type MetadataStoreRef struct {
+	// A reference to an externally managed VertexAIMetadataStore resource.
+	// Should be in the format "projects/{{projectID}}/locations/{{location}}/metadatastores/{{metadatastoreID}}".
+	External string `json:"external,omitempty"`
+
+	// The name of a VertexAIMetadataStore resource.
+	Name string `json:"name,omitempty"`
+
+	// The namespace of a VertexAIMetadataStore resource.
+	Namespace string `json:"namespace,omitempty"`
+}
+
+// NormalizedExternal provision the "External" value for other resource that depends on VertexAIMetadataStore.
+// If the "External" is given in the other resource's spec.VertexAIMetadataStoreRef, the given value will be used.
+// Otherwise, the "Name" and "Namespace" will be used to query the actual VertexAIMetadataStore object from the cluster.
+func (r *MetadataStoreRef) NormalizedExternal(ctx context.Context, reader client.Reader, otherNamespace string) (string, error) {
+	if r.External != "" && r.Name != "" {
+		return "", fmt.Errorf("cannot specify both name and external on %s reference", VertexAIMetadataStoreGVK.Kind)
+	}
+	// From given External
+	if r.External != "" {
+		if _, _, err := ParseMetadataStoreExternal(r.External); err != nil {
+			return "", err
+		}
+		return r.External, nil
+	}
+
+	// From the Config Connector object
+	if r.Namespace == "" {
+		r.Namespace = otherNamespace
+	}
+	key := types.NamespacedName{Name: r.Name, Namespace: r.Namespace}
+	u := &unstructured.Unstructured{}
+	u.SetGroupVersionKind(VertexAIMetadataStoreGVK)
+	if err := reader.Get(ctx, key, u); err != nil {
+		if apierrors.IsNotFound(err) {
+			return "", k8s.NewReferenceNotFoundError(u.GroupVersionKind(), key)
+		}
+		return "", fmt.Errorf("reading referenced %s %s: %w", VertexAIMetadataStoreGVK, key, err)
+	}
+	// Get external from status.externalRef. This is the most trustworthy place.
+	actualExternalRef, _, err := unstructured.NestedString(u.Object, "status", "externalRef")
+	if err != nil {
+		return "", fmt.Errorf("reading status.externalRef: %w", err)
+	}
+	if actualExternalRef == "" {
+		return "", k8s.NewReferenceNotReadyError(u.GroupVersionKind(), key)
+	}
+	r.External = actualExternalRef
+	return r.External, nil
+}

apis/vertexai/v1alpha1/metadatastore_types.go

@@ -0,0 +1,120 @@
+// 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.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package v1alpha1
+
+import (
+	refsv1beta1 "github.com/GoogleCloudPlatform/k8s-config-connector/apis/refs/v1beta1"
+	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/apis/k8s/v1alpha1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+var VertexAIMetadataStoreGVK = GroupVersion.WithKind("VertexAIMetadataStore")
+
+// VertexAIMetadataStoreSpec defines the desired state of VertexAIMetadataStore
+// +kcc:proto=google.cloud.aiplatform.v1beta1.MetadataStore
+type VertexAIMetadataStoreSpec struct {
+	// Customer-managed encryption key spec for a Metadata Store. If set, this
+	// Metadata Store and all sub-resources of this Metadata Store are secured
+	// using this key.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.encryption_spec
+	EncryptionSpec *EncryptionSpec `json:"encryptionSpec,omitempty"`
+
+	// Optional. Dataplex integration settings.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.dataplex_config
+	DataplexConfig *MetadataStore_DataplexConfig `json:"dataplexConfig,omitempty"`
+
+	// Description of the MetadataStore.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.description
+	Description *string `json:"description,omitempty"`
+
+	// The region of the Metadata Store. eg us-central1.
+	Region string `json:"region,omitempty"`
+
+	// The project that this resource belongs to.
+	ProjectRef *refsv1beta1.ProjectRef `json:"projectRef,omitempty"`
+
+	// The VertexAIMetadataStore name. If not given, the metadata.name will be used.
+	ResourceID *string `json:"resourceID,omitempty"`
+}
+
+// VertexAIMetadataStoreStatus defines the config connector machine state of VertexAIMetadataStore
+type VertexAIMetadataStoreStatus struct {
+	/* 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"`
+
+	// A unique specifier for the VertexAIMetadataStore resource in GCP.
+	ExternalRef *string `json:"externalRef,omitempty"`
+
+	// ObservedState is the state of the resource as most recently observed in GCP.
+	ObservedState *VertexAIMetadataStoreObservedState `json:"observedState,omitempty"`
+}
+
+// VertexAIMetadataStoreObservedState is the state of the VertexAIMetadataStore resource as most recently observed in GCP.
+// +kcc:proto=google.cloud.aiplatform.v1beta1.MetadataStore
+type VertexAIMetadataStoreObservedState struct {
+	// Output only. The resource name of the MetadataStore instance.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.name
+	Name *string `json:"name,omitempty"`
+
+	// Output only. Timestamp when this MetadataStore was created.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.create_time
+	CreateTime *string `json:"createTime,omitempty"`
+
+	// Output only. Timestamp when this MetadataStore was last updated.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.update_time
+	UpdateTime *string `json:"updateTime,omitempty"`
+
+	// Output only. State information of the MetadataStore.
+	// +kcc:proto:field=google.cloud.aiplatform.v1beta1.MetadataStore.state
+	State *MetadataStore_MetadataStoreState `json:"state,omitempty"`
+}
+
+// +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=gcpvertexaimetadatastore;gcpvertexaimetadatastores
+// +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: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'"
+
+// VertexAIMetadataStore is the Schema for the VertexAIMetadataStore API
+// +k8s:openapi-gen=true
+type VertexAIMetadataStore struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// +required
+	Spec   VertexAIMetadataStoreSpec   `json:"spec,omitempty"`
+	Status VertexAIMetadataStoreStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// VertexAIMetadataStoreList contains a list of VertexAIMetadataStore
+type VertexAIMetadataStoreList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []VertexAIMetadataStore `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&VertexAIMetadataStore{}, &VertexAIMetadataStoreList{})
+}