Skip to content

Commit 1f36ca8

Browse files
committed
Consolidate around klog/v2
Remove the logr.Logger field from the istiocsr Reconciler struct and replace all r.log calls with direct klog/v2 structured logging calls. This eliminates the go-logr/logr/testr dependency from the istiocsr package and consolidates logging on the existing klog/v2 dependency.
1 parent 5608078 commit 1f36ca8

10 files changed

Lines changed: 78 additions & 71 deletions

File tree

pkg/controller/istiocsr/certificates.go

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

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

1112
certmanagerv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
@@ -23,7 +24,7 @@ func (r *Reconciler) createOrApplyCertificates(istiocsr *v1alpha1.IstioCSR, reso
2324
}
2425

2526
certificateName := fmt.Sprintf("%s/%s", desired.GetNamespace(), desired.GetName())
26-
r.log.V(4).Info("reconciling certificate resource", "name", certificateName)
27+
klog.V(4).InfoS("reconciling certificate resource", "name", certificateName)
2728
fetched := &certmanagerv1.Certificate{}
2829
exist, err := r.Exists(r.ctx, client.ObjectKeyFromObject(desired), fetched)
2930
if err != nil {
@@ -35,13 +36,13 @@ func (r *Reconciler) createOrApplyCertificates(istiocsr *v1alpha1.IstioCSR, reso
3536
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeWarning, "ResourceAlreadyExists", "%s certificate resource already exists, maybe from previous installation", certificateName)
3637
}
3738
if hasObjectChanged(desired, fetched) {
38-
r.log.V(1).Info("certificate has been modified, updating to desired state", "name", certificateName)
39+
klog.V(1).InfoS("certificate has been modified, updating to desired state", "name", certificateName)
3940
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
4041
return common.FromClientError(err, "failed to update %s certificate resource", certificateName)
4142
}
4243
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "certificate resource %s reconciled back to desired state", certificateName)
4344
} else {
44-
r.log.V(4).Info("certificate resource already exists and is in expected state", "name", certificateName)
45+
klog.V(4).InfoS("certificate resource already exists and is in expected state", "name", certificateName)
4546
}
4647
}
4748

pkg/controller/istiocsr/controller.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414
"k8s.io/apimachinery/pkg/runtime"
1515
"k8s.io/apimachinery/pkg/types"
1616
"k8s.io/client-go/tools/record"
17+
"k8s.io/klog/v2"
1718

1819
ctrl "sigs.k8s.io/controller-runtime"
1920
"sigs.k8s.io/controller-runtime/pkg/builder"
@@ -22,8 +23,6 @@ import (
2223
"sigs.k8s.io/controller-runtime/pkg/predicate"
2324
"sigs.k8s.io/controller-runtime/pkg/reconcile"
2425

25-
"github.com/go-logr/logr"
26-
2726
certmanagerv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
2827

2928
v1alpha1 "github.com/openshift/cert-manager-operator/api/operator/v1alpha1"
@@ -41,7 +40,6 @@ type Reconciler struct {
4140

4241
ctx context.Context
4342
eventRecorder record.EventRecorder
44-
log logr.Logger
4543
scheme *runtime.Scheme
4644
}
4745

@@ -60,15 +58,14 @@ func New(mgr ctrl.Manager) (*Reconciler, error) {
6058
CtrlClient: c,
6159
ctx: context.Background(),
6260
eventRecorder: mgr.GetEventRecorderFor(ControllerName),
63-
log: ctrl.Log.WithName(ControllerName),
6461
scheme: mgr.GetScheme(),
6562
}, nil
6663
}
6764

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

7370
objLabels := obj.GetLabels()
7471
if objLabels != nil {
@@ -90,7 +87,10 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
9087
}
9188
key := strings.Split(value, "_")
9289
if len(key) != 2 {
93-
r.log.Error(fmt.Errorf("invalid label format"), "%s label value(%s) not in expected format on %s resource", IstiocsrResourceWatchLabelName, value, obj.GetName())
90+
klog.ErrorS(fmt.Errorf("invalid label format"), "label value not in expected format",
91+
"labelName", IstiocsrResourceWatchLabelName,
92+
"labelValue", value,
93+
"resource", obj.GetName())
9494
return false
9595
}
9696
namespace = key[0]
@@ -109,7 +109,7 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
109109
}
110110
}
111111

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

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

165165
// Fetch the istiocsr.openshift.operator.io CR
166166
istiocsr := &v1alpha1.IstioCSR{}
@@ -169,14 +169,14 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
169169
// NotFound errors, since they can't be fixed by an immediate
170170
// requeue (have to wait for a new notification), and can be processed
171171
// on deleted requests.
172-
r.log.V(1).Info("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
172+
klog.V(1).InfoS("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
173173
return ctrl.Result{}, nil
174174
}
175175
return ctrl.Result{}, fmt.Errorf("failed to fetch istiocsr.openshift.operator.io %q during reconciliation: %w", req.NamespacedName, err)
176176
}
177177

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

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

191-
r.log.V(1).Info("removed finalizer, cleanup complete", "request", req.NamespacedName)
191+
klog.V(1).InfoS("removed finalizer, cleanup complete", "request", req.NamespacedName)
192192
return ctrl.Result{}, nil
193193
}
194194

@@ -203,7 +203,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
203203
func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req types.NamespacedName) (ctrl.Result, error) {
204204
istioCSRCreateRecon := false
205205
if !containsProcessedAnnotation(istiocsr) && reflect.DeepEqual(istiocsr.Status, v1alpha1.IstioCSRStatus{}) {
206-
r.log.V(1).Info("starting reconciliation of newly created istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
206+
klog.V(1).InfoS("starting reconciliation of newly created istiocsr", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
207207
istioCSRCreateRecon = true
208208
}
209209

@@ -217,13 +217,13 @@ func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req ty
217217

218218
reconcileErr := r.reconcileIstioCSRDeployment(istiocsr, istioCSRCreateRecon)
219219
if reconcileErr != nil {
220-
r.log.Error(reconcileErr, "failed to reconcile IstioCSR deployment", "request", req)
220+
klog.ErrorS(reconcileErr, "failed to reconcile IstioCSR deployment", "request", req)
221221
}
222222

223223
return common.HandleReconcileResult(
224224
&istiocsr.Status.ConditionalStatus,
225225
reconcileErr,
226-
r.log.WithValues("namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName()),
226+
klog.NewKlogr().WithValues("namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName()),
227227
func(prependErr error) error {
228228
return r.updateCondition(istiocsr, prependErr)
229229
},

pkg/controller/istiocsr/deployments.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1414
"k8s.io/apimachinery/pkg/types"
1515
"k8s.io/apimachinery/pkg/util/validation/field"
16+
"k8s.io/klog/v2"
1617
"sigs.k8s.io/controller-runtime/pkg/client"
1718

1819
certmanagerv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
@@ -35,7 +36,7 @@ func (r *Reconciler) createOrApplyDeployments(istiocsr *v1alpha1.IstioCSR, resou
3536
}
3637

3738
deploymentName := fmt.Sprintf("%s/%s", desired.GetNamespace(), desired.GetName())
38-
r.log.V(4).Info("reconciling deployment resource", "name", deploymentName)
39+
klog.V(4).InfoS("reconciling deployment resource", "name", deploymentName)
3940
fetched := &appsv1.Deployment{}
4041
exist, err := r.Exists(r.ctx, client.ObjectKeyFromObject(desired), fetched)
4142
if err != nil {
@@ -47,13 +48,13 @@ func (r *Reconciler) createOrApplyDeployments(istiocsr *v1alpha1.IstioCSR, resou
4748
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeWarning, "ResourceAlreadyExists", "%s deployment resource already exists, maybe from previous installation", deploymentName)
4849
}
4950
if hasObjectChanged(desired, fetched) {
50-
r.log.V(1).Info("deployment has been modified, updating to desired state", "name", deploymentName)
51+
klog.V(1).InfoS("deployment has been modified, updating to desired state", "name", deploymentName)
5152
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
5253
return common.FromClientError(err, "failed to update %s deployment resource", deploymentName)
5354
}
5455
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "deployment resource %s reconciled back to desired state", deploymentName)
5556
} else {
56-
r.log.V(4).Info("deployment resource already exists and is in expected state", "name", deploymentName)
57+
klog.V(4).InfoS("deployment resource already exists and is in expected state", "name", deploymentName)
5758
}
5859
}
5960

@@ -575,13 +576,13 @@ func (r *Reconciler) createOrUpdateCAConfigMap(istiocsr *v1alpha1.IstioCSR, cert
575576
}
576577

577578
if exist && hasObjectChanged(desired, fetched) {
578-
r.log.V(1).Info("ca configmap need update", "name", configmapKey)
579+
klog.V(1).InfoS("ca configmap need update", "name", configmapKey)
579580
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
580581
return fmt.Errorf("failed to update %s configmap resource: %w", configmapKey, err)
581582
}
582583
r.eventRecorder.Eventf(istiocsr, corev1.EventTypeNormal, "Reconciled", "configmap resource %s reconciled back to desired state", configmapKey)
583584
} else {
584-
r.log.V(4).Info("configmap resource already exists and is in expected state", "name", configmapKey)
585+
klog.V(4).InfoS("configmap resource already exists and is in expected state", "name", configmapKey)
585586
}
586587

587588
if !exist {

pkg/controller/istiocsr/install_istiocsr.go

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

7+
"k8s.io/klog/v2"
8+
79
"github.com/openshift/cert-manager-operator/api/operator/v1alpha1"
810
"github.com/openshift/cert-manager-operator/pkg/controller/common"
911
)
@@ -22,32 +24,32 @@ func (r *Reconciler) reconcileIstioCSRDeployment(istiocsr *v1alpha1.IstioCSR, is
2224
maps.Copy(resourceLabels, controllerDefaultResourceLabels)
2325

2426
if err := r.createOrApplyNetworkPolicies(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
25-
r.log.Error(err, "failed to reconcile network policy resources")
27+
klog.ErrorS(err, "failed to reconcile network policy resources")
2628
return err
2729
}
2830

2931
if err := r.createOrApplyServices(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
30-
r.log.Error(err, "failed to reconcile service resource")
32+
klog.ErrorS(err, "failed to reconcile service resource")
3133
return err
3234
}
3335

3436
if err := r.createOrApplyServiceAccounts(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
35-
r.log.Error(err, "failed to reconcile serviceaccount resource")
37+
klog.ErrorS(err, "failed to reconcile serviceaccount resource")
3638
return err
3739
}
3840

3941
if err := r.createOrApplyRBACResource(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
40-
r.log.Error(err, "failed to reconcile rbac resources")
42+
klog.ErrorS(err, "failed to reconcile rbac resources")
4143
return err
4244
}
4345

4446
if err := r.createOrApplyCertificates(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
45-
r.log.Error(err, "failed to reconcile certificate resource")
47+
klog.ErrorS(err, "failed to reconcile certificate resource")
4648
return err
4749
}
4850

4951
if err := r.createOrApplyDeployments(istiocsr, resourceLabels, istioCSRCreateRecon); err != nil {
50-
r.log.Error(err, "failed to reconcile deployment resource")
52+
klog.ErrorS(err, "failed to reconcile deployment resource")
5153
return err
5254
}
5355

@@ -57,6 +59,6 @@ func (r *Reconciler) reconcileIstioCSRDeployment(istiocsr *v1alpha1.IstioCSR, is
5759
}
5860
}
5961

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

pkg/controller/istiocsr/networkpolicies.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ import (
88
networkingv1 "k8s.io/api/networking/v1"
99
"k8s.io/apimachinery/pkg/runtime"
1010
"k8s.io/apimachinery/pkg/types"
11+
"k8s.io/klog/v2"
1112

1213
"github.com/openshift/cert-manager-operator/api/operator/v1alpha1"
1314
"github.com/openshift/cert-manager-operator/pkg/controller/common"
1415
"github.com/openshift/cert-manager-operator/pkg/operator/assets"
1516
)
1617

1718
func (r *Reconciler) createOrApplyNetworkPolicies(istiocsr *v1alpha1.IstioCSR, resourceLabels map[string]string, istioCSRCreateRecon bool) error {
18-
r.log.V(4).Info("reconciling istio-csr network policies", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
19+
klog.V(4).InfoS("reconciling istio-csr network policies", "namespace", istiocsr.GetNamespace(), "name", istiocsr.GetName())
1920

2021
// Apply static network policy assets for istio-csr
2122
for _, assetPath := range istioCSRNetworkPolicyAssets {
@@ -65,7 +66,7 @@ func (r *Reconciler) getNetworkPolicyFromAsset(assetPath string, istiocsr *v1alp
6566
func (r *Reconciler) createOrUpdateNetworkPolicy(policy *networkingv1.NetworkPolicy, istioCSRCreateRecon bool) error {
6667
desired := policy.DeepCopy()
6768
policyName := fmt.Sprintf("%s/%s", desired.GetNamespace(), desired.GetName())
68-
r.log.V(4).Info("reconciling network policy resource", "name", policyName)
69+
klog.V(4).InfoS("reconciling network policy resource", "name", policyName)
6970

7071
fetched := &networkingv1.NetworkPolicy{}
7172
key := types.NamespacedName{
@@ -82,13 +83,13 @@ func (r *Reconciler) createOrUpdateNetworkPolicy(policy *networkingv1.NetworkPol
8283
r.eventRecorder.Eventf(policy, corev1.EventTypeWarning, "ResourceAlreadyExists", "%s network policy resource already exists, maybe from previous installation", policyName)
8384
}
8485
if hasObjectChanged(desired, fetched) {
85-
r.log.V(1).Info("network policy has been modified, updating to desired state", "name", policyName)
86+
klog.V(1).InfoS("network policy has been modified, updating to desired state", "name", policyName)
8687
if err := r.UpdateWithRetry(r.ctx, desired); err != nil {
8788
return common.FromClientError(err, "failed to update %s network policy resource", policyName)
8889
}
8990
r.eventRecorder.Eventf(policy, corev1.EventTypeNormal, "Reconciled", "network policy resource %s reconciled back to desired state", policyName)
9091
} else {
91-
r.log.V(4).Info("network policy resource already exists and is in expected state", "name", policyName)
92+
klog.V(4).InfoS("network policy resource already exists and is in expected state", "name", policyName)
9293
}
9394
}
9495

0 commit comments

Comments
 (0)