builder

Documentation

Index

• Variables
• type Command
• type GenericAPIServer
• type OpenAPIDefinition
• type Server
  • func (r *Server) Execute(ctx context.Context) error
  • func (r *Server) WithConfigFns(fns ...func(config *server.RecommendedConfig) *server.RecommendedConfig) *Server
  • func (r *Server) WithEtcdPath(etcdPath string) *Server
  • func (r *Server) WithFlagFns(fns ...func(set *pflag.FlagSet) *pflag.FlagSet) *Server
  • func (a *Server) WithLocalDebugExtension() *Server
  • func (r *Server) WithOpenAPIDefinitions(name, version string, defs openapicommon.GetOpenAPIDefinitions) *Server
  • func (r *Server) WithOptionsFns(fns ...func(*ServerOptions) *ServerOptions) *Server
  • func (r *Server) WithResourceAndHandler(obj resource.Object, sp *rest.StorageProvider) *Server
  • func (r *Server) WithServerFns(fns ...func(server *GenericAPIServer) *GenericAPIServer) *Server
  • func (r *Server) WithServerName(serverName string) *Server
  • func (r *Server) WithoutEtcd() *Server
• type ServerOptions
• type Storage

Variables

var APIServer = &Server{
	storageProvider: map[schema.GroupResource]*singletonProvider{},
}

APIServer builds an apiserver to server Kubernetes resources and sub resources.

Types

type Command

type Command = cobra.Command

Command is an alias for cobra.Command and is used to start the apiserver.

type GenericAPIServer

type GenericAPIServer = server.GenericAPIServer

GenericAPIServer is an alias for pkgserver.GenericAPIServer

type OpenAPIDefinition

type OpenAPIDefinition = common.OpenAPIDefinition

OpenAPIDefinition is an alias for common.OpenAPIDefinition

type Server

type Server struct {
	ServerName string
	EtcdPath   string
	// contains filtered or unexported fields
}

Server builds a new apiserver for a single API group

func (*Server) Execute

func (r *Server) Execute(ctx context.Context) error

Execute builds and executes the apiserver Command.

func (*Server) WithConfigFns

func (r *Server) WithConfigFns(fns ...func(config *server.RecommendedConfig) *server.RecommendedConfig) *Server

WithConfigFns sets functions to customize the RecommendedConfig

func (*Server) WithEtcdPath

func (r *Server) WithEtcdPath(etcdPath string) *Server

func (*Server) WithFlagFns

func (r *Server) WithFlagFns(fns ...func(set *pflag.FlagSet) *pflag.FlagSet) *Server

WithFlagFns sets functions to customize the flags for the compiled binary.

func (*Server) WithLocalDebugExtension

func (a *Server) WithLocalDebugExtension() *Server

WithLocalDebugExtension adds an optional local-debug mode to the apiserver so that it can be tested locally without involving a complete kubernetes cluster. A flag named "--standalone-debug-mode" will also be added the binary which forcily requires "--bind-address" to be "127.0.0.1" in order to avoid security issues.

func (*Server) WithOpenAPIDefinitions

func (r *Server) WithOpenAPIDefinitions(
	name, version string,
	defs openapicommon.GetOpenAPIDefinitions) *Server

func (*Server) WithOptionsFns

func (r *Server) WithOptionsFns(fns ...func(*ServerOptions) *ServerOptions) *Server

WithOptionsFns sets functions to customize the ServerOptions used to create the apiserver

func (*Server) WithResourceAndHandler

func (r *Server) WithResourceAndHandler(obj resource.Object, sp *rest.StorageProvider) *Server

WithResourceAndHandler registers a request handler for the resource rather than the default etcd backend storage.

Note: WithResourceAndHandler should never be called after the GroupResource has already been registered with another version.

Note: WithResourceAndHandler will NOT register the "status" subresource for the resource object.

func (*Server) WithServerFns

func (r *Server) WithServerFns(fns ...func(server *GenericAPIServer) *GenericAPIServer) *Server

WithServerFns sets functions to customize the GenericAPIServer

func (*Server) WithServerName

func (r *Server) WithServerName(serverName string) *Server

func (*Server) WithoutEtcd

func (r *Server) WithoutEtcd() *Server

WithoutEtcd removes etcd related settings from apiserver.

type ServerOptions

type ServerOptions = options.ServerOptions

ServerOptions is an alias for apiserverbuilder.ServerOptions

type Storage

type Storage = rest.Storage

Storage is an alias for rest.Storage. Storage implements the interfaces defined in the rest package to expose new REST endpoints for a Kubernetes resource.