crdclient

Documentation

Overview

Package crdclient provides an implementation of the config store and cache using Kubernetes Custom Resources and the informer framework from Kubernetes

This code relies heavily on code generation for performance reasons; to implement the Istio store interface, we need to take dynamic inputs. Using the dynamic informers results in poor performance, as the cache will store unstructured objects which need to be marshaled on each Get/List call. Using istio/client-go directly will cache objects marshaled, allowing us to have cheap Get/List calls, at the expense of some code gen.

Index

• func TranslateObject(r runtime.Object, gvk config.GroupVersionKind, domainSuffix string) config.Config
• type Client
  • func New(client kube.Client, opts Option) *Client
  • func NewForSchemas(client kube.Client, opts Option, schemas collection.Schemas) *Client
  • func (cl *Client) Create(cfg config.Config) (string, error)
  • func (cl *Client) Delete(typ config.GroupVersionKind, name, namespace string, resourceVersion *string) error
  • func (cl *Client) Get(typ config.GroupVersionKind, name, namespace string) *config.Config
  • func (cl *Client) HasSynced() bool
  • func (cl *Client) List(kind config.GroupVersionKind, namespace string) []config.Config
  • func (cl *Client) Patch(orig config.Config, patchFn config.PatchFunc) (string, error)
  • func (cl *Client) RegisterEventHandler(kind config.GroupVersionKind, handler model.EventHandler)
  • func (cl *Client) Run(stop <-chan struct{})
  • func (cl *Client) Schemas() collection.Schemas
  • func (cl *Client) Update(cfg config.Config) (string, error)
  • func (cl *Client) UpdateStatus(cfg config.Config) (string, error)
• type Option

Functions

func TranslateObject

func TranslateObject(r runtime.Object, gvk config.GroupVersionKind, domainSuffix string) config.Config

Types

type Client

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

Client is a client for Istio CRDs, implementing config store cache This is used for CRUD operators on Istio configuration, as well as handling of events on config changes

func New

func New(client kube.Client, opts Option) *Client

func NewForSchemas

func NewForSchemas(client kube.Client, opts Option, schemas collection.Schemas) *Client

func (*Client) Create

func (cl *Client) Create(cfg config.Config) (string, error)

Create implements store interface

func (*Client) Delete

func (cl *Client) Delete(typ config.GroupVersionKind, name, namespace string, resourceVersion *string) error

Delete implements store interface `resourceVersion` must be matched before deletion is carried out. If not possible, a 409 Conflict status will be

func (*Client) Get

func (cl *Client) Get(typ config.GroupVersionKind, name, namespace string) *config.Config

Get implements store interface

func (*Client) HasSynced

func (cl *Client) HasSynced() bool

func (*Client) List

func (cl *Client) List(kind config.GroupVersionKind, namespace string) []config.Config

List implements store interface

func (*Client) Patch

func (cl *Client) Patch(orig config.Config, patchFn config.PatchFunc) (string, error)

Patch applies only the modifications made in the PatchFunc rather than doing a full replace. Useful to avoid read-modify-write conflicts when there are many concurrent-writers to the same resource.

func (*Client) RegisterEventHandler

func (cl *Client) RegisterEventHandler(kind config.GroupVersionKind, handler model.EventHandler)

func (*Client) Run

func (cl *Client) Run(stop <-chan struct{})

Run the queue and all informers. Callers should wait for HasSynced() before depending on results.

func (*Client) Schemas

func (cl *Client) Schemas() collection.Schemas

Schemas for the store

func (*Client) Update

func (cl *Client) Update(cfg config.Config) (string, error)

Update implements store interface

func (*Client) UpdateStatus

func (cl *Client) UpdateStatus(cfg config.Config) (string, error)

type Option

type Option struct {
	Revision     string
	DomainSuffix string
	Identifier   string
	FiltersByGVK map[config.GroupVersionKind]kubetypes.Filter
}