use controller-runtime logging in controller

Author: interma

pkg/scaffold/controller/controller.go

@@ -120,8 +120,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 	{{ .Resource.Group}}{{ .Resource.Version }} "{{ .ResourcePackage }}/{{ .Resource.Group}}/{{ .Resource.Version }}"
+)
+
+var log = logf.Log.WithName("controller")
 {{ else }}	"context"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -133,8 +137,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 	{{ .Resource.Group}}{{ .Resource.Version }} "{{ .ResourcePackage }}/{{ .Resource.Group}}/{{ .Resource.Version }}"
-{{ end -}}
 )
+{{ end -}}
 
 /**
 * USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
@@ -245,7 +249,7 @@ func (r *Reconcile{{ .Resource.Kind }}) Reconcile(request reconcile.Request) (re
 	found := &appsv1.Deployment{}
 	err = r.Get(context.TODO(), types.NamespacedName{Name: deploy.Name, Namespace: deploy.Namespace}, found)
 	if err != nil && errors.IsNotFound(err) {
-		log.Printf("Creating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
+		log.Info("Creating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
 		err = r.Create(context.TODO(), deploy)
 		if err != nil {
 			return reconcile.Result{}, err
@@ -258,7 +262,7 @@ func (r *Reconcile{{ .Resource.Kind }}) Reconcile(request reconcile.Request) (re
 	// Update the found object and write the result back if there are any changes
 	if !reflect.DeepEqual(deploy.Spec, found.Spec) {
 		found.Spec = deploy.Spec
-		log.Printf("Updating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
+		log.Info("Updating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
 		err = r.Update(context.TODO(), found)
 		if err != nil {
 			return reconcile.Result{}, err

pkg/scaffold/controller/controllersuitetest.go

@@ -47,7 +47,7 @@ var controllerSuiteTestTemplate = `{{ .Boilerplate }}
 package {{ lower .Resource.Kind }}
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -72,7 +72,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()

test/project/pkg/controller/firstmate/firstmate_controller.go

@@ -18,7 +18,6 @@ package firstmate
 
 import (
 	"context"
-	"log"
 	"reflect"
 
 	appsv1 "k8s.io/api/apps/v1"
@@ -33,10 +32,13 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 	crewv1 "sigs.k8s.io/kubebuilder/test/project/pkg/apis/crew/v1"
 )
 
+var log = logf.Log.WithName("controller")
+
 /**
 * USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
 * business logic.  Delete these comments after modifying this file.*
@@ -143,7 +145,7 @@ func (r *ReconcileFirstMate) Reconcile(request reconcile.Request) (reconcile.Res
 	found := &appsv1.Deployment{}
 	err = r.Get(context.TODO(), types.NamespacedName{Name: deploy.Name, Namespace: deploy.Namespace}, found)
 	if err != nil && errors.IsNotFound(err) {
-		log.Printf("Creating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
+		log.Info("Creating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
 		err = r.Create(context.TODO(), deploy)
 		if err != nil {
 			return reconcile.Result{}, err
@@ -156,7 +158,7 @@ func (r *ReconcileFirstMate) Reconcile(request reconcile.Request) (reconcile.Res
 	// Update the found object and write the result back if there are any changes
 	if !reflect.DeepEqual(deploy.Spec, found.Spec) {
 		found.Spec = deploy.Spec
-		log.Printf("Updating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
+		log.Info("Updating Deployment %s/%s\n", deploy.Namespace, deploy.Name)
 		err = r.Update(context.TODO(), found)
 		if err != nil {
 			return reconcile.Result{}, err

test/project/pkg/controller/firstmate/firstmate_controller_suite_test.go

@@ -17,7 +17,7 @@ limitations under the License.
 package firstmate
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -42,7 +42,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()

test/project/pkg/controller/frigate/frigate_controller_suite_test.go

@@ -17,7 +17,7 @@ limitations under the License.
 package frigate
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -42,7 +42,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()

test/project/pkg/controller/healthcheckpolicy/healthcheckpolicy_controller_suite_test.go

@@ -17,7 +17,7 @@ limitations under the License.
 package healthcheckpolicy
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -42,7 +42,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()

test/project/pkg/controller/kraken/kraken_controller_suite_test.go

@@ -17,7 +17,7 @@ limitations under the License.
 package kraken
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -42,7 +42,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()

test/project/pkg/controller/namespace/namespace_controller_suite_test.go

@@ -17,7 +17,7 @@ limitations under the License.
 package namespace
 
 import (
-	"log"
+	stdlog "log"
 	"os"
 	"path/filepath"
 	"sync"
@@ -42,7 +42,7 @@ func TestMain(m *testing.M) {
 
 	var err error
 	if cfg, err = t.Start(); err != nil {
-		log.Fatal(err)
+		stdlog.Fatal(err)
 	}
 
 	code := m.Run()