add enabled flag to PublishedResources

On-behalf-of: @SAP christoph.mewes@sap.com

Author: xrstf

deploy/crd/kcp.io/syncagent.kcp.io_publishedresources.yaml

@@ -349,6 +349,10 @@ spec:
                       type: object
                   type: object
                 related:
+                  description: |-
+                    Related configures additional resources that semantically belong to the synced
+                    resource, like a Secret containing generated credentials. Related objects are
+                    synced along the main resource.
                   items:
                     properties:
                       group:
@@ -755,6 +759,22 @@ spec:
                     - apiGroup
                     - kind
                   type: object
+                synchronization:
+                  description: Synchronization allows to configure how the syncagent processes this resource.
+                  properties:
+                    enabled:
+                      description: |-
+                        Enabled can be used to toggle the synchronization as a whole. When set to
+                        false, the syncagent will only copy the CRD and include it in the APIExport,
+                        but not will attempt to synchronize objects of this resource from the kcp
+                        workspaces to the provider.
+                        Synchronization must be disabled for resources that are used as related
+                        resources for other PublishedResources. Otherwise the syncagent would
+                        potentially loop and never finish processing an object.
+                      type: boolean
+                  required:
+                    - enabled
+                  type: object
               required:
                 - resource
               type: object

sdk/apis/syncagent/v1alpha1/published_resource.go

@@ -96,7 +96,13 @@ type PublishedResourceSpec struct {
 	// directions during the synchronization.
 	Mutation *ResourceMutationSpec `json:"mutation,omitempty"`
 
+	// Related configures additional resources that semantically belong to the synced
+	// resource, like a Secret containing generated credentials. Related objects are
+	// synced along the main resource.
 	Related []RelatedResourceSpec `json:"related,omitempty"`
+
+	// Synchronization allows to configure how the syncagent processes this resource.
+	Synchronization *SynchronizationSpec `json:"synchronization,omitempty"`
 }
 
 // ResourceNaming describes how the names for local objects should be formed.
@@ -388,6 +394,19 @@ type ResourceFilter struct {
 	Resource *metav1.LabelSelector `json:"resource,omitempty"`
 }
 
+// SynchronizationSpec allows to configure how the syncagent processes a
+// PublishedResource.
+type SynchronizationSpec struct {
+	// Enabled can be used to toggle the synchronization as a whole. When set to
+	// false, the syncagent will only copy the CRD and include it in the APIExport,
+	// but not will attempt to synchronize objects of this resource from the kcp
+	// workspaces to the provider.
+	// Synchronization must be disabled for resources that are used as related
+	// resources for other PublishedResources. Otherwise the syncagent would
+	// potentially loop and never finish processing an object.
+	Enabled bool `json:"enabled"`
+}
+
 // PublishedResourceStatus stores status information about a published resource.
 type PublishedResourceStatus struct {
 	ResourceSchemaName string `json:"resourceSchemaName,omitempty"`