From c73bd359e5b6261d0623e8d7cd83dc3eda3b3eb5 Mon Sep 17 00:00:00 2001 From: Richie Escarez Date: Wed, 30 Oct 2019 11:59:00 -0700 Subject: [PATCH] update eventing-contrib api --- docs/reference/eventing/eventing-contrib.md | 601 ++++++++++++++++++-- 1 file changed, 544 insertions(+), 57 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib.md b/docs/reference/eventing/eventing-contrib.md index 37ec7c21392..007bdf0c283 100644 --- a/docs/reference/eventing/eventing-contrib.md +++ b/docs/reference/eventing/eventing-contrib.md @@ -17,9 +17,13 @@ Resource Types:
  • CamelSource
  • +CouchDbSource +
  • GitHubSource
  • KafkaSource +
  • +PrometheusSource

    • AwsSqsSource

    @@ -230,6 +234,19 @@ Kubernetes core/v1.ObjectReference

    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.

    + + @@ -247,6 +264,146 @@ CamelSourceStatus +

    CouchDbSource +

    +

    +

    CouchDbSource is the Schema for the githubsources API

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +sources.eventing.knative.dev/v1alpha1 + +
    +kind
    +string +    		CouchDbSource
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +CouchDbSourceSpec + + +    		 +
    +
    + + + + + + + + + + + + + + + + + + + + + +
    +serviceAccountName
    + +string + +    		 +(Optional) +

    ServiceAccountName holds the name of the Kubernetes service account +as which the underlying K8s resources should be run. If unspecified +this will default to the “default” service account for the namespace +in which the CouchDbSource exists.

    +
    +credentials
    + + +Kubernetes core/v1.ObjectReference + + +    		 +

    CouchDbCredentials is the credential to use to access CouchDb. +Must be a secret. Only Name and Namespace are used.

    +
    +feed
    + + +FeedType + + +    		 +

    Feed changes how CouchDB sends the response. +More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds

    +
    +database
    + +string + +    		 +

    Database is the database to watch for changes

    +
    +sink
    + +knative.dev/pkg/apis/v1alpha1.Destination + +    		 +(Optional) +

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

    +
    +
    +status
    + + +CouchDbSourceStatus + + +    		 +

    GitHubSource

    @@ -539,9 +696,7 @@ KafkaSourceNetSpec sink
    - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/v1alpha1.Destination @@ -591,6 +746,132 @@ KafkaSourceStatus +

    PrometheusSource +

    +

    +

    PrometheusSource is the Schema for the prometheussources API

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +apiVersion
    +string    		 + +sources.eventing.knative.dev/v1alpha1 + +
    +kind
    +string +    		PrometheusSource
    +metadata
    + + +Kubernetes meta/v1.ObjectMeta + + +    		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
    +spec
    + + +PrometheusSourceSpec + + +    		 +
    +
    + + + + + + + + + + + + + + + + + +
    +serviceAccountName
    + +string + +    		 +(Optional) +

    ServiceAccountName holds the name of the Kubernetes service account +as which the underlying K8s resources should be run. If unspecified +this will default to the “default” service account for the namespace +in which the PrometheusSource exists.

    +
    +serverURL
    + +string + +    		 +

    ServerURL is the URL of the Prometheus server

    +
    +promQL
    + +string + +    		 +

    PromQL is the Prometheus query for this source

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

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

    +
    +
    +status
    + + +PrometheusSourceStatus + + +    		 +

    AwsSqsSourceSpec

    @@ -708,13 +989,14 @@ string -

    CamelSourceOriginComponentSpec +

    CamelSourceOriginSpec

    (Appears on: -CamelSourceOriginSpec) +CamelSourceSpec)

    +

    CamelSourceOriginSpec is the integration flow to run

    @@ -726,59 +1008,97 @@ string + +
    -uri
    +integration
    -string +github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec     		-

    URI is a Camel component URI to use as starting point (e.g. “timer:tick?period=2s”)

    +

    Integration is a kind of source that contains a Camel K integration
    -properties
    +flow
    -map[string]string + +Flow +     		+

    Flow is a kind of source that contains a single Camel YAML flow route
    +

    CamelSourceSpec +

    +

    +(Appears on: +CamelSource) +

    +

    +

    CamelSourceSpec defines the desired state of CamelSource

    +

    + + + + + + + + + + + +
    FieldDescription
    -serviceAccountName
    +source
    -string + +CamelSourceOriginSpec + + +    		 +

    Source is the reference to the integration flow to run.

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

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

    +

    Sink is a reference to an object that will resolve to a domain name to use as the sink.
    -context
    +ceOverrides
    -string +knative.dev/pkg/apis/duck/v1.CloudEventOverrides     		(Optional) -

    The Camel K context to use when running the source

    +

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

    CamelSourceOriginSpec +

    CamelSourceStatus

    (Appears on: -CamelSourceSpec) +CamelSource)

    -

    CamelSourceOriginSpec is the integration flow to run

    +

    CamelSourceStatus defines the observed state of CamelSource

    @@ -790,50 +1110,42 @@ string - - - -
    -component
    - - -CamelSourceOriginComponentSpec - - -    		 -

    Component is a kind of source that directly references a Camel component -DEPRECATED

    -
    -integration
    +Status
    -github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec +knative.dev/pkg/apis/duck/v1.Status     		-

    Integration is a kind of source that contains a Camel K integration

    +

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

    +

    inherits duck/v1alpha1 Status, which currently provides: +* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. +* Conditions - the latest available observations of a resource’s current state.
    -flow
    +sinkUri
    string     		-

    Flow is a kind of source that contains a single Camel YAML flow route

    +(Optional) +

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

    CamelSourceSpec +

    CouchDbSourceSpec

    (Appears on: -CamelSource) +CouchDbSource)

    -

    CamelSourceSpec defines the desired state of CamelSource

    +

    CouchDbSourceSpec defines the desired state of CouchDbSource

    @@ -845,20 +1157,22 @@ string + + + + + + + + + + + +
    -source
    +serviceAccountName
    - -CamelSourceOriginSpec - +string     		-

    Source is the reference to the integration flow to run.

    +(Optional) +

    ServiceAccountName holds the name of the Kubernetes service account +as which the underlying K8s resources should be run. If unspecified +this will default to the “default” service account for the namespace +in which the CouchDbSource exists.
    -sink
    +credentials
    Kubernetes core/v1.ObjectReference @@ -866,20 +1180,57 @@ Kubernetes core/v1.ObjectReference     		+

    CouchDbCredentials is the credential to use to access CouchDb. +Must be a secret. Only Name and Namespace are used.

    +
    +feed
    + + +FeedType + + +    		 +

    Feed changes how CouchDB sends the response. +More information: https://docs.couchdb.org/en/stable/api/database/changes.html#changes-feeds

    +
    +database
    + +string + +    		 +

    Database is the database to watch for changes

    +
    +sink
    + +knative.dev/pkg/apis/v1alpha1.Destination + +    		 (Optional)

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

    CamelSourceStatus +

    CouchDbSourceStatus

    (Appears on: -CamelSource) +CouchDbSource)

    -

    CamelSourceStatus defines the observed state of CamelSource

    +

    CouchDbSourceStatus defines the observed state of CouchDbSource

    @@ -893,7 +1244,7 @@ Kubernetes core/v1.ObjectReference
    Status
    -knative.dev/pkg/apis/duck/v1alpha1.Status +knative.dev/pkg/apis/duck/v1beta1.Status     		@@ -914,11 +1265,30 @@ string (Optional) -

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

    +

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

    FeedType +(string alias)

    +

    +(Appears on: +CouchDbSourceSpec) +

    +

    +

    FeedType is the type of Feed

    +

    +

    Flow +(map[string]interface{} alias)

    +

    +(Appears on: +CamelSourceOriginSpec) +

    +

    +

    Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL

    +

    GitHubSourceSpec

    @@ -1391,9 +1761,7 @@ KafkaSourceNetSpec sink
    - -Kubernetes core/v1.ObjectReference - +knative.dev/pkg/apis/v1alpha1.Destination @@ -1449,7 +1817,7 @@ KafkaResourceSpec Status
    -knative.dev/pkg/apis/duck/v1alpha1.Status +knative.dev/pkg/apis/duck/v1.Status @@ -1545,6 +1913,125 @@ SecretValueFromSource +

    PrometheusSourceSpec +

    +

    +(Appears on: +PrometheusSource) +

    +

    +

    PrometheusSourceSpec defines the desired state of PrometheusSource

    +

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

    ServiceAccountName holds the name of the Kubernetes service account +as which the underlying K8s resources should be run. If unspecified +this will default to the “default” service account for the namespace +in which the PrometheusSource exists.

    +
    +serverURL
    + +string + +    		 +

    ServerURL is the URL of the Prometheus server

    +
    +promQL
    + +string + +    		 +

    PromQL is the Prometheus query for this source

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

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

    +
    +

    PrometheusSourceStatus +

    +

    +(Appears on: +PrometheusSource) +

    +

    +

    PrometheusSourceStatus defines the observed state of PrometheusSource

    +

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

    +
    +sinkUri
    + +string + +    		 +(Optional) +

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

    +

    SecretValueFromSource

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

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