client

Documentation

Index

• func ShardFromContext(ctx context.Context) shard.Name
• func WithCacheServiceRoundTripper(cfg *rest.Config) *rest.Config
• func WithDefaultShardRoundTripper(cfg *rest.Config, shard clientshard.Name) *rest.Config
• func WithShardInContext(parent context.Context, shard shard.Name) context.Context
• func WithShardNameFromContextRoundTripper(cfg *rest.Config) *rest.Config
• func WithShardNameFromObjectRoundTripper(cfg *rest.Config, ...) *rest.Config
• type CacheServiceRoundTripper
  • func NewCacheServiceRoundTripper(delegate http.RoundTripper) *CacheServiceRoundTripper
  • func (c *CacheServiceRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
  • func (c *CacheServiceRoundTripper) WrappedRoundTripper() http.RoundTripper
• type DefaultShardRoundTripper
  • func NewDefaultShardRoundTripper(delegate http.RoundTripper, shard clientshard.Name) *DefaultShardRoundTripper
  • func (c *DefaultShardRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
  • func (c *DefaultShardRoundTripper) WrappedRoundTripper() http.RoundTripper
• type ShardNameFromObjectRoundTripper
  • func NewShardNameFromObjectRoundTripper(delegate http.RoundTripper, ...) *ShardNameFromObjectRoundTripper
  • func (c *ShardNameFromObjectRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
  • func (c *ShardNameFromObjectRoundTripper) WrappedRoundTripper() http.RoundTripper
• type ShardRoundTripper
  • func NewShardRoundTripper(delegate http.RoundTripper) *ShardRoundTripper
  • func (c *ShardRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
  • func (c *ShardRoundTripper) WrappedRoundTripper() http.RoundTripper

Functions

func ShardFromContext

func ShardFromContext(ctx context.Context) shard.Name

ShardFromContext returns the value of the shard key on the ctx, or an empty Name if there is no shard key.

func WithCacheServiceRoundTripper

func WithCacheServiceRoundTripper(cfg *rest.Config) *rest.Config

WithCacheServiceRoundTripper wraps an existing config's with CacheServiceRoundTripper.

func WithDefaultShardRoundTripper

func WithDefaultShardRoundTripper(cfg *rest.Config, shard clientshard.Name) *rest.Config

WithDefaultShardRoundTripper wraps an existing config's with DefaultShardRoundTripper

Note: it is the caller responsibility to make a copy of the rest config.

func WithShardInContext

func WithShardInContext(parent context.Context, shard shard.Name) context.Context

WithShardInContext returns a context with the given shard set.

func WithShardNameFromContextRoundTripper

func WithShardNameFromContextRoundTripper(cfg *rest.Config) *rest.Config

WithShardNameFromContextRoundTripper wraps an existing config's with ShardRoundTripper.

Note: it is the caller responsibility to make a copy of the rest config.

func WithShardNameFromObjectRoundTripper

func WithShardNameFromObjectRoundTripper(cfg *rest.Config, requestInfoResolver func(*http.Request) (string, string, error), supportedResources ...string) *rest.Config

WithShardNameFromObjectRoundTripper wraps an existing config with ShardNameFromObjectRoundTripper.

Note: it is the caller responsibility to make a copy of the rest config.

Types

type CacheServiceRoundTripper

type CacheServiceRoundTripper struct {
	// contains filtered or unexported fields
}

CacheServiceRoundTripper is a http.RoundTripper that appends "/services/cache" prefix to a request.

func NewCacheServiceRoundTripper

func NewCacheServiceRoundTripper(delegate http.RoundTripper) *CacheServiceRoundTripper

NewCacheServiceRoundTripper creates a new CacheServiceRoundTripper.

func (*CacheServiceRoundTripper) RoundTrip

func (c *CacheServiceRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

func (*CacheServiceRoundTripper) WrappedRoundTripper

func (c *CacheServiceRoundTripper) WrappedRoundTripper() http.RoundTripper

type DefaultShardRoundTripper

type DefaultShardRoundTripper struct {
	// contains filtered or unexported fields
}

DefaultShardRoundTripper is a http.RoundTripper that sets a default shard name if not specified in the context.

func NewDefaultShardRoundTripper

func NewDefaultShardRoundTripper(delegate http.RoundTripper, shard clientshard.Name) *DefaultShardRoundTripper

NewDefaultShardRoundTripper creates a new round tripper that sets a default shard name.

func (*DefaultShardRoundTripper) RoundTrip

func (c *DefaultShardRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

func (*DefaultShardRoundTripper) WrappedRoundTripper

func (c *DefaultShardRoundTripper) WrappedRoundTripper() http.RoundTripper

type ShardNameFromObjectRoundTripper

type ShardNameFromObjectRoundTripper struct {
	// contains filtered or unexported fields
}

ShardNameFromObjectRoundTripper knows how to read a shard name from an object and store it in the context. it should be only used by the internal kube-clients that are not aware of a shard name.

func NewShardNameFromObjectRoundTripper

func NewShardNameFromObjectRoundTripper(delegate http.RoundTripper, requestInfoResolver func(*http.Request) (string, string, error), supportedResources ...string) *ShardNameFromObjectRoundTripper

NewShardNameFromObjectRoundTripper creates a new ShardNameFromObjectRoundTripper for the given resources.

func (*ShardNameFromObjectRoundTripper) RoundTrip

func (c *ShardNameFromObjectRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

func (*ShardNameFromObjectRoundTripper) WrappedRoundTripper

func (c *ShardNameFromObjectRoundTripper) WrappedRoundTripper() http.RoundTripper

type ShardRoundTripper

type ShardRoundTripper struct {
	// contains filtered or unexported fields
}

ShardRoundTripper is a shard aware wrapper around http.RoundTripper. It changes the URL path to target a shard from the context.

For example given "amber" shard name in the context it will change apis/apis.kcp.io/v1alpha1/apiexports to /shards/amber/apis/apis.kcp.io/v1alpha1/apiexports.

func NewShardRoundTripper

func NewShardRoundTripper(delegate http.RoundTripper) *ShardRoundTripper

NewShardRoundTripper creates a new shard aware round tripper.

func (*ShardRoundTripper) RoundTrip

func (c *ShardRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

func (*ShardRoundTripper) WrappedRoundTripper

func (c *ShardRoundTripper) WrappedRoundTripper() http.RoundTripper