pkg: github.com/knative/pkg/apis/duck Index | Files | Directories

package duck

import "github.com/knative/pkg/apis/duck"

Package duck defines logic for defining and consuming "duck typed" Kubernetes resources. Producers define partial resource definitions that resource authors may choose to implement to interoperate with consumers of these "duck typed" interfaces. For more information see: https://docs.google.com/document/d/16j8C91jML4fQRQPhnHihNJUJDcbvW0RM1YAX2REHgyY/edit#

Index

Package Files

cached.go const.go doc.go enqueue.go interface.go patch.go proxy.go register.go typed.go unstructured.go verify.go

Constants

const (
    // BindingExcludeLabel is a label that is placed on namespaces and
    // resources to exclude them from consideration when binding things.
    // It is critical that bindings dealing with Deployments label their
    // controller Deployment (or enclosing namespace). If you do not
    // specify this label, they are considered for binding (i.e. you opt-in
    // to getting everything considered for bindings). This is the default.
    BindingExcludeLabel = "bindings.knative.dev/exclude"

    // BindingIncludeLabel is a label that is placed on namespaces and
    // resources to include them in consideration when binding things.
    // This means that you have to explicitly label the namespaces/resources
    // for consideration for bindings.
    BindingIncludeLabel = "bindings.knative.dev/include"
)
const (
    GroupName = "duck.knative.dev"

    // AddressableDuckVersionLabel is the label we use to declare
    // that a type conforms to the Addressable duck type.
    AddressableDuckVersionLabel = "duck.knative.dev/addressable"

    // SourceDuckVersionLabel is the label we use to declare
    // that a type conforms to the Source duck type.
    SourceDuckVersionLabel = "duck.knative.dev/source"
)

func AsStructuredWatcher Uses

func AsStructuredWatcher(wf cache.WatchFunc, obj runtime.Object) cache.WatchFunc

AsStructuredWatcher is public for testing only. TODO(mattmoor): Move tests for this to `package duck` and make private.

func ConformsToType Uses

func ConformsToType(instance interface{}, iface Implementable) (bool, error)

ConformsToType will return true or false depending on whether a concrete resource properly implements the provided Implementable duck type.

It will return an error if marshal/unmarshalling fails

func CreateBytePatch Uses

func CreateBytePatch(before, after interface{}) ([]byte, error)

CreateBytePatch is a helper function that creates the same content as CreatePatch, but returns in []byte format instead of JSONPatch.

func CreateMergePatch Uses

func CreateMergePatch(before, after interface{}) ([]byte, error)

CreateMergePatch creates a json merge patch as specified in http://tools.ietf.org/html/draft-ietf-appsawg-json-merge-patch-07

func FromUnstructured Uses

func FromUnstructured(obj json.Marshaler, target interface{}) error

FromUnstructured takes unstructured object from (say from client-go/dynamic) and converts it into our duck types.

func NewProxyWatcher Uses

func NewProxyWatcher(ch chan watch.Event) watch.Interface

NewProxyWatcher creates new proxyWatcher by wrapping a channel

func ToUnstructured Uses

func ToUnstructured(desired OneOfOurs) (*unstructured.Unstructured, error)

ToUnstructured takes an instance of a OneOfOurs compatible type and converts it to unstructured.Unstructured. We take OneOfOurs in place or runtime.Object because sometimes we get resources that do not have their TypeMeta populated but that is required for unstructured.Unstructured to deserialize things, so we leverage our content-agnostic GroupVersionKind() method to populate this as-needed (in a copy, so that we don't modify the informer's copy, if that is what we are passed).

func VerifyType Uses

func VerifyType(instance interface{}, iface Implementable) error

VerifyType verifies that a particular concrete resource properly implements the provided Implementable duck type. It is expected that under the resource definition implementing a particular "Fooable" that one would write:

type ConcreteResource struct { ... }

// Check that ConcreteResource properly implement Fooable.
err := duck.VerifyType(&ConcreteResource{}, &something.Fooable{})

This will return an error if the duck typing is not satisfied.

type Bindable Uses

type Bindable interface {
    OneOfOurs

    // GetSubject returns the standard Binding duck's "Subject" field.
    GetSubject() tracker.Reference

    // GetBindingStatus returns the status of the Binding, which must
    // implement BindableStatus.
    GetBindingStatus() BindableStatus
}

Bindable may be implemented by Binding resources to use shared libraries.

type BindableStatus Uses

type BindableStatus interface {
    // InitializeConditions seeds the resource's status.conditions field
    // with all of the conditions that this Binding surfaces.
    InitializeConditions()

    // MarkBindingAvailable notes that this Binding has been properly
    // configured.
    MarkBindingAvailable()

    // MarkBindingUnavailable notes the provided reason for why the Binding
    // has failed.
    MarkBindingUnavailable(reason string, message string)

    // SetObservedGeneration updates the .status.observedGeneration to the
    // provided generation value.
    SetObservedGeneration(int64)
}

BindableStatus is the interface that the .status of Bindable resources must implement to work smoothly with our BaseReconciler.

type CachedInformerFactory Uses

type CachedInformerFactory struct {
    Delegate InformerFactory
    // contains filtered or unexported fields
}

CachedInformerFactory implements InformerFactory by delegating to another InformerFactory, but memoizing the results.

func (*CachedInformerFactory) Get Uses

func (cif *CachedInformerFactory) Get(gvr schema.GroupVersionResource) (cache.SharedIndexInformer, cache.GenericLister, error)

Get implements InformerFactory.

type EnqueueInformerFactory Uses

type EnqueueInformerFactory struct {
    Delegate InformerFactory

    EventHandler cache.ResourceEventHandler
}

EnqueueInformerFactory implements InformerFactory by delegating to another InformerFactory, but attaching a ResourceEventHandler to the informer.

func (*EnqueueInformerFactory) Get Uses

func (cif *EnqueueInformerFactory) Get(gvr schema.GroupVersionResource) (cache.SharedIndexInformer, cache.GenericLister, error)

Get implements InformerFactory.

type Implementable Uses

type Implementable interface {
    // GetFullType returns an instance of a full resource wrapping
    // an instance of this Implementable that can populate its fields
    // to verify json roundtripping.
    GetFullType() Populatable
}

Implementable is implemented by the Fooable duck type that consumers are expected to embed as a `.status.fooable` field.

type InformerFactory Uses

type InformerFactory interface {
    // Get returns a synced Informer/Lister pair for the provided schema.GroupVersionResource.
    Get(schema.GroupVersionResource) (cache.SharedIndexInformer, cache.GenericLister, error)
}

InformerFactory is used to create Informer/Lister pairs for a schema.GroupVersionResource

type JSONPatch Uses

type JSONPatch []jsonpatch.JsonPatchOperation

func CreatePatch Uses

func CreatePatch(before, after interface{}) (JSONPatch, error)

CreatePatch creates a patch as specified in http://jsonpatch.com/

func (JSONPatch) MarshalJSON Uses

func (p JSONPatch) MarshalJSON() ([]byte, error)

type OneOfOurs Uses

type OneOfOurs interface {
    kmeta.Accessor
    kmeta.OwnerRefable
}

OneOfOurs is the union of our Accessor interface and the OwnerRefable interface that is implemented by our resources that implement the kmeta.Accessor.

type Populatable Uses

type Populatable interface {
    apis.Listable

    // Populate fills in all possible fields, so that we can verify that
    // they roundtrip properly through JSON.
    Populate()
}

Populatable is implemented by a skeleton resource wrapping an Implementable duck type. It will generally have TypeMeta, ObjectMeta, and a Status field wrapping a Fooable field.

type TypedInformerFactory Uses

type TypedInformerFactory struct {
    Client       dynamic.Interface
    Type         apis.Listable
    ResyncPeriod time.Duration
    StopChannel  <-chan struct{}
}

TypedInformerFactory implements InformerFactory such that the elements tracked by the informer/lister have the type of the canonical "obj".

func (*TypedInformerFactory) Get Uses

func (dif *TypedInformerFactory) Get(gvr schema.GroupVersionResource) (cache.SharedIndexInformer, cache.GenericLister, error)

Get implements InformerFactory.

Directories

PathSynopsis
v1
v1alpha1
v1beta1

Package duck imports 18 packages (graph) and is imported by 1 packages. Updated 2020-07-09. Refresh now. Tools for package owners.