v1alpha1

package
v0.24.0-alpha.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2022 License: Apache-2.0 Imports: 8 Imported by: 157

Documentation

Index

Constants

View Source
const EndpointsResourceLock = "endpoints"

Variables

View Source
var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = localSchemeBuilder.AddToScheme
)

Functions

func Convert_config_ClientConnectionConfiguration_To_v1alpha1_ClientConnectionConfiguration

func Convert_config_ClientConnectionConfiguration_To_v1alpha1_ClientConnectionConfiguration(in *config.ClientConnectionConfiguration, out *ClientConnectionConfiguration, s conversion.Scope) error

func Convert_config_DebuggingConfiguration_To_v1alpha1_DebuggingConfiguration

func Convert_config_DebuggingConfiguration_To_v1alpha1_DebuggingConfiguration(in *config.DebuggingConfiguration, out *DebuggingConfiguration, s conversion.Scope) error

func Convert_config_FormatOptions_To_v1alpha1_FormatOptions added in v0.23.0

func Convert_config_FormatOptions_To_v1alpha1_FormatOptions(in *config.FormatOptions, out *FormatOptions, s conversion.Scope) error

Convert_config_FormatOptions_To_v1alpha1_FormatOptions is an autogenerated conversion function.

func Convert_config_JSONOptions_To_v1alpha1_JSONOptions added in v0.23.0

func Convert_config_JSONOptions_To_v1alpha1_JSONOptions(in *config.JSONOptions, out *JSONOptions, s conversion.Scope) error

Convert_config_JSONOptions_To_v1alpha1_JSONOptions is an autogenerated conversion function.

func Convert_config_LeaderElectionConfiguration_To_v1alpha1_LeaderElectionConfiguration

func Convert_config_LeaderElectionConfiguration_To_v1alpha1_LeaderElectionConfiguration(in *config.LeaderElectionConfiguration, out *LeaderElectionConfiguration, s conversion.Scope) error

func Convert_config_LoggingConfiguration_To_v1alpha1_LoggingConfiguration added in v0.19.0

func Convert_config_LoggingConfiguration_To_v1alpha1_LoggingConfiguration(in *config.LoggingConfiguration, out *LoggingConfiguration, s conversion.Scope) error

func Convert_config_VModuleItem_To_v1alpha1_VModuleItem added in v0.23.0

func Convert_config_VModuleItem_To_v1alpha1_VModuleItem(in *config.VModuleItem, out *VModuleItem, s conversion.Scope) error

Convert_config_VModuleItem_To_v1alpha1_VModuleItem is an autogenerated conversion function.

func Convert_v1alpha1_ClientConnectionConfiguration_To_config_ClientConnectionConfiguration

func Convert_v1alpha1_ClientConnectionConfiguration_To_config_ClientConnectionConfiguration(in *ClientConnectionConfiguration, out *config.ClientConnectionConfiguration, s conversion.Scope) error

func Convert_v1alpha1_DebuggingConfiguration_To_config_DebuggingConfiguration

func Convert_v1alpha1_DebuggingConfiguration_To_config_DebuggingConfiguration(in *DebuggingConfiguration, out *config.DebuggingConfiguration, s conversion.Scope) error

func Convert_v1alpha1_FormatOptions_To_config_FormatOptions added in v0.23.0

func Convert_v1alpha1_FormatOptions_To_config_FormatOptions(in *FormatOptions, out *config.FormatOptions, s conversion.Scope) error

Convert_v1alpha1_FormatOptions_To_config_FormatOptions is an autogenerated conversion function.

func Convert_v1alpha1_JSONOptions_To_config_JSONOptions added in v0.23.0

func Convert_v1alpha1_JSONOptions_To_config_JSONOptions(in *JSONOptions, out *config.JSONOptions, s conversion.Scope) error

Convert_v1alpha1_JSONOptions_To_config_JSONOptions is an autogenerated conversion function.

func Convert_v1alpha1_LeaderElectionConfiguration_To_config_LeaderElectionConfiguration

func Convert_v1alpha1_LeaderElectionConfiguration_To_config_LeaderElectionConfiguration(in *LeaderElectionConfiguration, out *config.LeaderElectionConfiguration, s conversion.Scope) error

func Convert_v1alpha1_LoggingConfiguration_To_config_LoggingConfiguration added in v0.19.0

func Convert_v1alpha1_LoggingConfiguration_To_config_LoggingConfiguration(in *LoggingConfiguration, out *config.LoggingConfiguration, s conversion.Scope) error

func Convert_v1alpha1_VModuleItem_To_config_VModuleItem added in v0.23.0

func Convert_v1alpha1_VModuleItem_To_config_VModuleItem(in *VModuleItem, out *config.VModuleItem, s conversion.Scope) error

Convert_v1alpha1_VModuleItem_To_config_VModuleItem is an autogenerated conversion function.

func RecommendedDebuggingConfiguration added in v0.18.0

func RecommendedDebuggingConfiguration(obj *DebuggingConfiguration)

RecommendedDebuggingConfiguration defaults profiling and debugging configuration. This will set the recommended default values, but they may be subject to change between API versions. This function is intentionally not registered in the scheme as a "normal" `SetDefaults_Foo` function to allow consumers of this type to set whatever defaults for their embedded configs. Forcing consumers to use these defaults would be problematic as defaulting in the scheme is done as part of the conversion, and there would be no easy way to opt-out. Instead, if you want to use this defaulting method run it in your wrapper struct of this type in its `SetDefaults_` method.

func RecommendedDefaultClientConnectionConfiguration

func RecommendedDefaultClientConnectionConfiguration(obj *ClientConnectionConfiguration)

RecommendedDefaultClientConnectionConfiguration defaults a pointer to a ClientConnectionConfiguration struct. This will set the recommended default values, but they may be subject to change between API versions. This function is intentionally not registered in the scheme as a "normal" `SetDefaults_Foo` function to allow consumers of this type to set whatever defaults for their embedded configs. Forcing consumers to use these defaults would be problematic as defaulting in the scheme is done as part of the conversion, and there would be no easy way to opt-out. Instead, if you want to use this defaulting method run it in your wrapper struct of this type in its `SetDefaults_` method.

func RecommendedDefaultLeaderElectionConfiguration

func RecommendedDefaultLeaderElectionConfiguration(obj *LeaderElectionConfiguration)

RecommendedDefaultLeaderElectionConfiguration defaults a pointer to a LeaderElectionConfiguration struct. This will set the recommended default values, but they may be subject to change between API versions. This function is intentionally not registered in the scheme as a "normal" `SetDefaults_Foo` function to allow consumers of this type to set whatever defaults for their embedded configs. Forcing consumers to use these defaults would be problematic as defaulting in the scheme is done as part of the conversion, and there would be no easy way to opt-out. Instead, if you want to use this defaulting method run it in your wrapper struct of this type in its `SetDefaults_` method.

func RecommendedLoggingConfiguration added in v0.19.0

func RecommendedLoggingConfiguration(obj *LoggingConfiguration)

RecommendedLoggingConfiguration defaults logging configuration. This will set the recommended default values, but they may be subject to change between API versions. This function is intentionally not registered in the scheme as a "normal" `SetDefaults_Foo` function to allow consumers of this type to set whatever defaults for their embedded configs. Forcing consumers to use these defaults would be problematic as defaulting in the scheme is done as part of the conversion, and there would be no easy way to opt-out. Instead, if you want to use this defaulting method run it in your wrapper struct of this type in its `SetDefaults_` method.

func RegisterConversions

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

Types

type ClientConnectionConfiguration

type ClientConnectionConfiguration struct {
	// kubeconfig is the path to a KubeConfig file.
	Kubeconfig string `json:"kubeconfig"`
	// 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 `json:"acceptContentTypes"`
	// contentType is the content type used when sending data to the server from this client.
	ContentType string `json:"contentType"`
	// qps controls the number of queries per second allowed for this connection.
	QPS float32 `json:"qps"`
	// burst allows extra queries to accumulate when a client is exceeding its rate.
	Burst int32 `json:"burst"`
}

ClientConnectionConfiguration contains details for constructing a client.

func (*ClientConnectionConfiguration) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConnectionConfiguration.

func (*ClientConnectionConfiguration) DeepCopyInto

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 `json:"enableProfiling,omitempty"`
	// enableContentionProfiling enables lock contention profiling, if
	// enableProfiling is true.
	EnableContentionProfiling *bool `json:"enableContentionProfiling,omitempty"`
}

DebuggingConfiguration holds configuration for Debugging related features.

func NewRecommendedDebuggingConfiguration added in v0.18.0

func NewRecommendedDebuggingConfiguration() *DebuggingConfiguration

NewRecommendedDebuggingConfiguration returns the current recommended DebuggingConfiguration. This may change between releases as recommendations shift.

func (*DebuggingConfiguration) DeepCopy

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 `json:"json,omitempty"`
}

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 `json:"splitStream,omitempty"`
	// [Experimental] InfoBufferSize sets the size of the info stream when
	// using split streams. The default is zero, which disables buffering.
	InfoBufferSize resource.QuantityValue `json:"infoBufferSize,omitempty"`
}

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 `json:"leaderElect"`
	// 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 `json:"leaseDuration"`
	// 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 `json:"renewDeadline"`
	// 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 `json:"retryPeriod"`
	// resourceLock indicates the resource object type that will be used to lock
	// during leader election cycles.
	ResourceLock string `json:"resourceLock"`
	// resourceName indicates the name of resource object that will be used to lock
	// during leader election cycles.
	ResourceName string `json:"resourceName"`
	// resourceName indicates the namespace of resource object that will be used to lock
	// during leader election cycles.
	ResourceNamespace string `json:"resourceNamespace"`
}

LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.

func (*LeaderElectionConfiguration) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaderElectionConfiguration.

func (*LeaderElectionConfiguration) DeepCopyInto

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 `json:"format,omitempty"`
	// Maximum number of seconds 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
	// messages. Higher values enable additional messages. Error messages
	// are always logged.
	Verbosity uint32 `json:"verbosity"`
	// VModule overrides the verbosity threshold for individual files.
	// Only supported for "text" log format.
	VModule VModuleConfiguration `json:"vmodule,omitempty"`
	// [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 `json:"options,omitempty"`
}

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

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

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.

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 `json:"filePattern"`
	// Verbosity is the threshold for log messages emitted inside files
	// that match the pattern.
	Verbosity uint32 `json:"verbosity"`
}

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL