Skip to content

Commit c3d8740

Browse files
committed
Consolidate around klog/v2
1 parent 07b3bdd commit c3d8740

File tree

15 files changed

+302
-237
lines changed

15 files changed

+302
-237
lines changed

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ go 1.24.4
55
require (
66
github.com/cert-manager/cert-manager v1.18.3
77
github.com/go-bindata/go-bindata v3.1.2+incompatible
8-
github.com/go-logr/logr v1.4.2
98
github.com/golangci/golangci-lint v1.50.1
109
github.com/google/go-cmp v0.6.0
1110
github.com/google/go-jsonnet v0.17.0
@@ -91,6 +90,7 @@ require (
9190
github.com/fzipp/gocyclo v0.6.0 // indirect
9291
github.com/go-critic/go-critic v0.6.5 // indirect
9392
github.com/go-errors/errors v1.4.2 // indirect
93+
github.com/go-logr/logr v1.4.2 // indirect
9494
github.com/go-logr/stdr v1.2.2 // indirect
9595
github.com/go-logr/zapr v1.3.0 // indirect
9696
github.com/go-openapi/jsonpointer v0.21.0 // indirect

pkg/controller/istiocsr/certificates.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55

66
corev1 "k8s.io/api/core/v1"
77
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
8+
"k8s.io/klog/v2"
89
"sigs.k8s.io/controller-runtime/pkg/client"
910

1011
certmanagerv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
@@ -21,7 +22,7 @@ func (r *Reconciler) createOrApplyCertificates(istiocsr *v1alpha1.IstioCSR, reso
2122
}
2223

2324
certificateName := fmt.Sprintf("%s/%s", desired.GetNamespace(), desired.GetName())
24-
r.log.V(4).Info("reconciling certificate resource", "name", certificateName)
25+
klog.V(4).InfoS("reconciling certificate resource", "name", certificateName)
2526
fetched := &certmanagerv1.Certificate{}
2627
exist, err := r.Exists(r.ctx, client.ObjectKeyFromObject(desired), fetched)
2728
if err != nil {
@@ -32,13 +33,13 @@ func (r *Reconciler) createOrApplyCertificates(istiocsr *v1alpha1.IstioCSR, reso
3233
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeWarning, "ResourceAlreadyExists", "%s certificate resource already exists, maybe from previous installation", certificateName)
3334
}
3435
if exist && hasObjectChanged(desired, fetched) {
35-
r.log.V(1).Info("certificate has been modified, updating to desired state", "name", certificateName)
36+
klog.V(1).InfoS("certificate has been modified, updating to desired state", "name", certificateName)
3637
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
3738
return FromClientError(err, "failed to update %s certificate resource", certificateName)
3839
}
3940
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "certificate resource %s reconciled back to desired state", certificateName)
4041
} else {
41-
r.log.V(4).Info("certificate resource already exists and is in expected state", "name", certificateName)
42+
klog.V(4).InfoS("certificate resource already exists and is in expected state", "name", certificateName)
4243
}
4344
if !exist {
4445
if err := r.Create(r.ctx, desired); err != nil {

pkg/controller/istiocsr/controller.go

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import (
1818
"k8s.io/apimachinery/pkg/types"
1919
"k8s.io/client-go/rest"
2020
"k8s.io/client-go/tools/record"
21+
"k8s.io/klog/v2"
2122

2223
ctrl "sigs.k8s.io/controller-runtime"
2324
"sigs.k8s.io/controller-runtime/pkg/builder"
@@ -27,8 +28,6 @@ import (
2728
"sigs.k8s.io/controller-runtime/pkg/predicate"
2829
"sigs.k8s.io/controller-runtime/pkg/reconcile"
2930

30-
"github.com/go-logr/logr"
31-
3231
certmanagerv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
3332

3433
v1alpha1 "github.com/openshift/cert-manager-operator/api/operator/v1alpha1"
@@ -50,7 +49,6 @@ type Reconciler struct {
5049

5150
ctx context.Context
5251
eventRecorder record.EventRecorder
53-
log logr.Logger
5452
scheme *runtime.Scheme
5553
}
5654

@@ -116,15 +114,14 @@ func New(mgr ctrl.Manager) (*Reconciler, error) {
116114
ctrlClient: c,
117115
ctx: context.Background(),
118116
eventRecorder: mgr.GetEventRecorderFor(ControllerName),
119-
log: ctrl.Log.WithName(ControllerName),
120117
scheme: mgr.GetScheme(),
121118
}, nil
122119
}
123120

124121
// SetupWithManager sets up the controller with the Manager.
125122
func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
126123
mapFunc := func(ctx context.Context, obj client.Object) []reconcile.Request {
127-
r.log.V(4).Info("received reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
124+
klog.V(4).InfoS("received reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
128125

129126
objLabels := obj.GetLabels()
130127
if objLabels != nil {
@@ -146,7 +143,10 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
146143
}
147144
key := strings.Split(value, "_")
148145
if len(key) != 2 {
149-
r.log.Error(fmt.Errorf("invalid label format"), "%s label value(%s) not in expected format on %s resource", IstiocsrResourceWatchLabelName, value, obj.GetName())
146+
klog.ErrorS(fmt.Errorf("invalid label format"), "label value not in expected format",
147+
"labelName", IstiocsrResourceWatchLabelName,
148+
"labelValue", value,
149+
"resource", obj.GetName())
150150
return false
151151
}
152152
namespace = key[0]
@@ -165,7 +165,7 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
165165
}
166166
}
167167

168-
r.log.V(4).Info("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
168+
klog.V(4).InfoS("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
169169
return []reconcile.Request{}
170170
}
171171

@@ -214,7 +214,7 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
214214
// Reconcile function to compare the state specified by the IstioCSR object against the actual cluster state,
215215
// and to make the cluster state reflect the state specified by the user.
216216
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
217-
r.log.V(1).Info("reconciling", "request", req)
217+
klog.V(1).InfoS("reconciling", "request", req)
218218

219219
// Fetch the istiocsr.openshift.operator.io CR
220220
istiocsr := &v1alpha1.IstioCSR{}
@@ -223,14 +223,14 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
223223
// NotFound errors, since they can't be fixed by an immediate
224224
// requeue (have to wait for a new notification), and can be processed
225225
// on deleted requests.
226-
r.log.V(1).Info("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
226+
klog.V(1).InfoS("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
227227
return ctrl.Result{}, nil
228228
}
229229
return ctrl.Result{}, fmt.Errorf("failed to fetch istiocsr.openshift.operator.io %q during reconciliation: %w", req.NamespacedName, err)
230230
}
231231

232232
if !istiocsr.DeletionTimestamp.IsZero() {
233-
r.log.V(1).Info("istiocsr.openshift.operator.io is marked for deletion", "namespace", req.NamespacedName)
233+
klog.V(1).InfoS("istiocsr.openshift.operator.io is marked for deletion", "namespace", req.NamespacedName)
234234

235235
if requeue, err := r.cleanUp(istiocsr); err != nil {
236236
return ctrl.Result{}, fmt.Errorf("clean up failed for %q istiocsr.openshift.operator.io instance deletion: %w", req.NamespacedName, err)
@@ -242,7 +242,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
242242
return ctrl.Result{}, err
243243
}
244244

245-
r.log.V(1).Info("removed finalizer, cleanup complete", "request", req.NamespacedName)
245+
klog.V(1).InfoS("removed finalizer, cleanup complete", "request", req.NamespacedName)
246246
return ctrl.Result{}, nil
247247
}
248248

@@ -257,7 +257,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
257257
func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req types.NamespacedName) (ctrl.Result, error) {
258258
istioCSRCreateRecon := false
259259
if !containsProcessedAnnotation(istiocsr) && reflect.DeepEqual(istiocsr.Status, v1alpha1.IstioCSRStatus{}) {
260-
r.log.V(1).Info("starting reconciliation of newly created istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
260+
klog.V(1).InfoS("starting reconciliation of newly created istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
261261
istioCSRCreateRecon = true
262262
}
263263

@@ -271,14 +271,14 @@ func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req ty
271271

272272
var errUpdate error = nil
273273
if err := r.reconcileIstioCSRDeployment(istiocsr, istioCSRCreateRecon); err != nil {
274-
r.log.Error(err, "failed to reconcile IstioCSR deployment", "request", req)
274+
klog.ErrorS(err, "failed to reconcile IstioCSR deployment", "request", req)
275275
if IsIrrecoverableError(err) {
276276
// Set both conditions atomically before updating status
277277
degradedChanged := istiocsr.Status.SetCondition(v1alpha1.Degraded, metav1.ConditionTrue, v1alpha1.ReasonFailed, fmt.Sprintf("reconciliation failed with irrecoverable error not retrying: %v", err))
278278
readyChanged := istiocsr.Status.SetCondition(v1alpha1.Ready, metav1.ConditionFalse, v1alpha1.ReasonReady, "")
279279

280280
if degradedChanged || readyChanged {
281-
r.log.V(2).Info("updating istiocsr conditions on irrecoverable error",
281+
klog.V(2).InfoS("updating istiocsr conditions on irrecoverable error",
282282
"namespace", istiocsr.GetNamespace(),
283283
"name", istiocsr.GetName(),
284284
"degradedChanged", degradedChanged,
@@ -293,7 +293,7 @@ func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req ty
293293
readyChanged := istiocsr.Status.SetCondition(v1alpha1.Ready, metav1.ConditionFalse, v1alpha1.ReasonInProgress, fmt.Sprintf("reconciliation failed, retrying: %v", err))
294294

295295
if degradedChanged || readyChanged {
296-
r.log.V(2).Info("updating istiocsr conditions on recoverable error",
296+
klog.V(2).InfoS("updating istiocsr conditions on recoverable error",
297297
"namespace", istiocsr.GetNamespace(),
298298
"name", istiocsr.GetName(),
299299
"degradedChanged", degradedChanged,
@@ -315,7 +315,7 @@ func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req ty
315315
readyChanged := istiocsr.Status.SetCondition(v1alpha1.Ready, metav1.ConditionTrue, v1alpha1.ReasonReady, "reconciliation successful")
316316

317317
if degradedChanged || readyChanged {
318-
r.log.V(2).Info("updating istiocsr conditions on successful reconciliation",
318+
klog.V(2).InfoS("updating istiocsr conditions on successful reconciliation",
319319
"namespace", istiocsr.GetNamespace(),
320320
"name", istiocsr.GetName(),
321321
"degradedChanged", degradedChanged,

pkg/controller/istiocsr/deployments.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
metav1validation "k8s.io/apimachinery/pkg/apis/meta/v1/validation"
1616
"k8s.io/apimachinery/pkg/types"
1717
"k8s.io/apimachinery/pkg/util/validation/field"
18+
"k8s.io/klog/v2"
1819
"k8s.io/kubernetes/pkg/apis/core"
1920
corevalidation "k8s.io/kubernetes/pkg/apis/core/validation"
2021
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -38,7 +39,7 @@ func (r *Reconciler) createOrApplyDeployments(istiocsr *v1alpha1.IstioCSR, resou
3839
}
3940

4041
deploymentName := fmt.Sprintf("%s/%s", desired.GetNamespace(), desired.GetName())
41-
r.log.V(4).Info("reconciling deployment resource", "name", deploymentName)
42+
klog.V(4).InfoS("reconciling deployment resource", "name", deploymentName)
4243
fetched := &appsv1.Deployment{}
4344
exist, err := r.Exists(r.ctx, client.ObjectKeyFromObject(desired), fetched)
4445
if err != nil {
@@ -49,13 +50,13 @@ func (r *Reconciler) createOrApplyDeployments(istiocsr *v1alpha1.IstioCSR, resou
4950
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeWarning, "ResourceAlreadyExists", "%s deployment resource already exists, maybe from previous installation", deploymentName)
5051
}
5152
if exist && hasObjectChanged(desired, fetched) {
52-
r.log.V(1).Info("deployment has been modified, updating to desired state", "name", deploymentName)
53+
klog.V(1).InfoS("deployment has been modified, updating to desired state", "name", deploymentName)
5354
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
5455
return FromClientError(err, "failed to update %s deployment resource", deploymentName)
5556
}
5657
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "deployment resource %s reconciled back to desired state", deploymentName)
5758
} else {
58-
r.log.V(4).Info("deployment resource already exists and is in expected state", "name", deploymentName)
59+
klog.V(4).InfoS("deployment resource already exists and is in expected state", "name", deploymentName)
5960
}
6061
if !exist {
6162
if err := r.Create(r.ctx, desired); err != nil {
@@ -555,13 +556,13 @@ func (r *Reconciler) createOrUpdateCAConfigMap(istiocsr *v1alpha1.IstioCSR, cert
555556
}
556557

557558
if exist && hasObjectChanged(desired, fetched) {
558-
r.log.V(1).Info("ca configmap need update", "name", configmapKey)
559+
klog.V(1).InfoS("ca configmap need update", "name", configmapKey)
559560
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
560561
return fmt.Errorf("failed to update %s configmap resource: %w", configmapKey, err)
561562
}
562563
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "configmap resource %s reconciled back to desired state", configmapKey)
563564
} else {
564-
r.log.V(4).Info("configmap resource already exists and is in expected state", "name", configmapKey)
565+
klog.V(4).InfoS("configmap resource already exists and is in expected state", "name", configmapKey)
565566
}
566567

567568
if !exist {

pkg/controller/istiocsr/install_istiocsr.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import (
44
"fmt"
55

66
"github.com/openshift/cert-manager-operator/api/operator/v1alpha1"
7+
"k8s.io/klog/v2"
78
)
89

910
func (r *Reconciler) reconcileIstioCSRDeployment(istiocsr *v1alpha1.IstioCSR, istioCSRCreateRecon bool) error {
@@ -29,27 +30,27 @@ func (r *Reconciler) reconcileIstioCSRDeployment(istiocsr *v1alpha1.IstioCSR, is
2930
}
3031

3132
if err := r.createOrApplyServices(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
32-
r.log.Error(err, "failed to reconcile service resource")
33+
klog.ErrorS(err, "failed to reconcile service resource")
3334
return err
3435
}
3536

3637
if err := r.createOrApplyServiceAccounts(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
37-
r.log.Error(err, "failed to reconcile serviceaccount resource")
38+
klog.ErrorS(err, "failed to reconcile serviceaccount resource")
3839
return err
3940
}
4041

4142
if err := r.createOrApplyRBACResource(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
42-
r.log.Error(err, "failed to reconcile rbac resources")
43+
klog.ErrorS(err, "failed to reconcile rbac resources")
4344
return err
4445
}
4546

4647
if err := r.createOrApplyCertificates(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
47-
r.log.Error(err, "failed to reconcile certificate resource")
48+
klog.ErrorS(err, "failed to reconcile certificate resource")
4849
return err
4950
}
5051

5152
if err := r.createOrApplyDeployments(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
52-
r.log.Error(err, "failed to reconcile deployment resource")
53+
klog.ErrorS(err, "failed to reconcile deployment resource")
5354
return err
5455
}
5556

@@ -59,6 +60,6 @@ func (r *Reconciler) reconcileIstioCSRDeployment(istiocsr *v1alpha1.IstioCSR, is
5960
}
6061
}
6162

62-
r.log.V(4).Info("finished reconciliation of istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
63+
klog.V(4).InfoS("finished reconciliation of istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
6364
return nil
6465
}

0 commit comments

Comments
 (0)