dynamic

Documentation

Overview

Package dynamic provides a client interface to arbitrary Kubernetes APIs that exposes common high level operations and exposes common metadata.

Index

• Variables
• func ContentConfig() restclient.ContentConfig
• func LegacyAPIPathResolverFunc(kind schema.GroupVersionKind) string
• func NewDiscoveryRESTMapper(resources []*metav1.APIResourceList, versionFunc meta.VersionInterfacesFunc) (*meta.DefaultRESTMapper, error)
• func NewObjectTyper(resources []*metav1.APIResourceList) (runtime.ObjectTyper, error)
• func VersionInterfaces(schema.GroupVersion) (*meta.VersionInterfaces, error)
• type APIPathResolverFunc
• type Client
  • func NewClient(conf *restclient.Config) (*Client, error)
  • func (c *Client) GetRateLimiter() flowcontrol.RateLimiter
  • func (c *Client) ParameterCodec(parameterCodec runtime.ParameterCodec) *Client
  • func (c *Client) Resource(resource *metav1.APIResource, namespace string) *ResourceClient
• type ClientPool
  • func NewClientPool(config *restclient.Config, mapper meta.RESTMapper, ...) ClientPool
  • func NewDynamicClientPool(cfg *restclient.Config) ClientPool
• type ObjectTyper
  • func (ot *ObjectTyper) ObjectKinds(obj runtime.Object) ([]schema.GroupVersionKind, bool, error)
  • func (ot *ObjectTyper) Recognizes(gvk schema.GroupVersionKind) bool
• type ResourceClient
  • func (rc *ResourceClient) Create(obj *unstructured.Unstructured) (*unstructured.Unstructured, error)
  • func (rc *ResourceClient) Delete(name string, opts *metav1.DeleteOptions) error
  • func (rc *ResourceClient) DeleteCollection(deleteOptions *metav1.DeleteOptions, listOptions metav1.ListOptions) error
  • func (rc *ResourceClient) Get(name string, opts metav1.GetOptions) (*unstructured.Unstructured, error)
  • func (rc *ResourceClient) List(opts metav1.ListOptions) (runtime.Object, error)
  • func (rc *ResourceClient) Patch(name string, pt types.PatchType, data []byte) (*unstructured.Unstructured, error)
  • func (rc *ResourceClient) Update(obj *unstructured.Unstructured) (*unstructured.Unstructured, error)
  • func (rc *ResourceClient) Watch(opts metav1.ListOptions) (watch.Interface, error)

Variables

var VersionedParameterEncoderWithV1Fallback runtime.ParameterCodec = versionedParameterEncoderWithV1Fallback{}

VersionedParameterEncoderWithV1Fallback is useful for encoding query parameters for thirdparty resources. It tries to convert object to the specified version before converting it to query parameters, and falls back to converting to v1 if the object is not registered in the specified version. For the record, currently API server always treats query parameters sent to a thirdparty resource endpoint as v1.

Functions

func ContentConfig

func ContentConfig() restclient.ContentConfig

ContentConfig returns a restclient.ContentConfig for dynamic types.

func LegacyAPIPathResolverFunc

func LegacyAPIPathResolverFunc(kind schema.GroupVersionKind) string

LegacyAPIPathResolverFunc can resolve paths properly with the legacy API.

func NewDiscoveryRESTMapper

func NewDiscoveryRESTMapper(resources []*metav1.APIResourceList, versionFunc meta.VersionInterfacesFunc) (*meta.DefaultRESTMapper, error)

NewDiscoveryRESTMapper returns a RESTMapper based on discovery information.

func NewObjectTyper

func NewObjectTyper(resources []*metav1.APIResourceList) (runtime.ObjectTyper, error)

NewObjectTyper constructs an ObjectTyper from discovery information.

func VersionInterfaces

func VersionInterfaces(schema.GroupVersion) (*meta.VersionInterfaces, error)

VersionInterfaces provides an object converter and metadata accessor appropriate for use with unstructured objects.

Types

type APIPathResolverFunc

type APIPathResolverFunc func(kind schema.GroupVersionKind) string

APIPathResolverFunc knows how to convert a groupVersion to its API path. The Kind field is optional.

type Client

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

Client is a Kubernetes client that allows you to access metadata and manipulate metadata of a Kubernetes API group.

func NewClient

func NewClient(conf *restclient.Config) (*Client, error)

NewClient returns a new client based on the passed in config. The codec is ignored, as the dynamic client uses it's own codec.

func (*Client) GetRateLimiter

func (c *Client) GetRateLimiter() flowcontrol.RateLimiter

GetRateLimiter returns rate limier.

func (*Client) ParameterCodec

func (c *Client) ParameterCodec(parameterCodec runtime.ParameterCodec) *Client

ParameterCodec returns a client with the provided parameter codec.

func (*Client) Resource

func (c *Client) Resource(resource *metav1.APIResource, namespace string) *ResourceClient

Resource returns an API interface to the specified resource for this client's group and version. If resource is not a namespaced resource, then namespace is ignored. The ResourceClient inherits the parameter codec of c.

type ClientPool

type ClientPool interface {
	// ClientForGroupVersionKind returns a client configured for the specified groupVersionResource.
	// Resource may be empty.
	ClientForGroupVersionResource(resource schema.GroupVersionResource) (*Client, error)
	// ClientForGroupVersionKind returns a client configured for the specified groupVersionKind.
	// Kind may be empty.
	ClientForGroupVersionKind(kind schema.GroupVersionKind) (*Client, error)
}

ClientPool manages a pool of dynamic clients.

func NewClientPool

func NewClientPool(config *restclient.Config, mapper meta.RESTMapper, apiPathResolverFunc APIPathResolverFunc) ClientPool

NewClientPool returns a ClientPool from the specified config. It reuses clients for the the same group version. It is expected this type may be wrapped by specific logic that special cases certain resources or groups.

func NewDynamicClientPool

func NewDynamicClientPool(cfg *restclient.Config) ClientPool

Instantiates a new dynamic client pool with the given config.

type ObjectTyper

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

ObjectTyper provides an ObjectTyper implementation for unstructured.Unstructured object based on discovery information.

func (*ObjectTyper) ObjectKinds

func (ot *ObjectTyper) ObjectKinds(obj runtime.Object) ([]schema.GroupVersionKind, bool, error)

ObjectKinds returns a slice of one element with the group,version,kind of the provided object, or an error if the object is not *unstructured.Unstructured or has no group,version,kind information.

func (*ObjectTyper) Recognizes

func (ot *ObjectTyper) Recognizes(gvk schema.GroupVersionKind) bool

Recognizes returns true if the provided group,version,kind was in the discovery information.

type ResourceClient

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

ResourceClient is an API interface to a specific resource under a dynamic client.

func (*ResourceClient) Create

func (rc *ResourceClient) Create(obj *unstructured.Unstructured) (*unstructured.Unstructured, error)

Create creates the provided resource.

func (*ResourceClient) Delete

func (rc *ResourceClient) Delete(name string, opts *metav1.DeleteOptions) error

Delete deletes the resource with the specified name.

func (*ResourceClient) DeleteCollection

func (rc *ResourceClient) DeleteCollection(deleteOptions *metav1.DeleteOptions, listOptions metav1.ListOptions) error

DeleteCollection deletes a collection of objects.

func (*ResourceClient) Get

func (rc *ResourceClient) Get(name string, opts metav1.GetOptions) (*unstructured.Unstructured, error)

Get gets the resource with the specified name.

func (*ResourceClient) List

func (rc *ResourceClient) List(opts metav1.ListOptions) (runtime.Object, error)

List returns a list of objects for this resource.

func (*ResourceClient) Patch

func (rc *ResourceClient) Patch(name string, pt types.PatchType, data []byte) (*unstructured.Unstructured, error)

func (*ResourceClient) Update

func (rc *ResourceClient) Update(obj *unstructured.Unstructured) (*unstructured.Unstructured, error)

Update updates the provided resource.

func (*ResourceClient) Watch

func (rc *ResourceClient) Watch(opts metav1.ListOptions) (watch.Interface, error)

Watch returns a watch.Interface that watches the resource.