add option to specify additional managed types (#225)

* add option to specify additional managed types (1)

* add option to specify additional managed types (2)

* add generate markers, generate

* add option to specify additional managed types (3)

* add option to specify additional managed types (4)

* add option to specify additional managed types (5)

* update docs

* improve apply handing for APIService objects

Author: cbarbian-sap

clm/cmd/delete.go

@@ -61,7 +61,7 @@ func newDeleteCmd() *cobra.Command {
 				return err
 			}
 
-			if ok, msg, err := reconciler.IsDeletionAllowed(context.TODO(), &release.Inventory); err != nil {
+			if ok, msg, err := reconciler.IsDeletionAllowed(context.TODO(), &release.Inventory, ownerId); err != nil {
 				return err
 			} else if !ok {
 				return fmt.Errorf(msg)

clm/cmd/util.go

@@ -67,7 +67,7 @@ func isEphmeralError(err error) bool {
 }
 
 func formatTimestamp(t time.Time) string {
-	d := time.Now().Sub(t)
+	d := time.Since(t)
 	if d > 24*time.Hour {
 		return fmt.Sprintf("%dd", d/24*time.Hour)
 	} else if d > time.Hour {

pkg/component/component.go

@@ -109,6 +109,17 @@ func assertPolicyConfiguration[T Component](component T) (PolicyConfiguration, b
 	return nil, false
 }
 
+// Check if given component or its spec implements TypeConfiguration (and return it).
+func assertTypeConfiguration[T Component](component T) (TypeConfiguration, bool) {
+	if typeConfiguration, ok := Component(component).(TypeConfiguration); ok {
+		return typeConfiguration, true
+	}
+	if typeConfiguration, ok := getSpec(component).(TypeConfiguration); ok {
+		return typeConfiguration, true
+	}
+	return nil, false
+}
+
 // Calculate digest of given component, honoring annotations, spec, and references.
 func calculateComponentDigest[T Component](component T) string {
 	digestData := make(map[string]any)
@@ -218,6 +229,11 @@ func (s *PolicySpec) GetMissingNamespacesPolicy() reconciler.MissingNamespacesPo
 	return s.MissingNamespacesPolicy
 }
 
+// Implement the TypeConfiguration interface.
+func (s *TypeSpec) GetAdditionalManagedTypes() []reconciler.TypeInfo {
+	return s.AdditionalManagedTypes
+}
+
 // Check if state is Ready.
 func (s *Status) IsReady() bool {
 	// caveat: this operates only on the status, so it does not check that observedGeneration == generation

pkg/component/reconciler.go

@@ -730,5 +730,8 @@ func (r *Reconciler[T]) getOptionsForComponent(component T) reconciler.Reconcile
 			options.MissingNamespacesPolicy = &missingNamespacesPolicy
 		}
 	}
+	if typeConfiguration, ok := assertTypeConfiguration(component); ok {
+		options.AdditionalManagedTypes = typeConfiguration.GetAdditionalManagedTypes()
+	}
 	return options
 }

pkg/component/target.go

@@ -82,7 +82,8 @@ func (t *reconcileTarget[T]) Delete(ctx context.Context, component T) (bool, err
 
 func (t *reconcileTarget[T]) IsDeletionAllowed(ctx context.Context, component T) (bool, string, error) {
 	// log := log.FromContext(ctx)
+	ownerId := t.reconcilerId + "/" + component.GetNamespace() + "/" + component.GetName()
 	status := component.GetStatus()
 
-	return t.reconciler.IsDeletionAllowed(ctx, &status.Inventory)
+	return t.reconciler.IsDeletionAllowed(ctx, &status.Inventory, ownerId)
 }

pkg/component/types.go

@@ -101,6 +101,17 @@ type PolicyConfiguration interface {
 	GetMissingNamespacesPolicy() reconciler.MissingNamespacesPolicy
 }
 
+// The TypeConfiguration interface is meant to be implemented by compoments (or their spec) which allow
+// to specify additional managed types.
+type TypeConfiguration interface {
+	// Get additional managed types; instances of these types are handled differently during
+	// apply and delete; foreign instances of these types will block deletion of the component.
+	// The fields of the returned TypeInfo structs can be concrete api groups, kinds,
+	// or wildcards ("*"); in addition, groups can be specified as a pattern of the form "*.<suffix>"",
+	// where the wildcard matches one or multiple dns labels.
+	GetAdditionalManagedTypes() []reconciler.TypeInfo
+}
+
 // +kubebuilder:object:generate=true
 
 // Legacy placement spec. Components may include this into their spec.
@@ -201,6 +212,16 @@ var _ PolicyConfiguration = &PolicySpec{}
 
 // +kubebuilder:object:generate=true
 
+// TypeSpec allows to specify additional managed types, which are not explicitly part of the component's manifests.
+// Components providing TypeConfiguration may include this into their spec.
+type TypeSpec struct {
+	AdditionalManagedTypes []reconciler.TypeInfo `json:"additionalManagedTypes,omitempty"`
+}
+
+var _ TypeConfiguration = &TypeSpec{}
+
+// +kubebuilder:object:generate=true
+
 // Component Status. Components must include this into their status.
 type Status struct {
 	ObservedGeneration int64        `json:"observedGeneration"`

pkg/component/zz_generated.deepcopy.go

@@ -18,12 +18,12 @@ func (i *InventoryItem) GetObjectKind() schema.ObjectKind {
 
 // Get inventory item's GroupVersionKind.
 func (i InventoryItem) GroupVersionKind() schema.GroupVersionKind {
-	return schema.GroupVersionKind(i.TypeInfo)
+	return schema.GroupVersionKind(i.TypeVersionInfo)
 }
 
 // Set inventory item's GroupVersionKind.
 func (i *InventoryItem) SetGroupVersionKind(gvk schema.GroupVersionKind) {
-	i.TypeInfo = TypeInfo(gvk)
+	i.TypeVersionInfo = TypeVersionInfo(gvk)
 }
 
 // Get inventory item's namespace.