v1alpha1

package
v0.0.0-...-627e2d1 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/knative/eventing-sources/pkg/apis/sources +k8s:defaulter-gen=TypeMeta +groupName=sources.eventing.knative.dev

Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/knative/eventing-sources/pkg/apis/sources +k8s:defaulter-gen=TypeMeta +groupName=sources.eventing.knative.dev

Index

Constants

View Source 
const (
	// KinesisSourceConditionReady has status True when the source is
	// ready to send events.
	KinesisSourceConditionReady = duckv1alpha1.ConditionReady

	// KinesisSourceConditionSinkProvided has status True when the
	// KinesisSource has been configured with a sink target.
	KinesisSourceConditionSinkProvided duckv1alpha1.ConditionType = "SinkProvided"

	// KinesisSourceConditionDeployed has status True when the
	// KinesisSource has had it's receive adapter deployment created.
	KinesisSourceConditionDeployed duckv1alpha1.ConditionType = "Deployed"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "sources.eventing.knative.dev", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type KiamOptions 

type KiamOptions struct {
	// AssignedIAMRole is the IAM role that KIAM assigns to Receive Adapter,
	// It could be the IAM role ARN, or role name (if the role is in the same AWS account as k8s cluster nodes).
	AssignedIAMRole string `json:"assignedIamRole"`

	// KCLIAMRoleARN is the IAM role ARN,
	// this role needs to be configured to trust the AssignedIAMRole of Receive Adapter.
	KCLIAMRoleARN string `json:"kclIamRoleArn"`
}

KiamOptions defines the spec for KIAM configuration

func (*KiamOptions) DeepCopy 

func (in *KiamOptions) DeepCopy() *KiamOptions

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

func (*KiamOptions) DeepCopyInto 

func (in *KiamOptions) DeepCopyInto(out *KiamOptions)

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

type KinesisSource 

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

	Spec   KinesisSourceSpec   `json:"spec,omitempty"`
	Status KinesisSourceStatus `json:"status,omitempty"`
}

KinesisSource is the Schema for the AWS Kinesis API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:categories=all,knative,eventing,sources

func (*KinesisSource) DeepCopy 

func (in *KinesisSource) DeepCopy() *KinesisSource

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

func (*KinesisSource) DeepCopyInto 

func (in *KinesisSource) DeepCopyInto(out *KinesisSource)

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

func (*KinesisSource) DeepCopyObject 

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

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

type KinesisSourceList 

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

KinesisSourceList contains a list of KinesisSource

func (*KinesisSourceList) DeepCopy 

func (in *KinesisSourceList) DeepCopy() *KinesisSourceList

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

func (*KinesisSourceList) DeepCopyInto 

func (in *KinesisSourceList) DeepCopyInto(out *KinesisSourceList)

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

func (*KinesisSourceList) DeepCopyObject 

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

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

type KinesisSourceSpec 

type KinesisSourceSpec struct {
	// Steam name.
	StreamName string `json:"streamName"`

	// Region
	Region string `json:"region"`

	// AwsCredsSecret is the credential used to poll the Kinesis data
	AwsCredsSecret corev1.SecretKeySelector `json:"awsCredsSecret,omitempty"`

	// KIAMOptions is the KIAM config used to poll Kinesis data
	KIAMOptions KiamOptions `json:"kiamOptions,omitempty"`

	// Sink is a reference to an object that will resolve to a domain name to
	// use as the sink.  This is where events will be received.
	// +optional
	Sink *corev1.ObjectReference `json:"sink,omitempty"`

	// ServiceAccoutName is the name of the ServiceAccount that will be used to
	// run the Receive Adapter Deployment.
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

KinesisSourceSpec defines the desired state of the source.

func (*KinesisSourceSpec) DeepCopy 

func (in *KinesisSourceSpec) DeepCopy() *KinesisSourceSpec

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

func (*KinesisSourceSpec) DeepCopyInto 

func (in *KinesisSourceSpec) DeepCopyInto(out *KinesisSourceSpec)

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

type KinesisSourceStatus 

type KinesisSourceStatus struct {
	// inherits duck/v1alpha1 Status, 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.
	duckv1alpha1.Status `json:",inline"`

	// SinkURI is the current active sink URI that has been configured for the KinesisSource.
	// +optional
	SinkURI string `json:"sinkUri,omitempty"`
}

KinesisSourceStatus defines the observed state of the source.

func (*KinesisSourceStatus) DeepCopy 

func (in *KinesisSourceStatus) DeepCopy() *KinesisSourceStatus

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

func (*KinesisSourceStatus) DeepCopyInto 

func (in *KinesisSourceStatus) DeepCopyInto(out *KinesisSourceStatus)

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

func (*KinesisSourceStatus) GetCondition 

func (s *KinesisSourceStatus) GetCondition(t duckv1alpha1.ConditionType) *duckv1alpha1.Condition

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

func (*KinesisSourceStatus) InitializeConditions 

func (s *KinesisSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*KinesisSourceStatus) IsReady 

func (s *KinesisSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*KinesisSourceStatus) MarkDeployed 

func (s *KinesisSourceStatus) MarkDeployed()

MarkDeployed sets the condition that the source has been deployed.

func (*KinesisSourceStatus) MarkDeploying 

func (s *KinesisSourceStatus) MarkDeploying(reason, messageFormat string, messageA ...interface{})

MarkDeploying sets the condition that the source is deploying.

func (*KinesisSourceStatus) MarkNoSink 

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

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

func (*KinesisSourceStatus) MarkNotDeployed 

func (s *KinesisSourceStatus) MarkNotDeployed(reason, messageFormat string, messageA ...interface{})

MarkNotDeployed sets the condition that the source has not been deployed.

func (*KinesisSourceStatus) MarkSink 

func (s *KinesisSourceStatus) MarkSink(uri string)

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

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.