interface: add the new CR-based envelope API [Experimental]

apis/placement/v1alpha1/envelope_types.go

@@ -0,0 +1,129 @@
+/*
+Copyright 2025 The KubeFleet 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 v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+// +genclient
+// +genclient:nonNamespaced
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope="Cluster",categories={fleet,fleet-placement}
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// ClusterResourceEnvelope wraps cluster-scoped resources for placement.
+type ClusterResourceEnvelope struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// The desired state of ClusterResourceEnvelope.
+	// +kubebuilder:validation:Required
+	Spec EnvelopeSpec `json:"spec"`
+
+	// The observed status of ClusterResourceEnvelope.
+	// +kubebuilder:validation:Optional
+	Status ClusterResourceEnvelopeStatus `json:"status,omitempty"`
+}
+
+// EnvelopeSpec helps wrap resources for placement.
+type EnvelopeSpec struct {
+	// A map of wrapped manifests.
+	//
+	// Each manifest is uniquely identified by a string key, typically a filename that represents
+	// the manifest.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinProperties=1
+	// +kubebuilder:validation:MaxProperties=50
+	Manifests map[string]Manifest `json:"manifests"`
+}
+
+// Manifest is a wrapped resource.
+type Manifest struct {
+	// The resource data.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:EmbeddedResource
+	// +kubebuilder:pruning:PreserveUnknownFields
+	Data runtime.RawExtension `json:"data"`
+}
+
+// ClusterResourceEnvelopeStatus is the observed status of a ClusterResourceEnvelope.
+type ClusterResourceEnvelopeStatus struct {
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	//
+	// Conditions is an array of current observed conditions for ClusterResourceEnvelope.
+	// +kubebuilder:validation:Optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+
+	// ManifestConditions is an array of current observed conditions for each manifest in the envelope.
+	// +kubebuilder:validation:Optional
+	ManifestConditions []ManifestCondition `json:"manifestConditions,omitempty"`
+}
+
+// ManifestCondition is the observed conditions of a wrapped manifest.
+type ManifestCondition struct {
+	// The name of the manifest.
+	// +kubebuilder:validation:Required
+	Name string `json:"name"`
+
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	//
+	// Conditions is an array of current observed conditions for a wrapped manifest.
+	// +kubebuilder:validation:Optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+}
+
+// +genclient
+// +genclient:Namespaced
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope="Namespaced",categories={fleet,fleet-placement}
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type ResourceEnvelope struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// The desired state of ResourceEnvelope.
+	// +kubebuilder:validation:Required
+	Spec EnvelopeSpec `json:"spec"`
+
+	// The observed status of ResourceEnvelope.
+	// +kubebuilder:validation:Optional
+	Status ResourceEnvelopeStatus `json:"status,omitempty"`
+}
+
+// ResourceEnvelopeStatus is the observed status of a ResourceEnvelope.
+type ResourceEnvelopeStatus struct {
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	//
+	// Conditions is an array of current observed conditions for ResourceEnvelope.
+	// +kubebuilder:validation:Optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+
+	// ManifestConditions is an array of current observed conditions for each manifest in the envelope.
+	// +kubebuilder:validation:Optional
+	ManifestConditions []ManifestCondition `json:"manifestConditions,omitempty"`
+}