Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientConnectionConfiguration ¶
type ClientConnectionConfiguration struct {
// kubeconfig is the path to a KubeConfig file.
Kubeconfig string
// acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
// default value of 'application/json'. This field will control all connections to the server used by a particular
// client.
AcceptContentTypes string
// contentType is the content type used when sending data to the server from this client.
ContentType string
// qps controls the number of queries per second allowed for this connection.
QPS float32
// burst allows extra queries to accumulate when a client is exceeding its rate.
Burst int32
}
ClientConnectionConfiguration contains details for constructing a client.
func (*ClientConnectionConfiguration) DeepCopy ¶
func (in *ClientConnectionConfiguration) DeepCopy() *ClientConnectionConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConnectionConfiguration.
func (*ClientConnectionConfiguration) DeepCopyInto ¶
func (in *ClientConnectionConfiguration) DeepCopyInto(out *ClientConnectionConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DebuggingConfiguration ¶
type DebuggingConfiguration struct {
// enableProfiling enables profiling via web interface host:port/debug/pprof/
EnableProfiling bool
// enableContentionProfiling enables lock contention profiling, if
// enableProfiling is true.
EnableContentionProfiling bool
}
DebuggingConfiguration holds configuration for Debugging related features.
func (*DebuggingConfiguration) DeepCopy ¶
func (in *DebuggingConfiguration) DeepCopy() *DebuggingConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DebuggingConfiguration.
func (*DebuggingConfiguration) DeepCopyInto ¶
func (in *DebuggingConfiguration) DeepCopyInto(out *DebuggingConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FormatOptions ¶ added in v0.23.0
type FormatOptions struct {
// [Experimental] JSON contains options for logging format "json".
JSON JSONOptions
}
FormatOptions contains options for the different logging formats.
func (*FormatOptions) DeepCopy ¶ added in v0.23.0
func (in *FormatOptions) DeepCopy() *FormatOptions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FormatOptions.
func (*FormatOptions) DeepCopyInto ¶ added in v0.23.0
func (in *FormatOptions) DeepCopyInto(out *FormatOptions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JSONOptions ¶ added in v0.23.0
type JSONOptions struct {
// [Experimental] SplitStream redirects error messages to stderr while
// info messages go to stdout, with buffering. The default is to write
// both to stdout, without buffering.
SplitStream bool
// [Experimental] InfoBufferSize sets the size of the info stream when
// using split streams. The default is zero, which disables buffering.
InfoBufferSize resource.QuantityValue
}
JSONOptions contains options for logging format "json".
func (*JSONOptions) DeepCopy ¶ added in v0.23.0
func (in *JSONOptions) DeepCopy() *JSONOptions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JSONOptions.
func (*JSONOptions) DeepCopyInto ¶ added in v0.23.0
func (in *JSONOptions) DeepCopyInto(out *JSONOptions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LeaderElectionConfiguration ¶
type LeaderElectionConfiguration struct {
// leaderElect enables a leader election client to gain leadership
// before executing the main loop. Enable this when running replicated
// components for high availability.
LeaderElect bool
// leaseDuration is the duration that non-leader candidates will wait
// after observing a leadership renewal until attempting to acquire
// leadership of a led but unrenewed leader slot. This is effectively the
// maximum duration that a leader can be stopped before it is replaced
// by another candidate. This is only applicable if leader election is
// enabled.
LeaseDuration metav1.Duration
// renewDeadline is the interval between attempts by the acting master to
// renew a leadership slot before it stops leading. This must be less
// than or equal to the lease duration. This is only applicable if leader
// election is enabled.
RenewDeadline metav1.Duration
// retryPeriod is the duration the clients should wait between attempting
// acquisition and renewal of a leadership. This is only applicable if
// leader election is enabled.
RetryPeriod metav1.Duration
// resourceLock indicates the resource object type that will be used to lock
// during leader election cycles.
ResourceLock string
// resourceName indicates the name of resource object that will be used to lock
// during leader election cycles.
ResourceName string
// resourceNamespace indicates the namespace of resource object that will be used to lock
// during leader election cycles.
ResourceNamespace string
}
LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.
func (*LeaderElectionConfiguration) DeepCopy ¶
func (in *LeaderElectionConfiguration) DeepCopy() *LeaderElectionConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaderElectionConfiguration.
func (*LeaderElectionConfiguration) DeepCopyInto ¶
func (in *LeaderElectionConfiguration) DeepCopyInto(out *LeaderElectionConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LoggingConfiguration ¶ added in v0.19.0
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.
FlushFrequency time.Duration
// Verbosity is the threshold that determines which log messages are
// logged. Default is zero which logs only the most important
// messages. Higher values enable additional messages. Error messages
// are always logged.
Verbosity VerbosityLevel
// VModule overrides the verbosity threshold for individual files.
// Only supported for "text" log format.
VModule VModuleConfiguration
// [Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
// Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)
Sanitization bool
// [Experimental] Options holds additional parameters that are specific
// to the different logging formats. Only the options for the selected
// format get used, but all of them get validated.
Options FormatOptions
}
LoggingConfiguration contains logging options Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
func (*LoggingConfiguration) DeepCopy ¶ added in v0.19.0
func (in *LoggingConfiguration) DeepCopy() *LoggingConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LoggingConfiguration.
func (*LoggingConfiguration) DeepCopyInto ¶ added in v0.19.0
func (in *LoggingConfiguration) DeepCopyInto(out *LoggingConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VModuleConfiguration ¶ added in v0.23.0
type VModuleConfiguration []VModuleItem
VModuleConfiguration is a collection of individual file names or patterns and the corresponding verbosity threshold.
func (VModuleConfiguration) DeepCopy ¶ added in v0.23.0
func (in VModuleConfiguration) DeepCopy() VModuleConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VModuleConfiguration.
func (VModuleConfiguration) DeepCopyInto ¶ added in v0.23.0
func (in VModuleConfiguration) DeepCopyInto(out *VModuleConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VModuleConfiguration) Set ¶ added in v0.23.0
func (vmodule *VModuleConfiguration) Set(value string) error
Set parses the -vmodule parameter (comma-separated list of pattern=N).
func (*VModuleConfiguration) String ¶ added in v0.23.0
func (vmodule *VModuleConfiguration) String() string
String returns the -vmodule parameter (comma-separated list of pattern=N).
func (*VModuleConfiguration) Type ¶ added in v0.23.0
func (vmodule *VModuleConfiguration) Type() string
type VModuleItem ¶ added in v0.23.0
type VModuleItem struct {
// FilePattern is a base file name (i.e. minus the ".go" suffix and
// directory) or a "glob" pattern for such a name. It must not contain
// comma and equal signs because those are separators for the
// corresponding klog command line argument.
FilePattern string
// Verbosity is the threshold for log messages emitted inside files
// that match the pattern.
Verbosity VerbosityLevel
}
VModuleItem defines verbosity for one or more files which match a certain glob pattern.
func (*VModuleItem) DeepCopy ¶ added in v0.23.0
func (in *VModuleItem) DeepCopy() *VModuleItem
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VModuleItem.
func (*VModuleItem) DeepCopyInto ¶ added in v0.23.0
func (in *VModuleItem) DeepCopyInto(out *VModuleItem)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VerbosityLevel ¶ added in v0.23.0
type VerbosityLevel uint32
VerbosityLevel represents a klog or logr verbosity threshold.
func (*VerbosityLevel) Get ¶ added in v0.23.0
func (l *VerbosityLevel) Get() interface{}
func (*VerbosityLevel) Set ¶ added in v0.23.0
func (l *VerbosityLevel) Set(value string) error
func (*VerbosityLevel) String ¶ added in v0.23.0
func (l *VerbosityLevel) String() string
func (*VerbosityLevel) Type ¶ added in v0.23.0
func (l *VerbosityLevel) Type() string
Source Files
Directories