From 40776cc069de666b9519cf4eef867612f311c45c Mon Sep 17 00:00:00 2001 From: RichieEscarez Date: Wed, 18 Nov 2020 14:39:52 -0800 Subject: [PATCH] Update API build and generate 0.19 API docs (#3043) * remove eventing-contrib * update gen-crd-api-reference-docs version to fix API build errors * API docs build for 0.19 * revert API version and add troubleshooting docs * revert file * remove whitespace * Update docs/reference/api/README.md Co-authored-by: Mike Petersen * add more detail * and now fix my typo Co-authored-by: Mike Petersen --- docs/reference/api/README.md | 23 +- .../api/eventing/eventing-contrib-api.md | 10 - .../api/eventing/eventing-contrib.md | 2046 ---- docs/reference/api/eventing/eventing.md | 8417 +++++++++-------- docs/reference/api/serving.md | 914 +- hack/gen-api-reference-docs.sh | 22 +- 6 files changed, 5546 insertions(+), 5886 deletions(-) delete mode 100644 docs/reference/api/eventing/eventing-contrib-api.md delete mode 100644 docs/reference/api/eventing/eventing-contrib.md diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index eea887d18..64775c8b8 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -9,7 +9,6 @@ The API source files are located at: - [Serving API](./serving.md) - [Eventing API](./eventing/eventing.md) -- [Eventing-contrib resources API](./eventing/eventing-contrib.md) ## Updating API Reference docs (for Knative maintainers) @@ -57,7 +56,6 @@ To generate a version of the API: - [Serving](https://github.com/knative/serving/releases/) - [Eventing](https://github.com/knative/eventing/releases/) - - [Eventing-contrib resources](https://github.com/knative/eventing-contrib/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 @@ -68,7 +66,6 @@ To generate a version of the API: KNATIVE_SERVING_COMMIT=[commit_or_tag] \ KNATIVE_EVENTING_COMMIT=[commit_or_tag] \ - KNATIVE_EVENTING_CONTRIB_COMMIT=[commit_or_tag] \ ./gen-api-reference-docs.sh ``` @@ -82,6 +79,25 @@ To generate a version of the API: After a successful build, the tool automatically opens that folder in the `tmp` directory. + If the script fails, there are a couple possible causes. + + * If you get the + `F1116 15:21:23.549503 63473 main.go:129] no API packages found in ./pkg/apis` + error, check if a new version of the script is available: + https://github.com/ahmetb/gen-crd-api-reference-docs/tags + + The script is kept up-to-date with changes that go into the Kubernetes API. + As Knative adds support for those APIs, you might need to make sure the + corresponding + [script `gen-crd-api-reference-docs` version](https://github.com/knative/docs/blob/master/hack/gen-api-reference-docs.sh#L26) + is used. + + * If you get the + `F0807 13:58:20.621526 168834 main.go:444] type invalid type has kind=Unsupported which is unhandled` + error, the import target might have moved. There might be other causes for that error but view + [#2054](https://github.com/knative/docs/pull/2054) (and the linked Issues) for details about how we handled that error + in the past. + 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. @@ -107,6 +123,5 @@ v0.18.0 API source files: ``` KNATIVE_SERVING_COMMIT=v0.18.0 \ KNATIVE_EVENTING_COMMIT=v0.18.0 \ -KNATIVE_EVENTING_CONTRIB_COMMIT=v0.18.0 \ ./gen-api-reference-docs.sh ``` diff --git a/docs/reference/api/eventing/eventing-contrib-api.md b/docs/reference/api/eventing/eventing-contrib-api.md deleted file mode 100644 index a2b959d03..000000000 --- a/docs/reference/api/eventing/eventing-contrib-api.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Eventing-contrib Resources" -linkTitle: "Eventing-contrib API" -weight: 50 -type: "docs" -aliases: - - /docs/reference/eventing/eventing-contrib-api ---- - -{{< readfile file="eventing-contrib.md" >}} diff --git a/docs/reference/api/eventing/eventing-contrib.md b/docs/reference/api/eventing/eventing-contrib.md deleted file mode 100644 index 9c483372d..000000000 --- a/docs/reference/api/eventing/eventing-contrib.md +++ /dev/null @@ -1,2046 +0,0 @@ -

Packages:

- -

sources.knative.dev/v1beta1

-

-

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

-

-Resource Types: -
    -

    KafkaLimitsSpec -

    -

    -(Appears on: -KafkaResourceSpec) -

    -

    -

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

    KafkaRequestsSpec -

    -

    -(Appears on: -KafkaResourceSpec) -

    -

    -

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

    KafkaResourceSpec -

    -

    -

    - - - - - - - - - - - - - - - - - -
    FieldDescription
    -requests
    - - -KafkaRequestsSpec - - -    		 -
    -limits
    - - -KafkaLimitsSpec - - -    		 -
    -

    KafkaSource -

    -

    -

    KafkaSource is the Schema for the kafkasources API.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -metadata
    - - -Kubernetes meta/v1.ObjectMeta - - -    		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
    -spec
    - - -KafkaSourceSpec - - -    		 -
    -
    - - - - - - - - - - - - - - - - - -
    -KafkaAuthSpec
    - - -KafkaAuthSpec - - -    		 -

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

    -
    -topics
    - -[]string - -    		 -

    Topic topics to consume messages from

    -
    -consumerGroup
    - -string - -    		 -(Optional) -

    ConsumerGroupID is the consumer group ID.

    -
    -SourceSpec
    - -knative.dev/pkg/apis/duck/v1.SourceSpec - -    		 -

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

    -

    inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

    -
    -
    -status
    - - -KafkaSourceStatus - - -    		 -
    -

    KafkaSourceSpec -

    -

    -(Appears on: -KafkaSource) -

    -

    -

    KafkaSourceSpec defines the desired state of the KafkaSource.

    -

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -KafkaAuthSpec
    - - -KafkaAuthSpec - - -    		 -

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

    -
    -topics
    - -[]string - -    		 -

    Topic topics to consume messages from

    -
    -consumerGroup
    - -string - -    		 -(Optional) -

    ConsumerGroupID is the consumer group ID.

    -
    -SourceSpec
    - -knative.dev/pkg/apis/duck/v1.SourceSpec - -    		 -

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

    -

    inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

    -
    -

    KafkaSourceStatus -

    -

    -(Appears on: -KafkaSource) -

    -

    -

    KafkaSourceStatus defines the observed state of KafkaSource.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -SourceStatus
    - -knative.dev/pkg/apis/duck/v1.SourceStatus - -    		 -

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

    -

    inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

    -
    -
    -

    messaging.knative.dev/v1alpha1

    -

    -

    Package v1alpha1 is the v1alpha1 version of the API.

    -

    -Resource Types: - -

    KafkaChannel -

    -

    -

    KafkaChannel is a resource representing a Kafka Channel.

    -

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

    Spec defines the desired state of the Channel.

    -
    -
    - - - - - - - - - - - - - -
    -numPartitions
    - -int32 - -    		 -

    NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

    -
    -replicationFactor
    - -int16 - -    		 -

    ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

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

    KafkaChannel conforms to Duck type Subscribable.

    -
    -
    -status
    - - -KafkaChannelStatus - - -    		 -(Optional) -

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

    -
    -

    KafkaChannelSpec -

    -

    -(Appears on: -KafkaChannel) -

    -

    -

    KafkaChannelSpec defines the specification for a KafkaChannel.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -numPartitions
    - -int32 - -    		 -

    NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

    -
    -replicationFactor
    - -int16 - -    		 -

    ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

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

    KafkaChannel conforms to Duck type Subscribable.

    -
    -

    KafkaChannelStatus -

    -

    -(Appears on: -KafkaChannel) -

    -

    -

    KafkaChannelStatus represents the current state of a KafkaChannel.

    -

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

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

    -

    inherits duck/v1 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.) -

    -

    KafkaChannel 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 - -    		 -

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

    -

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

    -
    -
    -

    messaging.knative.dev/v1beta1

    -

    -

    Package v1beta1 is the v1beta1 version of the API.

    -

    -Resource Types: - -

    KafkaChannel -

    -

    -

    KafkaChannel is a resource representing a Kafka Channel.

    -

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

    Spec defines the desired state of the Channel.

    -
    -
    - - - - - - - - - - - - - -
    -numPartitions
    - -int32 - -    		 -

    NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

    -
    -replicationFactor
    - -int16 - -    		 -

    ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

    -
    -ChannelableSpec
    - -knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec - -    		 -

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

    -

    Channel conforms to Duck type Channelable.

    -
    -
    -status
    - - -KafkaChannelStatus - - -    		 -(Optional) -

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

    -
    -

    KafkaChannelSpec -

    -

    -(Appears on: -KafkaChannel) -

    -

    -

    KafkaChannelSpec defines the specification for a KafkaChannel.

    -

    - - - - - - - - - - - - - - - - - - - - - -
    FieldDescription
    -numPartitions
    - -int32 - -    		 -

    NumPartitions is the number of partitions of a Kafka topic. By default, it is set to 1.

    -
    -replicationFactor
    - -int16 - -    		 -

    ReplicationFactor is the replication factor of a Kafka topic. By default, it is set to 1.

    -
    -ChannelableSpec
    - -knative.dev/eventing/pkg/apis/duck/v1.ChannelableSpec - -    		 -

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

    -

    Channel conforms to Duck type Channelable.

    -
    -

    KafkaChannelStatus -

    -

    -(Appears on: -KafkaChannel) -

    -

    -

    KafkaChannelStatus represents the current state of a KafkaChannel.

    -

    - - - - - - - - - - - - - -
    FieldDescription
    -ChannelableStatus
    - -knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus - -    		 -

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

    -

    Channel conforms to Duck type Channelable.

    -
    -
    -

    bindings.knative.dev/v1alpha1

    -

    -

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

    -

    -Resource Types: -
      -

      KafkaAuthSpec -

      -

      -(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -

      -

      -

      - - - - - - - - - - - - - - - - - -
      FieldDescription
      -bootstrapServers
      - -[]string - -      		 -

      Bootstrap servers are the Kafka servers the consumer will connect to.

      -
      -net
      - - -KafkaNetSpec - - -      		 -
      -

      KafkaBinding -

      -

      -

      KafkaBinding is the Schema for the kafkasources API.

      -

      - - - - - - - - - - - - - - - - - - - - - -
      FieldDescription
      -metadata
      - - -Kubernetes meta/v1.ObjectMeta - - -      		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
      -spec
      - - -KafkaBindingSpec - - -      		 -
      -
      - - - - - - - - - -
      -BindingSpec
      - -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -      		 -

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

      -
      -KafkaAuthSpec
      - - -KafkaAuthSpec - - -      		 -

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

      -
      -
      -status
      - - -KafkaBindingStatus - - -      		 -
      -

      KafkaBindingSpec -

      -

      -(Appears on: -KafkaBinding) -

      -

      -

      KafkaBindingSpec defines the desired state of the KafkaBinding.

      -

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

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

      -
      -KafkaAuthSpec
      - - -KafkaAuthSpec - - -      		 -

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

      -
      -

      KafkaBindingStatus -

      -

      -(Appears on: -KafkaBinding) -

      -

      -

      KafkaBindingStatus defines the observed state of KafkaBinding.

      -

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

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

      -
      -

      KafkaNetSpec -

      -

      -(Appears on: -KafkaAuthSpec) -

      -

      -

      - - - - - - - - - - - - - - - - - -
      FieldDescription
      -sasl
      - - -KafkaSASLSpec - - -      		 -
      -tls
      - - -KafkaTLSSpec - - -      		 -
      -

      KafkaSASLSpec -

      -

      -(Appears on: -KafkaNetSpec) -

      -

      -

      - - - - - - - - - - - - - - - - - - - - - -
      FieldDescription
      -enable
      - -bool - -      		 -
      -user
      - - -SecretValueFromSource - - -      		 -(Optional) -

      User is the Kubernetes secret containing the SASL username.

      -
      -password
      - - -SecretValueFromSource - - -      		 -(Optional) -

      Password is the Kubernetes secret containing the SASL password.

      -
      -

      KafkaTLSSpec -

      -

      -(Appears on: -KafkaNetSpec) -

      -

      -

      - - - - - - - - - - - - - - - - - - - - - - - - - -
      FieldDescription
      -enable
      - -bool - -      		 -
      -cert
      - - -SecretValueFromSource - - -      		 -(Optional) -

      Cert is the Kubernetes secret containing the client certificate.

      -
      -key
      - - -SecretValueFromSource - - -      		 -(Optional) -

      Key is the Kubernetes secret containing the client key.

      -
      -caCert
      - - -SecretValueFromSource - - -      		 -(Optional) -

      CACert is the Kubernetes secret containing the server CA cert.

      -
      -

      SecretValueFromSource -

      -

      -(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -

      -

      -

      SecretValueFromSource represents the source of a secret value

      -

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

      The Secret key to select from.

      -
      -
      -

      bindings.knative.dev/v1beta1

      -

      -

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

      -

      -Resource Types: -
        -

        KafkaAuthSpec -

        -

        -(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -

        -

        -

        - - - - - - - - - - - - - - - - - -
        FieldDescription
        -bootstrapServers
        - -[]string - -        		 -

        Bootstrap servers are the Kafka servers the consumer will connect to.

        -
        -net
        - - -KafkaNetSpec - - -        		 -
        -

        KafkaBinding -

        -

        -

        KafkaBinding is the Schema for the kafkasources API.

        -

        - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -spec
        - - -KafkaBindingSpec - - -        		 -
        -
        - - - - - - - - - -
        -BindingSpec
        - -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec - -        		 -

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

        -
        -KafkaAuthSpec
        - - -KafkaAuthSpec - - -        		 -

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

        -
        -
        -status
        - - -KafkaBindingStatus - - -        		 -
        -

        KafkaBindingSpec -

        -

        -(Appears on: -KafkaBinding) -

        -

        -

        KafkaBindingSpec defines the desired state of the KafkaBinding.

        -

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

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

        -
        -KafkaAuthSpec
        - - -KafkaAuthSpec - - -        		 -

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

        -
        -

        KafkaBindingStatus -

        -

        -(Appears on: -KafkaBinding) -

        -

        -

        KafkaBindingStatus defines the observed state of KafkaBinding.

        -

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

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

        -
        -

        KafkaNetSpec -

        -

        -(Appears on: -KafkaAuthSpec) -

        -

        -

        - - - - - - - - - - - - - - - - - -
        FieldDescription
        -sasl
        - - -KafkaSASLSpec - - -        		 -
        -tls
        - - -KafkaTLSSpec - - -        		 -
        -

        KafkaSASLSpec -

        -

        -(Appears on: -KafkaNetSpec) -

        -

        -

        - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -enable
        - -bool - -        		 -
        -user
        - - -SecretValueFromSource - - -        		 -(Optional) -

        User is the Kubernetes secret containing the SASL username.

        -
        -password
        - - -SecretValueFromSource - - -        		 -(Optional) -

        Password is the Kubernetes secret containing the SASL password.

        -
        -

        KafkaTLSSpec -

        -

        -(Appears on: -KafkaNetSpec) -

        -

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -enable
        - -bool - -        		 -
        -cert
        - - -SecretValueFromSource - - -        		 -(Optional) -

        Cert is the Kubernetes secret containing the client certificate.

        -
        -key
        - - -SecretValueFromSource - - -        		 -(Optional) -

        Key is the Kubernetes secret containing the client key.

        -
        -caCert
        - - -SecretValueFromSource - - -        		 -(Optional) -

        CACert is the Kubernetes secret containing the server CA cert.

        -
        -

        SecretValueFromSource -

        -

        -(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -

        -

        -

        SecretValueFromSource represents the source of a secret value

        -

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

        The Secret key to select from.

        -
        -
        -

        sources.knative.dev/v1alpha1

        -

        -

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

        -

        -Resource Types: -
          -

          KafkaLimitsSpec -

          -

          -(Appears on: -KafkaResourceSpec) -

          -

          -

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

          KafkaRequestsSpec -

          -

          -(Appears on: -KafkaResourceSpec) -

          -

          -

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

          KafkaResourceSpec -

          -

          -(Appears on: -KafkaSourceSpec) -

          -

          -

          - - - - - - - - - - - - - - - - - -
          FieldDescription
          -requests
          - - -KafkaRequestsSpec - - -          		 -
          -limits
          - - -KafkaLimitsSpec - - -          		 -
          -

          KafkaSource -

          -

          -

          KafkaSource is the Schema for the kafkasources API.

          -

          - - - - - - - - - - - - - - - - - - - - - -
          FieldDescription
          -metadata
          - - -Kubernetes meta/v1.ObjectMeta - - -          		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
          -spec
          - - -KafkaSourceSpec - - -          		 -
          -
          - - - - - - - - - - - - - - - - - - - - - - - - - -
          -KafkaAuthSpec
          - - -KafkaAuthSpec - - -          		 -

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

          -
          -topics
          - -[]string - -          		 -

          Topic topics to consume messages from

          -
          -consumerGroup
          - -string - -          		 -(Optional) -

          ConsumerGroupID is the consumer group ID.

          -
          -sink
          - -knative.dev/pkg/apis/duck/v1.Destination - -          		 -(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. -Deprecated: v1beta1 drops this field.

          -
          -resources
          - - -KafkaResourceSpec - - -          		 -

          Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

          -
          -
          -status
          - - -KafkaSourceStatus - - -          		 -
          -

          KafkaSourceSpec -

          -

          -(Appears on: -KafkaSource) -

          -

          -

          KafkaSourceSpec defines the desired state of the KafkaSource.

          -

          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          FieldDescription
          -KafkaAuthSpec
          - - -KafkaAuthSpec - - -          		 -

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

          -
          -topics
          - -[]string - -          		 -

          Topic topics to consume messages from

          -
          -consumerGroup
          - -string - -          		 -(Optional) -

          ConsumerGroupID is the consumer group ID.

          -
          -sink
          - -knative.dev/pkg/apis/duck/v1.Destination - -          		 -(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. -Deprecated: v1beta1 drops this field.

          -
          -resources
          - - -KafkaResourceSpec - - -          		 -

          Resource limits and Request specifications of the Receive Adapter Deployment -Deprecated: v1beta1 drops this field.

          -
          -

          KafkaSourceStatus -

          -

          -(Appears on: -KafkaSource) -

          -

          -

          KafkaSourceStatus defines the observed state of KafkaSource.

          -

          - - - - - - - - - - - - - -
          FieldDescription
          -SourceStatus
          - -knative.dev/pkg/apis/duck/v1.SourceStatus - -          		 -

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

          -

          inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

          -
          -
          -

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

          diff --git a/docs/reference/api/eventing/eventing.md b/docs/reference/api/eventing/eventing.md index 7447acb08..996ab92f4 100644 --- a/docs/reference/api/eventing/eventing.md +++ b/docs/reference/api/eventing/eventing.md @@ -4,39 +4,42 @@ duck.knative.dev/v1
        • +duck.knative.dev/v1alpha1 +
          • +
        • duck.knative.dev/v1beta1
        • +flows.knative.dev/v1beta1 +
          • +
        • +sources.knative.dev/v1beta1 +
          • +
        • eventing.knative.dev/v1
        • +sources.knative.dev/v1 +
          • +
        • +sources.knative.dev/v1alpha1 +
          • +
        • eventing.knative.dev/v1beta1
        • messaging.knative.dev/v1
        • -sources.knative.dev/v1alpha1 -
          • -
        • -sources.knative.dev/v1beta1 +messaging.knative.dev/v1beta1
        • configs.internal.knative.dev/v1alpha1
        • -duck.knative.dev/v1alpha1 -
          • -
        • flows.knative.dev/v1
        • -flows.knative.dev/v1beta1 -
          • -
        • -messaging.knative.dev/v1beta1 -
          • -
        • sources.knative.dev/v1alpha2
          • @@ -350,8 +353,8 @@ string 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 the time interval between retries. -For exponential policy , backoff delay is backoffDelay*2^.

          +

          For linear policy, backoff delay is backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

          @@ -678,6 +681,827 @@ string
          +

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

            +
            +delivery
            + + +DeliverySpec + + +            		 +(Optional) +

            DeliverySpec contains options controlling the event delivery

            +
            +
            +status
            + + +ChannelableStatus + + +            		 +
            +

            ChannelableCombined +

            +

            +

            ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of +v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is +only used by Subscription Controller to synthesize patches and read the Status +of the Channelable Resources. +This is not a real resource.

            +

            + + + + + + + + + + + + + + + + + + + + + +
            FieldDescription
            +metadata
            + + +Kubernetes meta/v1.ObjectMeta + + +            		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
            +spec
            + + +ChannelableCombinedSpec + + +            		 +

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

            +
            +
            + + + + + + + + + + + + + +
            +SubscribableTypeSpec
            + + +SubscribableTypeSpec + + +            		 +

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

            +

            SubscribableTypeSpec is for the v1alpha1 spec compatibility.

            +
            +SubscribableSpec
            + + +SubscribableSpec + + +            		 +

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

            +

            SubscribableSpec is for the v1beta1 spec compatibility.

            +
            +delivery
            + + +DeliverySpec + + +            		 +(Optional) +

            DeliverySpec contains options controlling the event delivery

            +
            +
            +status
            + + +ChannelableCombinedStatus + + +            		 +
            +

            ChannelableCombinedSpec +

            +

            +(Appears on: +ChannelableCombined) +

            +

            +

            ChannelableSpec contains Spec of the Channelable object

            +

            + + + + + + + + + + + + + + + + + + + + + +
            FieldDescription
            +SubscribableTypeSpec
            + + +SubscribableTypeSpec + + +            		 +

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

            +

            SubscribableTypeSpec is for the v1alpha1 spec compatibility.

            +
            +SubscribableSpec
            + + +SubscribableSpec + + +            		 +

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

            +

            SubscribableSpec is for the v1beta1 spec compatibility.

            +
            +delivery
            + + +DeliverySpec + + +            		 +(Optional) +

            DeliverySpec contains options controlling the event delivery

            +
            +

            ChannelableCombinedStatus +

            +

            +(Appears on: +ChannelableCombined) +

            +

            +

            ChannelableStatus contains the Status of a Channelable object.

            +

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

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

            +

            inherits duck/v1 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.) +

            +

            SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

            +
            +SubscribableStatus
            + + +SubscribableStatus + + +            		 +

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

            +

            SubscribableStatus is the v1beta1 part of the Subscribers status.

            +
            +errorChannel
            + + +Kubernetes core/v1.ObjectReference + + +            		 +(Optional) +

            ErrorChannel is set by the channel when it supports native error handling via a channel

            +
            +

            ChannelableSpec +

            +

            +(Appears on: +Channelable) +

            +

            +

            ChannelableSpec contains Spec of the Channelable object

            +

            + + + + + + + + + + + + + + + + + +
            FieldDescription
            +SubscribableTypeSpec
            + + +SubscribableTypeSpec + + +            		 +

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

            +
            +delivery
            + + +DeliverySpec + + +            		 +(Optional) +

            DeliverySpec contains options controlling the event delivery

            +
            +

            ChannelableStatus +

            +

            +(Appears on: +Channelable) +

            +

            +

            ChannelableStatus contains the Status of a Channelable object.

            +

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

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

            +

            inherits duck/v1 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.

            +
            +errorChannel
            + + +Kubernetes core/v1.ObjectReference + + +            		 +(Optional) +

            ErrorChannel is set by the channel when it supports native error handling via a channel

            +
            +

            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
            +metadata
            + + +Kubernetes meta/v1.ObjectMeta + + +            		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
            +

            Subscribable +

            +

            +(Appears on: +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.

            +
            +

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

            +
            +

            SubscribableTypeSpec +

            +

            +(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) +

            +

            +

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

            +

            + + + + + + + + + + + + + +
            FieldDescription
            +subscribable
            + + +Subscribable + + +            		 +
            +

            SubscribableTypeStatus +

            +

            +(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType) +

            +

            +

            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
            +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
            + +knative.dev/pkg/apis.URL + +            		 +(Optional) +
            +replyURI
            + +knative.dev/pkg/apis.URL + +            		 +(Optional) +
            +deadLetterSink
            + +knative.dev/pkg/apis.URL + +            		 +(Optional) +
            +delivery
            + + +DeliverySpec + + +            		 +(Optional) +
            +

            duck.knative.dev/v1beta1

            Package v1beta1 is the v1beta1 version of the API.

            @@ -991,8 +1815,8 @@ string 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 the time interval between retries. -For exponential policy , backoff delay is backoffDelay*2^.

            +

            For linear policy, backoff delay is backoffDelay*. +For exponential policy, backoff delay is backoffDelay*2^.

            @@ -1256,8 +2080,8 @@ DeliverySpec

            (Appears on: -SubscribableStatus, -SubscribableStatus) +SubscribableStatus, +SubscribableStatus)

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

            @@ -1322,6 +2146,1888 @@ string
            +

            flows.knative.dev/v1beta1

            +

            +

            Package v1beta1 is the v1beta1 version of the API.

            +

            +Resource Types: +
              +

              Parallel +

              +

              +

              Parallel 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
              + + +ParallelSpec + + +              		 +

              Spec defines the desired state of the Parallel.

              +
              +
              + + + + + + + + + + + + + +
              +branches
              + + +[]ParallelBranch + + +              		 +

              Branches is the list of Filter/Subscribers pairs.

              +
              +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
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(Optional) +

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

              +
              +
              +status
              + + +ParallelStatus + + +              		 +(Optional) +

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

              +
              +

              ParallelBranch +

              +

              +(Appears on: +ParallelSpec) +

              +

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +filter
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(Optional) +

              Filter is the expression guarding the branch

              +
              +subscriber
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +

              Subscriber receiving the event when the filter passes

              +
              +reply
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(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 Parallel Reply

              +
              +delivery
              + + +DeliverySpec + + +              		 +(Optional) +

              Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc. +Needed for Roundtripping v1alpha1 <-> v1beta1.

              +
              +

              ParallelBranchStatus +

              +

              +(Appears on: +ParallelStatus) +

              +

              +

              ParallelBranchStatus represents the current state of a Parallel branch

              +

              + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +filterSubscriptionStatus
              + + +ParallelSubscriptionStatus + + +              		 +

              FilterSubscriptionStatus corresponds to the filter subscription status.

              +
              +filterChannelStatus
              + + +ParallelChannelStatus + + +              		 +

              FilterChannelStatus corresponds to the filter channel status.

              +
              +subscriberSubscriptionStatus
              + + +ParallelSubscriptionStatus + + +              		 +

              SubscriptionStatus corresponds to the subscriber subscription status.

              +
              +

              ParallelChannelStatus +

              +

              +(Appears on: +ParallelBranchStatus, +ParallelStatus) +

              +

              +

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

              +
              +

              ParallelSpec +

              +

              +(Appears on: +Parallel) +

              +

              +

              + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +branches
              + + +[]ParallelBranch + + +              		 +

              Branches is the list of Filter/Subscribers pairs.

              +
              +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
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(Optional) +

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

              +
              +

              ParallelStatus +

              +

              +(Appears on: +Parallel) +

              +

              +

              ParallelStatus represents the current state of a Parallel.

              +

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

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

              +

              inherits duck/v1 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
              + + +ParallelChannelStatus + + +              		 +

              IngressChannelStatus corresponds to the ingress channel status.

              +
              +branchStatuses
              + + +[]ParallelBranchStatus + + +              		 +

              BranchStatuses is an array of corresponding to branch statuses. +Matches the Spec.Branches array in the order.

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

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

              +

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

              +
              +

              ParallelSubscriptionStatus +

              +

              +(Appears on: +ParallelBranchStatus) +

              +

              +

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

              +
              +

              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
              + + +[]SequenceStep + + +              		 +

              Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options

              +
              +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
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(Optional) +

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

              +
              +
              +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
              + + +[]SequenceStep + + +              		 +

              Steps is the list of Destinations (processors / functions) that will be called in the order +provided. Each step has its own delivery options

              +
              +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
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +(Optional) +

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

              +
              +

              SequenceStatus +

              +

              +(Appears on: +Sequence) +

              +

              +

              SequenceStatus represents the current state of a Sequence.

              +

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

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

              +

              inherits duck/v1 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/v1.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}

              +
              +

              SequenceStep +

              +

              +(Appears on: +SequenceSpec) +

              +

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +Destination
              + +knative.dev/pkg/apis/duck/v1.Destination + +              		 +

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

              +

              Subscriber receiving the step event

              +
              +delivery
              + + +DeliverySpec + + +              		 +(Optional) +

              Delivery is the delivery specification for events to the subscriber +This includes things like retries, DLQ, etc.

              +
              +

              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.knative.dev/v1beta1

              +

              +

              Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.

              +

              +Resource Types: + +

              ApiServerSource +

              +

              +

              ApiServerSource is the Schema for the apiserversources API

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1beta1 + +
              +kind
              +string +              		ApiServerSource
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +ApiServerSourceSpec + + +              		 +
              +
              + + + + + + + + + + + + + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +resources
              + + +[]APIVersionKindSelector + + +              		 +

              Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +mode
              + +string + +              		 +(Optional) +

              EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

              +
              +serviceAccountName
              + +string + +              		 +(Optional) +

              ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

              +
              +
              +status
              + + +ApiServerSourceStatus + + +              		 +
              +

              ContainerSource +

              +

              +

              ContainerSource is the Schema for the containersources API

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1beta1 + +
              +kind
              +string +              		ContainerSource
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +ContainerSourceSpec + + +              		 +
              +
              + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +template
              + + +Kubernetes core/v1.PodTemplateSpec + + +              		 +

              Template describes the pods that will be created

              +
              +
              +status
              + + +ContainerSourceStatus + + +              		 +
              +

              PingSource +

              +

              +

              PingSource is the Schema for the PingSources API.

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1beta1 + +
              +kind
              +string +              		PingSource
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +PingSourceSpec + + +              		 +
              +
              + + + + + + + + + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +schedule
              + +string + +              		 +(Optional) +

              Schedule is the cronjob schedule. Defaults to * * * * *.

              +
              +timezone
              + +string + +              		 +

              Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

              +
              +jsonData
              + +string + +              		 +(Optional) +

              JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.

              +
              +
              +status
              + + +PingSourceStatus + + +              		 +
              +

              SinkBinding +

              +

              +

              SinkBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1beta1 + +
              +kind
              +string +              		SinkBinding
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +SinkBindingSpec + + +              		 +
              +
              + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +BindingSpec
              + +knative.dev/pkg/apis/duck/v1beta1.BindingSpec + +              		 +

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

              +

              inherits duck/v1beta1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

              +
              +
              +status
              + + +SinkBindingStatus + + +              		 +
              +

              APIVersionKind +

              +

              +(Appears on: +ApiServerSourceSpec) +

              +

              +

              APIVersionKind is an APIVersion and Kind tuple.

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              + +string + +              		 +

              APIVersion - the API version of the resource to watch.

              +
              +kind
              + +string + +              		 +

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

              +
              +

              APIVersionKindSelector +

              +

              +(Appears on: +ApiServerSourceSpec) +

              +

              +

              APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

              +

              + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              + +string + +              		 +

              APIVersion - the API version of the resource to watch.

              +
              +kind
              + +string + +              		 +

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

              +
              +selector
              + + +Kubernetes meta/v1.LabelSelector + + +              		 +(Optional) +

              LabelSelector filters this source to objects to those resources pass the +label selector. +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

              +
              +

              ApiServerSourceSpec +

              +

              +(Appears on: +ApiServerSource) +

              +

              +

              ApiServerSourceSpec defines the desired state of ApiServerSource

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +resources
              + + +[]APIVersionKindSelector + + +              		 +

              Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +mode
              + +string + +              		 +(Optional) +

              EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

              +
              +serviceAccountName
              + +string + +              		 +(Optional) +

              ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

              +
              +

              ApiServerSourceStatus +

              +

              +(Appears on: +ApiServerSource) +

              +

              +

              ApiServerSourceStatus defines the observed state of ApiServerSource

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              ContainerSourceSpec +

              +

              +(Appears on: +ContainerSource) +

              +

              +

              ContainerSourceSpec defines the desired state of ContainerSource

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +template
              + + +Kubernetes core/v1.PodTemplateSpec + + +              		 +

              Template describes the pods that will be created

              +
              +

              ContainerSourceStatus +

              +

              +(Appears on: +ContainerSource) +

              +

              +

              ContainerSourceStatus defines the observed state of ContainerSource

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              PingSourceSpec +

              +

              +(Appears on: +PingSource) +

              +

              +

              PingSourceSpec defines the desired state of the PingSource.

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +schedule
              + +string + +              		 +(Optional) +

              Schedule is the cronjob schedule. Defaults to * * * * *.

              +
              +timezone
              + +string + +              		 +

              Timezone modifies the actual time relative to the specified timezone. +Defaults to the system time zone. +More general information about time zones: https://www.iana.org/time-zones +List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

              +
              +jsonData
              + +string + +              		 +(Optional) +

              JsonData is json encoded data used as the body of the event posted to +the sink. Default is empty. If set, datacontenttype will also be set +to “application/json”.

              +
              +

              PingSourceStatus +

              +

              +(Appears on: +PingSource) +

              +

              +

              PingSourceStatus defines the observed state of PingSource.

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              SinkBindingSpec +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingSpec holds the desired state of the SinkBinding (from the client).

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +BindingSpec
              + +knative.dev/pkg/apis/duck/v1beta1.BindingSpec + +              		 +

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

              +

              inherits duck/v1beta1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

              +
              +

              SinkBindingStatus +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              eventing.knative.dev/v1

              Package v1 is the v1 version of the API.

              @@ -1806,6 +4512,1374 @@ knative.dev/pkg/apis.URL
              +

              sources.knative.dev/v1

              +

              +

              Package v1 contains API Schema definitions for the sources v1 API group.

              +

              +Resource Types: + +

              ApiServerSource +

              +

              +

              ApiServerSource is the Schema for the apiserversources API

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1 + +
              +kind
              +string +              		ApiServerSource
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +ApiServerSourceSpec + + +              		 +
              +
              + + + + + + + + + + + + + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +resources
              + + +[]APIVersionKindSelector + + +              		 +

              Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +mode
              + +string + +              		 +(Optional) +

              EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

              +
              +serviceAccountName
              + +string + +              		 +(Optional) +

              ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

              +
              +
              +status
              + + +ApiServerSourceStatus + + +              		 +
              +

              ContainerSource +

              +

              +

              ContainerSource is the Schema for the containersources API

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1 + +
              +kind
              +string +              		ContainerSource
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +ContainerSourceSpec + + +              		 +
              +
              + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +template
              + + +Kubernetes core/v1.PodTemplateSpec + + +              		 +

              Template describes the pods that will be created

              +
              +
              +status
              + + +ContainerSourceStatus + + +              		 +
              +

              SinkBinding +

              +

              +

              SinkBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1 + +
              +kind
              +string +              		SinkBinding
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +SinkBindingSpec + + +              		 +
              +
              + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +BindingSpec
              + +knative.dev/pkg/apis/duck/v1.BindingSpec + +              		 +

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

              +

              inherits duck/v1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

              +
              +
              +status
              + + +SinkBindingStatus + + +              		 +
              +

              APIVersionKind +

              +

              +(Appears on: +ApiServerSourceSpec) +

              +

              +

              APIVersionKind is an APIVersion and Kind tuple.

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              + +string + +              		 +

              APIVersion - the API version of the resource to watch.

              +
              +kind
              + +string + +              		 +

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

              +
              +

              APIVersionKindSelector +

              +

              +(Appears on: +ApiServerSourceSpec) +

              +

              +

              APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

              +

              + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              + +string + +              		 +

              APIVersion - the API version of the resource to watch.

              +
              +kind
              + +string + +              		 +

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

              +
              +selector
              + + +Kubernetes meta/v1.LabelSelector + + +              		 +(Optional) +

              LabelSelector filters this source to objects to those resources pass the +label selector. +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

              +
              +

              ApiServerSourceSpec +

              +

              +(Appears on: +ApiServerSource) +

              +

              +

              ApiServerSourceSpec defines the desired state of ApiServerSource

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +resources
              + + +[]APIVersionKindSelector + + +              		 +

              Resource are the resources this source will track and send related +lifecycle events from the Kubernetes ApiServer, with an optional label +selector to help filter.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +mode
              + +string + +              		 +(Optional) +

              EventMode controls the format of the event. +Reference sends a dataref event type for the resource under watch. +Resource send the full resource lifecycle event. +Defaults to Reference

              +
              +serviceAccountName
              + +string + +              		 +(Optional) +

              ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set.

              +
              +

              ApiServerSourceStatus +

              +

              +(Appears on: +ApiServerSource) +

              +

              +

              ApiServerSourceStatus defines the observed state of ApiServerSource

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              ContainerSourceSpec +

              +

              +(Appears on: +ContainerSource) +

              +

              +

              ContainerSourceSpec defines the desired state of ContainerSource

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +template
              + + +Kubernetes core/v1.PodTemplateSpec + + +              		 +

              Template describes the pods that will be created

              +
              +

              ContainerSourceStatus +

              +

              +(Appears on: +ContainerSource) +

              +

              +

              ContainerSourceStatus defines the observed state of ContainerSource

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              SinkBindingSpec +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingSpec holds the desired state of the SinkBinding (from the client).

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

              +

              inherits duck/v1 SourceSpec, which currently provides: +* Sink - a reference to an object that will resolve to a domain name or +a URI directly to use as the sink. +* CloudEventOverrides - defines overrides to control the output format +and modifications of the event sent to the sink.

              +
              +BindingSpec
              + +knative.dev/pkg/apis/duck/v1.BindingSpec + +              		 +

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

              +

              inherits duck/v1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations.

              +
              +

              SinkBindingStatus +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +
              +

              sources.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.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
              + +knative.dev/pkg/apis/duck/v1beta1.Destination + +              		 +(Optional) +

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

              +
              +ceOverrides
              + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +              		 +(Optional) +

              CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +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 + + +              		 +
              +

              SinkBinding +

              +

              +

              SinkBinding describes a Binding that is also a Source. +The sink (from the Source duck) is resolved to a URL and +then projected into the subject by augmenting the runtime +contract of the referenced containers to have a K_SINK +environment variable holding the endpoint to which to send +cloud events.

              +

              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              FieldDescription
              +apiVersion
              +string              		 + +sources.knative.dev/v1alpha1 + +
              +kind
              +string +              		SinkBinding
              +metadata
              + + +Kubernetes meta/v1.ObjectMeta + + +              		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
              +spec
              + + +SinkBindingSpec + + +              		 +
              +
              + + + + + + + + + +
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

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

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

              +
              +
              +status
              + + +SinkBindingStatus + + +              		 +
              +

              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/sig-architecture/api-conventions.md#types-kinds

              +
              +labelSelector
              + + +Kubernetes meta/v1.LabelSelector + + +              		 +

              LabelSelector restricts this source to objects with the selected labels +More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

              +
              +controllerSelector
              + + +Kubernetes meta/v1.OwnerReference + + +              		 +

              ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. +Only apiVersion and kind are used. Both are optional. +Deprecated: Per-resource owner refs will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV.

              +
              +controller
              + +bool + +              		 +

              If true, send an event referencing the object controlling the resource +Deprecated: Per-resource controller flag will no longer be supported in +v1alpha2, please use Spec.Owner as a GKV.

              +
              +

              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
              + +knative.dev/pkg/apis/duck/v1beta1.Destination + +              		 +(Optional) +

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

              +
              +ceOverrides
              + +knative.dev/pkg/apis/duck/v1.CloudEventOverrides + +              		 +(Optional) +

              CloudEventOverrides defines overrides to control the output format and +modifications of the event sent to the sink.

              +
              +owner
              + + +APIVersionKind + + +              		 +(Optional) +

              ResourceOwner is an additional filter to only track resources that are +owned by a specific resource type. If ResourceOwner matches Resources[n] +then Resources[n] is allowed to pass the ResourceOwner filter.

              +
              +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
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the +Source.

              +
              +

              SinkBindingSpec +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingSpec holds the desired state of the SinkBinding (from the client).

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +SourceSpec
              + +knative.dev/pkg/apis/duck/v1.SourceSpec + +              		 +

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

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

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

              +
              +

              SinkBindingStatus +

              +

              +(Appears on: +SinkBinding) +

              +

              +

              SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

              +

              + + + + + + + + + + + + + +
              FieldDescription
              +SourceStatus
              + +knative.dev/pkg/apis/duck/v1.SourceStatus + +              		 +

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

              +
              +

              eventing.knative.dev/v1beta1

              Package v1beta1 is the v1beta1 version of the API.

              @@ -3395,20 +7469,22 @@ knative.dev/pkg/apis.URL
              -

              sources.knative.dev/v1alpha1

              +

              messaging.knative.dev/v1beta1

              -

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

              +

              Package v1beta1 is the v1beta1 version of the API.

              Resource Types: -

              ApiServerSource +

              Channel

              -

              ApiServerSource is the Schema for the apiserversources API

              +

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

              @@ -3424,7 +7500,7 @@ Resource Types: string @@ -3433,7 +7509,212 @@ sources.knative.dev/v1alpha1 kind
              string - + + + + + + + + + + + + + + + +
              -sources.knative.dev/v1alpha1 +messaging.knative.dev/v1beta1
              ApiServerSourceChannel
              +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.

              +
              +ChannelableSpec
              + + +ChannelableSpec + + +              		 +

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

              +

              Channel conforms to ChannelableSpec

              +
              +
              +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/v1beta1 + +
              +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.

              +
              +
              + + + + + +
              +ChannelableSpec
              + + +ChannelableSpec + + +              		 +

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

              +

              Channel conforms to Duck type Channelable.

              +
              +
              +status
              + + +InMemoryChannelStatus + + +              		 +(Optional) +

              Status represents the current state of the Channel. 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.

              +

              + + + + + + + + + + + + + + + @@ -3464,82 +7745,70 @@ ApiServerSourceSpec
              FieldDescription
              +apiVersion
              +string              		 + +messaging.knative.dev/v1beta1 + +
              +kind
              +string +              		Subscription
              @@ -3453,8 +7734,8 @@ Refer to the Kubernetes API documentation for the fields of the spec
              - -ApiServerSourceSpec + +SubscriptionSpec
              - - - - - - - -
              -resources
              +channel
              - -[]ApiServerResource + +Kubernetes core/v1.ObjectReference               		-

              Resources is the list of resources to watch

              +

              Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference 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.)
              -serviceAccountName
              +subscriber
              -string +knative.dev/pkg/apis/duck/v1.Destination               		(Optional) -

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

              +

              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.
              -sink
              +reply
              -knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination               		(Optional) -

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

              +

              Reply specifies (optionally) how to handle events returned from +the Subscriber target.
              -ceOverrides
              +delivery
              -knative.dev/pkg/apis/duck/v1.CloudEventOverrides - -              		 -(Optional) -

              CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

              -
              -owner
              - - -APIVersionKind + +DeliverySpec               		(Optional) -

              ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

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

              +

              Delivery configuration
              @@ -3549,8 +7818,8 @@ string status
              - -ApiServerSourceStatus + +SubscriptionStatus @@ -3559,15 +7828,21 @@ ApiServerSourceStatus -

              SinkBinding +

              ChannelDefaulter

              -

              SinkBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

              +

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

              +

              +

              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.

              @@ -3579,21 +7854,133 @@ cloud events.

              +channelTemplate
              + + +ChannelTemplateSpec + + + + - + +
              -apiVersion
              -string              		 - -sources.knative.dev/v1alpha1 - +

              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.
              -kind
              -string +ChannelableSpec
              + + +ChannelableSpec + + +              		 +

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

              +

              Channel conforms to ChannelableSpec

              		SinkBinding
              +

              ChannelStatus +

              +

              +(Appears on: +Channel) +

              +

              +

              ChannelStatus represents the current state of a Channel.

              +

              + + + + + + + + + + + + + + + + + +
              FieldDescription
              +ChannelableStatus
              + + +ChannelableStatus + + +              		 +

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

              +

              Channel conforms to ChannelableStatus

              +
              +channel
              + +knative.dev/pkg/apis/duck/v1.KReference + +              		 +

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

              +
              +

              ChannelTemplateSpec +

              +

              +(Appears on: +ChannelSpec, +ParallelSpec, +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.

              +

              + + + + + + + + @@ -3612,66 +8000,31 @@ Refer to the Kubernetes API documentation for the fields of the - - - -
              FieldDescription
              metadata
              @@ -3604,6 +7991,7 @@ Kubernetes meta/v1.ObjectMeta               		+(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field. spec
              - -SinkBindingSpec - +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.



              - - - - - - - -
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

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

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

              -
              -status
              - - -SinkBindingStatus - - -              		 -
              -

              ApiServerResource +

              InMemoryChannelSpec

              (Appears on: -ApiServerSourceSpec) +InMemoryChannel)

              -

              ApiServerResource defines the resource to watch

              +

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

              @@ -3683,80 +8036,30 @@ SinkBindingStatus - - - - - - - - - - - - - - - -
              -apiVersion
              +ChannelableSpec
              -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/sig-architecture/api-conventions.md#types-kinds

              -
              -labelSelector
              - - -Kubernetes meta/v1.LabelSelector + +ChannelableSpec               		-

              LabelSelector restricts this source to objects with the selected labels -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

              -
              -controllerSelector
              - - -Kubernetes meta/v1.OwnerReference - - -              		 -

              ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind. -Only apiVersion and kind are used. Both are optional. -Deprecated: Per-resource owner refs will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

              -
              -controller
              - -bool - -              		 -

              If true, send an event referencing the object controlling the resource -Deprecated: Per-resource controller flag will no longer be supported in -v1alpha2, please use Spec.Owner as a GKV.

              +

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

              +

              Channel conforms to Duck type Channelable.
              -

              ApiServerSourceSpec +

              InMemoryChannelStatus

              (Appears on: -ApiServerSource) +InMemoryChannel)

              -

              ApiServerSourceSpec defines the desired state of ApiServerSource

              +

              ChannelStatus represents the current state of a Channel.

              @@ -3768,94 +8071,128 @@ v1alpha2, please use Spec.Owner as a GKV.

              + + +
              -resources
              +ChannelableStatus
              - -[]ApiServerResource + +ChannelableStatus               		-

              Resources is the list of resources to watch

              +

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

              +

              Channel conforms to Duck type Channelable.

              +
              +

              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
              +channel
              + + +Kubernetes core/v1.ObjectReference + + +              		 +

              Reference to a channel that will be used to create the subscription +You can specify only the following fields of the ObjectReference: +- Kind +- APIVersion +- Name +The resource pointed by this ObjectReference 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.)
              -serviceAccountName
              +subscriber
              -string +knative.dev/pkg/apis/duck/v1.Destination               		(Optional) -

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

              +

              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.
              -sink
              +reply
              -knative.dev/pkg/apis/duck/v1beta1.Destination +knative.dev/pkg/apis/duck/v1.Destination               		(Optional) -

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

              +

              Reply specifies (optionally) how to handle events returned from +the Subscriber target.
              -ceOverrides
              +delivery
              -knative.dev/pkg/apis/duck/v1.CloudEventOverrides - -              		 -(Optional) -

              CloudEventOverrides defines overrides to control the output format and -modifications of the event sent to the sink.

              -
              -owner
              - - -APIVersionKind + +DeliverySpec               		(Optional) -

              ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

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

              +

              Delivery configuration
              -

              ApiServerSourceStatus +

              SubscriptionStatus

              (Appears on: -ApiServerSource) +Subscription)

              -

              ApiServerSourceStatus defines the observed state of ApiServerSource

              +

              SubscriptionStatus (computed) for a subscription

              @@ -3867,34 +8204,44 @@ string + + + +
              -SourceStatus
              +Status
              -knative.dev/pkg/apis/duck/v1.SourceStatus +knative.dev/pkg/apis/duck/v1.Status

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

              -

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

              +

              inherits duck/v1 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.
              -

              SinkBindingSpec +

              SubscriptionStatusPhysicalSubscription

              (Appears on: -SinkBinding) +SubscriptionStatus)

              -

              SinkBindingSpec holds the desired state of the SinkBinding (from the client).

              +

              SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.

              @@ -3906,1108 +8253,35 @@ Source.

              - -
              -SourceSpec
              +subscriberUri
              -knative.dev/pkg/apis/duck/v1.SourceSpec +knative.dev/pkg/apis.URL               		-

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

              +

              SubscriberURI is the fully resolved URI for spec.subscriber.
              -BindingSpec
              +replyUri
              -knative.dev/pkg/apis/duck/v1alpha1.BindingSpec +knative.dev/pkg/apis.URL               		-

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

              +

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

              SinkBindingStatus -

              -

              -(Appears on: -SinkBinding) -

              -

              -

              SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

              -

              - - - - - - - - - - -
              FieldDescription
              -SourceStatus
              +deadLetterSinkUri
              -knative.dev/pkg/apis/duck/v1.SourceStatus +knative.dev/pkg/apis.URL               		-

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

              -
              -
              -

              sources.knative.dev/v1beta1

              -

              -

              Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.

              -

              -Resource Types: - -

              ApiServerSource -

              -

              -

              ApiServerSource is the Schema for the apiserversources API

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -apiVersion
              -string              		 - -sources.knative.dev/v1beta1 - -
              -kind
              -string -              		ApiServerSource
              -metadata
              - - -Kubernetes meta/v1.ObjectMeta - - -              		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
              -spec
              - - -ApiServerSourceSpec - - -              		 -
              -
              - - - - - - - - - - - - - - - - - - - - - -
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -resources
              - - -[]APIVersionKindSelector - - -              		 -

              Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter.

              -
              -owner
              - - -APIVersionKind - - -              		 -(Optional) -

              ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

              -
              -mode
              - -string - -              		 -(Optional) -

              EventMode controls the format of the event. -Reference sends a dataref event type for the resource under watch. -Resource send the full resource lifecycle event. -Defaults to Reference

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

              ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.

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

              ContainerSource -

              -

              -

              ContainerSource is the Schema for the containersources API

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -apiVersion
              -string              		 - -sources.knative.dev/v1beta1 - -
              -kind
              -string -              		ContainerSource
              -metadata
              - - -Kubernetes meta/v1.ObjectMeta - - -              		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
              -spec
              - - -ContainerSourceSpec - - -              		 -
              -
              - - - - - - - - - -
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -template
              - - -Kubernetes core/v1.PodTemplateSpec - - -              		 -

              Template describes the pods that will be created

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

              PingSource -

              -

              -

              PingSource is the Schema for the PingSources API.

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -apiVersion
              -string              		 - -sources.knative.dev/v1beta1 - -
              -kind
              -string -              		PingSource
              -metadata
              - - -Kubernetes meta/v1.ObjectMeta - - -              		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
              -spec
              - - -PingSourceSpec - - -              		 -
              -
              - - - - - - - - - - - - - - - - - -
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -schedule
              - -string - -              		 -(Optional) -

              Schedule is the cronjob schedule. Defaults to * * * * *.

              -
              -timezone
              - -string - -              		 -

              Timezone modifies the actual time relative to the specified timezone. -Defaults to the system time zone. -More general information about time zones: https://www.iana.org/time-zones -List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

              -
              -jsonData
              - -string - -              		 -(Optional) -

              JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

              -
              -
              -status
              - - -PingSourceStatus - - -              		 -
              -

              SinkBinding -

              -

              -

              SinkBinding describes a Binding that is also a Source. -The sink (from the Source duck) is resolved to a URL and -then projected into the subject by augmenting the runtime -contract of the referenced containers to have a K_SINK -environment variable holding the endpoint to which to send -cloud events.

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -apiVersion
              -string              		 - -sources.knative.dev/v1beta1 - -
              -kind
              -string -              		SinkBinding
              -metadata
              - - -Kubernetes meta/v1.ObjectMeta - - -              		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
              -spec
              - - -SinkBindingSpec - - -              		 -
              -
              - - - - - - - - - -
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -BindingSpec
              - -knative.dev/pkg/apis/duck/v1beta1.BindingSpec - -              		 -

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

              -

              inherits duck/v1beta1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations.

              -
              -
              -status
              - - -SinkBindingStatus - - -              		 -
              -

              APIVersionKind -

              -

              -(Appears on: -ApiServerSourceSpec) -

              -

              -

              APIVersionKind is an APIVersion and Kind tuple.

              -

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

              APIVersion - the API version of the resource to watch.

              -
              -kind
              - -string - -              		 -

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

              -
              -

              APIVersionKindSelector -

              -

              -(Appears on: -ApiServerSourceSpec) -

              -

              -

              APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

              -

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

              APIVersion - the API version of the resource to watch.

              -
              -kind
              - -string - -              		 -

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

              -
              -selector
              - - -Kubernetes meta/v1.LabelSelector - - -              		 -(Optional) -

              LabelSelector filters this source to objects to those resources pass the -label selector. -More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

              -
              -

              ApiServerSourceSpec -

              -

              -(Appears on: -ApiServerSource) -

              -

              -

              ApiServerSourceSpec defines the desired state of ApiServerSource

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -resources
              - - -[]APIVersionKindSelector - - -              		 -

              Resource are the resources this source will track and send related -lifecycle events from the Kubernetes ApiServer, with an optional label -selector to help filter.

              -
              -owner
              - - -APIVersionKind - - -              		 -(Optional) -

              ResourceOwner is an additional filter to only track resources that are -owned by a specific resource type. If ResourceOwner matches Resources[n] -then Resources[n] is allowed to pass the ResourceOwner filter.

              -
              -mode
              - -string - -              		 -(Optional) -

              EventMode controls the format of the event. -Reference sends a dataref event type for the resource under watch. -Resource send the full resource lifecycle event. -Defaults to Reference

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

              ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set.

              -
              -

              ApiServerSourceStatus -

              -

              -(Appears on: -ApiServerSource) -

              -

              -

              ApiServerSourceStatus defines the observed state of ApiServerSource

              -

              - - - - - - - - - - - - - -
              FieldDescription
              -SourceStatus
              - -knative.dev/pkg/apis/duck/v1.SourceStatus - -              		 -

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

              -

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

              -
              -

              ContainerSourceSpec -

              -

              -(Appears on: -ContainerSource) -

              -

              -

              ContainerSourceSpec defines the desired state of ContainerSource

              -

              - - - - - - - - - - - - - - - - - -
              FieldDescription
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -template
              - - -Kubernetes core/v1.PodTemplateSpec - - -              		 -

              Template describes the pods that will be created

              -
              -

              ContainerSourceStatus -

              -

              -(Appears on: -ContainerSource) -

              -

              -

              ContainerSourceStatus defines the observed state of ContainerSource

              -

              - - - - - - - - - - - - - -
              FieldDescription
              -SourceStatus
              - -knative.dev/pkg/apis/duck/v1.SourceStatus - -              		 -

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

              -

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

              -
              -

              PingSourceSpec -

              -

              -(Appears on: -PingSource) -

              -

              -

              PingSourceSpec defines the desired state of the PingSource.

              -

              - - - - - - - - - - - - - - - - - - - - - - - - - -
              FieldDescription
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -schedule
              - -string - -              		 -(Optional) -

              Schedule is the cronjob schedule. Defaults to * * * * *.

              -
              -timezone
              - -string - -              		 -

              Timezone modifies the actual time relative to the specified timezone. -Defaults to the system time zone. -More general information about time zones: https://www.iana.org/time-zones -List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

              -
              -jsonData
              - -string - -              		 -(Optional) -

              JsonData is json encoded data used as the body of the event posted to -the sink. Default is empty. If set, datacontenttype will also be set -to “application/json”.

              -
              -

              PingSourceStatus -

              -

              -(Appears on: -PingSource) -

              -

              -

              PingSourceStatus defines the observed state of PingSource.

              -

              - - - - - - - - - - - - - -
              FieldDescription
              -SourceStatus
              - -knative.dev/pkg/apis/duck/v1.SourceStatus - -              		 -

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

              -

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

              -
              -

              SinkBindingSpec -

              -

              -(Appears on: -SinkBinding) -

              -

              -

              SinkBindingSpec holds the desired state of the SinkBinding (from the client).

              -

              - - - - - - - - - - - - - - - - - -
              FieldDescription
              -SourceSpec
              - -knative.dev/pkg/apis/duck/v1.SourceSpec - -              		 -

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

              -

              inherits duck/v1 SourceSpec, which currently provides: -* Sink - a reference to an object that will resolve to a domain name or -a URI directly to use as the sink. -* CloudEventOverrides - defines overrides to control the output format -and modifications of the event sent to the sink.

              -
              -BindingSpec
              - -knative.dev/pkg/apis/duck/v1beta1.BindingSpec - -              		 -

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

              -

              inherits duck/v1beta1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations.

              -
              -

              SinkBindingStatus -

              -

              -(Appears on: -SinkBinding) -

              -

              -

              SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

              -

              - - - - - - - - - - - @@ -5303,827 +8577,6 @@ string
              FieldDescription
              -SourceStatus
              - -knative.dev/pkg/apis/duck/v1.SourceStatus - -              		 -

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

              -

              inherits duck/v1 SourceStatus, 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 - the current active sink URI that has been configured for the -Source.

              +

              ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.
              -

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

                -
                -delivery
                - - -DeliverySpec - - -                		 -(Optional) -

                DeliverySpec contains options controlling the event delivery

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

                ChannelableCombined -

                -

                -

                ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -v1alpha1 and v1beta1 duck types. This is not to be used by resource writers and is -only used by Subscription Controller to synthesize patches and read the Status -of the Channelable Resources. -This is not a real resource.

                -

                - - - - - - - - - - - - - - - - - - - - - -
                FieldDescription
                -metadata
                - - -Kubernetes meta/v1.ObjectMeta - - -                		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
                -spec
                - - -ChannelableCombinedSpec - - -                		 -

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

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

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

                -

                SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                -
                -SubscribableSpec
                - - -SubscribableSpec - - -                		 -

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

                -

                SubscribableSpec is for the v1beta1 spec compatibility.

                -
                -delivery
                - - -DeliverySpec - - -                		 -(Optional) -

                DeliverySpec contains options controlling the event delivery

                -
                -
                -status
                - - -ChannelableCombinedStatus - - -                		 -
                -

                ChannelableCombinedSpec -

                -

                -(Appears on: -ChannelableCombined) -

                -

                -

                ChannelableSpec contains Spec of the Channelable object

                -

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

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

                -

                SubscribableTypeSpec is for the v1alpha1 spec compatibility.

                -
                -SubscribableSpec
                - - -SubscribableSpec - - -                		 -

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

                -

                SubscribableSpec is for the v1beta1 spec compatibility.

                -
                -delivery
                - - -DeliverySpec - - -                		 -(Optional) -

                DeliverySpec contains options controlling the event delivery

                -
                -

                ChannelableCombinedStatus -

                -

                -(Appears on: -ChannelableCombined) -

                -

                -

                ChannelableStatus contains the Status of a Channelable object.

                -

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

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

                -

                inherits duck/v1 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.) -

                -

                SubscribableTypeStatus is the v1alpha1 part of the Subscribers status

                -
                -SubscribableStatus
                - - -SubscribableStatus - - -                		 -

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

                -

                SubscribableStatus is the v1beta1 part of the Subscribers status.

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

                ErrorChannel is set by the channel when it supports native error handling via a channel

                -
                -

                ChannelableSpec -

                -

                -(Appears on: -Channelable) -

                -

                -

                ChannelableSpec contains Spec of the Channelable object

                -

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

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

                -
                -delivery
                - - -DeliverySpec - - -                		 -(Optional) -

                DeliverySpec contains options controlling the event delivery

                -
                -

                ChannelableStatus -

                -

                -(Appears on: -Channelable) -

                -

                -

                ChannelableStatus contains the Status of a Channelable object.

                -

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

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

                -

                inherits duck/v1 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.

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

                ErrorChannel is set by the channel when it supports native error handling via a channel

                -
                -

                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
                -metadata
                - - -Kubernetes meta/v1.ObjectMeta - - -                		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
                -

                Subscribable -

                -

                -(Appears on: -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.

                -
                -

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

                -
                -

                SubscribableTypeSpec -

                -

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

                -

                -

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

                -

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

                SubscribableTypeStatus -

                -

                -(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) -

                -

                -

                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
                -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
                - -knative.dev/pkg/apis.URL - -                		 -(Optional) -
                -replyURI
                - -knative.dev/pkg/apis.URL - -                		 -(Optional) -
                -deadLetterSink
                - -knative.dev/pkg/apis.URL - -                		 -(Optional) -
                -delivery
                - - -DeliverySpec - - -                		 -(Optional) -
                -

                flows.knative.dev/v1

                Package v1 is the v1 version of the API.

                @@ -6957,1658 +9410,6 @@ knative.dev/pkg/apis.Condition
                -

                flows.knative.dev/v1beta1

                -

                -

                Package v1beta1 is the v1beta1 version of the API.

                -

                -Resource Types: -
                  -

                  Parallel -

                  -

                  -

                  Parallel 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
                  - - -ParallelSpec - - -                  		 -

                  Spec defines the desired state of the Parallel.

                  -
                  -
                  - - - - - - - - - - - - - -
                  -branches
                  - - -[]ParallelBranch - - -                  		 -

                  Branches is the list of Filter/Subscribers pairs.

                  -
                  -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
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -
                  -status
                  - - -ParallelStatus - - -                  		 -(Optional) -

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

                  -
                  -

                  ParallelBranch -

                  -

                  -(Appears on: -ParallelSpec) -

                  -

                  -

                  - - - - - - - - - - - - - - - - - - - - - - - - - -
                  FieldDescription
                  -filter
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

                  Filter is the expression guarding the branch

                  -
                  -subscriber
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -

                  Subscriber receiving the event when the filter passes

                  -
                  -reply
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(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 Parallel Reply

                  -
                  -delivery
                  - - -DeliverySpec - - -                  		 -(Optional) -

                  Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc. -Needed for Roundtripping v1alpha1 <-> v1beta1.

                  -
                  -

                  ParallelBranchStatus -

                  -

                  -(Appears on: -ParallelStatus) -

                  -

                  -

                  ParallelBranchStatus represents the current state of a Parallel branch

                  -

                  - - - - - - - - - - - - - - - - - - - - - -
                  FieldDescription
                  -filterSubscriptionStatus
                  - - -ParallelSubscriptionStatus - - -                  		 -

                  FilterSubscriptionStatus corresponds to the filter subscription status.

                  -
                  -filterChannelStatus
                  - - -ParallelChannelStatus - - -                  		 -

                  FilterChannelStatus corresponds to the filter channel status.

                  -
                  -subscriberSubscriptionStatus
                  - - -ParallelSubscriptionStatus - - -                  		 -

                  SubscriptionStatus corresponds to the subscriber subscription status.

                  -
                  -

                  ParallelChannelStatus -

                  -

                  -(Appears on: -ParallelBranchStatus, -ParallelStatus) -

                  -

                  -

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

                  -
                  -

                  ParallelSpec -

                  -

                  -(Appears on: -Parallel) -

                  -

                  -

                  - - - - - - - - - - - - - - - - - - - - - -
                  FieldDescription
                  -branches
                  - - -[]ParallelBranch - - -                  		 -

                  Branches is the list of Filter/Subscribers pairs.

                  -
                  -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
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -

                  ParallelStatus -

                  -

                  -(Appears on: -Parallel) -

                  -

                  -

                  ParallelStatus represents the current state of a Parallel.

                  -

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

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

                  -

                  inherits duck/v1 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
                  - - -ParallelChannelStatus - - -                  		 -

                  IngressChannelStatus corresponds to the ingress channel status.

                  -
                  -branchStatuses
                  - - -[]ParallelBranchStatus - - -                  		 -

                  BranchStatuses is an array of corresponding to branch statuses. -Matches the Spec.Branches array in the order.

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

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

                  -

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

                  -
                  -

                  ParallelSubscriptionStatus -

                  -

                  -(Appears on: -ParallelBranchStatus) -

                  -

                  -

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

                  -
                  -

                  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
                  - - -[]SequenceStep - - -                  		 -

                  Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

                  -
                  -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
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -
                  -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
                  - - -[]SequenceStep - - -                  		 -

                  Steps is the list of Destinations (processors / functions) that will be called in the order -provided. Each step has its own delivery options

                  -
                  -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
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -

                  SequenceStatus -

                  -

                  -(Appears on: -Sequence) -

                  -

                  -

                  SequenceStatus represents the current state of a Sequence.

                  -

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

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

                  -

                  inherits duck/v1 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/v1.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}

                  -
                  -

                  SequenceStep -

                  -

                  -(Appears on: -SequenceSpec) -

                  -

                  -

                  - - - - - - - - - - - - - - - - - -
                  FieldDescription
                  -Destination
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -

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

                  -

                  Subscriber receiving the step event

                  -
                  -delivery
                  - - -DeliverySpec - - -                  		 -(Optional) -

                  Delivery is the delivery specification for events to the subscriber -This includes things like retries, DLQ, etc.

                  -
                  -

                  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.

                  -
                  -
                  -

                  messaging.knative.dev/v1beta1

                  -

                  -

                  Package v1beta1 is the v1beta1 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/v1beta1 - -
                  -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.

                  -
                  -ChannelableSpec
                  - - -ChannelableSpec - - -                  		 -

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

                  -

                  Channel conforms to ChannelableSpec

                  -
                  -
                  -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/v1beta1 - -
                  -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.

                  -
                  -
                  - - - - - -
                  -ChannelableSpec
                  - - -ChannelableSpec - - -                  		 -

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

                  -

                  Channel conforms to Duck type Channelable.

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

                  Status represents the current state of the Channel. 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                  		 - -messaging.knative.dev/v1beta1 - -
                  -kind
                  -string -                  		Subscription
                  -metadata
                  - - -Kubernetes meta/v1.ObjectMeta - - -                  		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
                  -spec
                  - - -SubscriptionSpec - - -                  		 -
                  -
                  - - - - - - - - - - - - - - - - - -
                  -channel
                  - - -Kubernetes core/v1.ObjectReference - - -                  		 -

                  Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference 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.)

                  -
                  -subscriber
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

                  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.

                  -
                  -reply
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -delivery
                  - - -DeliverySpec - - -                  		 -(Optional) -

                  Delivery configuration

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

                  ChannelDefaulter -

                  -

                  -

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

                  -

                  -

                  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.

                  -
                  -ChannelableSpec
                  - - -ChannelableSpec - - -                  		 -

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

                  -

                  Channel conforms to ChannelableSpec

                  -
                  -

                  ChannelStatus -

                  -

                  -(Appears on: -Channel) -

                  -

                  -

                  ChannelStatus represents the current state of a Channel.

                  -

                  - - - - - - - - - - - - - - - - - -
                  FieldDescription
                  -ChannelableStatus
                  - - -ChannelableStatus - - -                  		 -

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

                  -

                  Channel conforms to ChannelableStatus

                  -
                  -channel
                  - -knative.dev/pkg/apis/duck/v1.KReference - -                  		 -

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

                  -
                  -

                  ChannelTemplateSpec -

                  -

                  -(Appears on: -ChannelSpec, -ParallelSpec, -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.

                  -
                  -
                  - -
                  -
                  -

                  InMemoryChannelSpec -

                  -

                  -(Appears on: -InMemoryChannel) -

                  -

                  -

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

                  -

                  - - - - - - - - - - - - - -
                  FieldDescription
                  -ChannelableSpec
                  - - -ChannelableSpec - - -                  		 -

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

                  -

                  Channel conforms to Duck type Channelable.

                  -
                  -

                  InMemoryChannelStatus -

                  -

                  -(Appears on: -InMemoryChannel) -

                  -

                  -

                  ChannelStatus represents the current state of a Channel.

                  -

                  - - - - - - - - - - - - - -
                  FieldDescription
                  -ChannelableStatus
                  - - -ChannelableStatus - - -                  		 -

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

                  -

                  Channel conforms to Duck type Channelable.

                  -
                  -

                  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
                  -channel
                  - - -Kubernetes core/v1.ObjectReference - - -                  		 -

                  Reference to a channel that will be used to create the subscription -You can specify only the following fields of the ObjectReference: -- Kind -- APIVersion -- Name -The resource pointed by this ObjectReference 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.)

                  -
                  -subscriber
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

                  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.

                  -
                  -reply
                  - -knative.dev/pkg/apis/duck/v1.Destination - -                  		 -(Optional) -

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

                  -
                  -delivery
                  - - -DeliverySpec - - -                  		 -(Optional) -

                  Delivery configuration

                  -
                  -

                  SubscriptionStatus -

                  -

                  -(Appears on: -Subscription) -

                  -

                  -

                  SubscriptionStatus (computed) for a subscription

                  -

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

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

                  -

                  inherits duck/v1 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
                  - -knative.dev/pkg/apis.URL - -                  		 -

                  SubscriberURI is the fully resolved URI for spec.subscriber.

                  -
                  -replyUri
                  - -knative.dev/pkg/apis.URL - -                  		 -

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

                  -
                  -deadLetterSinkUri
                  - -knative.dev/pkg/apis.URL - -                  		 -

                  ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.

                  -
                  -

                  sources.knative.dev/v1alpha2

                  Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group

                  @@ -9632,5 +10433,5 @@ Source.

                  Generated with gen-crd-api-reference-docs -on git commit 74b9bed2. +on git commit 0f9a8c55c.

                  diff --git a/docs/reference/api/serving.md b/docs/reference/api/serving.md index dc525dc14..366e623d4 100644 --- a/docs/reference/api/serving.md +++ b/docs/reference/api/serving.md @@ -1,11 +1,682 @@

                  Packages:

                  +

                  autoscaling.internal.knative.dev/v1alpha1

                  +

                  +

                  Package v1alpha1 contains the Autoscaling v1alpha1 API types.

                  +

                  +Resource Types: + +

                  PodAutoscaler +

                  +

                  +

                  PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative +components instantiate autoscalers. This definition is an abstraction that may be backed +by multiple definitions. For more information, see the Knative Pluggability presentation: +https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit

                  +

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

                  Spec holds the desired state of the PodAutoscaler (from the client).

                  +
                  +
                  + + + + + + + + + + + + + + + + + +
                  +containerConcurrency
                  + +int64 + +                  		 +(Optional) +

                  ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

                  +
                  +scaleTargetRef
                  + + +Kubernetes core/v1.ObjectReference + + +                  		 +

                  ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

                  +
                  +reachability
                  + + +ReachabilityType + + +                  		 +(Optional) +

                  Reachability specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

                  +
                  +protocolType
                  + +knative.dev/networking/pkg/apis/networking.ProtocolType + +                  		 +

                  The application-layer protocol. Matches ProtocolType inferred from the revision spec.

                  +
                  +
                  +status
                  + + +PodAutoscalerStatus + + +                  		 +(Optional) +

                  Status communicates the observed state of the PodAutoscaler (from the controller).

                  +
                  +

                  Metric +

                  +

                  +

                  Metric represents a resource to configure the metric collector with.

                  +

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

                  Spec holds the desired state of the Metric (from the client).

                  +
                  +
                  + + + + + + + + + + + + + +
                  +stableWindow
                  + +time.Duration + +                  		 +

                  StableWindow is the aggregation window for metrics in a stable state.

                  +
                  +panicWindow
                  + +time.Duration + +                  		 +

                  PanicWindow is the aggregation window for metrics where quick reactions are needed.

                  +
                  +scrapeTarget
                  + +string + +                  		 +

                  ScrapeTarget is the K8s service that publishes the metric endpoint.

                  +
                  +
                  +status
                  + + +MetricStatus + + +                  		 +(Optional) +

                  Status communicates the observed state of the Metric (from the controller).

                  +
                  +

                  MetricSpec +

                  +

                  +(Appears on: +Metric) +

                  +

                  +

                  MetricSpec contains all values a metric collector needs to operate.

                  +

                  + + + + + + + + + + + + + + + + + + + + + +
                  FieldDescription
                  +stableWindow
                  + +time.Duration + +                  		 +

                  StableWindow is the aggregation window for metrics in a stable state.

                  +
                  +panicWindow
                  + +time.Duration + +                  		 +

                  PanicWindow is the aggregation window for metrics where quick reactions are needed.

                  +
                  +scrapeTarget
                  + +string + +                  		 +

                  ScrapeTarget is the K8s service that publishes the metric endpoint.

                  +
                  +

                  MetricStatus +

                  +

                  +(Appears on: +Metric) +

                  +

                  +

                  MetricStatus reflects the status of metric collection for this specific entity.

                  +

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

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

                  +
                  +

                  PodAutoscalerSpec +

                  +

                  +(Appears on: +PodAutoscaler) +

                  +

                  +

                  PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).

                  +

                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                  FieldDescription
                  +containerConcurrency
                  + +int64 + +                  		 +(Optional) +

                  ContainerConcurrency specifies the maximum allowed +in-flight (concurrent) requests per container of the Revision. +Defaults to 0 which means unlimited concurrency.

                  +
                  +scaleTargetRef
                  + + +Kubernetes core/v1.ObjectReference + + +                  		 +

                  ScaleTargetRef defines the /scale-able resource that this PodAutoscaler +is responsible for quickly right-sizing.

                  +
                  +reachability
                  + + +ReachabilityType + + +                  		 +(Optional) +

                  Reachability specifies whether or not the ScaleTargetRef can be reached (ie. has a route). +Defaults to ReachabilityUnknown

                  +
                  +protocolType
                  + +knative.dev/networking/pkg/apis/networking.ProtocolType + +                  		 +

                  The application-layer protocol. Matches ProtocolType inferred from the revision spec.

                  +
                  +

                  PodAutoscalerStatus +

                  +

                  +(Appears on: +PodAutoscaler) +

                  +

                  +

                  PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).

                  +

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

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

                  +
                  +serviceName
                  + +string + +                  		 +

                  ServiceName is the K8s Service name that serves the revision, scaled by this PA. +The service is created and owned by the ServerlessService object owned by this PA.

                  +
                  +metricsServiceName
                  + +string + +                  		 +

                  MetricsServiceName is the K8s Service name that provides revision metrics. +The service is managed by the PA object.

                  +
                  +desiredScale
                  + +int32 + +                  		 +

                  DesiredScale shows the current desired number of replicas for the revision.

                  +
                  +actualScale
                  + +int32 + +                  		 +

                  ActualScale shows the actual number of replicas for the revision.

                  +
                  +

                  PodScalable +

                  +

                  +

                  PodScalable is a duck type that the resources referenced by the +PodAutoscaler’s ScaleTargetRef must implement. They must also +implement the /scale sub-resource for use with /scale based +implementations (e.g. HPA), but this further constrains the shape +the referenced resources may take.

                  +

                  + + + + + + + + + + + + + + + + + + + + + +
                  FieldDescription
                  +metadata
                  + + +Kubernetes meta/v1.ObjectMeta + + +                  		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                  +spec
                  + + +PodScalableSpec + + +                  		 +
                  +
                  + + + + + + + + + + + + + +
                  +replicas
                  + +int32 + +                  		 +
                  +selector
                  + + +Kubernetes meta/v1.LabelSelector + + +                  		 +
                  +template
                  + + +Kubernetes core/v1.PodTemplateSpec + + +                  		 +
                  +
                  +status
                  + + +PodScalableStatus + + +                  		 +
                  +

                  PodScalableSpec +

                  +

                  +(Appears on: +PodScalable) +

                  +

                  +

                  PodScalableSpec is the specification for the desired state of a +PodScalable (or at least our shared portion).

                  +

                  + + + + + + + + + + + + + + + + + + + + + +
                  FieldDescription
                  +replicas
                  + +int32 + +                  		 +
                  +selector
                  + + +Kubernetes meta/v1.LabelSelector + + +                  		 +
                  +template
                  + + +Kubernetes core/v1.PodTemplateSpec + + +                  		 +
                  +

                  PodScalableStatus +

                  +

                  +(Appears on: +PodScalable) +

                  +

                  +

                  PodScalableStatus is the observed state of a PodScalable (or at +least our shared portion).

                  +

                  + + + + + + + + + + + + + +
                  FieldDescription
                  +replicas
                  + +int32 + +                  		 +
                  +

                  ReachabilityType +(string alias)

                  +

                  +(Appears on: +PodAutoscalerSpec) +

                  +

                  +

                  ReachabilityType is the enumeration type for the different states of reachability +to the ScaleTarget of a PodAutoscaler

                  +

                  +

                  serving.knative.dev/v1

                  +

                  Package v1 contains the Serving v1 API types.

                  Resource Types:
                  • @@ -460,7 +1131,7 @@ ServiceStatus

                    (Appears on: -Configuration, +Configuration, ServiceSpec)

                    @@ -541,7 +1212,7 @@ ConfigurationStatusFields

                    (Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus)

                    @@ -628,7 +1299,7 @@ string

                    (Appears on: -Revision, +Revision, RevisionTemplateSpec)

                    @@ -886,7 +1557,7 @@ be provided.

                    (Appears on: -Route, +Route, ServiceSpec)

                    @@ -968,7 +1639,7 @@ RouteStatusFields

                    (Appears on: -RouteStatus, +RouteStatus, ServiceStatus)

                    @@ -1163,7 +1834,7 @@ specific to RouteStatus.

                    (Appears on: -RouteSpec, +RouteSpec, RouteStatusFields)

                    @@ -1271,7 +1942,236 @@ a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)<

                    +

                    serving.knative.dev/v1alpha1

                    +

                    +

                    Package v1alpha1 contains the v1alpha1 versions of the serving apis. +Api versions allow the api contract for a resource to be changed while keeping +backward compatibility by support multiple concurrent versions +of the same resource

                    +

                    +Resource Types: + +

                    DomainMapping +

                    +

                    +

                    DomainMapping is a mapping from a custom hostname to an Addressable.

                    +

                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +apiVersion
                    +string                    		 + +serving.knative.dev/v1alpha1 + +
                    +kind
                    +string +                    		DomainMapping
                    +metadata
                    + + +Kubernetes meta/v1.ObjectMeta + + +                    		 +(Optional) +

                    Standard object’s metadata. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

                    +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
                    +spec
                    + + +DomainMappingSpec + + +                    		 +(Optional) +

                    Spec is the desired state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                    +
                    +
                    + + + + + +
                    +ref
                    + +knative.dev/pkg/apis/duck/v1.KReference + +                    		 +

                    Ref points to an Addressable. +Currently, Ref must be a KSvc.

                    +
                    +
                    +status
                    + + +DomainMappingStatus + + +                    		 +(Optional) +

                    Status is the current state of the DomainMapping. +More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

                    +
                    +

                    CannotConvertError +

                    +

                    +

                    CannotConvertError is returned when a field cannot be converted.

                    +

                    + + + + + + + + + + + + + + + + + +
                    FieldDescription
                    +Message
                    + +string + +                    		 +
                    +Field
                    + +string + +                    		 +
                    +

                    DomainMappingSpec +

                    +

                    +(Appears on: +DomainMapping) +

                    +

                    +

                    DomainMappingSpec describes the DomainMapping the user wishes to exist.

                    +

                    + + + + + + + + + + + + + +
                    FieldDescription
                    +ref
                    + +knative.dev/pkg/apis/duck/v1.KReference + +                    		 +

                    Ref points to an Addressable. +Currently, Ref must be a KSvc.

                    +
                    +

                    DomainMappingStatus +

                    +

                    +(Appears on: +DomainMapping) +

                    +

                    +

                    DomainMappingStatus describes the current state of the DomainMapping.

                    +

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

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

                    +
                    +url
                    + +knative.dev/pkg/apis.URL + +                    		 +(Optional) +

                    URL is the URL of this DomainMapping.

                    +
                    +address
                    + +knative.dev/pkg/apis/duck/v1.Addressable + +                    		 +(Optional) +

                    Address holds the information needed for a DomainMapping to be the target of an event.

                    +
                    +

                    Generated with gen-crd-api-reference-docs -on git commit af83e581d. +on git commit db4879e0f.

                    diff --git a/hack/gen-api-reference-docs.sh b/hack/gen-api-reference-docs.sh index 8b78c07ff..372ea6100 100755 --- a/hack/gen-api-reference-docs.sh +++ b/hack/gen-api-reference-docs.sh @@ -23,7 +23,7 @@ SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" REFDOCS_PKG="github.com/ahmetb/gen-crd-api-reference-docs" REFDOCS_REPO="https://${REFDOCS_PKG}.git" -REFDOCS_VER="v0.1.5" +REFDOCS_VER="v0.2.0" KNATIVE_SERVING_REPO="github.com/knative/serving" KNATIVE_SERVING_IMPORT_PATH="knative.dev/serving" @@ -35,10 +35,10 @@ KNATIVE_EVENTING_IMPORT_PATH="knative.dev/eventing" KNATIVE_EVENTING_COMMIT="${KNATIVE_EVENTING_COMMIT:?specify the \$KNATIVE_EVENTING_COMMIT variable}" KNATIVE_EVENTING_OUT_FILE="eventing/eventing.md" -KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib" -KNATIVE_EVENTING_CONTRIB_IMPORT_PATH="knative.dev/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" +# KNATIVE_EVENTING_CONTRIB_REPO="github.com/knative/eventing-contrib" +# KNATIVE_EVENTING_CONTRIB_IMPORT_PATH="knative.dev/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= @@ -166,12 +166,12 @@ main() { gen_refdocs "${refdocs_bin}" "${clone_root}" "${template_dir}" \ "${out_dir}/${KNATIVE_EVENTING_OUT_FILE}" "${knative_eventing_root}" "./pkg/apis" - local knative_eventing_contrib_root - knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_IMPORT_PATH}" - 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_CONTRIB_OUT_FILE}" "${knative_eventing_contrib_root}" "." + # local knative_eventing_contrib_root + # knative_eventing_contrib_root="${clone_root}/src/${KNATIVE_EVENTING_CONTRIB_IMPORT_PATH}" + # 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_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"