Template folder cleanup (v3)

- Structure the template files in the same way as the scaffolded files
- Provide a more descriptive name and comment for each template
- Fix references to interfaces being implemented

Signed-off-by: Adrian Orive <[email protected]>

Author: Adirio

pkg/plugin/v3/scaffolds/api.go

@@ -25,11 +25,12 @@ import (
 	"sigs.k8s.io/kubebuilder/pkg/plugin/internal/machinery"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/scaffold"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates"
-	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/api"
-	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/controller"
+	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/api"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/crd"
+	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/crd/patches"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/rbac"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/samples"
+	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/controllers"
 )
 
 var _ scaffold.Scaffolder = &apiScaffolder{}
@@ -92,8 +93,8 @@ func (s *apiScaffolder) scaffold() error {
 			&samples.CRDSample{},
 			&rbac.CRDEditorRole{},
 			&rbac.CRDViewerRole{},
-			&crd.EnableWebhookPatch{},
-			&crd.EnableCAInjectionPatch{},
+			&patches.EnableWebhookPatch{},
+			&patches.EnableCAInjectionPatch{},
 		); err != nil {
 			return fmt.Errorf("error scaffolding APIs: %v", err)
 		}
@@ -111,8 +112,8 @@ func (s *apiScaffolder) scaffold() error {
 	if s.doController {
 		if err := machinery.NewScaffold(s.plugins...).Execute(
 			s.newUniverse(),
-			&controller.SuiteTest{WireResource: s.doResource},
-			&controller.Controller{ControllerRuntimeVersion: ControllerRuntimeVersion, WireResource: s.doResource},
+			&controllers.SuiteTest{WireResource: s.doResource},
+			&controllers.Controller{ControllerRuntimeVersion: ControllerRuntimeVersion, WireResource: s.doResource},
 		); err != nil {
 			return fmt.Errorf("error scaffolding controller: %v", err)
 		}

pkg/plugin/v3/scaffolds/init.go

@@ -27,12 +27,12 @@ import (
 	"sigs.k8s.io/kubebuilder/pkg/plugin/scaffold"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/certmanager"
-	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/hack"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/kdefault"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/manager"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/prometheus"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/rbac"
 	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/webhook"
+	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/hack"
 )
 
 const (
@@ -101,9 +101,9 @@ func (s *initScaffolder) scaffold() error {
 		&templates.GitIgnore{},
 		&rbac.AuthProxyRole{},
 		&rbac.AuthProxyRoleBinding{},
-		&kdefault.AuthProxyPatch{},
+		&kdefault.ManagerAuthProxyPatch{},
 		&rbac.AuthProxyService{},
-		&rbac.ClientClusterRole{},
+		&rbac.AuthProxyClientRole{},
 		&manager.Config{Image: imageName},
 		&templates.Main{},
 		&templates.GoMod{ControllerRuntimeVersion: ControllerRuntimeVersion},
@@ -115,20 +115,20 @@ func (s *initScaffolder) scaffold() error {
 			ControllerRuntimeVersion: ControllerRuntimeVersion,
 		},
 		&templates.Dockerfile{},
-		&templates.DockerignoreFile{},
-		&kdefault.Kustomize{},
+		&templates.DockerIgnore{},
+		&kdefault.Kustomization{},
 		&kdefault.ManagerWebhookPatch{},
-		&rbac.ManagerRoleBinding{},
+		&rbac.RoleBinding{},
 		&rbac.LeaderElectionRole{},
 		&rbac.LeaderElectionRoleBinding{},
-		&rbac.KustomizeRBAC{},
+		&rbac.Kustomization{},
 		&manager.Kustomization{},
 		&webhook.Kustomization{},
-		&webhook.KustomizeConfigWebhook{},
+		&webhook.KustomizeConfig{},
 		&webhook.Service{},
 		&prometheus.Kustomization{},
-		&prometheus.ServiceMonitor{},
-		&certmanager.CertManager{},
+		&prometheus.Monitor{},
+		&certmanager.Certificate{},
 		&certmanager.Kustomization{},
 		&certmanager.KustomizeConfig{},
 	)

pkg/plugin/v3/scaffolds/internal/templates/config/api/group.go renamed to pkg/plugin/v3/scaffolds/internal/templates/api/group.go

@@ -24,15 +24,15 @@ import (
 
 var _ file.Template = &Group{}
 
-// Group scaffolds the api/<version>/groupversion_info.go
+// Group scaffolds the file that defines the registration methods for a certain group and version
 type Group struct {
 	file.TemplateMixin
 	file.MultiGroupMixin
 	file.BoilerplateMixin
 	file.ResourceMixin
 }
 
-// SetTemplateDefaults implements input.Template
+// SetTemplateDefaults implements file.Template
 func (f *Group) SetTemplateDefaults() error {
 	if f.Path == "" {
 		if f.MultiGroup {

pkg/plugin/v3/scaffolds/internal/templates/config/api/types.go renamed to pkg/plugin/v3/scaffolds/internal/templates/api/types.go

@@ -25,15 +25,15 @@ import (
 
 var _ file.Template = &Types{}
 
-// Types scaffolds the api/<version>/<kind>_types.go file to define the schema for an API
+// Types scaffolds the file that defines the schema for a CRD
 type Types struct {
 	file.TemplateMixin
 	file.MultiGroupMixin
 	file.BoilerplateMixin
 	file.ResourceMixin
 }
 
-// SetTemplateDefaults implements input.Template
+// SetTemplateDefaults implements file.Template
 func (f *Types) SetTemplateDefaults() error {
 	if f.Path == "" {
 		if f.MultiGroup {

pkg/plugin/v3/scaffolds/internal/templates/config/api/webhook.go renamed to pkg/plugin/v3/scaffolds/internal/templates/api/webhook.go

@@ -26,7 +26,7 @@ import (
 
 var _ file.Template = &Webhook{}
 
-// Webhook scaffolds a Webhook for a Resource
+// Webhook scaffolds the file that defines a webhook for a CRD or a builtin resource
 type Webhook struct { // nolint:maligned
 	file.TemplateMixin
 	file.MultiGroupMixin
@@ -42,7 +42,7 @@ type Webhook struct { // nolint:maligned
 	Validating bool
 }
 
-// SetTemplateDefaults implements input.Template
+// SetTemplateDefaults implements file.Template
 func (f *Webhook) SetTemplateDefaults() error {
 	if f.Path == "" {
 		if f.MultiGroup {

pkg/plugin/v3/scaffolds/internal/templates/config/api/webhook_suitetest.go renamed to pkg/plugin/v3/scaffolds/internal/templates/api/webhook_suitetest.go

@@ -10,7 +10,7 @@ import (
 var _ file.Template = &WebhookSuite{}
 var _ file.Inserter = &WebhookSuite{}
 
-// WebhookSuite scaffolds the webhook_suite.go file to setup the webhook test
+// WebhookSuite scaffolds the file that sets up the webhook tests
 type WebhookSuite struct {
 	file.TemplateMixin
 	file.MultiGroupMixin

pkg/plugin/v3/scaffolds/internal/templates/config/certmanager/certificate.go

@@ -22,15 +22,15 @@ import (
 	"sigs.k8s.io/kubebuilder/pkg/model/file"
 )
 
-var _ file.Template = &CertManager{}
+var _ file.Template = &Certificate{}
 
-// CertManager scaffolds an issuer CR and a certificate CR
-type CertManager struct {
+// Certificate scaffolds a file that defines the issuer CR and the certificate CR
+type Certificate struct {
 	file.TemplateMixin
 }
 
-// SetTemplateDefaults implements input.Template
-func (f *CertManager) SetTemplateDefaults() error {
+// SetTemplateDefaults implements file.Template
+func (f *Certificate) SetTemplateDefaults() error {
 	if f.Path == "" {
 		f.Path = filepath.Join("config", "certmanager", "certificate.yaml")
 	}

pkg/plugin/v3/scaffolds/internal/templates/config/certmanager/kustomize.go renamed to pkg/plugin/v3/scaffolds/internal/templates/config/certmanager/kustomization.go

@@ -24,12 +24,12 @@ import (
 
 var _ file.Template = &Kustomization{}
 
-// Kustomization scaffolds the kustomizaiton in the certmanager folder
+// Kustomization scaffolds a file that defines the kustomization scheme for the certmanager folder
 type Kustomization struct {
 	file.TemplateMixin
 }
 
-// SetTemplateDefaults implements input.Template
+// SetTemplateDefaults implements file.Template
 func (f *Kustomization) SetTemplateDefaults() error {
 	if f.Path == "" {
 		f.Path = filepath.Join("config", "certmanager", "kustomization.yaml")

pkg/plugin/v3/scaffolds/internal/templates/config/certmanager/kustomizeconfig.go

@@ -24,12 +24,12 @@ import (
 
 var _ file.Template = &KustomizeConfig{}
 
-// KustomizeConfig scaffolds the kustomizeconfig in the certmanager folder
+// KustomizeConfig scaffolds a file that configures the kustomization for the certmanager folder
 type KustomizeConfig struct {
 	file.TemplateMixin
 }
 
-// SetTemplateDefaults implements input.Template
+// SetTemplateDefaults implements file.Template
 func (f *KustomizeConfig) SetTemplateDefaults() error {
 	if f.Path == "" {
 		f.Path = filepath.Join("config", "certmanager", "kustomizeconfig.yaml")

pkg/plugin/v3/scaffolds/internal/templates/config/crd/kustomization.go

@@ -26,7 +26,7 @@ import (
 var _ file.Template = &Kustomization{}
 var _ file.Inserter = &Kustomization{}
 
-// Kustomization scaffolds the kustomization file in manager folder.
+// Kustomization scaffolds a file that defines the kustomization scheme for the crd folder
 type Kustomization struct {
 	file.TemplateMixin
 	file.ResourceMixin