reference

Documentation

Overview

Package reference provides a way to reference Kubernetes resources.

Index

• type LocalConfigMapReference
  • func (in *LocalConfigMapReference) DeepCopy() *LocalConfigMapReference
  • func (in *LocalConfigMapReference) DeepCopyInto(out *LocalConfigMapReference)
  • func (ref *LocalConfigMapReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, ...) (runtime.Object, bool, error)
• type LocalKeyedSecretReference
  • func (in *LocalKeyedSecretReference) DeepCopy() *LocalKeyedSecretReference
  • func (in *LocalKeyedSecretReference) DeepCopyInto(out *LocalKeyedSecretReference)
• type LocalObjectReference
  • func (in *LocalObjectReference) DeepCopy() *LocalObjectReference
  • func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)
  • func (ref *LocalObjectReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, ...) (runtime.Object, bool, error)
• type LocalSecretReference
  • func (in *LocalSecretReference) DeepCopy() *LocalSecretReference
  • func (in *LocalSecretReference) DeepCopyInto(out *LocalSecretReference)
  • func (ref *LocalSecretReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, ...) (runtime.Object, bool, error)
• type ObjectReference
  • func (in *ObjectReference) DeepCopy() *ObjectReference
  • func (in *ObjectReference) DeepCopyInto(out *ObjectReference)
  • func (ref *ObjectReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, ...) (runtime.Object, bool, error)
• type ObjectWithReferences
• type Reference

Types

type LocalConfigMapReference

type LocalConfigMapReference struct {
	// Name is the name of the config map.
	Name string `json:"name"`
}

LocalConfigMapReference is a reference to a config map in the same namespace. +kubebuilder:object:generate=true

func (*LocalConfigMapReference) DeepCopy

func (in *LocalConfigMapReference) DeepCopy() *LocalConfigMapReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalConfigMapReference.

func (*LocalConfigMapReference) DeepCopyInto

func (in *LocalConfigMapReference) DeepCopyInto(out *LocalConfigMapReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LocalConfigMapReference) Resolve

func (ref *LocalConfigMapReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, parent runtime.Object) (runtime.Object, bool, error)

Resolve resolves the reference to its underlying config map.

type LocalKeyedSecretReference

type LocalKeyedSecretReference struct {
	*LocalSecretReference `json:",inline"`
	// Key is the key of the value in the secret.
	Key string `json:"key"`
}

LocalKeyedSecretReference is a reference to a secret in the same namespace containing a single keyed value. +kubebuilder:object:generate=true

func (*LocalKeyedSecretReference) DeepCopy

func (in *LocalKeyedSecretReference) DeepCopy() *LocalKeyedSecretReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalKeyedSecretReference.

func (*LocalKeyedSecretReference) DeepCopyInto

func (in *LocalKeyedSecretReference) DeepCopyInto(out *LocalKeyedSecretReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalObjectReference

type LocalObjectReference struct {
	// Name is the name of the resource.
	Name string `json:"name,omitempty"`
	// APIVersion is the API version of the resource.
	APIVersion string `json:"apiVersion,omitempty"`
	// Kind is the kind of the resource.
	Kind string `json:"kind,omitempty"`
}

LocalObjectReference is a reference to a resource in the same namespace. +kubebuilder:object:generate=true

func (*LocalObjectReference) DeepCopy

func (in *LocalObjectReference) DeepCopy() *LocalObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalObjectReference.

func (*LocalObjectReference) DeepCopyInto

func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LocalObjectReference) Resolve

func (ref *LocalObjectReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, parent runtime.Object) (runtime.Object, bool, error)

Resolve resolves the reference to its underlying resource.

type LocalSecretReference

type LocalSecretReference struct {
	// Name is the name of the secret.
	Name string `json:"name"`
}

LocalSecretReference is a reference to a secret in the same namespace. +kubebuilder:object:generate=true

func (*LocalSecretReference) DeepCopy

func (in *LocalSecretReference) DeepCopy() *LocalSecretReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalSecretReference.

func (*LocalSecretReference) DeepCopyInto

func (in *LocalSecretReference) DeepCopyInto(out *LocalSecretReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LocalSecretReference) Resolve

func (ref *LocalSecretReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, parent runtime.Object) (runtime.Object, bool, error)

Resolve resolves the reference to its underlying secret.

type ObjectReference

type ObjectReference struct {
	// Name is the name of the resource.
	Name string `json:"name,omitempty"`
	// Namespace is the namespace of the resource.
	Namespace string `json:"namespace,omitempty"`
	// APIVersion is the API version of the resource.
	APIVersion string `json:"apiVersion,omitempty"`
	// Kind is the kind of the resource.
	Kind string `json:"kind,omitempty"`
}

ObjectReference is a reference to an arbitrary Kubernetes resource. +kubebuilder:object:generate=true

func (*ObjectReference) DeepCopy

func (in *ObjectReference) DeepCopy() *ObjectReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.

func (*ObjectReference) DeepCopyInto

func (in *ObjectReference) DeepCopyInto(out *ObjectReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ObjectReference) Resolve

func (ref *ObjectReference) Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, parent runtime.Object) (runtime.Object, bool, error)

Resolve resolves the reference to its underlying resource.

type ObjectWithReferences

type ObjectWithReferences interface {
	// ResolveReferences resolves all references in the object.
	ResolveReferences(ctx context.Context, reader client.Reader, scheme *runtime.Scheme) (bool, error)
}

type Reference

type Reference interface {
	// Resolve resolves the reference to its underlying resource.
	Resolve(ctx context.Context, reader client.Reader, scheme *runtime.Scheme, parent runtime.Object) (obj runtime.Object, ok bool, err error)
}