options

package
v1.23.8 Latest Latest
Warning

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

 Go to latest Published: Mar 24, 2022 License: Apache-2.0 Imports: 26 Imported by: 1

Documentation

Overview

Package options contains flags and options for initializing kube-apiserver

Index

Constants

View Source 
const (
	DefaultEtcdPathPrefix = "/registry"
)

Variables

View Source 
var AllOrderedPlugins = []string{
	admit.PluginName,
	deny.PluginName,
}

AllOrderedPlugins is the list of all the plugins in order.

View Source 
var DefaultServiceIPCIDR net.IPNet = net.IPNet{IP: net.ParseIP("10.0.0.0"), Mask: net.CIDRMask(24, 32)}

DefaultServiceIPCIDR is a CIDR notation of IP range from which to allocate service cluster IPs

View Source 
var DefaultServiceNodePortRange = utilnet.PortRange{Base: 30000, Size: 2768}

DefaultServiceNodePortRange is the default port range for NodePort services.

Functions

func DefaultAdvertiseAddress 

func DefaultAdvertiseAddress(s *genericoptions.ServerRunOptions, insecure *genericoptions.DeprecatedInsecureServingOptions) 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 DefaultOffAdmissionPlugins 

func DefaultOffAdmissionPlugins() sets.String

DefaultOffAdmissionPlugins get admission plugins off by default for kube-apiserver.

func NewInsecureServingOptions 

func NewInsecureServingOptions() *genericoptions.DeprecatedInsecureServingOptionsWithLoopback

NewInsecureServingOptions is for creating an unauthenticated, unauthorized, insecure port. No one should be using these anymore.

func NewSecureServingOptions 

func NewSecureServingOptions() *genericoptions.SecureServingOptionsWithLoopback

NewSecureServingOptions gives default values for the kube-apiserver which are not the options wanted by "normal" API servers running on the platform

func RegisterAllAdmissionPlugins 

func RegisterAllAdmissionPlugins(plugins *admission.Plugins)

RegisterAllAdmissionPlugins registers all admission plugins and sets the recommended plugins order.

func ToPreferredVersionString 

func ToPreferredVersionString(versions []schema.GroupVersion) string

ToPreferredVersionString returns the preferred versions of all registered groups in the form of "group1/version1,group2/version2,...". This is compatible with the flag format

Types

type AdmissionOptions 

type AdmissionOptions struct {
	// GenericAdmission holds the generic admission options.
	GenericAdmission *genericoptions.AdmissionOptions
	// DEPRECATED flag, should use EnabledAdmissionPlugins and DisabledAdmissionPlugins.
	// They are mutually exclusive, specify both will lead to an error.
	PluginNames []string
}

AdmissionOptions holds the admission options. It is a wrap of generic AdmissionOptions.

func NewAdmissionOptions 

func NewAdmissionOptions() *AdmissionOptions

NewAdmissionOptions creates a new instance of AdmissionOptions Note: 

In addition it calls RegisterAllAdmissionPlugins to register
all kube-apiserver admission plugins.

Provides the list of RecommendedPluginOrder that holds sane values
that can be used by servers that don't care about admission chain.
Servers that do care can overwrite/append that field after creation.

func (*AdmissionOptions) AddFlags 

func (a *AdmissionOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to admission for kube-apiserver to the specified FlagSet

func (*AdmissionOptions) ApplyTo 

func (a *AdmissionOptions) ApplyTo(
	c *server.Config,
	informers informers.SharedInformerFactory,
	kubeAPIServerClientConfig *rest.Config,
	features featuregate.FeatureGate,
	pluginInitializers ...admission.PluginInitializer,
) error

ApplyTo adds the admission chain to the server configuration. Kube-apiserver just call generic AdmissionOptions.ApplyTo.

func (*AdmissionOptions) Validate 

func (a *AdmissionOptions) Validate() []error

Validate verifies flags passed to kube-apiserver AdmissionOptions. Kube-apiserver verifies PluginNames and then call generic AdmissionOptions.Validate.

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
	OIDC           *OIDCAuthenticationOptions
	PasswordFile   *PasswordFileAuthenticationOptions
	RequestHeader  *genericoptions.RequestHeaderAuthenticationOptions
	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(authInfo *genericapiserver.AuthenticationInfo,
	secureServing *genericapiserver.SecureServingInfo) error

func (*BuiltInAuthenticationOptions) ToAuthenticationConfig 

func (s *BuiltInAuthenticationOptions) ToAuthenticationConfig() (kubeauthenticator.Config, error)

func (*BuiltInAuthenticationOptions) Validate 

func (s *BuiltInAuthenticationOptions) Validate() []error

Validate checks invalid config combination

func (*BuiltInAuthenticationOptions) WithAll 

func (s *BuiltInAuthenticationOptions) WithAll() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithAnonymous 

func (s *BuiltInAuthenticationOptions) WithAnonymous() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithBootstrapToken 

func (s *BuiltInAuthenticationOptions) WithBootstrapToken() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithClientCert 

func (s *BuiltInAuthenticationOptions) WithClientCert() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithOIDC 

func (s *BuiltInAuthenticationOptions) WithOIDC() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithRequestHeader 

func (s *BuiltInAuthenticationOptions) WithRequestHeader() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithTokenFile 

func (s *BuiltInAuthenticationOptions) WithTokenFile() *BuiltInAuthenticationOptions

func (*BuiltInAuthenticationOptions) WithWebHook 

func (s *BuiltInAuthenticationOptions) WithWebHook() *BuiltInAuthenticationOptions

type BuiltInAuthorizationOptions 

type BuiltInAuthorizationOptions struct {
	Modes                       []string
	PolicyFile                  string
	WebhookConfigFile           string
	WebhookCacheAuthorizedTTL   time.Duration
	WebhookCacheUnauthorizedTTL time.Duration
}

func NewBuiltInAuthorizationOptions 

func NewBuiltInAuthorizationOptions() *BuiltInAuthorizationOptions

func (*BuiltInAuthorizationOptions) AddFlags 

func (s *BuiltInAuthorizationOptions) AddFlags(fs *pflag.FlagSet)

func (*BuiltInAuthorizationOptions) ToAuthorizationConfig 

func (s *BuiltInAuthorizationOptions) ToAuthorizationConfig() authorizer.AuthorizationConfig

func (*BuiltInAuthorizationOptions) Validate 

func (s *BuiltInAuthorizationOptions) Validate() []error

type DynamoDBOptions 

type DynamoDBOptions struct {
	StorageConfig *storagebackend.AWSDynamoDBConfig
}

func (*DynamoDBOptions) AddFlags 

func (s *DynamoDBOptions) AddFlags(fs *pflag.FlagSet)

AddMysqlStorageFlags adds flags related to mysql storage for a specific APIServer to the specified FlagSet

func (*DynamoDBOptions) Validate 

func (s *DynamoDBOptions) Validate() []error

type MongoDBOptions 

type MongoDBOptions struct {
	StorageConfig *storagebackend.MongoExtendConfig
}

func (*MongoDBOptions) AddFlags 

func (s *MongoDBOptions) AddFlags(fs *pflag.FlagSet)

AddMongoDBStorageFlags adds flags related to mysql storage for a specific APIServer to the specified FlagSet

func (*MongoDBOptions) Validate 

func (s *MongoDBOptions) Validate() []error

type MysqlOptions 

type MysqlOptions struct {
	StorageConfig           storagebackend.Config
	DefaultStorageMediaType string
}

MysqlOptions mysql as a backend

func NewMysqlOptions 

func NewMysqlOptions(backendConfig *storagebackend.Config) *MysqlOptions

NewMysqlOptions create mysql options

func (*MysqlOptions) AddFlags 

func (s *MysqlOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to mysql storage for a specific APIServer to the specified FlagSet you must set storage-backend flag with mysql.

func (*MysqlOptions) ApplyTo 

func (s *MysqlOptions) ApplyTo(c *server.Config) error

ApplyTo apply to server

func (*MysqlOptions) ApplyWithStorageFactoryTo 

func (s *MysqlOptions) ApplyWithStorageFactoryTo(factory serverstorage.StorageFactory, c *server.Config) error

ApplyWithStorageFactoryTo apply to storage factory

func (*MysqlOptions) Validate 

func (s *MysqlOptions) Validate() []error

Validate validate mysql input options

type OIDCAuthenticationOptions 

type OIDCAuthenticationOptions struct {
	CAFile         string
	ClientID       string
	IssuerURL      string
	UsernameClaim  string
	UsernamePrefix string
	GroupsClaim    string
	GroupsPrefix   string
	SigningAlgs    []string
	RequiredClaims map[string]string
}

type PasswordFileAuthenticationOptions 

type PasswordFileAuthenticationOptions struct {
	BasicAuthFile string
}

type SimpleRestOptionsFactory 

type SimpleRestOptionsFactory struct {
	Options MysqlOptions
}

SimpleRestOptionsFactory simple rest options factory

func (*SimpleRestOptionsFactory) GetRESTOptions 

func (f *SimpleRestOptionsFactory) GetRESTOptions(resource schema.GroupResource) (generic.RESTOptions, error)

GetRESTOptions impl generic.RESTOptions

type SqliteOptions 

type SqliteOptions struct {
	StorageConfig           storagebackend.Config
	DefaultStorageMediaType string
}

SqliteOptions sqlite as a backend

func NewSqliteOptions 

func NewSqliteOptions(backendConfig *storagebackend.Config) *SqliteOptions

NewSqliteOptions create mysql options

func (*SqliteOptions) AddFlags 

func (s *SqliteOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds flags related to mysql storage for a specific APIServer to the specified FlagSet you must set storage-backend flag with mysql.

func (*SqliteOptions) ApplyTo 

func (s *SqliteOptions) ApplyTo(c *server.Config) error

ApplyTo apply to server

func (*SqliteOptions) ApplyWithStorageFactoryTo 

func (s *SqliteOptions) ApplyWithStorageFactoryTo(factory serverstorage.StorageFactory, c *server.Config) error

ApplyWithStorageFactoryTo apply to storage factory

func (*SqliteOptions) Validate 

func (s *SqliteOptions) Validate() []error

Validate validate mysql input options

type SqliteSimpleRestOptionsFactory 

type SqliteSimpleRestOptionsFactory struct {
	Options SqliteOptions
}

SqliteSimpleRestOptionsFactory simple rest options factory

func (*SqliteSimpleRestOptionsFactory) GetRESTOptions 

func (f *SqliteSimpleRestOptionsFactory) GetRESTOptions(resource schema.GroupResource) (generic.RESTOptions, error)

GetRESTOptions impl generic.RESTOptions

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
}

type WebHookAuthenticationOptions 

type WebHookAuthenticationOptions struct {
	ConfigFile string
	CacheTTL   time.Duration
}

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.