options

package
v1.9.0-industry.5 Latest Latest
Warning

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

 Go to latest Published: Apr 4, 2023 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause, + 8 more Imports: 30 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CompleteGenericAndSecureOptions 

func CompleteGenericAndSecureOptions(genericOpts *GenericOptions, secureServingOpts *SecureServingOptions) error

CompleteGenericAndSecureOptions is used to initialize the parameter values that are not filled in the common settings.

func GenerateSelfSignedCertKey added in v1.9.0 

func GenerateSelfSignedCertKey(host string, alternateIPs []net.IP, alternateDNS []string) ([]byte, []byte, error)

copy from k8s.io/client-go/util/cert GenerateSelfSignedCertKey creates a self-signed certificate and key for the given host. Host may be an IP or a DNS name You may also specify additional subject alt names (either ip or dns names) for the certificate.

func GenerateSelfSignedCertKeyWithFixtures added in v1.9.0 

func GenerateSelfSignedCertKeyWithFixtures(host string, alternateIPs []net.IP, alternateDNS []string, fixtureDirectory string) ([]byte, []byte, error)

copy from k8s.io/client-go/util/cert GenerateSelfSignedCertKeyWithFixtures creates a self-signed certificate and key for the given host. Host may be an IP or a DNS name. You may also specify additional subject alt names (either ip or dns names) for the certificate.

If fixtureDirectory is non-empty, it is a directory path which can contain pre-generated certs. The format is: <host>_<ip>-<ip>_<alternateDNS>-<alternateDNS>.crt <host>_<ip>-<ip>_<alternateDNS>-<alternateDNS>.key Certs/keys not existing in that directory are created.

Types

type AuthenticationOptions 

type AuthenticationOptions struct {
	ClientCert           *genericoptions.ClientCertAuthenticationOptions
	OIDC                 *OIDCOptions
	WebHook              *WebHookOptions
	RequestHeader        *genericoptions.RequestHeaderAuthenticationOptions
	TokenFile            *TokenFileAuthenticationOptions
	TokenSuccessCacheTTL time.Duration
	TokenFailureCacheTTL time.Duration
}

AuthenticationOptions contains the options that http request authentication.

func NewAuthenticationOptions 

func NewAuthenticationOptions() *AuthenticationOptions

NewAuthenticationOptions creates the default AuthenticationOptions object.

func (*AuthenticationOptions) AddFlags 

func (o *AuthenticationOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*AuthenticationOptions) ApplyFlags 

func (o *AuthenticationOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type AuthenticationWithAPIOptions 

type AuthenticationWithAPIOptions struct {
	APIAudiences       []string
	PrivilegedUsername string
	*AuthenticationOptions
}

AuthenticationWithAPIOptions contains the options that http request authentication.

func NewAuthenticationWithAPIOptions 

func NewAuthenticationWithAPIOptions() *AuthenticationWithAPIOptions

NewAuthenticationWithAPIOptions creates the default AuthenticationOptions object.

func (*AuthenticationWithAPIOptions) AddFlags 

func (o *AuthenticationWithAPIOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*AuthenticationWithAPIOptions) ApplyFlags 

func (o *AuthenticationWithAPIOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type AuthorizationOptions 

type AuthorizationOptions struct {
	Modes             []string
	WebhookConfigFile string
	WebhookVersion    string
	*genericserveroptions.DelegatingAuthorizationOptions
}

AuthorizationOptions defines the configuration parameters required to include the authorization.

func NewAuthorizationOptions 

func NewAuthorizationOptions() *AuthorizationOptions

NewAuthorizationOptions creates the default AuthorizationOptions object and returns it.

func (*AuthorizationOptions) AddFlags 

func (o *AuthorizationOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*AuthorizationOptions) ApplyFlags 

func (o *AuthorizationOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type DebugOptions 

type DebugOptions struct {
	EnableProfiling           bool
	EnableContentionProfiling bool
}

DebugOptions holds the Debugging options.

func NewDebugOptions 

func NewDebugOptions() *DebugOptions

NewDebugOptions creates the default DebugOptions object.

func (*DebugOptions) AddFlags 

func (o *DebugOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to debugging for controller manager to the specified FlagSet.

func (*DebugOptions) ApplyFlags 

func (o *DebugOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

func (*DebugOptions) ApplyTo 

func (o *DebugOptions) ApplyTo(cfg *componentconfig.DebuggingConfiguration) error

ApplyTo fills up Debugging config with options.

type GenericOptions 

type GenericOptions struct {
	*genericserveroptions.ServerRunOptions
	ExternalPort   int
	ExternalScheme string
	ExternalCAFile string
}

GenericOptions contains the options while running a generic api server.

func NewGenericOptions 

func NewGenericOptions() *GenericOptions

NewGenericOptions creates a Options object with default parameters.

func (*GenericOptions) AddFlags 

func (o *GenericOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*GenericOptions) ApplyFlags 

func (o *GenericOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

func (*GenericOptions) DefaultAdvertiseAddress 

func (o *GenericOptions) DefaultAdvertiseAddress(secure *SecureServingOptions) error

DefaultAdvertiseAddress sets the field AdvertiseAddress if unset. The field will be set based on the SecureSecureServingOptions.

func (*GenericOptions) DefaultAdvertiseAddressWithInsecure 

func (o *GenericOptions) DefaultAdvertiseAddressWithInsecure(secure *SecureServingOptions, insecure *InsecureServingOptions) error

DefaultAdvertiseAddressWithInsecure sets the field AdvertiseAddress if unset. The field will be set based on the SecureSecureServingOptions and InsecureServingOptions.

type InsecureServingOptions 

type InsecureServingOptions struct {
	*genericoptions.DeprecatedInsecureServingOptions
}

InsecureServingOptions contains the options that serve HTTP.

func NewInsecureServingOptions 

func NewInsecureServingOptions(defaultPort int) *InsecureServingOptions

NewInsecureServingOptions gives default values for the http server which are not the options wanted by "normal" servers running on the platform.

func (*InsecureServingOptions) AddFlags 

func (o *InsecureServingOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*InsecureServingOptions) ApplyFlags 

func (o *InsecureServingOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type OIDCOptions 

type OIDCOptions struct {
	CAFile            string
	ClientID          string
	IssuerURL         string
	ExternalIssuerURL string
	UsernameClaim     string
	UsernamePrefix    string
	DisplayNameClaim  string
	GroupsClaim       string
	GroupsPrefix      string
	TenantIDClaim     string
	TenantIDPrefix    string
	SigningAlgs       []string
	RequiredClaims    map[string]string
	TokenReviewPath   string
}

OIDCOptions defines the configuration options needed to initialize OpenID Connect authentication.

func NewOIDCOptions 

func NewOIDCOptions() *OIDCOptions

NewOIDCOptions creates the default OIDCOptions object.

func (*OIDCOptions) AddFlags 

func (o *OIDCOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*OIDCOptions) ApplyFlags 

func (o *OIDCOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type OIDCWithSecretOptions 

type OIDCWithSecretOptions struct {
	*OIDCOptions
	ClientSecret string
}

OIDCWithSecretOptions defines the configuration options needed to initialize OpenID Connect authentication.

func NewOIDCWithSecretOptions 

func NewOIDCWithSecretOptions() *OIDCWithSecretOptions

NewOIDCWithSecretOptions creates the default OIDCWithSecretOptions object.

func (*OIDCWithSecretOptions) AddFlags 

func (o *OIDCWithSecretOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*OIDCWithSecretOptions) ApplyFlags 

func (o *OIDCWithSecretOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

type PasswordFileAuthenticationOptions 

type PasswordFileAuthenticationOptions struct {
	BasicAuthFile string
}

PasswordFileAuthenticationOptions defines the configuration when using static password file authentication

type RegistryOptions 

type RegistryOptions struct {
	Domain    string
	Namespace string
}

RegistryOptions holds the container registry options.

func NewRegistryOptions 

func NewRegistryOptions() *RegistryOptions

NewRegistryOptions creates the default RegistryOptions object.

func (*RegistryOptions) AddFlags 

func (o *RegistryOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to debugging for controller manager to the specified FlagSet.

func (*RegistryOptions) ApplyFlags 

func (o *RegistryOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

func (*RegistryOptions) Validate 

func (o *RegistryOptions) Validate() []error

Validate checks validation of RegistryOptions.

type SecureServingOptions 

type SecureServingOptions struct {
	*apiserveroptions.SecureServingOptionsWithLoopback
}

SecureServingOptions contains the options that serve HTTPS.

func NewSecureServingOptions 

func NewSecureServingOptions(serverName string, defaultPort int) *SecureServingOptions

NewSecureServingOptions gives default values for the HTTPS server which are not the options wanted by "normal" servers running on the platform.

func (*SecureServingOptions) AddFlags 

func (o *SecureServingOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*SecureServingOptions) ApplyFlags 

func (o *SecureServingOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

func (*SecureServingOptions) ApplyTo added in v1.9.0 

func (o *SecureServingOptions) ApplyTo(secureServingInfo **server.SecureServingInfo, loopbackClientConfig **rest.Config) error

rewrite apiserveroptions.SecureServingOptionsWithLoopback ApplyTo ApplyTo fills up serving information in the server configuration.

type TokenFileAuthenticationOptions 

type TokenFileAuthenticationOptions struct {
	TokenFile string
}

TokenFileAuthenticationOptions defines the configuration when using static token file authentication.

type WebHookOptions added in v1.2.5 

type WebHookOptions struct {
	ConfigFile string
	Version    string
	CacheTTL   time.Duration
}

func NewWebhookOptions added in v1.2.5 

func NewWebhookOptions() *WebHookOptions

NewWebhookOptions creates the default WebHookOptions object.

func (*WebHookOptions) AddFlags added in v1.2.5 

func (w *WebHookOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags for log to the specified FlagSet object.

func (*WebHookOptions) ApplyFlags added in v1.2.5 

func (w *WebHookOptions) ApplyFlags() []error

ApplyFlags parsing parameters from the command line or configuration file to the options instance.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.