restcfg

Documentation

Overview

Package restcfg contains utility functions to deal with rest configs.

Index

• Constants
• func InitFlags(flagset *flag.FlagSet)
• func SetRateLimiter(cfg *rest.Config) *rest.Config
• func SetRateLimiterWithCustomParameters(cfg *rest.Config, timeout time.Duration, qps float32, burst int) *rest.Config

Constants

const (
	// DefaultClientTimeout -> The default timeout value assigned to client-go clients.
	DefaultClientTimeout = 10 * time.Second
	// DefaultQPS -> The default QPS value assigned to client-go clients.
	DefaultQPS = uint(100)
	// DefaultBurst -> The default burst value assigned to client-go clients.
	DefaultBurst = uint(100)
)

Functions

func InitFlags

func InitFlags(flagset *flag.FlagSet)

InitFlags initializes the flags to configure the rate limiter parameters.

func SetRateLimiter

func SetRateLimiter(cfg *rest.Config) *rest.Config

SetRateLimiter configures the rate limiting parameters of the given rest configuration to the values obtained from the command line parameters.

func SetRateLimiterWithCustomParameters

func SetRateLimiterWithCustomParameters(cfg *rest.Config, timeout time.Duration, qps float32, burst int) *rest.Config

SetRateLimiterWithCustomParameters configures the rate limiting parameters of the given rest configuration.