From 1397e226d30e0076d019ce4abceb16156d92f8ce Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Thu, 19 Sep 2019 13:05:01 -0700 Subject: [PATCH] eventing-contrib API and consistent file names (#1805) --- docs/reference/README.md | 20 +- .../eventing/eventing-contrib-api.md | 2 +- ...ntrib-resources.md => eventing-contrib.md} | 516 +- docs/reference/eventing/eventing.md | 4755 +---------------- docs/reference/serving.md | 4 +- hack/gen-api-reference-docs.sh | 16 +- 6 files changed, 218 insertions(+), 5095 deletions(-) rename docs/reference/eventing/{eventing-contrib-resources.md => eventing-contrib.md} (86%) diff --git a/docs/reference/README.md b/docs/reference/README.md index 715a233c3..81ce9ea16 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -11,7 +11,7 @@ The API source files are located at: - [Serving API](./serving.md) - [Eventing API](./eventing/eventing.md) -- [Eventing-contrib resources API](./eventing/eventing-resources.md) +- [Eventing-contrib resources API](./eventing/eventing-contrib.md) ## Updating API Reference docs (for Knative maintainers) @@ -57,18 +57,20 @@ To generate a version of the API: 1. Locate the commits or tags that correspond to the version of the API that you want to generate: + - [Serving](https://github.com/knative/serving/releases/) - [Eventing](https://github.com/knative/eventing/releases/) - [Eventing-contrib resources](https://github.com/knative/eventing-contrib/releases/) - - [Serving](https://github.com/knative/serving/releases/) 1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you specify the commits or tags for each of the corresponding Knative component variables (`KNATIVE_[component_name]_COMMIT`): ``` - KNATIVE_EVENTING_COMMIT=[commit_or_tag] \ - KNATIVE_EVENTING_SOURCES_COMMIT=[commit_or_tag] \ + cd hack + KNATIVE_SERVING_COMMIT=[commit_or_tag] \ + KNATIVE_EVENTING_COMMIT=[commit_or_tag] \ + KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \ ./gen-api-reference-docs.sh ``` @@ -85,12 +87,6 @@ To generate a version of the API: 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. -1. IMPORTANT: There are some limitations to the build script that require manual - changes to the HTML. For the `serving.md` and - `eventing-contrib-resources.md`, you must manually fix the `Packages` lists. - Details for the required manual changes are in - [PR 1552](https://github.com/knative/docs/pull/1552#issuecomment-506891983). - You can now perform the necessary steps to open a PR, complete a review, and merge the new API files into the appropriate branch of the `knative/docs` repo. See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for details @@ -108,8 +104,8 @@ Using tags from each repo, you would run the following command to generate the v0.3.0 API source files: ``` -KNATIVE_EVENTING_COMMIT=v0.3.0 \ -KNATIVE_EVENTING_SOURCES_COMMIT=v0.3.0 \ KNATIVE_SERVING_COMMIT=v0.3.0 \ +KNATIVE_EVENTING_COMMIT=v0.3.0 \ +KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \ ./gen-api-reference-docs.sh ``` diff --git a/docs/reference/eventing/eventing-contrib-api.md b/docs/reference/eventing/eventing-contrib-api.md index 3f08b0fba..8a393358c 100644 --- a/docs/reference/eventing/eventing-contrib-api.md +++ b/docs/reference/eventing/eventing-contrib-api.md @@ -5,4 +5,4 @@ weight: 50 type: "docs" --- -{{< readfile file="eventing-contrib-resources.md" relative="true" >}} +{{< readfile file="eventing-contrib.md" relative="true" >}} diff --git a/docs/reference/eventing/eventing-contrib-resources.md b/docs/reference/eventing/eventing-contrib.md similarity index 86% rename from docs/reference/eventing/eventing-contrib-resources.md rename to docs/reference/eventing/eventing-contrib.md index aab1f7532..37ec7c213 100644 --- a/docs/reference/eventing/eventing-contrib-resources.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -17,8 +17,6 @@ Resource Types:
  • CamelSource
  • -GcpPubSubSource -
  • GitHubSource
  • KafkaSource @@ -249,160 +247,6 @@ CamelSourceStatus -

    GcpPubSubSource -

    -

    -

    GcpPubSubSource is the Schema for the gcppubsubsources API.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -sources.eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		GcpPubSubSource
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -GcpPubSubSourceSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    -gcpCredsSecret
    - - -Kubernetes core/v1.SecretKeySelector - - -    		 -

    GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used -to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format -( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).

    -
    -googleCloudProject
    - -string - -    		 -

    GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

    -
    -topic
    - -string - -    		 -

    Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the -unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not -‘projects/my-gcp-project/topics/laconia’.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -transformer
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Transformer is a reference to an object that will resolve to a domain name to use as the transformer.

    -
    -serviceAccountName
    - -string - -    		 -

    ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment.

    -
    -
    -status
    - - -GcpPubSubSourceStatus - - -    		 -

    GitHubSource

    @@ -1075,164 +919,6 @@ string -

    GcpPubSubSourceSpec -

    -

    -(Appears on: -GcpPubSubSource) -

    -

    -

    GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -gcpCredsSecret
    - - -Kubernetes core/v1.SecretKeySelector - - -    		 -

    GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used -to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format -( see https://cloud.google.com/iam/docs/creating-managing-service-account-keys ).

    -
    -googleCloudProject
    - -string - -    		 -

    GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in.

    -
    -topic
    - -string - -    		 -

    Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the -unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not -‘projects/my-gcp-project/topics/laconia’.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -transformer
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Transformer is a reference to an object that will resolve to a domain name to use as the transformer.

    -
    -serviceAccountName
    - -string - -    		 -

    ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment.

    -
    -

    GcpPubSubSourceStatus -

    -

    -(Appears on: -GcpPubSubSource) -

    -

    -

    GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1alpha1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1alpha1 Status, 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
    - -string - -    		 -(Optional) -

    SinkURI is the current active sink URI that has been configured for the GcpPubSubSource.

    -
    -transformerUri
    - -string - -    		 -(Optional) -

    TransformerURI is the current active transformer URI that has been configured for the GcpPubSubSource.

    -

    GitHubSourceSpec

    @@ -1863,7 +1549,8 @@ SecretValueFromSource

    (Appears on: -GitHubSourceSpec) +KafkaSourceSASLSpec, +KafkaSourceTLSSpec)

    SecretValueFromSource represents the source of a secret value

    @@ -1895,8 +1582,7 @@ Kubernetes core/v1.SecretKeySelector

    (Appears on: -KafkaSourceSASLSpec, -KafkaSourceTLSSpec) +GitHubSourceSpec)

    SecretValueFromSource represents the source of a secret value

    @@ -1932,6 +1618,8 @@ Kubernetes core/v1.SecretKeySelector Resource Types:

    KafkaChannel

    @@ -2018,7 +1706,7 @@ int16 subscribable
    -github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -2045,6 +1733,96 @@ date.

    +

    NatssChannel +

    +

    +

    NatssChannel is a resource representing a NATSS Channel.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +messaging.knative.dev/v1alpha1 + +
    +kind
    +string +    		NatssChannel
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +(Optional) +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +NatssChannelSpec + + +    		 +

    Spec defines the desired state of the Channel.

    +
    +
    + + + + + +
    +subscribable
    + +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable + +    		 +

    NatssChannel conforms to Duck type Subscribable.

    +
    +
    +status
    + + +NatssChannelStatus + + +    		 +(Optional) +

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

    +

    KafkaChannelSpec

    @@ -2088,7 +1866,7 @@ int16 subscribable
    -github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -2151,7 +1929,103 @@ provided targets from inside the cluster.

    SubscribableTypeStatus
    -github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus +knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus + + + +

    +(Members of SubscribableTypeStatus are embedded into this type.) +

    +

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    + + + + +

    NatssChannelSpec +

    +

    +(Appears on: +NatssChannel) +

    +

    +

    NatssChannelSpec defines the specification for a NatssChannel.

    +

    + + + + + + + + + + + + + +
    FieldDescription
    +subscribable
    + +knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable + +    		 +

    NatssChannel conforms to Duck type Subscribable.

    +
    +

    NatssChannelStatus +

    +

    +(Appears on: +NatssChannel) +

    +

    +

    NatssChannelStatus represents the current state of a NatssChannel.

    +

    + + + + + + + + + + + + + + + + + +
    FieldDescription
    +Status
    + +knative.dev/pkg/apis/duck/v1beta1.Status + +    		 +

    +(Members of Status are embedded into this type.) +

    +

    inherits duck/v1beta1 Status, 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.

    +
    +AddressStatus
    + +knative.dev/pkg/apis/duck/v1alpha1.AddressStatus + +    		 +

    +(Members of AddressStatus are embedded into this type.) +

    +

    NatssChannel is Addressable. It currently exposes the endpoint as a +fully-qualified DNS name which will distribute traffic over the +provided targets from inside the cluster.

    +

    It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    +
    +SubscribableTypeStatus
    + +knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus     		@@ -2166,5 +2040,5 @@ github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus

    Generated with gen-crd-api-reference-docs -on git commit 4bda4fca. +on git commit 89b43a1d.

    diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 261b1b6d7..4bfcf05ee 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,4751 +1,4 @@ -

    Packages:

    - -

    messaging.knative.dev/v1alpha1

    -

    -

    Package v1alpha1 is the v1alpha1 version of the API.

    -

    -Resource Types: - -

    Channel -

    -

    -

    Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -messaging.knative.dev/v1alpha1 - -
    -kind
    -string -    		Channel
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ChannelSpec - - -    		 -

    Spec defines the desired state of the Channel.

    -
    -
    - - - - - - - - - -
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -

    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.

    -
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -
    -status
    - - -ChannelStatus - - -    		 -(Optional) -

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

    -
    -

    InMemoryChannel -

    -

    -

    InMemoryChannel is a resource representing an in memory channel

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -messaging.knative.dev/v1alpha1 - -
    -kind
    -string -    		InMemoryChannel
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -InMemoryChannelSpec - - -    		 -

    Spec defines the desired state of the Channel.

    -
    -
    - - - - - -
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -
    -status
    - - -InMemoryChannelStatus - - -    		 -(Optional) -

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

    -
    -

    ChannelSpec -

    -

    -(Appears on: -Channel) -

    -

    -

    ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel. -It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -

    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.

    -
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -

    ChannelStatus -

    -

    -(Appears on: -Channel) -

    -

    -

    ChannelStatus represents the current state of a Channel.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -AddressStatus
    - -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -    		 -

    -(Members of AddressStatus are embedded into this type.) -

    -

    Channel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster.

    -

    It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    -
    -SubscribableTypeStatus
    - - -SubscribableTypeStatus - - -    		 -

    -(Members of SubscribableTypeStatus are embedded into this type.) -

    -

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    -
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

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

    -
    -

    Choice -

    -

    -

    Choice defines conditional branches that will be wired in -series through Channels and Subscriptions.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ChoiceSpec - - -    		 -

    Spec defines the desired state of the Choice.

    -
    -
    - - - - - - - - - - - - - -
    -cases
    - - -[]ChoiceCase - - -    		 -

    Cases is the list of Filter/Subscribers pairs. Filters are evaluated in the order -provided, until one pass (returns true)

    -
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

    -
    -reply
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

    -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -

    The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -
    -status
    - - -ChoiceStatus - - -    		 -(Optional) -

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

    -
    -

    ChoiceCase -

    -

    -(Appears on: -ChoiceSpec) -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -filter
    - - -SubscriberSpec - - -    		 -

    Filter is the expression guarding the branch/case

    -
    -subscriber
    - - -SubscriberSpec - - -    		 -

    Subscriber receiving the event when the filter passes

    -
    -reply
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reply is a Reference to where the result of Subscriber of this case gets sent to. -If not specified, sent the result to the Choice Reply

    -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -

    The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -

    ChoiceCaseStatus -

    -

    -(Appears on: -ChoiceStatus) -

    -

    -

    ChoiceCaseStatus represents the current state of a Choice case

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -filterSubscriptionStatus
    - - -ChoiceSubscriptionStatus - - -    		 -

    FilterSubscriptionStatus corresponds to the filter subscription status.

    -
    -filterChannelStatus
    - - -ChoiceChannelStatus - - -    		 -

    FilterChannelStatus corresponds to the filter channel status.

    -
    -subscriberSubscriptionStatus
    - - -ChoiceSubscriptionStatus - - -    		 -

    SubscriptionStatus corresponds to the subscriber subscription status.

    -
    -

    ChoiceChannelStatus -

    -

    -(Appears on: -ChoiceCaseStatus, -ChoiceStatus) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Channel is the reference to the underlying channel.

    -
    -ready
    - -knative.dev/pkg/apis.Condition - -    		 -

    ReadyCondition indicates whether the Channel is ready or not.

    -
    -

    ChoiceSpec -

    -

    -(Appears on: -Choice) -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -cases
    - - -[]ChoiceCase - - -    		 -

    Cases is the list of Filter/Subscribers pairs. Filters are evaluated in the order -provided, until one pass (returns true)

    -
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

    -
    -reply
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reply is a Reference to where the result of a case Subscriber gets sent to -when the case does not have a Reply

    -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -

    The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -

    ChoiceStatus -

    -

    -(Appears on: -Choice) -

    -

    -

    ChoiceStatus represents the current state of a Choice.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1alpha1 Status, 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.

    -
    -ingressChannelStatus
    - - -ChoiceChannelStatus - - -    		 -

    IngressChannelStatus corresponds to the ingress channel status.

    -
    -caseStatuses
    - - -[]ChoiceCaseStatus - - -    		 -

    CaseStatuses is an array of corresponding to cases status. -Matches the Spec.Cases array in the order.

    -
    -AddressStatus
    - -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -    		 -

    -(Members of AddressStatus are embedded into this type.) -

    -

    AddressStatus is the starting point to this Choice. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    -
    -

    ChoiceSubscriptionStatus -

    -

    -(Appears on: -ChoiceCaseStatus) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -subscription
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Subscription is the reference to the underlying Subscription.

    -
    -ready
    - -knative.dev/pkg/apis.Condition - -    		 -

    ReadyCondition indicates whether the Subscription is ready or not.

    -
    -

    InMemoryChannelSpec -

    -

    -(Appears on: -InMemoryChannel) -

    -

    -

    InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -

    InMemoryChannelStatus -

    -

    -(Appears on: -InMemoryChannel) -

    -

    -

    ChannelStatus represents the current state of a Channel.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -AddressStatus
    - -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -    		 -

    -(Members of AddressStatus are embedded into this type.) -

    -

    InMemoryChannel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster.

    -

    It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    -
    -SubscribableTypeStatus
    - - -SubscribableTypeStatus - - -    		 -

    -(Members of SubscribableTypeStatus are embedded into this type.) -

    -

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    -
    -

    Sequence -

    -

    -

    Sequence defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -SequenceSpec - - -    		 -

    Spec defines the desired state of the Sequence.

    -
    -
    - - - - - - - - - - - - - -
    -steps
    - - -[]SubscriberSpec - - -    		 -

    Steps is the list of Subscribers (processors / functions) that will be called in the order -provided.

    -
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

    -
    -reply
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reply is a Reference to where the result of the last Subscriber gets sent to.

    -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -

    The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -
    -status
    - - -SequenceStatus - - -    		 -(Optional) -

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

    -
    -

    SequenceChannelStatus -

    -

    -(Appears on: -SequenceStatus) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Channel is the reference to the underlying channel.

    -
    -ready
    - -knative.dev/pkg/apis.Condition - -    		 -

    ReadyCondition indicates whether the Channel is ready or not.

    -
    -

    SequenceSpec -

    -

    -(Appears on: -Sequence) -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -steps
    - - -[]SubscriberSpec - - -    		 -

    Steps is the list of Subscribers (processors / functions) that will be called in the order -provided.

    -
    -channelTemplate
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD -for the namespace (or cluster, in case there are no defaults for the namespace).

    -
    -reply
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reply is a Reference to where the result of the last Subscriber gets sent to.

    -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -

    The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -

    SequenceStatus -

    -

    -(Appears on: -Sequence) -

    -

    -

    SequenceStatus represents the current state of a Sequence.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1alpha1 Status, 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.

    -
    -subscriptionStatuses
    - - -[]SequenceSubscriptionStatus - - -    		 -

    SubscriptionStatuses is an array of corresponding Subscription statuses. -Matches the Spec.Steps array in the order.

    -
    -channelStatuses
    - - -[]SequenceChannelStatus - - -    		 -

    ChannelStatuses is an array of corresponding Channel statuses. -Matches the Spec.Steps array in the order.

    -
    -AddressStatus
    - -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -    		 -

    -(Members of AddressStatus are embedded into this type.) -

    -

    AddressStatus is the starting point to this Sequence. Sending to this -will target the first subscriber. -It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    -
    -

    SequenceSubscriptionStatus -

    -

    -(Appears on: -SequenceStatus) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -subscription
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Subscription is the reference to the underlying Subscription.

    -
    -ready
    - -knative.dev/pkg/apis.Condition - -    		 -

    ReadyCondition indicates whether the Subscription is ready or not.

    -
    -
    -

    sources.eventing.knative.dev/v1alpha1

    -

    -

    Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group

    -

    -Resource Types: - -

    ApiServerSource -

    -

    -

    ApiServerSource is the Schema for the apiserversources API

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -sources.eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		ApiServerSource
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ApiServerSourceSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - -
    -resources
    - - -[]ApiServerResource - - -    		 -

    Resources is the list of resources to watch

    -
    -serviceAccountName
    - -string - -    		 -(Optional) -

    ServiceAccountName is the name of the ServiceAccount to use to run this -source.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -mode
    - -string - -    		 -

    Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

    -
    -
    -status
    - - -ApiServerSourceStatus - - -    		 -
    -

    ContainerSource -

    -

    -

    ContainerSource is the Schema for the containersources API

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -sources.eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		ContainerSource
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ContainerSourceSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    -template
    - - -Kubernetes core/v1.PodTemplateSpec - - -    		 -(Optional) -

    Template describes the pods that will be created

    -
    -image
    - -string - -    		 -

    DeprecatedImage is the image to run inside of the container. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -args
    - -[]string - -    		 -

    DeprecatedArgs are passed to the ContainerSpec as they are. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -env
    - - -[]Kubernetes core/v1.EnvVar - - -    		 -(Optional) -

    DeprecatedEnv is the list of environment variables to set in the container. -Cannot be updated. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -serviceAccountName
    - -string - -    		 -(Optional) -

    DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this -source. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -
    -status
    - - -ContainerSourceStatus - - -    		 -
    -

    CronJobSource -

    -

    -

    CronJobSource is the Schema for the cronjobsources API.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -sources.eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		CronJobSource
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -CronJobSourceSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - - - - - -
    -schedule
    - -string - -    		 -

    Schedule is the cronjob schedule.

    -
    -data
    - -string - -    		 -

    Data is the data posted to the target function.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -serviceAccountName
    - -string - -    		 -

    ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment.

    -
    -resources
    - - -CronJobResourceSpec - - -    		 -

    Resource limits and Request specifications of the Receive Adapter Deployment

    -
    -
    -status
    - - -CronJobSourceStatus - - -    		 -
    -

    ApiServerResource -

    -

    -(Appears on: -ApiServerSourceSpec) -

    -

    -

    ApiServerResource defines the resource to watch

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    - -string - -    		 -

    API version of the resource to watch.

    -
    -kind
    - -string - -    		 -

    Kind of the resource to watch. -More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    -
    -controller
    - -bool - -    		 -

    If true, send an event referencing the object controlling the resource

    -
    -

    ApiServerSourceSpec -

    -

    -(Appears on: -ApiServerSource) -

    -

    -

    ApiServerSourceSpec defines the desired state of ApiServerSource

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -resources
    - - -[]ApiServerResource - - -    		 -

    Resources is the list of resources to watch

    -
    -serviceAccountName
    - -string - -    		 -(Optional) -

    ServiceAccountName is the name of the ServiceAccount to use to run this -source.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -mode
    - -string - -    		 -

    Mode is the mode the receive adapter controller runs under: Ref or Resource. -Ref sends only the reference to the resource. -Resource send the full resource.

    -
    -

    ApiServerSourceStatus -

    -

    -(Appears on: -ApiServerSource) -

    -

    -

    ApiServerSourceStatus defines the observed state of ApiServerSource

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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
    - -string - -    		 -(Optional) -

    SinkURI is the current active sink URI that has been configured for the ApiServerSource.

    -
    -

    ContainerSourceSpec -

    -

    -(Appears on: -ContainerSource) -

    -

    -

    ContainerSourceSpec defines the desired state of ContainerSource

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -template
    - - -Kubernetes core/v1.PodTemplateSpec - - -    		 -(Optional) -

    Template describes the pods that will be created

    -
    -image
    - -string - -    		 -

    DeprecatedImage is the image to run inside of the container. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -args
    - -[]string - -    		 -

    DeprecatedArgs are passed to the ContainerSpec as they are. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -env
    - - -[]Kubernetes core/v1.EnvVar - - -    		 -(Optional) -

    DeprecatedEnv is the list of environment variables to set in the container. -Cannot be updated. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -serviceAccountName
    - -string - -    		 -(Optional) -

    DeprecatedServiceAccountName is the name of the ServiceAccount to use to run this -source. -This field is to be deprecated. Use Template instead. -When Template is set, this field is ignored.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -

    ContainerSourceStatus -

    -

    -(Appears on: -ContainerSource) -

    -

    -

    ContainerSourceStatus defines the observed state of ContainerSource

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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
    - -string - -    		 -(Optional) -

    SinkURI is the current active sink URI that has been configured for the ContainerSource.

    -
    -

    CronJobLimitsSpec -

    -

    -(Appears on: -CronJobResourceSpec) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -cpu
    - -string - -    		 -
    -memory
    - -string - -    		 -
    -

    CronJobRequestsSpec -

    -

    -(Appears on: -CronJobResourceSpec) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -cpu
    - -string - -    		 -
    -memory
    - -string - -    		 -
    -

    CronJobResourceSpec -

    -

    -(Appears on: -CronJobSourceSpec) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -requests
    - - -CronJobRequestsSpec - - -    		 -
    -limits
    - - -CronJobLimitsSpec - - -    		 -
    -

    CronJobSourceSpec -

    -

    -(Appears on: -CronJobSource) -

    -

    -

    CronJobSourceSpec defines the desired state of the CronJobSource.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -schedule
    - -string - -    		 -

    Schedule is the cronjob schedule.

    -
    -data
    - -string - -    		 -

    Data is the data posted to the target function.

    -
    -sink
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Sink is a reference to an object that will resolve to a domain name to use as the sink.

    -
    -serviceAccountName
    - -string - -    		 -

    ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment.

    -
    -resources
    - - -CronJobResourceSpec - - -    		 -

    Resource limits and Request specifications of the Receive Adapter Deployment

    -
    -

    CronJobSourceStatus -

    -

    -(Appears on: -CronJobSource) -

    -

    -

    CronJobSourceStatus defines the observed state of CronJobSource.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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
    - -string - -    		 -(Optional) -

    SinkURI is the current active sink URI that has been configured for the CronJobSource.

    -
    -
    -

    duck.knative.dev/v1alpha1

    -

    -

    Package v1alpha1 is the v1alpha1 version of the API.

    -

    -Resource Types: - -

    Channelable -

    -

    -

    Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -Channelable ObjectReferences and access their subscription and address data. This is not a real resource.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -duck.knative.dev/v1alpha1 - -
    -kind
    -string -    		Channelable
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ChannelableSpec - - -    		 -

    Spec is the part where the Channelable fulfills the Subscribable contract.

    -
    -
    - - - - - -
    -SubscribableTypeSpec
    - - -SubscribableTypeSpec - - -    		 -

    -(Members of SubscribableTypeSpec are embedded into this type.) -

    -
    -
    -status
    - - -ChannelableStatus - - -    		 -
    -

    Resource -

    -

    -

    Resource is a skeleton type wrapping all Kubernetes resources. It is typically used to watch -arbitrary other resources (such as any Source or Addressable). This is not a real resource.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -duck.knative.dev/v1alpha1 - -
    -kind
    -string -    		Resource
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -

    SubscribableType -

    -

    -

    SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers -defining compatible resources to embed it. We will typically use this type to deserialize -SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -duck.knative.dev/v1alpha1 - -
    -kind
    -string -    		SubscribableType
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -SubscribableTypeSpec - - -    		 -

    SubscribableTypeSpec is the part where Subscribable object is -configured as to be compatible with Subscribable contract.

    -
    -
    - - - - - -
    -subscribable
    - - -Subscribable - - -    		 -
    -
    -status
    - - -SubscribableTypeStatus - - -    		 -

    SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract.

    -
    -

    ChannelDefaulter -

    -

    -

    ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.

    -

    -

    ChannelTemplateSpec -

    -

    -(Appears on: -BrokerSpec, -ChannelSpec, -ChoiceSpec, -SequenceSpec) -

    -

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -spec
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

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

    -
    -
    - -
    -
    -

    ChannelTemplateSpecInternal -

    -

    -

    ChannelTemplateSpecInternal is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

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

    -
    -
    - -
    -
    -

    ChannelableSpec -

    -

    -(Appears on: -Channelable) -

    -

    -

    ChannelableSpec contains Spec of the Channelable object

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -SubscribableTypeSpec
    - - -SubscribableTypeSpec - - -    		 -

    -(Members of SubscribableTypeSpec are embedded into this type.) -

    -
    -

    ChannelableStatus -

    -

    -(Appears on: -Channelable) -

    -

    -

    ChannelableStatus contains the Status of a Channelable object.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -AddressStatus
    - -knative.dev/pkg/apis/duck/v1alpha1.AddressStatus - -    		 -

    -(Members of AddressStatus are embedded into this type.) -

    -

    AddressStatus is the part where the Channelable fulfills the Addressable contract.

    -
    -SubscribableTypeStatus
    - - -SubscribableTypeStatus - - -    		 -

    -(Members of SubscribableTypeStatus are embedded into this type.) -

    -

    Subscribers is populated with the statuses of each of the Channelable’s subscribers.

    -
    -

    Subscribable -

    -

    -(Appears on: -ChannelSpec, -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) -

    -

    -

    Subscribable is the schema for the subscribable portion of the spec -section of the resource.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -subscribers
    - - -[]SubscriberSpec - - -    		 -

    This is the list of subscriptions for this subscribable.

    -
    -

    SubscribableStatus -

    -

    -(Appears on: -SubscribableTypeStatus) -

    -

    -

    SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -subscribers
    - - -[]SubscriberStatus - - -    		 -

    This is the list of subscription’s statuses for this channel.

    -
    -

    SubscribableTypeSpec -

    -

    -(Appears on: -SubscribableType, -ChannelableSpec) -

    -

    -

    SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -subscribable
    - - -Subscribable - - -    		 -
    -

    SubscribableTypeStatus -

    -

    -(Appears on: -SubscribableType, -ChannelStatus, -ChannelStatus, -ChannelableStatus, -InMemoryChannelStatus) -

    -

    -

    SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -subscribablestatus
    - - -SubscribableStatus - - -    		 -
    -

    SubscriberSpec -

    -

    -(Appears on: -Subscribable) -

    -

    -

    SubscriberSpec defines a single subscriber to a Subscribable. -Ref is a reference to the Subscription this SubscriberSpec was created for -SubscriberURI is the endpoint for the subscriber -ReplyURI is the endpoint for the reply -At least one of SubscriberURI and ReplyURI must be present

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -ref
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Deprecated: use UID.

    -
    -uid
    - -k8s.io/apimachinery/pkg/types.UID - -    		 -(Optional) -

    UID is used to understand the origin of the subscriber.

    -
    -generation
    - -int64 - -    		 -(Optional) -

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

    -
    -subscriberURI
    - -string - -    		 -(Optional) -
    -replyURI
    - -string - -    		 -(Optional) -
    -

    SubscriberStatus -

    -

    -(Appears on: -SubscribableStatus) -

    -

    -

    SubscriberStatus defines the status of a single subscriber to a Channel.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -uid
    - -k8s.io/apimachinery/pkg/types.UID - -    		 -(Optional) -

    UID is used to understand the origin of the subscriber.

    -
    -observedGeneration
    - -int64 - -    		 -(Optional) -

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

    -
    -ready
    - - -Kubernetes core/v1.ConditionStatus - - -    		 -(Optional) -

    Status of the subscriber.

    -
    -message
    - -string - -    		 -(Optional) -

    A human readable message indicating details of Ready status.

    -
    -
    -

    eventing.knative.dev/v1alpha1

    -

    -

    Package v1alpha1 is the v1alpha1 version of the API.

    -

    -Resource Types: - -

    Broker -

    -

    -

    Broker collects a pool of events that are consumable using Triggers. Brokers -provide a well-known endpoint for event delivery that senders can use with -minimal knowledge of the event routing strategy. Receivers use Triggers to -request delivery of events from a Broker’s pool to a specific URL or -Addressable endpoint.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		Broker
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -BrokerSpec - - -    		 -

    Spec defines the desired state of the Broker.

    -
    -
    - - - - - - - - - -
    -channelTemplate
    - - -ChannelSpec - - -    		 -(Optional) -

    DeprecatedChannelTemplate, if specified will be used to create all the Channels used internally by the -Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default -Channel CRD for the namespace will be used using the channelTemplateSpec attribute.

    -
    -channelTemplateSpec
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the -Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there -are no defaults for the namespace).

    -
    -
    -status
    - - -BrokerStatus - - -    		 -(Optional) -

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

    -
    -

    Channel -

    -

    -

    Channel is an abstract resource that implements the Addressable contract. -The Provisioner provisions infrastructure to accepts events and -deliver to Subscriptions.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		Channel
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ChannelSpec - - -    		 -

    Spec defines the desired state of the Channel.

    -
    -
    - - - - - - - - - - - - - - - - - -
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -provisioner
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Provisioner defines the name of the Provisioner backing this channel.

    -
    -arguments
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

    Arguments defines the arguments to pass to the Provisioner which -provisions this Channel.

    -
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -
    -status
    - - -ChannelStatus - - -    		 -(Optional) -

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

    -
    -

    ClusterChannelProvisioner -

    -

    -

    ClusterChannelProvisioner encapsulates a provisioning strategy for the -backing resources required to realize a particular resource type.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		ClusterChannelProvisioner
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -ClusterChannelProvisionerSpec - - -    		 -

    Spec defines the Types provisioned by this Provisioner.

    -
    -
    - - - - - -
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -
    -status
    - - -ClusterChannelProvisionerStatus - - -    		 -(Optional) -

    Status is the current status of the Provisioner.

    -
    -

    EventType -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		EventType
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -EventTypeSpec - - -    		 -

    Spec defines the desired state of the EventType.

    -
    -
    - - - - - - - - - - - - - - - - - - - - - -
    -type
    - -string - -    		 -

    Type represents the CloudEvents type. It is authoritative.

    -
    -source
    - -string - -    		 -

    Source is a URI, it represents the CloudEvents source.

    -
    -schema
    - -string - -    		 -(Optional) -

    Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional.

    -
    -broker
    - -string - -    		 -

    Broker refers to the Broker that can provide the EventType.

    -
    -description
    - -string - -    		 -(Optional) -

    Description is an optional field used to describe the EventType, in any meaningful way.

    -
    -
    -status
    - - -EventTypeStatus - - -    		 -(Optional) -

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

    -
    -

    Subscription -

    -

    -

    Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		Subscription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -SubscriptionSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - -
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

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

    -
    -subscriber
    - - -SubscriberSpec - - -    		 -(Optional) -

    Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a channel as specified by the Reply.

    -
    -reply
    - - -ReplyStrategy - - -    		 -(Optional) -

    Reply specifies (optionally) how to handle events returned from -the Subscriber target.

    -
    -
    -status
    - - -SubscriptionStatus - - -    		 -
    -

    Trigger -

    -

    -

    Trigger represents a request to have events delivered to a consumer from a -Broker’s event pool.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -apiVersion
    -string    		 - -eventing.knative.dev/v1alpha1 - -
    -kind
    -string -    		Trigger
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -(Optional) -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -TriggerSpec - - -    		 -

    Spec defines the desired state of the Trigger.

    -
    -
    - - - - - - - - - - - - - -
    -broker
    - -string - -    		 -

    Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

    -
    -filter
    - - -TriggerFilter - - -    		 -(Optional) -

    Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

    -
    -subscriber
    - - -SubscriberSpec - - -    		 -

    Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

    -
    -
    -status
    - - -TriggerStatus - - -    		 -(Optional) -

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

    -
    -

    BrokerSpec -

    -

    -(Appears on: -Broker) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -channelTemplate
    - - -ChannelSpec - - -    		 -(Optional) -

    DeprecatedChannelTemplate, if specified will be used to create all the Channels used internally by the -Broker. Only Provisioner and Arguments may be specified. If left unspecified, the default -Channel CRD for the namespace will be used using the channelTemplateSpec attribute.

    -
    -channelTemplateSpec
    - - -ChannelTemplateSpec - - -    		 -(Optional) -

    ChannelTemplate specifies which Channel CRD to use to create all the Channels used internally by the -Broker. If left unspecified, it is set to the default Channel CRD for the namespace (or cluster, in case there -are no defaults for the namespace).

    -
    -

    BrokerStatus -

    -

    -(Appears on: -Broker) -

    -

    -

    BrokerStatus represents the current state of a Broker.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -address
    - -knative.dev/pkg/apis/duck/v1alpha1.Addressable - -    		 -

    Broker is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster.

    -

    It generally has the form {broker}-router.{namespace}.svc.{cluster domain name}

    -
    -triggerChannel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    TriggerChannel is an objectref to the object for the TriggerChannel

    -
    -IngressChannel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    IngressChannel is an objectref to the object for the IngressChannel

    -
    -

    ChannelProvisionerDefaulter -

    -

    -

    ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not -specify any Provisioner.

    -

    -

    ChannelSpec -

    -

    -(Appears on: -Channel, -BrokerSpec) -

    -

    -

    ChannelSpec specifies the Provisioner backing a channel and the configuration -arguments for a Channel.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -provisioner
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

    Provisioner defines the name of the Provisioner backing this channel.

    -
    -arguments
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

    Arguments defines the arguments to pass to the Provisioner which -provisions this Channel.

    -
    -subscribable
    - - -Subscribable - - -    		 -

    Channel conforms to Duck type Subscribable.

    -
    -

    ChannelStatus -

    -

    -(Appears on: -Channel) -

    -

    -

    ChannelStatus represents the current state of a Channel.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -address
    - -knative.dev/pkg/apis/duck/v1alpha1.Addressable - -    		 -

    Channel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster.

    -

    It generally has the form {channel}.{namespace}.svc.{cluster domain name}

    -
    -internal
    - -k8s.io/apimachinery/pkg/runtime.RawExtension - -    		 -(Optional) -

    Internal is status unique to each ClusterChannelProvisioner.

    -
    -SubscribableTypeStatus
    - - -SubscribableTypeStatus - - -    		 -

    -(Members of SubscribableTypeStatus are embedded into this type.) -

    -
    -

    ClusterChannelProvisionerSpec -

    -

    -(Appears on: -ClusterChannelProvisioner) -

    -

    -

    ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -

    ClusterChannelProvisionerStatus -

    -

    -(Appears on: -ClusterChannelProvisioner) -

    -

    -

    ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -

    EventTypeSpec -

    -

    -(Appears on: -EventType) -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -type
    - -string - -    		 -

    Type represents the CloudEvents type. It is authoritative.

    -
    -source
    - -string - -    		 -

    Source is a URI, it represents the CloudEvents source.

    -
    -schema
    - -string - -    		 -(Optional) -

    Schema is a URI, it represents the CloudEvents schemaurl extension attribute. -It may be a JSON schema, a protobuf schema, etc. It is optional.

    -
    -broker
    - -string - -    		 -

    Broker refers to the Broker that can provide the EventType.

    -
    -description
    - -string - -    		 -(Optional) -

    Description is an optional field used to describe the EventType, in any meaningful way.

    -
    -

    EventTypeStatus -

    -

    -(Appears on: -EventType) -

    -

    -

    EventTypeStatus represents the current state of a EventType.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -

    HasSpec -

    -

    -

    -

    ReplyStrategy -

    -

    -(Appears on: -SubscriptionSpec) -

    -

    -

    ReplyStrategy specifies the handling of the SubscriberSpec’s returned replies. -If no SubscriberSpec is specified, the identity function is assumed.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference must meet the Addressable contract -with a reference to the Addressable duck type. If the resource does not meet this contract, -it will be reflected in the Subscription’s status.

    -
    -

    SubscriberSpec -

    -

    -(Appears on: -ChoiceCase, -SequenceSpec, -SubscriptionSpec, -TriggerSpec) -

    -

    -

    SubscriberSpec specifies the reference to an object that’s expected to -provide the resolved target of the action. -Currently we inspect the objects Status and see if there’s a predefined -Status field that we will then use to dispatch events to be processed by -the target. Currently must resolve to a k8s service. -Note that in the future we should try to utilize subresources (/resolve ?) to -make this cleaner, but CRDs do not support subresources yet, so we need -to rely on a specified Status field today. By relying on this behaviour -we can utilize a dynamic client instead of having to understand all -kinds of different types of objects. As long as they adhere to this -particular contract, they can be used as a Target.

    -

    This ensures that we can support external targets and for ease of use -we also allow for an URI to be specified. -There of course is also a requirement for the resolved SubscriberSpec to -behave properly at the data plane level. -TODO: Add a pointer to a real spec for this. -For now, this means: Receive an event payload, and respond with one of: -success and an optional response event, or failure. -Delivery failures may be retried by the channel

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -ref
    - - -Kubernetes core/v1.ObjectReference - - -    		 -(Optional) -

    Reference to an object that will be used to find the target -endpoint, which should implement the Addressable duck type. -For example, this could be a reference to a Route resource -or a Knative Service resource. -TODO: Specify the required fields the target object must -have in the status. -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name

    -
    -dnsName
    - -string - -    		 -(Optional) -

    Deprecated: Use URI instead. -Reference to a ‘known’ endpoint where no resolving is done. -http://k8s-service for example -http://myexternalhandler.example.com/foo/bar

    -
    -uri
    - -string - -    		 -(Optional) -

    Reference to a ‘known’ endpoint where no resolving is done. -http://k8s-service for example -http://myexternalhandler.example.com/foo/bar

    -
    -

    SubscriptionSpec -

    -

    -(Appears on: -Subscription) -

    -

    -

    SubscriptionSpec specifies the Channel for incoming events, a Subscriber target -for processing those events and where to put the result of the processing. Only -From (where the events are coming from) is always required. You can optionally -only Process the events (results in no output events) by leaving out the Result. -You can also perform an identity transformation on the incoming events by leaving -out the Subscriber and only specifying Result.

    -

    The following are all valid specifications: -channel –[subscriber]–> reply -Sink, no outgoing events: -channel – subscriber -no-op function (identity transformation): -channel –> reply

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -generation
    - -int64 - -    		 -(Optional) -

    TODO By enabling the status subresource metadata.generation should increment -thus making this property obsolete.

    -

    We should be able to drop this property with a CRD conversion webhook -in the future

    -
    -channel
    - - -Kubernetes core/v1.ObjectReference - - -    		 -

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

    -
    -subscriber
    - - -SubscriberSpec - - -    		 -(Optional) -

    Subscriber is reference to (optional) function for processing events. -Events from the Channel will be delivered here and replies are -sent to a channel as specified by the Reply.

    -
    -reply
    - - -ReplyStrategy - - -    		 -(Optional) -

    Reply specifies (optionally) how to handle events returned from -the Subscriber target.

    -
    -

    SubscriptionStatus -

    -

    -(Appears on: -Subscription) -

    -

    -

    SubscriptionStatus (computed) for a subscription

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -physicalSubscription
    - - -SubscriptionStatusPhysicalSubscription - - -    		 -

    PhysicalSubscription is the fully resolved values that this Subscription represents.

    -
    -

    SubscriptionStatusPhysicalSubscription -

    -

    -(Appears on: -SubscriptionStatus) -

    -

    -

    SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -subscriberURI
    - -string - -    		 -

    SubscriberURI is the fully resolved URI for spec.subscriber.

    -
    -replyURI
    - -string - -    		 -

    ReplyURI is the fully resolved URI for the spec.reply.

    -
    -

    TriggerFilter -

    -

    -(Appears on: -TriggerSpec) -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -sourceAndType
    - - -TriggerFilterSourceAndType - - -    		 -(Optional) -

    DeprecatedSourceAndType filters events based on exact matches on the -CloudEvents type and source attributes. This field has been replaced by the -Attributes field.

    -
    -attributes
    - - -TriggerFilterAttributes - - -    		 -(Optional) -

    Attributes filters events by exact match on event context attributes. -Each key in the map is compared with the equivalent key in the event -context. An event passes the filter if all values are equal to the -specified values.

    -

    Nested context attributes are not supported as keys. Only string values are supported.

    -
    -

    TriggerFilterAttributes -(map[string]string alias)

    -

    -(Appears on: -TriggerFilter) -

    -

    -

    TriggerFilterAttributes is a map of context attribute names to values for -filtering by equality. Only exact matches will pass the filter. You can use the value “ -to indicate all strings match.

    -

    -

    TriggerFilterSourceAndType -

    -

    -(Appears on: -TriggerFilter) -

    -

    -

    TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and -source attributes. Only exact matches will pass the filter. Either or both type and source can -use the value “ to indicate all strings match.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -type
    - -string - -    		 -
    -source
    - -string - -    		 -
    -

    TriggerSpec -

    -

    -(Appears on: -Trigger) -

    -

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -broker
    - -string - -    		 -

    Broker is the broker that this trigger receives events from. If not specified, will default -to ‘default’.

    -
    -filter
    - - -TriggerFilter - - -    		 -(Optional) -

    Filter is the filter to apply against all events from the Broker. Only events that pass this -filter will be sent to the Subscriber. If not specified, will default to allowing all events.

    -
    -subscriber
    - - -SubscriberSpec - - -    		 -

    Subscriber is the addressable that receives events from the Broker that pass the Filter. It -is required.

    -
    -

    TriggerStatus -

    -

    -(Appears on: -Trigger) -

    -

    -

    TriggerStatus represents the current state of a Trigger.

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -Status
    - -knative.dev/pkg/apis/duck/v1beta1.Status - -    		 -

    -(Members of Status are embedded into this type.) -

    -

    inherits duck/v1beta1 Status, 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.

    -
    -subscriberURI
    - -string - -    		 -

    SubscriberURI is the resolved URI of the receiver for this Trigger.

    -
    -
    -

    -Generated with gen-crd-api-reference-docs -on git commit a59dae6f. -

    + +

    See the Knative Eventing repo for the API.

    + +

    There is currently an [API doc build tool issue](https://github.com/knative/docs/issues/1661) that we hope to resolve soon.

    diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 46b35b7aa..6427f632c 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,4 +1,4 @@ -

    See the Knative Serving repo for the v0.8 API.

    +

    See the Knative Serving repo for the API.

    -

    There is currently an API doc build tool issue that we hope to resolve soon.

    +

    There is currently an [API doc build tool issue](https://github.com/knative/docs/issues/1661) that we hope to resolve soon.

    diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index ad8dbf1c1..f6014acdc 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -33,9 +33,9 @@ KNATIVE_EVENTING_REPO="github.com/knative/eventing" KNATIVE_EVENTING_COMMIT="${KNATIVE_EVENTING_COMMIT:?specify the \$KNATIVE_EVENTING_COMMIT variable}" KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md" -KNATIVE_EVENTING_RESOURCES_REPO="github.com/knative/eventing-contrib" -KNATIVE_EVENTING_RESOURCES_COMMIT="${KNATIVE_EVENTING_RESOURCES_COMMIT:?specify the \$KNATIVE_EVENTING_RESOURCES_COMMIT variable}" -KNATIVE_EVENTING_RESOURCES_OUT_FILE="eventing/eventing-contrib-resources.md" +KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib" +KNATIVE_EVENTING_CONTRIB_COMMIT="${KNATIVE_EVENTING_CONTRIB_COMMIT:?specify the \$KNATIVE_EVENTING_CONTRIB_COMMIT variable}" +KNATIVE_EVENTING_CONTRIB_OUT_FILE="eventing/eventing-contrib.md" cleanup_refdocs_root= cleanup_repo_clone_root= @@ -163,12 +163,12 @@ main() { gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ "${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}" "./pkg/apis" - local knative_eventing_resources_root - knative_eventing_resources_root="${clone_root}/src/${KNATIVE_EVENTING_RESOURCES_REPO}" - clone_at_commit "https://${KNATIVE_EVENTING_RESOURCES_REPO}.git" "${KNATIVE_EVENTING_RESOURCES_COMMIT}" \ - "${knative_eventing_resources_root}" + local knative_eventing_contrib_root + knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_REPO}" + clone_at_commit "https://${KNATIVE_EVENTING_CONTRIB_REPO}.git" "${KNATIVE_EVENTING_CONTRIB_COMMIT}" \ + "${knative_eventing_contrib_root}" gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ - "${out_dir}/${KNATIVE_EVENTING_RESOURCES_OUT_FILE}" "${knative_eventing_resources_root}" "." + "${out_dir}/${KNATIVE_EVENTING_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "." log "SUCCESS: Generated docs written to ${out_dir}/." log "Opening the ${out_dir}/ directory. You can now copy these API files"