Documentation

Overview

    Package options contains flags and options for initializing an apiserver

    Index

    Constants

    View Source
    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 AnyTokenAuthenticationOptions

            type AnyTokenAuthenticationOptions struct {
            	Allow bool
            }

            type BootstrapTokenAuthenticationOptions

            type BootstrapTokenAuthenticationOptions struct {
            	Allow bool
            }

            type BuiltInAuthenticationOptions

            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 (*BuiltInAuthenticationOptions) ToAuthenticationConfig

              func (*BuiltInAuthenticationOptions) Validate

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

                Validate checks invalid config combination

                func (*BuiltInAuthenticationOptions) WithAll

                func (*BuiltInAuthenticationOptions) WithAnyToken

                func (*BuiltInAuthenticationOptions) WithAnyonymous

                func (*BuiltInAuthenticationOptions) WithBootstrapToken

                func (*BuiltInAuthenticationOptions) WithClientCert

                func (*BuiltInAuthenticationOptions) WithKeystone

                func (*BuiltInAuthenticationOptions) WithOIDC

                func (*BuiltInAuthenticationOptions) WithPasswordFile

                func (*BuiltInAuthenticationOptions) WithRequestHeader

                func (*BuiltInAuthenticationOptions) WithServiceAccounts

                func (*BuiltInAuthenticationOptions) WithTokenFile

                func (*BuiltInAuthenticationOptions) WithWebHook

                type BuiltInAuthorizationOptions

                type BuiltInAuthorizationOptions struct {
                	Mode                        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) Modes

                func (s *BuiltInAuthorizationOptions) Modes() []string

                func (*BuiltInAuthorizationOptions) ToAuthorizationConfig

                func (*BuiltInAuthorizationOptions) Validate

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

                type CloudProviderOptions

                type CloudProviderOptions struct {
                	CloudConfigFile string
                	CloudProvider   string
                }

                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

                type InsecureServingOptions struct {
                	BindAddress net.IP
                	BindPort    int
                }

                  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 (*InsecureServingOptions) DefaultExternalAddress

                    func (s *InsecureServingOptions) DefaultExternalAddress() (net.IP, error)

                    func (InsecureServingOptions) Validate

                    func (s InsecureServingOptions) Validate(portArg string) []error

                    type KeystoneAuthenticationOptions

                    type KeystoneAuthenticationOptions struct {
                    	URL    string
                    	CAFile string
                    }

                    type OIDCAuthenticationOptions

                    type OIDCAuthenticationOptions struct {
                    	CAFile        string
                    	ClientID      string
                    	IssuerURL     string
                    	UsernameClaim string
                    	GroupsClaim   string
                    }

                    type PasswordFileAuthenticationOptions

                    type PasswordFileAuthenticationOptions struct {
                    	BasicAuthFile string
                    }

                    type ServiceAccountAuthenticationOptions

                    type ServiceAccountAuthenticationOptions struct {
                    	KeyFiles []string
                    	Lookup   bool
                    }

                    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
                          }