component-base: fix documentation of log flush frequency

The intention for Kubernetes 1.23 was to support `flushFrequency: 60` and treat
that as seconds. But time.Duration counts nanoseconds. Because the struct is
embedded inside the beta KubeletConfiguration, we cannot switch to a type that
serializes differently (like metav1.Duration) and therefore (for now) just
update the documentation to match the implementation from Kubernetes 1.23.
This commit is contained in:
Patrick Ohly 2022-01-18 12:03:34 +01:00
parent 018288b38f
commit f9c8a9d794
2 changed files with 6 additions and 4 deletions

View File

@ -93,8 +93,9 @@ type LoggingConfiguration struct {
// Format Flag specifies the structure of log messages.
// default value of format is `text`
Format string
// Maximum number of seconds between log flushes. Ignored if the
// selected logging backend writes log messages without buffering.
// Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
// flushes. Ignored if the selected logging backend writes log
// messages without buffering.
FlushFrequency time.Duration
// Verbosity is the threshold that determines which log messages are
// logged. Default is zero which logs only the most important

View File

@ -90,8 +90,9 @@ type LoggingConfiguration struct {
// Format Flag specifies the structure of log messages.
// default value of format is `text`
Format string `json:"format,omitempty"`
// Maximum number of seconds between log flushes. Ignored if the
// selected logging backend writes log messages without buffering.
// Maximum number of nanoseconds (i.e. 1s = 1000000000) between log
// flushes. Ignored if the selected logging backend writes log
// messages without buffering.
FlushFrequency time.Duration `json:"flushFrequency"`
// Verbosity is the threshold that determines which log messages are
// logged. Default is zero which logs only the most important