Documentation ¶
Overview ¶
Package options contains flags and options for initializing an apiserver
Index ¶
- Constants
- func DefaultAdvertiseAddress(s *genericoptions.ServerRunOptions, insecure *InsecureServingOptions) error
- func NewSecureServingOptions() *genericoptions.SecureServingOptions
- type APIEnablementOptions
- type AnonymousAuthenticationOptions
- type BootstrapTokenAuthenticationOptions
- type BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) AddFlags(fs *pflag.FlagSet)
- func (o *BuiltInAuthenticationOptions) ApplyAuthorization(authorization *BuiltInAuthorizationOptions)
- func (o *BuiltInAuthenticationOptions) ApplyTo(c *genericapiserver.Config) error
- func (s *BuiltInAuthenticationOptions) ToAuthenticationConfig() authenticator.AuthenticatorConfig
- func (s *BuiltInAuthenticationOptions) Validate() []error
- func (s *BuiltInAuthenticationOptions) WithAll() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithAnonymous() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithBootstrapToken() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithClientCert() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithKeystone() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithOIDC() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithPasswordFile() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithRequestHeader() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithServiceAccounts() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithTokenFile() *BuiltInAuthenticationOptions
- func (s *BuiltInAuthenticationOptions) WithWebHook() *BuiltInAuthenticationOptions
- type BuiltInAuthorizationOptions
- func (s *BuiltInAuthorizationOptions) AddFlags(fs *pflag.FlagSet)
- func (s *BuiltInAuthorizationOptions) Modes() []string
- func (s *BuiltInAuthorizationOptions) ToAuthorizationConfig(informerFactory informers.SharedInformerFactory) authorizer.AuthorizationConfig
- func (s *BuiltInAuthorizationOptions) Validate() []error
- type CloudProviderOptions
- type InsecureServingOptions
- func (s *InsecureServingOptions) AddDeprecatedFlags(fs *pflag.FlagSet)
- func (s *InsecureServingOptions) AddFlags(fs *pflag.FlagSet)
- func (s *InsecureServingOptions) ApplyTo(c *server.Config) (*kubeserver.InsecureServingInfo, error)
- func (s *InsecureServingOptions) DefaultExternalAddress() (net.IP, error)
- func (s InsecureServingOptions) Validate(portArg string) []error
- type KeystoneAuthenticationOptions
- type OIDCAuthenticationOptions
- type PasswordFileAuthenticationOptions
- type ServiceAccountAuthenticationOptions
- type StorageSerializationOptions
- type TokenFileAuthenticationOptions
- type WebHookAuthenticationOptions
Constants ¶
const (
DefaultEtcdPathPrefix = "/registry"
)
Variables ¶
This section is empty.
Functions ¶
func DefaultAdvertiseAddress ¶
func DefaultAdvertiseAddress(s *genericoptions.ServerRunOptions, insecure *InsecureServingOptions) error
DefaultAdvertiseAddress sets the field AdvertiseAddress if unset. The field will be set based on the SecureServingOptions. If the SecureServingOptions is not present, DefaultExternalAddress will fall back to the insecure ServingOptions.
func NewSecureServingOptions ¶
func NewSecureServingOptions() *genericoptions.SecureServingOptions
NewSecureServingOptions gives default values for the kube-apiserver and federation-apiserver which are not the options wanted by "normal" API servers running on the platform
Types ¶
type APIEnablementOptions ¶
type APIEnablementOptions struct {
RuntimeConfig utilflag.ConfigurationMap
}
APIEnablementOptions contains the options for which resources to turn on and off. Given small aggregated API servers, this option isn't required for "normal" API servers
func NewAPIEnablementOptions ¶
func NewAPIEnablementOptions() *APIEnablementOptions
func (*APIEnablementOptions) AddFlags ¶
func (s *APIEnablementOptions) AddFlags(fs *pflag.FlagSet)
AddFlags adds flags for a specific APIServer to the specified FlagSet
type AnonymousAuthenticationOptions ¶
type AnonymousAuthenticationOptions struct {
Allow bool
}
type BootstrapTokenAuthenticationOptions ¶
type BootstrapTokenAuthenticationOptions struct {
Enable bool
}
type BuiltInAuthenticationOptions ¶
type BuiltInAuthenticationOptions struct { Anonymous *AnonymousAuthenticationOptions BootstrapToken *BootstrapTokenAuthenticationOptions ClientCert *genericoptions.ClientCertAuthenticationOptions Keystone *KeystoneAuthenticationOptions OIDC *OIDCAuthenticationOptions PasswordFile *PasswordFileAuthenticationOptions RequestHeader *genericoptions.RequestHeaderAuthenticationOptions ServiceAccounts *ServiceAccountAuthenticationOptions TokenFile *TokenFileAuthenticationOptions WebHook *WebHookAuthenticationOptions TokenSuccessCacheTTL time.Duration TokenFailureCacheTTL time.Duration }
func NewBuiltInAuthenticationOptions ¶
func NewBuiltInAuthenticationOptions() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) AddFlags ¶
func (s *BuiltInAuthenticationOptions) AddFlags(fs *pflag.FlagSet)
func (*BuiltInAuthenticationOptions) ApplyAuthorization ¶
func (o *BuiltInAuthenticationOptions) ApplyAuthorization(authorization *BuiltInAuthorizationOptions)
ApplyAuthorization will conditionally modify the authentication options based on the authorization options
func (*BuiltInAuthenticationOptions) ApplyTo ¶
func (o *BuiltInAuthenticationOptions) ApplyTo(c *genericapiserver.Config) error
func (*BuiltInAuthenticationOptions) ToAuthenticationConfig ¶
func (s *BuiltInAuthenticationOptions) ToAuthenticationConfig() authenticator.AuthenticatorConfig
func (*BuiltInAuthenticationOptions) Validate ¶
func (s *BuiltInAuthenticationOptions) Validate() []error
Validate checks invalid config combination
func (*BuiltInAuthenticationOptions) WithAll ¶
func (s *BuiltInAuthenticationOptions) WithAll() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithAnonymous ¶ added in v1.8.8
func (s *BuiltInAuthenticationOptions) WithAnonymous() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithBootstrapToken ¶
func (s *BuiltInAuthenticationOptions) WithBootstrapToken() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithClientCert ¶
func (s *BuiltInAuthenticationOptions) WithClientCert() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithKeystone ¶
func (s *BuiltInAuthenticationOptions) WithKeystone() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithOIDC ¶
func (s *BuiltInAuthenticationOptions) WithOIDC() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithPasswordFile ¶
func (s *BuiltInAuthenticationOptions) WithPasswordFile() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithRequestHeader ¶
func (s *BuiltInAuthenticationOptions) WithRequestHeader() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithServiceAccounts ¶
func (s *BuiltInAuthenticationOptions) WithServiceAccounts() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithTokenFile ¶
func (s *BuiltInAuthenticationOptions) WithTokenFile() *BuiltInAuthenticationOptions
func (*BuiltInAuthenticationOptions) WithWebHook ¶
func (s *BuiltInAuthenticationOptions) WithWebHook() *BuiltInAuthenticationOptions
type BuiltInAuthorizationOptions ¶
type BuiltInAuthorizationOptions struct { Mode string PolicyFile string WebhookConfigFile string WebhookCacheAuthorizedTTL time.Duration }
func NewBuiltInAuthorizationOptions ¶
func NewBuiltInAuthorizationOptions() *BuiltInAuthorizationOptions
func (*BuiltInAuthorizationOptions) AddFlags ¶
func (s *BuiltInAuthorizationOptions) AddFlags(fs *pflag.FlagSet)
func (*BuiltInAuthorizationOptions) Modes ¶
func (s *BuiltInAuthorizationOptions) Modes() []string
func (*BuiltInAuthorizationOptions) ToAuthorizationConfig ¶
func (s *BuiltInAuthorizationOptions) ToAuthorizationConfig(informerFactory informers.SharedInformerFactory) authorizer.AuthorizationConfig
func (*BuiltInAuthorizationOptions) Validate ¶
func (s *BuiltInAuthorizationOptions) Validate() []error
type CloudProviderOptions ¶
func NewCloudProviderOptions ¶
func NewCloudProviderOptions() *CloudProviderOptions
func (*CloudProviderOptions) AddFlags ¶
func (s *CloudProviderOptions) AddFlags(fs *pflag.FlagSet)
func (*CloudProviderOptions) DefaultExternalHost ¶
func (s *CloudProviderOptions) DefaultExternalHost(genericoptions *genericoptions.ServerRunOptions) error
func (*CloudProviderOptions) Validate ¶
func (s *CloudProviderOptions) Validate() []error
type InsecureServingOptions ¶
InsecureServingOptions are for creating an unauthenticated, unauthorized, insecure port. No one should be using these anymore.
func NewInsecureServingOptions ¶
func NewInsecureServingOptions() *InsecureServingOptions
NewInsecureServingOptions is for creating an unauthenticated, unauthorized, insecure port. No one should be using these anymore.
func (*InsecureServingOptions) AddDeprecatedFlags ¶
func (s *InsecureServingOptions) AddDeprecatedFlags(fs *pflag.FlagSet)
func (*InsecureServingOptions) AddFlags ¶
func (s *InsecureServingOptions) AddFlags(fs *pflag.FlagSet)
func (*InsecureServingOptions) ApplyTo ¶
func (s *InsecureServingOptions) ApplyTo(c *server.Config) (*kubeserver.InsecureServingInfo, error)
func (*InsecureServingOptions) DefaultExternalAddress ¶
func (s *InsecureServingOptions) DefaultExternalAddress() (net.IP, error)
func (InsecureServingOptions) Validate ¶
func (s InsecureServingOptions) Validate(portArg string) []error
type PasswordFileAuthenticationOptions ¶
type PasswordFileAuthenticationOptions struct {
BasicAuthFile string
}
type StorageSerializationOptions ¶
type StorageSerializationOptions struct { StorageVersions string // The default values for StorageVersions. StorageVersions overrides // these; you can change this if you want to change the defaults (e.g., // for testing). This is not actually exposed as a flag. DefaultStorageVersions string }
StorageSerializationOptions contains the options for encoding resources.
func NewStorageSerializationOptions ¶
func NewStorageSerializationOptions() *StorageSerializationOptions
func (*StorageSerializationOptions) AddFlags ¶
func (s *StorageSerializationOptions) AddFlags(fs *pflag.FlagSet)
AddFlags adds flags for a specific APIServer to the specified FlagSet
func (*StorageSerializationOptions) StorageGroupsToEncodingVersion ¶
func (s *StorageSerializationOptions) StorageGroupsToEncodingVersion() (map[string]schema.GroupVersion, error)
StorageGroupsToEncodingVersion returns a map from group name to group version, computed from s.StorageVersions flag.
type TokenFileAuthenticationOptions ¶
type TokenFileAuthenticationOptions struct {
TokenFile string
}