Merge pull request #7562 from ykakarap/runtimesdk-runtimeextensions-settings

✨ add Settings support to RuntimeExtensions

Author: k8s-ci-robot

api/v1beta1/clusterclass_types.go

@@ -532,6 +532,12 @@ type ExternalPatchDefinition struct {
 	// ValidateExtension references an extension which is called to validate the topology.
 	// +optional
 	ValidateExtension *string `json:"validateExtension,omitempty"`
+
+	// Settings defines key value pairs to be passed to the extensions.
+	// Values defined here take precedence over the values defined in the
+	// corresponding ExtensionConfig.
+	// +optional
+	Settings map[string]string `json:"settings,omitempty"`
 }
 
 // LocalObjectTemplate defines a template for a topology Class.

api/v1beta1/zz_generated.deepcopy.go

@@ -34,6 +34,12 @@ type ExtensionConfigSpec struct {
 	// Defaults to the empty LabelSelector, which matches all objects.
 	// +optional
 	NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`
+
+	// Settings defines key value pairs to be passed to all calls
+	// to all supported RuntimeExtensions.
+	// Note: Settings can be overridden on the ClusterClass.
+	// +optional
+	Settings map[string]string `json:"settings,omitempty"`
 }
 
 // ClientConfig contains the information to make a client

api/v1beta1/zz_generated.openapi.go

@@ -20,6 +20,33 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
+// RequestObject is a runtime.Object extended with methods to handle request-specific fields.
+// +kubebuilder:object:generate=false
+type RequestObject interface {
+	runtime.Object
+	GetSettings() map[string]string
+	SetSettings(settings map[string]string)
+}
+
+// CommonRequest is the data structure common to all request types.
+// Note: By embedding CommonRequest in a runtime.Object the RequestObject
+// interface is satisfied.
+type CommonRequest struct {
+	// Settings defines key value pairs to be passed to the call.
+	// +optional
+	Settings map[string]string `json:"settings,omitempty"`
+}
+
+// GetSettings get the Settings field from the CommonRequest.
+func (r *CommonRequest) GetSettings() map[string]string {
+	return r.Settings
+}
+
+// SetSettings sets the Settings field in the CommonRequest.
+func (r *CommonRequest) SetSettings(settings map[string]string) {
+	r.Settings = settings
+}
+
 // ResponseObject is a runtime.Object extended with methods to handle response-specific fields.
 // +kubebuilder:object:generate=false
 type ResponseObject interface {

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

@@ -28,6 +28,9 @@ import (
 type BeforeClusterCreateRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 }
@@ -51,6 +54,9 @@ func BeforeClusterCreate(*BeforeClusterCreateRequest, *BeforeClusterCreateRespon
 type AfterControlPlaneInitializedRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 }
@@ -75,6 +81,9 @@ func AfterControlPlaneInitialized(*AfterControlPlaneInitializedRequest, *AfterCo
 type BeforeClusterUpgradeRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 
@@ -105,6 +114,9 @@ func BeforeClusterUpgrade(*BeforeClusterUpgradeRequest, *BeforeClusterUpgradeRes
 type AfterControlPlaneUpgradeRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 
@@ -132,6 +144,9 @@ func AfterControlPlaneUpgrade(*AfterControlPlaneUpgradeRequest, *AfterControlPla
 type AfterClusterUpgradeRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 
@@ -159,6 +174,9 @@ func AfterClusterUpgrade(*AfterClusterUpgradeRequest, *AfterClusterUpgradeRespon
 type BeforeClusterDeleteRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains fields common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Cluster is the cluster object the lifecycle hook corresponds to.
 	Cluster clusterv1.Cluster `json:"cluster"`
 }

config/crd/bases/runtime.cluster.x-k8s.io_extensionconfigs.yaml

@@ -30,6 +30,9 @@ import (
 type GeneratePatchesRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains Settings field common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Variables are global variables for all templates.
 	Variables []Variable `json:"variables"`
 
@@ -107,6 +110,9 @@ func GeneratePatches(*GeneratePatchesRequest, *GeneratePatchesResponse) {}
 type ValidateTopologyRequest struct {
 	metav1.TypeMeta `json:",inline"`
 
+	// CommonRequest contains Settings field common to all request types.
+	CommonRequest `json:",inline"`
+
 	// Variables are global variables for all templates.
 	Variables []Variable `json:"variables"`