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_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

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

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_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

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

func RecommendedDebuggingConfiguration

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

        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

                    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 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

                                type LoggingConfiguration struct {
                                	// Format Flag specifies the structure of log messages.
                                	// default value of format is `text`
                                	Format string `json:"format,omitempty"`
                                	// [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 `json:"sanitization,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

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

                                    func (*LoggingConfiguration) DeepCopyInto

                                    func (in *LoggingConfiguration) DeepCopyInto(out *LoggingConfiguration)

                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.