PingSource reference

This topic provides reference information about the configurable fields for the PingSource object.

PingSource

A PingSource definition supports the following fields:

Field	Description	Required or optional
apiVersion	Specifies the API version, for example sources.knative.dev/v1.	Required
kind	Identifies this resource object as a PingSource object.	Required
metadata	Specifies metadata that uniquely identifies the PingSource object. For example, a name.	Required
spec	Specifies the configuration information for this PingSource object.	Required
spec.contentType	The media type of data or dataBase64. Default is empty.	Optional
spec.data	The data used as the body of the event posted to the sink. Default is empty. Mutually exclusive with dataBase64.	Required if not sending base64 encoded data
spec.dataBase64	A base64-encoded string of the actual event's body posted to the sink. Default is empty. Mutually exclusive with data.	Required if sending base64 encoded data
spec.schedule	Specifies the cron schedule. Defaults to * * * * *.	Optional
spec.sink	A reference to an object that resolves to a URI to use as the sink.	Required
spec.timezone	Modifies the actual time relative to the specified timezone. Defaults to the system time zone. See the list of valid tz database time zones on Wikipedia. For general information about time zones, see the IANA website.	Optional
spec.ceOverrides	Defines overrides to control the output format and modifications to the event sent to the sink.	Optional
status	Defines the observed state of PingSource.	Optional
status.observedGeneration	The 'Generation' of the Service that was last processed by the controller.	Optional
status.conditions	The latest available observations of a resource's current state.	Optional
status.sinkUri	The current active sink URI that has been configured for the Source.	Optional

CloudEvent Overrides

CloudEvent Overrides defines overrides to control the output format and modifications of the event sent to the sink.

A ceOverrides definition supports the following fields:

Field	Description	Required or optional
extensions	Specifies which attributes are added or overridden on the outbound event. Each extensions key-value pair is set independently on the event as an attribute extension.	Optional

Note

Only valid CloudEvent attribute names are allowed as extensions. You cannot set the spec defined attributes from the extensions override configuration. For example, you can not modify the type attribute.

Example: CloudEvent Overrides

apiVersion: sources.knative.dev/v1
kind: PingSource
metadata:
  name: test-heartbeats
spec:
  ...
  ceOverrides:
    extensions:
      extra: this is an extra attribute
      additional: 42

Contract

This results in the K_CE_OVERRIDES environment variable being set on the subject as follows:

{ "extensions": { "extra": "this is an extra attribute", "additional": "42" } }