Sample Source Lifecycle and Types

API Definition

  1. Define the types required in the resource’s schema in pkg/apis/samples/v1alpha1/samplesource_types.go This includes the fields that will be required in the resource yaml as well as what will be referenced in the controller using the source’s clientset and API
  1. // +genclient
  2. // +genreconciler
  3. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  4. // +k8s:openapi-gen=true
  5. type SampleSource struct {
  6.     metav1.TypeMeta `json:",inline"`
  7.     // +optional
  8.     metav1.ObjectMeta `json:"metadata,omitempty"`
  10.     // Spec holds the desired state of the SampleSource (from the client).
  11.     Spec SampleSourceSpec `json:"spec"`
  13.     // Status communicates the observed state of the SampleSource (from the controller).
  14.     // +optional
  15.     Status SampleSourceStatus `json:"status,omitempty"`
  16. }
  18. // SampleSourceSpec holds the desired state of the SampleSource (from the client).
  19. type SampleSourceSpec struct {
  20.     // inherits duck/v1 SourceSpec, which currently provides:
  21.     // * Sink - a reference to an object that will resolve to a domain name or
  22.     //   a URI directly to use as the sink.
  23.     // * CloudEventOverrides - defines overrides to control the output format
  24.     //   and modifications of the event sent to the sink.
  25.     duckv1.SourceSpec `json:",inline"`
  27.     // ServiceAccountName holds the name of the Kubernetes service account
  28.     // as which the underlying K8s resources should be run. If unspecified
  29.     // this will default to the "default" service account for the namespace
  30.     // in which the SampleSource exists.
  31.     // +optional
  32.     ServiceAccountName string `json:"serviceAccountName,omitempty"`
  34.     // Interval is the time interval between events.
  35.     //
  36.     // The string format is a sequence of decimal numbers, each with optional
  37.     // fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". Valid time
  38.     // units are "ns", "us" (or "µs"), "ms", "s", "m", "h". If unspecified
  39.     // this will default to "10s".
  40.     Interval string `json:"interval"`
  41. }
  43. // SampleSourceStatus communicates the observed state of the SampleSource (from the controller).
  44. type SampleSourceStatus struct {
  45.     duckv1.Status `json:",inline"`
  47.     // SinkURI is the current active sink URI that has been configured
  48.     // for the SampleSource.
  49.     // +optional
  50.     SinkURI *apis.URL `json:"sinkUri,omitempty"`
  51. }

Define the lifecycle that will be reflected in the status and SinkURI fields

  1. const (
  2.     // SampleConditionReady has status True when the SampleSource is ready to send events.
  3.     SampleConditionReady = apis.ConditionReady
  4.     // ...
  5. )

Define the functions that will be called from the Reconciler functions to set the lifecycle conditions. This is typically done in pkg/apis/samples/VERSION/samplesource_lifecycle.go

  1. // InitializeConditions sets relevant unset conditions to Unknown state.
  2. func (s *SampleSourceStatus) InitializeConditions() {
  3.     SampleCondSet.Manage(s).InitializeConditions()
  4. }
  6. ...
  8. // MarkSink sets the condition that the source has a sink configured.
  9. func (s *SampleSourceStatus) MarkSink(uri *apis.URL) {
  10.     s.SinkURI = uri
  11.     if len(uri.String()) > 0 {
  12.         SampleCondSet.Manage(s).MarkTrue(SampleConditionSinkProvided)
  13.     } else {
  14.         SampleCondSet.Manage(s).MarkUnknown(SampleConditionSinkProvided, "SinkEmpty", "Sink has resolved to empty.%s", "")
  15.     }
  16. }
  18. // MarkNoSink sets the condition that the source does not have a sink configured.
  19. func (s *SampleSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{}) {
  20.     SampleCondSet.Manage(s).MarkFalse(SampleConditionSinkProvided, reason, messageFormat, messageA...)
  21. }