simplify scaffolding

Author: cbarbian-sap

scaffold/templates/api/v1alpha1/types.go.tpl

@@ -17,27 +17,27 @@ limitations under the License.
 package {{ .groupVersion }}
 
 import (
-	"context"
-
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	runtime "k8s.io/apimachinery/pkg/runtime"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/sap/component-operator-runtime/pkg/component"
 	componentoperatorruntimetypes "github.com/sap/component-operator-runtime/pkg/types"
 )
 
 // {{ .kind }}Spec defines the desired state of {{ .kind }}
 type {{ .kind }}Spec struct {
-	// You can remove component.Spec, but then you have to provide your own (meaningful)
-	// implementations of GetDeploymentNamespace() and GetDeploymentName() below.
-	component.Spec `json:",inline"`
+	// Uncomment the following if you want to make deployment namespace and name configurable
+	// here in the spec (independently of the component's metadata.namespace and metadata.name);
+	// if you do, also review the implementations of GetDeploymentNamespace() and GetDeploymentName() below.
+	// component.Spec `json:",inline"`
+
 	// Add your own fields here, describing the deployment of the managed component.
 }
 
 // {{ .kind }}Status defines the observed state of {{ .kind }}
 type {{ .kind }}Status struct {
 	component.Status `json:",inline"`
+
 	// You may add your own fields here; this is rarely needed.
 }
 
@@ -76,16 +76,18 @@ func (s *{{ .kind }}Spec) ToUnstructured() map[string]any {
 }
 
 func (c *{{ .kind }}) GetDeploymentNamespace() string {
-	if c.Spec.Namespace != "" {
-		return c.Spec.Namespace
-	}
+	// Uncomment the following if you allow specification of deployment namespace via the component spec.
+	// if c.Spec.Namespace != "" {
+	// 	return c.Spec.Namespace
+	// }
 	return c.Namespace
 }
 
 func (c *{{ .kind }}) GetDeploymentName() string {
-	if c.Spec.Name != "" {
-		return c.Spec.Name
-	}
+	// Uncomment the following if you allow specification of deployment name via the component spec.
+	// if c.Spec.Name != "" {
+	// 	return c.Spec.Name
+	// }
 	return c.Name
 }
 
@@ -97,22 +99,6 @@ func (c *{{ .kind }}) GetStatus() *component.Status {
 	return &c.Status.Status
 }
 
-// The following post read hook ensures that Spec.Namespace and Spec.Name are properly defaulted (as metadata.namespace/metadata.name).
-// The hook will be called by the reconciler after retrieving the component object from the Kubernetes API.
-// Of course, the same could be (better) achieved by a mutating admission webhook, but we strive to build component operators
-// without admission webhooks.
-// You can remove this hook (and its registration in pkg/operator/operator.go) if you do not use .Spec.Namespace or .Spec.Name anywhere,
-// or if you have chosen not to include component.Spec in {{.kind}}Spec above.
-func PostReadHook(ctx context.Context, client client.Client, c *{{ .kind }}) error {
-	if c.Spec.Namespace == "" {
-		c.Spec.Namespace = c.Namespace
-	}
-	if c.Spec.Name == "" {
-		c.Spec.Name = c.Name
-	}
-	return nil
-}
-
 func init() {
 	SchemeBuilder.Register(&{{ .kind }}{}, &{{ .kind }}List{})
 }

scaffold/templates/pkg/operator/operator.go.tpl

@@ -117,8 +117,6 @@ func (o *Operator) Setup(mgr ctrl.Manager, discoveryClient discovery.DiscoveryIn
 		mgr.GetEventRecorderFor(o.options.Name),
 		mgr.GetScheme(),
 		resourceGenerator,
-	).WithPostReadHook(
-		operatorv1alpha1.PostReadHook,
 	).SetupWithManager(mgr); err != nil {
 		return errors.Wrapf(err, "unable to create controller")
 	}