v1alpha1

Documentation

Overview

Package v1alpha1 contains the definition of custom API objects. +k8s:deepcopy-gen=package +groupName=sources.kyma-project.io

Index

• Constants
• Variables
• func HTTPSourceGVK() schema.GroupVersionKind
• func Resource(resource string) schema.GroupResource
• type HTTPSource
  • func (in *HTTPSource) DeepCopy() *HTTPSource
  • func (in *HTTPSource) DeepCopyInto(out *HTTPSource)
  • func (in *HTTPSource) DeepCopyObject() runtime.Object
  • func (s *HTTPSource) ToKey() string
  • func (s *HTTPSource) ToOwner() *metav1.OwnerReference
• type HTTPSourceList
  • func (in *HTTPSourceList) DeepCopy() *HTTPSourceList
  • func (in *HTTPSourceList) DeepCopyInto(out *HTTPSourceList)
  • func (in *HTTPSourceList) DeepCopyObject() runtime.Object
• type HTTPSourceSpec
  • func (in *HTTPSourceSpec) DeepCopy() *HTTPSourceSpec
  • func (in *HTTPSourceSpec) DeepCopyInto(out *HTTPSourceSpec)
• type HTTPSourceStatus
  • func (in *HTTPSourceStatus) DeepCopy() *HTTPSourceStatus
  • func (in *HTTPSourceStatus) DeepCopyInto(out *HTTPSourceStatus)
  • func (s *HTTPSourceStatus) InitializeConditions()
  • func (s *HTTPSourceStatus) IsReady() bool
  • func (s *HTTPSourceStatus) MarkNoSink()
  • func (s *HTTPSourceStatus) MarkPeerAuthenticationCreated(peerAuthentication *securityv1beta1.PeerAuthentication)
  • func (s *HTTPSourceStatus) MarkServiceCreated(service *corev1.Service)
  • func (s *HTTPSourceStatus) MarkSink(uri string)
  • func (s *HTTPSourceStatus) PropagateDeploymentReady(deployment *appsv1.Deployment)

Constants

const (
	// HTTPConditionSinkProvided has status True when the HTTPSource has
	// been configured with a sink target.
	HTTPConditionSinkProvided apis.ConditionType = "SinkProvided"

	// HTTPConditionDeployed has status True when the HTTPSource adapter
	// has been successfully deployed.
	HTTPConditionDeployed apis.ConditionType = "Deployed"

	// HTTPConditionPeerAuthenticationCreated has status True when the PeerAuthentication for
	// Deployment has been successfully created.
	HTTPConditionPeerAuthenticationCreated apis.ConditionType = "PeerAuthenticationCreated"

	// HTTPConditionServiceCreated has status True when the Service for
	// Deployment has been successfully created.
	HTTPConditionServiceCreated apis.ConditionType = "ServiceCreated"
)

const (
	HTTPSourceReasonSinkNotFound                 = "SinkNotFound"
	HTTPSourceReasonSinkEmpty                    = "EmptySinkURI"
	HTTPSourceReasonServiceNotReady              = "ServiceNotReady"
	HTTPSourceReasonPeerAuthenticationNotCreated = "PeerAuthenticationNotCreated"
	HTTPSourceReasonServiceNotCreated            = "ServiceNotCreated"
)

Variables

var (
	// SchemeBuilder creates a Scheme builder that is used to register known types.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme registers the types stored in SchemeBuilder.
	AddToScheme = SchemeBuilder.AddToScheme
)

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

SchemeGroupVersion contains the group and version used to register custom types.

Functions

func HTTPSourceGVK

func HTTPSourceGVK() schema.GroupVersionKind

HTTPSourceGVK returns a GroupVersionKind for the HTTPSource type.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

Types

type HTTPSource

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

	Spec   HTTPSourceSpec   `json:"spec,omitempty"`
	Status HTTPSourceStatus `json:"status,omitempty"`
}

HTTPSource is a HTTP event source.

func (*HTTPSource) DeepCopy

func (in *HTTPSource) DeepCopy() *HTTPSource

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

func (*HTTPSource) DeepCopyInto

func (in *HTTPSource) DeepCopyInto(out *HTTPSource)

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

func (*HTTPSource) DeepCopyObject

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

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

func (*HTTPSource) ToKey

func (s *HTTPSource) ToKey() string

ToKey returns a key corresponding to the HTTPSource.

func (*HTTPSource) ToOwner

func (s *HTTPSource) ToOwner() *metav1.OwnerReference

ToOwner return a OwnerReference corresponding to the given HTTPSource.

type HTTPSourceList

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

HTTPSourceList is a list of HTTPSource.

func (*HTTPSourceList) DeepCopy

func (in *HTTPSourceList) DeepCopy() *HTTPSourceList

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

func (*HTTPSourceList) DeepCopyInto

func (in *HTTPSourceList) DeepCopyInto(out *HTTPSourceList)

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

func (*HTTPSourceList) DeepCopyObject

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

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

type HTTPSourceSpec

type HTTPSourceSpec struct {
	Source string `json:"source"`
}

HTTPSourceSpec defines the desired state of HTTPSource.

func (*HTTPSourceSpec) DeepCopy

func (in *HTTPSourceSpec) DeepCopy() *HTTPSourceSpec

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

func (*HTTPSourceSpec) DeepCopyInto

func (in *HTTPSourceSpec) DeepCopyInto(out *HTTPSourceSpec)

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

type HTTPSourceStatus

type HTTPSourceStatus struct {
	// inherits duck/v1beta1 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.
	duckv1beta1.Status `json:",inline"`

	// URI of the events sink
	SinkURI string
}

HTTPSourceStatus defines the observed state of HTTPSource.

func (*HTTPSourceStatus) DeepCopy

func (in *HTTPSourceStatus) DeepCopy() *HTTPSourceStatus

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

func (*HTTPSourceStatus) DeepCopyInto

func (in *HTTPSourceStatus) DeepCopyInto(out *HTTPSourceStatus)

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

func (*HTTPSourceStatus) InitializeConditions

func (s *HTTPSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*HTTPSourceStatus) IsReady

func (s *HTTPSourceStatus) IsReady() bool

IsReady returns whether the HTTPSource is ready to serve the requested configuration.

func (*HTTPSourceStatus) MarkNoSink

func (s *HTTPSourceStatus) MarkNoSink()

MarkNoSink sets the SinkProvided condition to False with the given reason and message.

func (*HTTPSourceStatus) MarkPeerAuthenticationCreated

func (s *HTTPSourceStatus) MarkPeerAuthenticationCreated(peerAuthentication *securityv1beta1.PeerAuthentication)

MarkPeerAuthenticationCreated sets the PeerAuthenticationCreated condition to True once a PeerAuthentication is created.

func (*HTTPSourceStatus) MarkServiceCreated

func (s *HTTPSourceStatus) MarkServiceCreated(service *corev1.Service)

MarkServiceCreated sets the ServiceCreated condition to True once a Service is created.

func (*HTTPSourceStatus) MarkSink

func (s *HTTPSourceStatus) MarkSink(uri string)

MarkSink sets the SinkProvided condition to True using the given URI.

func (*HTTPSourceStatus) PropagateDeploymentReady

func (s *HTTPSourceStatus) PropagateDeploymentReady(deployment *appsv1.Deployment)

PropagateDeploymentReady uses the readiness of the provided Deployment to determine whether the Deployed condition should be marked as true or false.