v1alpha1

package
v0.18.8 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2020 License: Apache-2.0 Imports: 18 Imported by: 19

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package +groupName=messaging.knative.dev

Index

Constants

View Source 
const (
	// KafkaChannelConditionReady has status True when all subconditions below have been set to True.
	KafkaChannelConditionReady = apis.ConditionReady

	// KafkaChannelConditionDispatcherReady has status True when a Dispatcher deployment is ready
	// Keyed off appsv1.DeploymentAvailable, which means minimum available replicas required are up
	// and running for at least minReadySeconds.
	KafkaChannelConditionDispatcherReady apis.ConditionType = "DispatcherReady"

	// KafkaChannelConditionServiceReady has status True when a k8s Service is ready. This
	// basically just means it exists because there's no meaningful status in Service. See Endpoints
	// below.
	KafkaChannelConditionServiceReady apis.ConditionType = "ServiceReady"

	// KafkaChannelConditionEndpointsReady has status True when a k8s Service Endpoints are backed
	// by at least one endpoint.
	KafkaChannelConditionEndpointsReady apis.ConditionType = "EndpointsReady"

	// KafkaChannelConditionAddressable has status true when this KafkaChannel meets
	// the Addressable contract and has a non-empty hostname.
	KafkaChannelConditionAddressable apis.ConditionType = "Addressable"

	// KafkaChannelConditionServiceReady has status True when a k8s Service representing the channel is ready.
	// Because this uses ExternalName, there are no endpoints to check.
	KafkaChannelConditionChannelServiceReady apis.ConditionType = "ChannelServiceReady"

	// KafkaChannelConditionTopicReady has status True when the Kafka topic to use by the channel exists.
	KafkaChannelConditionTopicReady apis.ConditionType = "TopicReady"

	// KafkaChannelConditionConfigReady has status True when the Kafka configuration to use by the channel exists and is valid
	// (ie. the connection has been established).
	KafkaChannelConditionConfigReady apis.ConditionType = "ConfigurationReady"
)

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: messaging.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

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

Types

type KafkaChannel 

type KafkaChannel struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the desired state of the Channel.
	Spec KafkaChannelSpec `json:"spec,omitempty"`

	// Status represents the current state of the KafkaChannel. This data may be out of
	// date.
	// +optional
	Status KafkaChannelStatus `json:"status,omitempty"`
}

KafkaChannel is a resource representing a Kafka Channel.

func (*KafkaChannel) ConvertFrom added in v0.16.0 

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

ConvertFrom implements apis.Convertible. Converts obj from v1beta1.KafkaChannel into v1alpha1.KafkaChannel

func (*KafkaChannel) ConvertTo added in v0.16.0 

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

ConvertTo implements apis.Convertible. Converts channel (from v1alpha1.KafkaChannel) into v1beta1.KafkaChannel

func (*KafkaChannel) DeepCopy 

func (in *KafkaChannel) DeepCopy() *KafkaChannel

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

func (*KafkaChannel) DeepCopyInto 

func (in *KafkaChannel) DeepCopyInto(out *KafkaChannel)

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

func (*KafkaChannel) DeepCopyObject 

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

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

func (*KafkaChannel) GetConditionSet added in v0.16.0 

func (*KafkaChannel) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*KafkaChannel) GetGroupVersionKind 

func (c *KafkaChannel) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns GroupVersionKind for KafkaChannels

func (*KafkaChannel) GetStatus added in v0.16.0 

func (k *KafkaChannel) GetStatus() *duckv1.Status

GetStatus retrieves the duck status for this resource. Implements the KRShaped interface.

func (*KafkaChannel) SetDefaults 

func (c *KafkaChannel) SetDefaults(ctx context.Context)

func (*KafkaChannel) Validate 

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

type KafkaChannelList 

type KafkaChannelList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []KafkaChannel `json:"items"`
}

KafkaChannelList is a collection of KafkaChannels.

func (*KafkaChannelList) DeepCopy 

func (in *KafkaChannelList) DeepCopy() *KafkaChannelList

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

func (*KafkaChannelList) DeepCopyInto 

func (in *KafkaChannelList) DeepCopyInto(out *KafkaChannelList)

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

func (*KafkaChannelList) DeepCopyObject 

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

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

type KafkaChannelSpec 

type KafkaChannelSpec struct {
	// NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.
	NumPartitions int32 `json:"numPartitions"`

	// ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.
	ReplicationFactor int16 `json:"replicationFactor"`

	// KafkaChannel conforms to Duck type Subscribable.
	Subscribable *eventingduck.Subscribable `json:"subscribable,omitempty"`
}

KafkaChannelSpec defines the specification for a KafkaChannel.

func (*KafkaChannelSpec) DeepCopy 

func (in *KafkaChannelSpec) DeepCopy() *KafkaChannelSpec

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

func (*KafkaChannelSpec) DeepCopyInto 

func (in *KafkaChannelSpec) DeepCopyInto(out *KafkaChannelSpec)

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

func (*KafkaChannelSpec) SetDefaults 

func (cs *KafkaChannelSpec) SetDefaults(ctx context.Context)

func (*KafkaChannelSpec) Validate 

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

type KafkaChannelStatus 

type KafkaChannelStatus struct {
	// inherits duck/v1 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.
	duckv1.Status `json:",inline"`

	// KafkaChannel is Addressable. It currently exposes the endpoint as a
	// fully-qualified DNS name which will distribute traffic over the
	// provided targets from inside the cluster.
	//
	// It generally has the form {channel}.{namespace}.svc.{cluster domain name}
	duckv1alpha1.AddressStatus `json:",inline"`

	// Subscribers is populated with the statuses of each of the Channelable's subscribers.
	eventingduck.SubscribableTypeStatus `json:",inline"`
}

KafkaChannelStatus represents the current state of a KafkaChannel.

func (*KafkaChannelStatus) DeepCopy 

func (in *KafkaChannelStatus) DeepCopy() *KafkaChannelStatus

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

func (*KafkaChannelStatus) DeepCopyInto 

func (in *KafkaChannelStatus) DeepCopyInto(out *KafkaChannelStatus)

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

func (*KafkaChannelStatus) GetCondition 

func (cs *KafkaChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition

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

func (*KafkaChannelStatus) InitializeConditions 

func (cs *KafkaChannelStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*KafkaChannelStatus) IsReady 

func (cs *KafkaChannelStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*KafkaChannelStatus) MarkChannelServiceFailed 

func (cs *KafkaChannelStatus) MarkChannelServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkChannelServiceTrue 

func (cs *KafkaChannelStatus) MarkChannelServiceTrue()

func (*KafkaChannelStatus) MarkConfigFailed added in v0.13.0 

func (cs *KafkaChannelStatus) MarkConfigFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkConfigTrue added in v0.13.0 

func (cs *KafkaChannelStatus) MarkConfigTrue()

func (*KafkaChannelStatus) MarkDispatcherFailed 

func (cs *KafkaChannelStatus) MarkDispatcherFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkDispatcherUnknown added in v0.13.0 

func (cs *KafkaChannelStatus) MarkDispatcherUnknown(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkEndpointsFailed 

func (cs *KafkaChannelStatus) MarkEndpointsFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkEndpointsTrue 

func (cs *KafkaChannelStatus) MarkEndpointsTrue()

func (*KafkaChannelStatus) MarkServiceFailed 

func (cs *KafkaChannelStatus) MarkServiceFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkServiceTrue 

func (cs *KafkaChannelStatus) MarkServiceTrue()

func (*KafkaChannelStatus) MarkServiceUnknown added in v0.13.0 

func (cs *KafkaChannelStatus) MarkServiceUnknown(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkTopicFailed 

func (cs *KafkaChannelStatus) MarkTopicFailed(reason, messageFormat string, messageA ...interface{})

func (*KafkaChannelStatus) MarkTopicTrue 

func (cs *KafkaChannelStatus) MarkTopicTrue()

func (*KafkaChannelStatus) PropagateDispatcherStatus 

func (cs *KafkaChannelStatus) PropagateDispatcherStatus(ds *appsv1.DeploymentStatus)

TODO: Unify this with the ones from Eventing. Say: Broker, Trigger.

func (*KafkaChannelStatus) SetAddress 

func (cs *KafkaChannelStatus) SetAddress(url *apis.URL)

SetAddress sets the address (as part of Addressable contract) and marks the correct condition.

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.