messaging.knative.dev / v1 / Subscription
- object
.spec
- object
.spec .channel
Reference to a channel that will be used to create the subscription. You can specify only the following fields of the KReference: kind, apiVersion, name and namespace. The resource pointed by this KReference must meet the contract to the ChannelableSpec duck type. If the resource does not meet this contract it will be reflected in the Subscription’s status. This field is immutable. We have no good answer on what happens to the events that are currently in the channel being consumed from and what the semantics there should be. For now, you can always delete the Subscription and recreate it to point to a different channel, giving the user more control over what semantics should be used (drain the channel first, possibly have events dropped, etc.)
- string
.spec .channel .apiVersion
API version of the referent.
- string
.spec .channel .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .channel .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .channel .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ This is optional field, it gets defaulted to the object holding it if left out.
- object
.spec .delivery
Delivery configuration
- string
.spec .delivery .backoffDelay
BackoffDelay is the delay before retrying. More information on Duration format: - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 For linear policy, backoff delay is backoffDelay*
. For exponential policy, backoff delay is backoffDelay*2^ . - string
.spec .delivery .backoffPolicy
BackoffPolicy is the retry backoff policy (linear, exponential).
- object
.spec .delivery .deadLetterSink
DeadLetterSink is the sink receiving event that could not be sent to a destination.
- object
.spec .delivery .deadLetterSink .ref
Ref points to an Addressable.
- string
.spec .delivery .deadLetterSink .ref .apiVersion
API version of the referent.
- string
.spec .delivery .deadLetterSink .ref .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .delivery .deadLetterSink .ref .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .delivery .deadLetterSink .ref .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ This is optional field, it gets defaulted to the object holding it if left out.
- string
.spec .delivery .deadLetterSink .uri
URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.
- string
.spec .delivery .deadLetterSink .CACerts
Certification Authority (CA) certificates in PEM format that the source trusts when sending events to the sink.
- string
.spec .delivery .deadLetterSink .audience
Audience is the OIDC audience. This only needs to be set if the target is not an Addressable and thus the Audience can’t be received from the target itself. If specified, it takes precedence over the target’s Audience.
- integer
.spec .delivery .retry
Retry is the minimum number of retries the sender should attempt when sending an event before moving it to the dead letter sink.
- object
.spec .reply
Reply specifies (optionally) how to handle events returned from the Subscriber target.
- object
.spec .reply .ref
Ref points to an Addressable.
- string
.spec .reply .ref .apiVersion
API version of the referent.
- string
.spec .reply .ref .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .reply .ref .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .reply .ref .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ This is optional field, it gets defaulted to the object holding it if left out.
- string
.spec .reply .uri
URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.
- string
.spec .reply .CACerts
Certification Authority (CA) certificates in PEM format that the source trusts when sending events to the sink.
- string
.spec .reply .audience
Audience is the OIDC audience. This only needs to be set if the target is not an Addressable and thus the Audience can’t be received from the target itself. If specified, it takes precedence over the target’s Audience.
- object
.spec .subscriber
Subscriber is reference to (optional) function for processing events. Events from the Channel will be delivered here and replies are sent to a Destination as specified by the Reply.
- object
.spec .subscriber .ref
Ref points to an Addressable.
- string
.spec .subscriber .ref .apiVersion
API version of the referent.
- string
.spec .subscriber .ref .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .subscriber .ref .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .subscriber .ref .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ This is optional field, it gets defaulted to the object holding it if left out.
- string
.spec .subscriber .uri
URI can be an absolute URL(non-empty scheme and non-empty host) pointing to the target or a relative URI. Relative URIs will be resolved using the base URI retrieved from Ref.
- string
.spec .subscriber .CACerts
Certification Authority (CA) certificates in PEM format that the subscription trusts when sending events to the sink.
- string
.spec .subscriber .audience
Audience is the OIDC audience. This only needs to be set if the target is not an Addressable and thus the Audience can’t be received from the target itself. If specified, it takes precedence over the target’s Audience.
- object
.status
- object
.status .annotations
Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
- object
.status .auth
Auth provides the relevant information for OIDC authentication.
- string
.status .auth .serviceAccountName
ServiceAccountName is the name of the generated service account used for this components OIDC authentication.
- array
.status .conditions
Conditions the latest available observations of a resource’s current state.
- string
.status .conditions[] .lastTransitionTime
LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).
- string
.status .conditions[] .message
A human readable message indicating details about the transition.
- string
.status .conditions[] .reason
The reason for the condition’s last transition.
- string
.status .conditions[] .severity
Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.
- string required
.status .conditions[] .status
Status of the condition, one of True, False, Unknown.
- string required
.status .conditions[] .type
Type of condition.
- integer
.status .observedGeneration
ObservedGeneration is the ‘Generation’ of the Service that was last processed by the controller.
- object
.status .physicalSubscription
PhysicalSubscription is the fully resolved values that this Subscription represents.
- string
.status .physicalSubscription .deadLetterSinkUri
ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.
- string
.status .physicalSubscription .deadLetterSinkCACerts
Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.
- string
.status .physicalSubscription .deadLetterSinkAudience
OIDC audience of the dead letter sink.
- string
.status .physicalSubscription .replyUri
ReplyURI is the fully resolved URI for the spec.reply.
- string
.status .physicalSubscription .replyCACerts
Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.
- string
.status .physicalSubscription .replyAudience
ReplyAudience is the OIDC audience for the replyUri.
- string
.status .physicalSubscription .subscriberUri
SubscriberURI is the fully resolved URI for spec.subscriber.
- string
.status .physicalSubscription .subscriberCACerts
Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.
- string
.status .physicalSubscription .subscriberAudience
SubscriberAudience is the OIDC audience for the subscriberUri.