diff --git a/tools/events/interfaces.go b/tools/events/interfaces.go index 56c678aa..2e6e2eae 100644 --- a/tools/events/interfaces.go +++ b/tools/events/interfaces.go @@ -33,6 +33,9 @@ type EventRecorder interface { // should be in UpperCamelCase format (starting with a capital letter). "reason" will be used // to automate handling of events, so imagine people writing switch statements to handle them. // You want to make that easy. + // 'action' explains what happened with regarding/what action did the ReportingController + // (ReportingController is a type of a Controller reporting an Event, e.g. k8s.io/node-controller, k8s.io/kubelet.) + // take in regarding's name; it should be in UpperCamelCase format (starting with a capital letter). // 'note' is intended to be human readable. Eventf(regarding runtime.Object, related runtime.Object, eventtype, reason, action, note string, args ...interface{}) }