TopologyMutation: Implement external patches

Signed-off-by: Stefan Büringer [email protected]

api/v1beta1/clusterclass_types.go

@@ -338,7 +338,13 @@ type ClusterClassPatch struct {
 
 	// Definitions define the patches inline.
 	// Note: Patches will be applied in the order of the array.
-	Definitions []PatchDefinition `json:"definitions"`
+	// +optional
+	Definitions []PatchDefinition `json:"definitions,omitempty"`
+
+	// External defines an external patch.
+	// FIXME(sbueringer): internal or external only => validate
+	// +optional
+	External *ExternalPatchDefinition `json:"external,omitempty"`
 }
 
 // PatchDefinition defines a patch which is applied to customize the referenced templates.
@@ -441,6 +447,18 @@ type JSONPatchValue struct {
 	Template *string `json:"template,omitempty"`
 }
 
+// ExternalPatchDefinition defines an external patch.
+type ExternalPatchDefinition struct {
+	// GenerateExtension references an extension which is called to generate patches.
+	// FIXME(sbueringer): Q: Fine that GenerateExtension is optional as well?
+	// +optional
+	GenerateExtension *string `json:"generateExtension,omitempty"`
+
+	// GenerateExtension references an extension which is called to validate the topology.
+	// +optional
+	ValidateExtension *string `json:"validateExtension,omitempty"`
+}
+
 // LocalObjectTemplate defines a template for a topology Class.
 type LocalObjectTemplate struct {
 	// Ref is a required reference to a custom resource

config/crd/bases/cluster.x-k8s.io_clusterclasses.yaml

@@ -794,11 +794,24 @@ spec:
                         will be disabled. If EnabledIf is not set, the patch will
                         be enabled per default.
                       type: string
+                    external:
+                      description: 'External defines an external patch. FIXME(sbueringer):
+                        internal or external only => validate'
+                      properties:
+                        generateExtension:
+                          description: 'GenerateExtension references an extension
+                            which is called to generate patches. FIXME(sbueringer):
+                            Q: Fine that GenerateExtension is optional as well?'
+                          type: string
+                        validateExtension:
+                          description: GenerateExtension references an extension which
+                            is called to validate the topology.
+                          type: string
+                      type: object
                     name:
                       description: Name of the patch.
                       type: string
                   required:
-                  - definitions
                   - name
                   type: object
                 type: array

controllers/alias.go

@@ -32,6 +32,7 @@ import (
 	clustertopologycontroller "sigs.k8s.io/cluster-api/internal/controllers/topology/cluster"
 	machinedeploymenttopologycontroller "sigs.k8s.io/cluster-api/internal/controllers/topology/machinedeployment"
 	machinesettopologycontroller "sigs.k8s.io/cluster-api/internal/controllers/topology/machineset"
+	runtimeclient "sigs.k8s.io/cluster-api/internal/runtime/client"
 )
 
 // Following types provides access to reconcilers implemented in internal/controllers, thus
@@ -133,6 +134,8 @@ type ClusterTopologyReconciler struct {
 	// race conditions caused by an outdated cache.
 	APIReader client.Reader
 
+	RuntimeClient runtimeclient.Client
+
 	// WatchFilterValue is the label value used to filter events prior to reconciliation.
 	WatchFilterValue string
 
@@ -146,6 +149,7 @@ func (r *ClusterTopologyReconciler) SetupWithManager(ctx context.Context, mgr ct
 		Client:                    r.Client,
 		APIReader:                 r.APIReader,
 		UnstructuredCachingClient: r.UnstructuredCachingClient,
+		RuntimeClient:             r.RuntimeClient,
 		WatchFilterValue:          r.WatchFilterValue,
 	}).SetupWithManager(ctx, mgr, options)
 }

exp/runtime/hooks/api/v1alpha1/common_types.go

@@ -41,11 +41,12 @@ type RetryResponseObject interface {
 
 // CommonResponse is the data structure common to all response types.
 type CommonResponse struct {
-	// Status of the call. One of "Success" or "Failure".
+	// Status of the call.
+	// One of: "Success" or "Failure".
 	Status ResponseStatus `json:"status"`
 
 	// A human-readable description of the status of the call.
-	Message string `json:"message"`
+	Message string `json:"message,omitempty"`
 }
 
 // SetMessage sets the message field for the CommonResponse.

exp/runtime/hooks/api/v1alpha1/topologymutation_types.go

@@ -171,7 +171,7 @@ type HolderReference struct {
 }
 
 // ValidateTopology validates the Cluster topology after all patches have been applied.
-func ValidateTopology(*GeneratePatchesRequest, *GeneratePatchesResponse) {}
+func ValidateTopology(*ValidateTopologyRequest, *ValidateTopologyResponse) {}
 
 func init() {
 	catalogBuilder.RegisterHook(GeneratePatches, &runtimecatalog.HookMeta{