resource

Documentation

Index

• func ToClientKey(res ezkube.ResourceId) client.ObjectKey
• type Client
• type ClusterSnapshot
  • func (cs ClusterSnapshot) Clone(selectors ...GVKSelectorFunc) ClusterSnapshot
  • func (cs ClusterSnapshot) Delete(cluster string, gvk schema.GroupVersionKind, id types.NamespacedName)
  • func (s ClusterSnapshot) ForEachObject(...)
  • func (cs ClusterSnapshot) Insert(cluster string, gvk schema.GroupVersionKind, obj TypedObject)
  • func (cs ClusterSnapshot) Merge(toMerge ClusterSnapshot) ClusterSnapshot
• type GVKSelectorFunc
• type Snapshot
  • func (s Snapshot) Clone(selectors ...GVKSelectorFunc) Snapshot
  • func (s Snapshot) Delete(gvk schema.GroupVersionKind, id types.NamespacedName)
  • func (s Snapshot) ForEachObject(handleObject func(gvk schema.GroupVersionKind, obj TypedObject))
  • func (s Snapshot) Insert(gvk schema.GroupVersionKind, obj TypedObject)
  • func (s Snapshot) Merge(toMerge Snapshot) Snapshot
• type TypedObject

Functions

func ToClientKey

func ToClientKey(res ezkube.ResourceId) client.ObjectKey

Types

type Client

type Client interface {
	client.Client
}

right now this just allows us to generate mocks for the client. (ilackarms): eventually it might make sense to put clients for non-kube backends in this package

type ClusterSnapshot

type ClusterSnapshot map[string]Snapshot

ClusterSnapshot represents a set of snapshots partitioned by cluster

func (ClusterSnapshot) Clone

func (cs ClusterSnapshot) Clone(selectors ...GVKSelectorFunc) ClusterSnapshot

func (ClusterSnapshot) Delete

func (cs ClusterSnapshot) Delete(
	cluster string,
	gvk schema.GroupVersionKind,
	id types.NamespacedName,
)

func (ClusterSnapshot) ForEachObject

func (s ClusterSnapshot) ForEachObject(
	handleObject func(
		cluster string,
		gvk schema.GroupVersionKind,
		obj TypedObject,
	),
)

func (ClusterSnapshot) Insert

func (cs ClusterSnapshot) Insert(cluster string, gvk schema.GroupVersionKind, obj TypedObject)

func (ClusterSnapshot) Merge

func (cs ClusterSnapshot) Merge(toMerge ClusterSnapshot) ClusterSnapshot

Merges the ClusterSnapshot with a ClusterSnapshot passed in as an argument. If a cluster exists in both ClusterSnapshots, then both Snapshots for the cluster is merged; with the passed in ClusterSnapshot's corresponding Snapshot taking precedence in case of conflicts.

type GVKSelectorFunc

type GVKSelectorFunc = func(GVK schema.GroupVersionKind) bool

type Snapshot

type Snapshot map[schema.GroupVersionKind]map[types.NamespacedName]TypedObject

Snapshot represents a generic snapshot of client.Objects scoped to a single cluster

func (Snapshot) Clone

func (s Snapshot) Clone(selectors ...GVKSelectorFunc) Snapshot

func (Snapshot) Delete

func (s Snapshot) Delete(gvk schema.GroupVersionKind, id types.NamespacedName)

func (Snapshot) ForEachObject

func (s Snapshot) ForEachObject(handleObject func(gvk schema.GroupVersionKind, obj TypedObject))

func (Snapshot) Insert

func (s Snapshot) Insert(gvk schema.GroupVersionKind, obj TypedObject)

func (Snapshot) Merge

func (s Snapshot) Merge(toMerge Snapshot) Snapshot

Merges the Snapshot with a Snapshot passed in as an argument. The values in the passed in Snapshot will take precedence when there is an object mapped to the same gvk and name in both Snapshots.

type TypedObject

type TypedObject interface {
	client.Object
	SetGroupVersionKind(gvk schema.GroupVersionKind)
}

a typed object is a client.Object with a TypeMeta