v1alpha1

Documentation

Overview

+k8s:deepcopy-gen=package +groupName=sources.knative.dev

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type CephSource
  • func (in *CephSource) DeepCopy() *CephSource
  • func (in *CephSource) DeepCopyInto(out *CephSource)
  • func (in *CephSource) DeepCopyObject() runtime.Object
  • func (*CephSource) GetConditionSet() apis.ConditionSet
  • func (*CephSource) GetGroupVersionKind() schema.GroupVersionKind
  • func (cs *CephSource) GetStatus() *duckv1.Status
  • func (s *CephSource) SetDefaults(ctx context.Context)
  • func (s *CephSource) Validate(ctx context.Context) *apis.FieldError
• type CephSourceList
  • func (in *CephSourceList) DeepCopy() *CephSourceList
  • func (in *CephSourceList) DeepCopyInto(out *CephSourceList)
  • func (in *CephSourceList) DeepCopyObject() runtime.Object
• type CephSourceSpec
  • func (in *CephSourceSpec) DeepCopy() *CephSourceSpec
  • func (in *CephSourceSpec) DeepCopyInto(out *CephSourceSpec)
  • func (sspec *CephSourceSpec) Validate(ctx context.Context) *apis.FieldError
• type CephSourceStatus
  • func (in *CephSourceStatus) DeepCopy() *CephSourceStatus
  • func (in *CephSourceStatus) DeepCopyInto(out *CephSourceStatus)
  • func (s *CephSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition
  • func (s *CephSourceStatus) InitializeConditions()
  • func (s *CephSourceStatus) IsReady() bool
  • func (s *CephSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})
  • func (s *CephSourceStatus) MarkSink(uri *apis.URL)
  • func (s *CephSourceStatus) PropagateDeploymentAvailability(d *appsv1.Deployment)

Constants

const (
	// CephConditionReady has status True when the CephSource is ready to send events.
	CephConditionReady = apis.ConditionReady

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

	// CephConditionDeployed has status True when the CephSource has had it's deployment created.
	CephConditionDeployed apis.ConditionType = "Deployed"
)

const (
	// CephSourceConditionReady is set when the revision is starting to materialize
	// runtime resources, and becomes true when those resources are ready.
	CephSourceConditionReady = apis.ConditionReady
)

Variables

var (
	AddToScheme = schemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: ceph.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 CephSource

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

	// Spec holds the desired state of the CephSource (from the client).
	Spec CephSourceSpec `json:"spec"`

	// Status communicates the observed state of the CephSource (from the controller).
	// +optional
	Status CephSourceStatus `json:"status,omitempty"`
}

+genclient +genreconciler +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*CephSource) DeepCopy

func (in *CephSource) DeepCopy() *CephSource

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

func (*CephSource) DeepCopyInto

func (in *CephSource) DeepCopyInto(out *CephSource)

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

func (*CephSource) DeepCopyObject

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

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

func (*CephSource) GetConditionSet

func (*CephSource) GetConditionSet() apis.ConditionSet

GetConditionSet returns CephSource ConditionSet.

func (*CephSource) GetGroupVersionKind

func (*CephSource) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*CephSource) GetStatus

func (cs *CephSource) GetStatus() *duckv1.Status

GetStatus retrieves the status of the resource. Implements the KRShaped interface.

func (*CephSource) SetDefaults

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

SetDefaults mutates CephSource.

func (*CephSource) Validate

func (s *CephSource) Validate(ctx context.Context) *apis.FieldError

Validate validates CephSource.

type CephSourceList

type CephSourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []CephSource `json:"items"`
}

CephSourceList is a list of CephSource resources

func (*CephSourceList) DeepCopy

func (in *CephSourceList) DeepCopy() *CephSourceList

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

func (*CephSourceList) DeepCopyInto

func (in *CephSourceList) DeepCopyInto(out *CephSourceList)

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

func (*CephSourceList) DeepCopyObject

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

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

type CephSourceSpec

type CephSourceSpec struct {
	// inherits duck/v1 SourceSpec, which currently provides:
	// * Sink - a reference to an object that will resolve to a domain name or
	//   a URI directly to use as the sink.
	// * CloudEventOverrides - defines overrides to control the output format
	//   and modifications of the event sent to the sink.
	duckv1.SourceSpec `json:",inline"`

	// ServiceAccountName holds the name of the Kubernetes service account
	// as which the underlying K8s resources should be run. If unspecified
	// this will default to the "default" service account for the namespace
	// in which the CephSource exists.
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// Port holds the port number on which the adapter is listening on
	Port string `json:"port"`
}

CephSourceSpec holds the desired state of the CephSource (from the client).

func (*CephSourceSpec) DeepCopy

func (in *CephSourceSpec) DeepCopy() *CephSourceSpec

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

func (*CephSourceSpec) DeepCopyInto

func (in *CephSourceSpec) DeepCopyInto(out *CephSourceSpec)

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

func (*CephSourceSpec) Validate

func (sspec *CephSourceSpec) Validate(ctx context.Context) *apis.FieldError

Validate validates CephSourceSpec.

type CephSourceStatus

type CephSourceStatus 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"`
}

CephSourceStatus communicates the observed state of the CephSource (from the controller).

func (*CephSourceStatus) DeepCopy

func (in *CephSourceStatus) DeepCopy() *CephSourceStatus

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

func (*CephSourceStatus) DeepCopyInto

func (in *CephSourceStatus) DeepCopyInto(out *CephSourceStatus)

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

func (*CephSourceStatus) GetCondition

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

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

func (*CephSourceStatus) InitializeConditions

func (s *CephSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*CephSourceStatus) IsReady

func (s *CephSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*CephSourceStatus) MarkNoSink

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

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

func (*CephSourceStatus) MarkSink

func (s *CephSourceStatus) MarkSink(uri *apis.URL)

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

func (*CephSourceStatus) PropagateDeploymentAvailability

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

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