Omit repetitive events during cluster creation

[jayesh-srivastava]

What type of PR is this?
/kind feature
/kind cleanup

What this PR does / why we need it: This PR removes unnecessary repetitive events during cluster creation.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #2651

Special notes for your reviewer:

TODOs:

• squashed commits
• includes documentation
• adds unit tests

Release note:

Remove repetitive events during cluster creation 

[jayesh-srivastava]

/test pull-cluster-api-provider-azure-test
/test pull-cluster-api-provider-azure-coverage

[mboersma]

Thanks @jayesh-srivastava! I'm all for brevity.

How exactly does this show up as repetitive? Do we get multiples of the same event when we provision a cluster, or is this not a useful thing to record in the first place?

Edit: never mind, I read #2651. I guess the question is: is it ok to omit this event entirely, instead of trying to log it just once?

[jayesh-srivastava]

@mboersma It made sense at the moment to remove this entirely but I guess we can have a level 2 logger to have some brevity. What are your thoughts?

[mboersma]

/lgtm

I don't think in general it's necessary to note success cases. We should assume things are working and only log exceptional events, IMHO.

I searched the codebase for where else we use EventRecorder, and I don't see any other cases where we create an event for "successful reconcile." So I think we can just remove these, as you've done.

[CecileRobertMichon]

/lgtm
/approve

[CecileRobertMichon]

/hold

@jayesh-srivastava please squash commits and add a release note in the PR description so we can give you credit in the release

[jayesh-srivastava]

@jayesh-srivastava please squash commits and add a release note in the PR description so we can give you credit in the release

@CecileRobertMichon Done!

[mboersma]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon, mboersma

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [CecileRobertMichon,mboersma]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mboersma]

/hold cancel

[jackfrancis]

/cherry-pick release-1.4
/cherry-pick release-1.5

[k8s-infra-cherrypick-robot]

@jackfrancis: #2652 failed to apply on top of branch "release-1.4":

Applying: Fix repetitive events
Using index info to reconstruct a base tree...
M	exp/controllers/azuremanagedcontrolplane_controller.go
M	exp/controllers/azuremanagedmachinepool_controller.go
Falling back to patching base and 3-way merge...
Auto-merging exp/controllers/azuremanagedmachinepool_controller.go
CONFLICT (content): Merge conflict in exp/controllers/azuremanagedmachinepool_controller.go
Auto-merging exp/controllers/azuremanagedcontrolplane_controller.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix repetitive events
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.4
/cherry-pick release-1.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.