kubeclient

Documentation

Index

• Constants
• func AssertSecureConfig(kubeConfig *restclient.Config) error
• func AssertSecureTransport(rt http.RoundTripper) error
• func Secure(config *restclient.Config) (kubernetes.Interface, *restclient.Config, error)
• func SecureAnonymousClientConfig(kubeConfig *restclient.Config) *restclient.Config
• type Client
  • func New(opts ...Option) (*Client, error)
• type Middleware
• type MiddlewareFunc
  • func (f MiddlewareFunc) Handle(ctx context.Context, rt RoundTrip)
• type Middlewares
  • func (m Middlewares) Handle(ctx context.Context, rt RoundTrip)
• type Object
• type Option
  • func WithConfig(config *restclient.Config) Option
  • func WithMiddleware(middleware Middleware) Option
  • func WithTLSConfigFunc(tlsConfigFunc ptls.ConfigFunc) Option
  • func WithTransportWrapper(wrapper transport.WrapperFunc) Option
• type RoundTrip
• type Verb

Constants

const (
	VerbCreate           verb = "create"
	VerbUpdate           verb = "update"
	VerbDelete           verb = "delete"
	VerbDeleteCollection verb = "deletecollection"
	VerbGet              verb = "get"
	VerbList             verb = "list"
	VerbWatch            verb = "watch"
	VerbPatch            verb = "patch"

	VerbProxy verb = "proxy" // proxy unsupported for now
)

Functions

func AssertSecureConfig

func AssertSecureConfig(kubeConfig *restclient.Config) error

func AssertSecureTransport

func AssertSecureTransport(rt http.RoundTripper) error

func Secure

func Secure(config *restclient.Config) (kubernetes.Interface, *restclient.Config, error)

func SecureAnonymousClientConfig

func SecureAnonymousClientConfig(kubeConfig *restclient.Config) *restclient.Config

SecureAnonymousClientConfig has the same properties as restclient.AnonymousClientConfig while still enforcing the secure TLS configuration of the ptls / phttp packages.

Types

type Client

type Client struct {
	Kubernetes         kubernetes.Interface
	Aggregation        aggregatorclient.Interface
	PinnipedConcierge  pinnipedconciergeclientset.Interface
	PinnipedSupervisor pinnipedsupervisorclientset.Interface

	JSONConfig, ProtoConfig *restclient.Config
}

func New

func New(opts ...Option) (*Client, error)

type Middleware

type Middleware interface {
	Handle(ctx context.Context, rt RoundTrip)
}

type MiddlewareFunc

type MiddlewareFunc func(ctx context.Context, rt RoundTrip)

func (MiddlewareFunc) Handle

func (f MiddlewareFunc) Handle(ctx context.Context, rt RoundTrip)

type Middlewares

type Middlewares []Middleware

func (Middlewares) Handle

func (m Middlewares) Handle(ctx context.Context, rt RoundTrip)

type Object

type Object interface {
	runtime.Object // generic access to TypeMeta
	metav1.Object  // generic access to ObjectMeta
}

type Option

type Option func(*clientConfig)

func WithConfig

func WithConfig(config *restclient.Config) Option

func WithMiddleware

func WithMiddleware(middleware Middleware) Option

func WithTLSConfigFunc

func WithTLSConfigFunc(tlsConfigFunc ptls.ConfigFunc) Option

WithTLSConfigFunc will cause the client to use the provided configuration from the ptls package when the client makes requests. For example, pass ptls.Default or ptls.Secure as the argument. When this Option is not used, the client will default to using ptls.Secure.

func WithTransportWrapper

func WithTransportWrapper(wrapper transport.WrapperFunc) Option

WithTransportWrapper will wrap the client-go http.RoundTripper chain *after* the middleware wrapper is applied. I.e., this wrapper has the opportunity to supply an http.RoundTripper that runs first in the client-go http.RoundTripper chain.

type RoundTrip

type RoundTrip interface {
	Verb() Verb
	Namespace() string // this is the only valid way to check namespace, Object.GetNamespace() will almost always be empty
	NamespaceScoped() bool
	Resource() schema.GroupVersionResource
	Subresource() string
	MutateRequest(f func(obj Object) error)
	MutateResponse(f func(obj Object) error)
}

type Verb

type Verb interface {
	// contains filtered or unexported methods
}