binding

Documentation

Index

• Constants
• Variables
• func IsErrEmptyAnnotationName(err error) bool
• func IsErrHandlerNotFound(err error) bool
• func IsErrInvalidAnnotationPrefix(err error) bool
• func IsServiceBindingAnnotation(annotationKey string) (bool, error)
• func NewDefinitionBuilder(annotationName string, annotationValue string, ...) *annotationBackedDefinitionBuilder
• type BindingType
• type Definition
• type DefinitionBuilder
• type ErrEmptyAnnotationName
  • func (e ErrEmptyAnnotationName) Error() string
• type ErrInvalidAnnotationPrefix
  • func (e ErrInvalidAnnotationPrefix) Error() string
• type SpecHandler
  • func NewSpecHandler(kubeClient dynamic.Interface, annotationKey string, annotationValue string, ...) (*SpecHandler, error)
  • func (s *SpecHandler) Handle() (result, error)
• type UnstructuredResourceReader
• type Value

Constants

const (
	AnnotationPrefix                = "service.binding"
	ProvisionedServiceAnnotationKey = "servicebinding.io/provisioned-service"
	TypeKey                         = AnnotationPrefix + "/type"
)

Variables

var ErrInvalidAnnotationName = errors.New("invalid annotation name")

Functions

func IsErrEmptyAnnotationName

func IsErrEmptyAnnotationName(err error) bool

func IsErrHandlerNotFound

func IsErrHandlerNotFound(err error) bool

func IsErrInvalidAnnotationPrefix

func IsErrInvalidAnnotationPrefix(err error) bool

func IsServiceBindingAnnotation

func IsServiceBindingAnnotation(annotationKey string) (bool, error)

func NewDefinitionBuilder

func NewDefinitionBuilder(annotationName string, annotationValue string, configMapReader UnstructuredResourceReader, secretReader UnstructuredResourceReader) *annotationBackedDefinitionBuilder

Types

type BindingType

type BindingType string

bindingType encodes the medium the binding should deliver the configuration value.

const (
	// TypeVolumeMount indicates the binding should happen through a volume mount.
	TypeVolumeMount BindingType = "volumemount"
	// TypeEnvVar indicates the binding should happen through environment variables.
	TypeEnvVar BindingType = "env"
)

type Definition

type Definition interface {
	Apply(u *unstructured.Unstructured) (Value, error)
	GetPath() string
	NonExistingOptional(Value) bool
}

type DefinitionBuilder

type DefinitionBuilder interface {
	Build() (Definition, error)
}

type ErrEmptyAnnotationName

type ErrEmptyAnnotationName string

func (ErrEmptyAnnotationName) Error

func (e ErrEmptyAnnotationName) Error() string

type ErrInvalidAnnotationPrefix

type ErrInvalidAnnotationPrefix string

func (ErrInvalidAnnotationPrefix) Error

func (e ErrInvalidAnnotationPrefix) Error() string

type SpecHandler

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

func NewSpecHandler

func NewSpecHandler(
	kubeClient dynamic.Interface,
	annotationKey string,
	annotationValue string,
	obj unstructured.Unstructured,
) (*SpecHandler, error)

func (*SpecHandler) Handle

func (s *SpecHandler) Handle() (result, error)

type UnstructuredResourceReader

type UnstructuredResourceReader func(namespace string, name string) (*unstructured.Unstructured, error)

type Value

type Value interface {
	Get() interface{}
}