v1alpha1

package
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2020 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:deepcopy-gen=package +groupName=sources.knative.dev

Index

Constants

View Source 
const (
	// ApiServerConditionReady has status True when the ApiServerSource is ready to send events.
	ApiServerConditionReady = apis.ConditionReady

	// ApiServerConditionSinkProvided has status True when the ApiServerSource has been configured with a sink target.
	ApiServerConditionSinkProvided apis.ConditionType = "SinkProvided"

	// ApiServerConditionDeployed has status True when the ApiServerSource has had it's deployment created.
	ApiServerConditionDeployed apis.ConditionType = "Deployed"

	// ApiServerConditionSufficientPermissions has status True when the ApiServerSource has sufficient permissions to access resources.
	ApiServerConditionSufficientPermissions apis.ConditionType = "SufficientPermissions"
)
View Source 
const (
	// ApiServerSourceAddEventType is the ApiServerSource CloudEvent type for adds.
	ApiServerSourceAddEventType = "dev.knative.apiserver.resource.add"
	// ApiServerSourceUpdateEventType is the ApiServerSource CloudEvent type for updates.
	ApiServerSourceUpdateEventType = "dev.knative.apiserver.resource.update"
	// ApiServerSourceDeleteEventType is the ApiServerSource CloudEvent type for deletions.
	ApiServerSourceDeleteEventType = "dev.knative.apiserver.resource.delete"

	// ApiServerSourceAddRefEventType is the ApiServerSource CloudEvent type for ref adds.
	ApiServerSourceAddRefEventType = "dev.knative.apiserver.ref.add"
	// ApiServerSourceUpdateRefEventType is the ApiServerSource CloudEvent type for ref updates.
	ApiServerSourceUpdateRefEventType = "dev.knative.apiserver.ref.update"
	// ApiServerSourceDeleteRefEventType is the ApiServerSource CloudEvent type for ref deletions.
	ApiServerSourceDeleteRefEventType = "dev.knative.apiserver.ref.delete"
)
View Source 
const (
	// RefMode produces payloads of ObjectReference
	RefMode = "Ref"
	// ResourceMode produces payloads of ResourceEvent
	ResourceMode = "Resource"
)
View Source 
const (
	// SinkBindingConditionReady is configured to indicate whether the Binding
	// has been configured for resources subject to its runtime contract.
	SinkBindingConditionReady = apis.ConditionReady
)

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var ApiServerSourceEventTypes = []string{
	ApiServerSourceAddEventType,
	ApiServerSourceDeleteEventType,
	ApiServerSourceUpdateEventType,
	ApiServerSourceAddRefEventType,
	ApiServerSourceDeleteRefEventType,
	ApiServerSourceUpdateRefEventType,
}

ApiServerSourceEventTypes is the list of CloudEvent types the ApiServerSource emits.

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: sources.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func GetSinkURI added in v0.11.0 

func GetSinkURI(ctx context.Context) *apis.URL

GetSinkURI accesses the apis.URL for the Sink URI that has been associated with this context.

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func WithSinkURI added in v0.11.0 

func WithSinkURI(ctx context.Context, uri *apis.URL) context.Context

WithSinkURI notes on the context for binding that the resolved SinkURI is the provided apis.URL.

Types

type ApiServerResource 

type ApiServerResource struct {
	// API version of the resource to watch.
	APIVersion string `json:"apiVersion"`

	// Kind of the resource to watch.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind"`

	// LabelSelector restricts this source to objects with the selected labels
	// More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	LabelSelector metav1.LabelSelector `json:"labelSelector"`

	// ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind.
	// Only apiVersion and kind are used. Both are optional.
	// Deprecated: Per-resource owner refs will no longer be supported in
	// v1alpha2, please use Spec.Owner as a GKV.
	ControllerSelector metav1.OwnerReference `json:"controllerSelector"`

	// If true, send an event referencing the object controlling the resource
	// Deprecated: Per-resource controller flag will no longer be supported in
	// v1alpha2, please use Spec.Owner as a GKV.
	Controller bool `json:"controller"`
}

ApiServerResource defines the resource to watch

func (*ApiServerResource) DeepCopy 

func (in *ApiServerResource) DeepCopy() *ApiServerResource

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

func (*ApiServerResource) DeepCopyInto 

func (in *ApiServerResource) DeepCopyInto(out *ApiServerResource)

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

type ApiServerSource 

type ApiServerSource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ApiServerSourceSpec   `json:"spec,omitempty"`
	Status ApiServerSourceStatus `json:"status,omitempty"`
}

ApiServerSource is the Schema for the apiserversources API

func (*ApiServerSource) ConvertFrom added in v0.13.0 

func (sink *ApiServerSource) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible. Converts obj from a higher version into v1alpha1.ApiServerSource.

func (*ApiServerSource) ConvertTo added in v0.13.0 

func (source *ApiServerSource) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible. Converts source (from v1alpha1.ApiServerSource) into into a higher version.

func (*ApiServerSource) DeepCopy 

func (in *ApiServerSource) DeepCopy() *ApiServerSource

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

func (*ApiServerSource) DeepCopyInto 

func (in *ApiServerSource) DeepCopyInto(out *ApiServerSource)

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

func (*ApiServerSource) DeepCopyObject 

func (in *ApiServerSource) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ApiServerSource) GetGroupVersionKind 

func (s *ApiServerSource) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*ApiServerSource) GetUntypedSpec added in v0.10.0 

func (s *ApiServerSource) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the ApiServerSource.

func (*ApiServerSource) SetDefaults added in v0.10.0 

func (s *ApiServerSource) SetDefaults(ctx context.Context)

func (*ApiServerSource) Validate added in v0.10.0 

func (c *ApiServerSource) Validate(ctx context.Context) *apis.FieldError

type ApiServerSourceList 

type ApiServerSourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ApiServerSource `json:"items"`
}

ApiServerSourceList contains a list of ApiServerSource

func (*ApiServerSourceList) DeepCopy 

func (in *ApiServerSourceList) DeepCopy() *ApiServerSourceList

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

func (*ApiServerSourceList) DeepCopyInto 

func (in *ApiServerSourceList) DeepCopyInto(out *ApiServerSourceList)

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

func (*ApiServerSourceList) DeepCopyObject 

func (in *ApiServerSourceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ApiServerSourceSpec 

type ApiServerSourceSpec struct {
	// Resources is the list of resources to watch
	Resources []ApiServerResource `json:"resources"`

	// ServiceAccountName is the name of the ServiceAccount to use to run this
	// source.
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// Sink is a reference to an object that will resolve to a domain name to use as the sink.
	// +optional
	Sink *duckv1beta1.Destination `json:"sink,omitempty"`

	// CloudEventOverrides defines overrides to control the output format and
	// modifications of the event sent to the sink.
	// +optional
	CloudEventOverrides *duckv1.CloudEventOverrides `json:"ceOverrides,omitempty"`

	// ResourceOwner is an additional filter to only track resources that are
	// owned by a specific resource type. If ResourceOwner matches Resources[n]
	// then Resources[n] is allowed to pass the ResourceOwner filter.
	// +optional
	ResourceOwner *v1alpha2.APIVersionKind `json:"owner,omitempty"`

	// Mode is the mode the receive adapter controller runs under: Ref or Resource.
	// `Ref` sends only the reference to the resource.
	// `Resource` send the full resource.
	Mode string `json:"mode,omitempty"`
}

ApiServerSourceSpec defines the desired state of ApiServerSource

func (*ApiServerSourceSpec) DeepCopy 

func (in *ApiServerSourceSpec) DeepCopy() *ApiServerSourceSpec

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

func (*ApiServerSourceSpec) DeepCopyInto 

func (in *ApiServerSourceSpec) DeepCopyInto(out *ApiServerSourceSpec)

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

func (*ApiServerSourceSpec) SetDefaults added in v0.10.0 

func (ss *ApiServerSourceSpec) SetDefaults(ctx context.Context)

func (*ApiServerSourceSpec) Validate added in v0.10.0 

func (cs *ApiServerSourceSpec) Validate(ctx context.Context) *apis.FieldError

type ApiServerSourceStatus 

type ApiServerSourceStatus struct {
	// inherits duck/v1 SourceStatus, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last
	//   processed by the controller.
	// * Conditions - the latest available observations of a resource's current
	//   state.
	// * SinkURI - the current active sink URI that has been configured for the
	//   Source.
	duckv1.SourceStatus `json:",inline"`
}

ApiServerSourceStatus defines the observed state of ApiServerSource

func (*ApiServerSourceStatus) DeepCopy 

func (in *ApiServerSourceStatus) DeepCopy() *ApiServerSourceStatus

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

func (*ApiServerSourceStatus) DeepCopyInto 

func (in *ApiServerSourceStatus) DeepCopyInto(out *ApiServerSourceStatus)

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

func (*ApiServerSourceStatus) GetCondition 

func (s *ApiServerSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the condition currently associated with the given type, or nil.

func (*ApiServerSourceStatus) GetTopLevelCondition added in v0.16.0 

func (s *ApiServerSourceStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level condition.

func (*ApiServerSourceStatus) InitializeConditions 

func (s *ApiServerSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*ApiServerSourceStatus) IsReady 

func (s *ApiServerSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*ApiServerSourceStatus) MarkNoSink 

func (s *ApiServerSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})

MarkNoSink sets the condition that the source does not have a sink configured.

func (*ApiServerSourceStatus) MarkNoSufficientPermissions added in v0.11.0 

func (s *ApiServerSourceStatus) MarkNoSufficientPermissions(reason, messageFormat string, messageA ...interface{})

MarkNoSufficientPermissions sets the condition that the source does not have enough permissions to access the resources

func (*ApiServerSourceStatus) MarkSink 

func (s *ApiServerSourceStatus) MarkSink(uri string)

MarkSink sets the condition that the source has a sink configured.

func (*ApiServerSourceStatus) MarkSinkWarnRefDeprecated added in v0.10.0 

func (s *ApiServerSourceStatus) MarkSinkWarnRefDeprecated(uri string)

MarkSinkWarnDeprecated sets the condition that the source has a sink configured and warns ref is deprecated.

func (*ApiServerSourceStatus) MarkSufficientPermissions added in v0.11.0 

func (s *ApiServerSourceStatus) MarkSufficientPermissions()

MarkSufficientPermissions sets the condition that the source has enough permissions to access the resources.

func (*ApiServerSourceStatus) PropagateDeploymentAvailability added in v0.8.0 

func (s *ApiServerSourceStatus) PropagateDeploymentAvailability(d *appsv1.Deployment)

PropagateDeploymentAvailability uses the availability of the provided Deployment to determine if ApiServerConditionDeployed should be marked as true or false.

type SinkBinding added in v0.11.0 

type SinkBinding struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SinkBindingSpec   `json:"spec"`
	Status SinkBindingStatus `json:"status"`
}

SinkBinding describes a Binding that is also a Source. The `sink` (from the Source duck) is resolved to a URL and then projected into the `subject` by augmenting the runtime contract of the referenced containers to have a `K_SINK` environment variable holding the endpoint to which to send cloud events.

func (*SinkBinding) ConvertFrom added in v0.13.0 

func (sink *SinkBinding) ConvertFrom(ctx context.Context, obj apis.Convertible) error

ConvertFrom implements apis.Convertible. Converts obj from a higher version into v1alpha1.SinkBinding.

func (*SinkBinding) ConvertTo added in v0.13.0 

func (source *SinkBinding) ConvertTo(ctx context.Context, obj apis.Convertible) error

ConvertTo implements apis.Convertible. Converts source from v1alpha1.SinkBinding into a higher version.

func (*SinkBinding) DeepCopy added in v0.11.0 

func (in *SinkBinding) DeepCopy() *SinkBinding

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

func (*SinkBinding) DeepCopyInto added in v0.11.0 

func (in *SinkBinding) DeepCopyInto(out *SinkBinding)

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

func (*SinkBinding) DeepCopyObject added in v0.11.0 

func (in *SinkBinding) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*SinkBinding) Do added in v0.11.0 

func (sb *SinkBinding) Do(ctx context.Context, ps *duckv1.WithPod)

Do implements psbinding.Bindable

func (*SinkBinding) GetBindingStatus added in v0.11.0 

func (sb *SinkBinding) GetBindingStatus() duck.BindableStatus

GetBindingStatus implements psbinding.Bindable

func (*SinkBinding) GetGroupVersionKind added in v0.11.0 

func (s *SinkBinding) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*SinkBinding) GetSubject added in v0.11.0 

func (sb *SinkBinding) GetSubject() tracker.Reference

GetSubject implements psbinding.Bindable

func (*SinkBinding) GetUntypedSpec added in v0.11.0 

func (s *SinkBinding) GetUntypedSpec() interface{}

GetUntypedSpec implements apis.HasSpec

func (*SinkBinding) SetDefaults added in v0.11.0 

func (fb *SinkBinding) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*SinkBinding) Undo added in v0.11.0 

func (sb *SinkBinding) Undo(ctx context.Context, ps *duckv1.WithPod)

func (*SinkBinding) Validate added in v0.11.0 

func (fb *SinkBinding) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type SinkBindingList added in v0.11.0 

type SinkBindingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []SinkBinding `json:"items"`
}

SinkBindingList contains a list of SinkBinding

func (*SinkBindingList) DeepCopy added in v0.11.0 

func (in *SinkBindingList) DeepCopy() *SinkBindingList

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

func (*SinkBindingList) DeepCopyInto added in v0.11.0 

func (in *SinkBindingList) DeepCopyInto(out *SinkBindingList)

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

func (*SinkBindingList) DeepCopyObject added in v0.11.0 

func (in *SinkBindingList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SinkBindingSpec added in v0.11.0 

type SinkBindingSpec struct {
	duckv1.SourceSpec        `json:",inline"`
	duckv1alpha1.BindingSpec `json:",inline"`
}

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

func (*SinkBindingSpec) DeepCopy added in v0.11.0 

func (in *SinkBindingSpec) DeepCopy() *SinkBindingSpec

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

func (*SinkBindingSpec) DeepCopyInto added in v0.11.0 

func (in *SinkBindingSpec) DeepCopyInto(out *SinkBindingSpec)

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

func (*SinkBindingSpec) Validate added in v0.11.0 

func (fbs *SinkBindingSpec) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type SinkBindingStatus added in v0.11.0 

type SinkBindingStatus struct {
	duckv1.SourceStatus `json:",inline"`
}

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

func (*SinkBindingStatus) DeepCopy added in v0.11.0 

func (in *SinkBindingStatus) DeepCopy() *SinkBindingStatus

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

func (*SinkBindingStatus) DeepCopyInto added in v0.11.0 

func (in *SinkBindingStatus) DeepCopyInto(out *SinkBindingStatus)

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

func (*SinkBindingStatus) InitializeConditions added in v0.11.0 

func (sbs *SinkBindingStatus) InitializeConditions()

InitializeConditions populates the SinkBindingStatus's conditions field with all of its conditions configured to Unknown.

func (*SinkBindingStatus) MarkBindingAvailable added in v0.11.0 

func (sbs *SinkBindingStatus) MarkBindingAvailable()

MarkBindingAvailable marks the SinkBinding's Ready condition to True.

func (*SinkBindingStatus) MarkBindingUnavailable added in v0.11.0 

func (sbs *SinkBindingStatus) MarkBindingUnavailable(reason, message string)

MarkBindingUnavailable marks the SinkBinding's Ready condition to False with the provided reason and message.

func (*SinkBindingStatus) SetObservedGeneration added in v0.11.0 

func (sbs *SinkBindingStatus) SetObservedGeneration(gen int64)

SetObservedGeneration implements psbinding.BindableStatus

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.