messaging.knative.dev/v1/Channel

object

.spec

Spec defines the desired state of the Channel.

object

ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel. This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.

string

.spec .channelTemplate .apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

string

.spec .channelTemplate .kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

object

.spec .channelTemplate .spec

Spec defines the Spec to use for each channel created. Passed in verbatim to the Channel CRD as Spec section.

object

.spec .delivery

DeliverySpec contains the default delivery spec for each subscription to this Channelable. Each subscription delivery spec, if any, overrides this global delivery spec.

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.

array

.spec .subscribers

This is the list of subscriptions for this subscribable.

object

.spec .subscribers[] .delivery

DeliverySpec contains options controlling the event delivery

string

.spec .subscribers[] .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 .subscribers[] .delivery .backoffPolicy

BackoffPolicy is the retry backoff policy (linear, exponential).

object

.spec .subscribers[] .delivery .deadLetterSink

DeadLetterSink is the sink receiving event that could not be sent to a destination.

object

.spec .subscribers[] .delivery .deadLetterSink .ref

Ref points to an Addressable.

string

.spec .subscribers[] .delivery .deadLetterSink .ref .apiVersion

API version of the referent.

string

.spec .subscribers[] .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 .subscribers[] .delivery .deadLetterSink .ref .name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

.spec .subscribers[] .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 .subscribers[] .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.

integer

.spec .subscribers[] .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.

integer

.spec .subscribers[] .generation

Generation of the origin of the subscriber with uid:UID.

string

.spec .subscribers[] .name

The name of the subscription

string

.spec .subscribers[] .replyUri

ReplyURI is the endpoint for the reply

string

.spec .subscribers[] .replyCACerts

Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.

string

.spec .subscribers[] .replyAudience

ReplyAudience is the OIDC audience for the replyUri.

string

.spec .subscribers[] .subscriberUri

SubscriberURI is the endpoint for the subscriber

string

.spec .subscribers[] .subscriberCACerts

Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.

string

.spec .subscribers[] .subscriberAudience

SubscriberAudience is the OIDC audience for the subscriberUri.

string

.spec .subscribers[] .uid

UID is used to understand the origin of the subscriber.

object

.spec .subscribers[] .auth

Auth provides the relevant information for OIDC authentication.

string

.spec .subscribers[] .auth .serviceAccountName

ServiceAccountName is the name of the generated service account used for this components OIDC authentication.

object

.status

Status represents the current state of the Channel. This data may be out of date.

object

.status .address

Channel is Addressable. It exposes the endpoint as an URI to get events delivered into the Channel mesh.

string

.status .address .name

string

.status .address .url

string

.status .address .CACerts

string

.status .address .audience

array

.status .addresses

Channel is Addressable. It exposes the endpoints as URIs to get events delivered into the Channel mesh.

string

.status .addresses[] .name

string

.status .addresses[] .url

string

.status .addresses[] .CACerts

string

.status .addresses[] .audience

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 .channel

Channel is an KReference to the Channel CRD backing this Channel.

string

.status .channel .apiVersion

API version of the referent.

string

.status .channel .kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

.status .channel .name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

.status .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.

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.

object

.status .deadLetterChannel

DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel Failed messages are delivered here.

string

.status .deadLetterChannel .apiVersion

API version of the referent.

string

.status .deadLetterChannel .kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

string

.status .deadLetterChannel .name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

string

.status .deadLetterChannel .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