diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 61f9f9327..eea887d18 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -85,6 +85,9 @@ To generate a version of the API: 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. +1. The linter now fails for content with trailing whitespaces. Use a tool of your choice to + remove all trailing whitespace. For example, search for and remove: `\s+$` + You can now perform the necessary steps to open a PR, complete a review, and merge the new API files into the appropriate branch of the `knative/docs` repo. See the [contributor flow](https://github.com/knative/community/blob/master/docs/DOCS-CONTRIBUTING.md) for details @@ -92,19 +95,18 @@ about requesting changes in the `knative/docs` repo. ### Example - -To build a set of Knative API docs for v0.3, you can use the `v0.3.0` the tags +To build a set of Knative API docs for v0.18, you can use the `v0.18.0` the tags from each of the Knative component repositories, like -[Serving v0.3.0](https://github.com/knative/serving/tree/v0.3.0). If you want to -use a commit for Serving v0.3.0, you would use -[4d198d](https://github.com/knative/serving/commit/4d198db8756db2f8a3c228302a97fb3a216a9475). +[Serving v0.18.0](https://github.com/knative/serving/tree/v0.18.0). If you want to +use a commit for Serving v0.18.0, you would use +[850b7c](https://github.com/knative/serving/commit/850b7cca7d7701b052420a030f2308d19938d45e). Using tags from each repo, you would run the following command to generate the -v0.3.0 API source files: +v0.18.0 API source files: ``` -KNATIVE_SERVING_COMMIT=v0.3.0 \ -KNATIVE_EVENTING_COMMIT=v0.3.0 \ -KNATIVE_EVENTING_CONTRIB_COMMIT=v0.3.0 \ +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/_index.md b/docs/reference/api/_index.md index 25b21f007..9c3c73ee9 100644 --- a/docs/reference/api/_index.md +++ b/docs/reference/api/_index.md @@ -1,11 +1,6 @@ --- title: "Knative API Reference Documentation" linkTitle: "API" -weight: 100 +weight: 50 type: "docs" -aliases: -aliases: - - /docs/reference/ --- - -{{% readfile file="README.md" %}} diff --git a/docs/reference/api/eventing/eventing-contrib.md b/docs/reference/api/eventing/eventing-contrib.md index a8cb795b1..9c483372d 100644 --- a/docs/reference/api/eventing/eventing-contrib.md +++ b/docs/reference/api/eventing/eventing-contrib.md @@ -1,24 +1,372 @@
Packages:
+
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
+ +Resource Types: ++(Appears on: +KafkaResourceSpec) +
++
+Field | +Description | +
---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+(Appears on: +KafkaResourceSpec) +
++
+Field | +Description | +
---|---|
+cpu
+
+string
+
+ |
++ | +
+memory
+
+string
+
+ |
++ | +
+
+Field | +Description | +
---|---|
+requests
+
+
+KafkaRequestsSpec
+
+
+ |
++ | +
+limits
+
+
+KafkaLimitsSpec
+
+
+ |
++ | +
+
KafkaSource is the Schema for the kafkasources API.
+ +Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec
+
+
+KafkaSourceSpec
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+KafkaSourceStatus
+
+
+ |
++ | +
+(Appears on: +KafkaSource) +
++
KafkaSourceSpec defines the desired state of the KafkaSource.
+ +Field | +Description | +
---|---|
+KafkaAuthSpec
+
+
+KafkaAuthSpec
+
+
+ |
+
+
+(Members of |
+
+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 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. + |
+
+(Appears on: +KafkaSource) +
++
KafkaSourceStatus defines the observed state of KafkaSource.
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
Package v1alpha1 is the v1alpha1 version of the API.
@@ -26,8 +374,6 @@ Resource Types:-
NatssChannel is a resource representing a NATSS Channel.
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-messaging.knative.dev/v1alpha1
-
- |
-||
-kind
-string
- |
-NatssChannel |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-NatssChannelSpec
-
-
- |
-
- Spec defines the desired state of the Channel. -- -
|
-||
-status
-
-
-NatssChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the NatssChannel. This data may be out of -date. - |
-
@@ -349,102 +605,6 @@ knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus -
-(Appears on: -NatssChannel) -
--
NatssChannelSpec defines the specification for a NatssChannel.
- -Field | -Description | -
---|---|
-subscribable
-
-knative.dev/eventing/pkg/apis/duck/v1alpha1.Subscribable
-
- |
-
- NatssChannel conforms to Duck type Subscribable. - |
-
-(Appears on: -NatssChannel) -
--
NatssChannelStatus represents the current state of a NatssChannel.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 NatssChannel is Addressable. It currently exposes the endpoint as a -fully-qualified DNS name which will distribute traffic over the -provided targets from inside the cluster. -It generally has the form {channel}.{namespace}.svc.{cluster domain name} - |
-
-SubscribableTypeStatus
-
-knative.dev/eventing/pkg/apis/duck/v1alpha1.SubscribableTypeStatus
-
- |
-
-
-(Members of Subscribers is populated with the statuses of each of the Channelable’s subscribers. - |
-
@@ -658,6 +818,420 @@ knative.dev/eventing/pkg/apis/duck/v1.ChannelableStatus
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: ++(Appears on: +KafkaBindingSpec, +KafkaSourceSpec) +
++
+Field | +Description | +
---|---|
+bootstrapServers
+
+[]string
+
+ |
+
+ Bootstrap servers are the Kafka servers the consumer will connect to. + |
+
+net
+
+
+KafkaNetSpec
+
+
+ |
++ | +
+
KafkaBinding is the Schema for the kafkasources API.
+ +Field | +Description | +||||
---|---|---|---|---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+KafkaBindingSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+KafkaBindingStatus
+
+
+ |
++ | +
+(Appears on: +KafkaBinding) +
++
KafkaBindingSpec defines the desired state of the KafkaBinding.
+ +Field | +Description | +
---|---|
+BindingSpec
+
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+ |
+
+
+(Members of |
+
+KafkaAuthSpec
+
+
+KafkaAuthSpec
+
+
+ |
+
+
+(Members of |
+
+(Appears on: +KafkaBinding) +
++
KafkaBindingStatus defines the observed state of KafkaBinding.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of |
+
+(Appears on: +KafkaAuthSpec) +
++
+Field | +Description | +
---|---|
+sasl
+
+
+KafkaSASLSpec
+
+
+ |
++ | +
+tls
+
+
+KafkaTLSSpec
+
+
+ |
++ | +
+(Appears on: +KafkaNetSpec) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +KafkaNetSpec) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +KafkaSASLSpec, +KafkaTLSSpec) +
++
SecretValueFromSource represents the source of a secret value
+ +Field | +Description | +
---|---|
+secretKeyRef
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
+ The Secret key to select from. + |
+
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
@@ -668,7 +1242,7 @@ Resource Types:(Appears on: -KafkaBindingSpec, +KafkaBindingSpec, KafkaSourceSpec)
@@ -1042,7 +1616,7 @@ SecretValueFromSource
(Appears on: -KafkaSASLSpec, +KafkaSASLSpec, KafkaTLSSpec)
@@ -1072,2056 +1646,12 @@ Kubernetes core/v1.SecretKeySelector
-
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group
- -Resource Types: --(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-(Appears on: -KafkaResourceSpec) -
--
-Field | -Description | -
---|---|
-cpu
-
-string
-
- |
-- | -
-memory
-
-string
-
- |
-- | -
-
-Field | -Description | -
---|---|
-requests
-
-
-KafkaRequestsSpec
-
-
- |
-- | -
-limits
-
-
-KafkaLimitsSpec
-
-
- |
-- | -
-
KafkaSource is the Schema for the kafkasources API.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||
-spec
-
-
-KafkaSourceSpec
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-KafkaSourceStatus
-
-
- |
-- | -
-(Appears on: -KafkaSource) -
--
KafkaSourceSpec defines the desired state of the KafkaSource.
- -Field | -Description | -
---|---|
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-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 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. - |
-
-(Appears on: -KafkaSource) -
--
KafkaSourceStatus defines the observed state of KafkaSource.
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types: --
AwsSqsSource is the Schema for the AWS SQS API
- -Field | -Description | -||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||||||
-kind
-string
- |
-AwsSqsSource |
-||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec
-
-
-AwsSqsSourceSpec
-
-
- |
-
- - -
|
-||||||||||
-status
-
-
-AwsSqsSourceStatus
-
-
- |
-- | -
-
CamelSource is the Schema for the camelsources API
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||
-kind
-string
- |
-CamelSource |
-||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-CamelSourceSpec
-
-
- |
-
- - -
|
-||||||
-status
-
-
-CamelSourceStatus
-
-
- |
-- | -
-
CouchDbSource is the Schema for the githubsources API
- -Field | -Description | -||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.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
-
-
- |
-
- - -
|
-||||||||||
-status
-
-
-CouchDbSourceStatus
-
-
- |
-- | -
-
GitHubSource is the Schema for the githubsources API
- -Field | -Description | -||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||||||||||||
-kind
-string
- |
-GitHubSource |
-||||||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||||||
-spec
-
-
-GitHubSourceSpec
-
-
- |
-
- - -
|
-||||||||||||||||
-status
-
-
-GitHubSourceStatus
-
-
- |
-- | -
-
GitLabSource is the Schema for the gitlabsources API
- -Field | -Description | -||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha1
-
- |
-||||||||||||||
-kind
-string
- |
-GitLabSource |
-||||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||||
-spec
-
-
-GitLabSourceSpec
-
-
- |
-
- - -
|
-||||||||||||||
-status
-
-
-GitLabSourceStatus
-
-
- |
-- | -
-
PrometheusSource is the Schema for the prometheussources API
- -Field | -Description | -||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.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
-
-
- |
-
- - -
|
-||||||||||||||||
-status
-
-
-PrometheusSourceStatus
-
-
- |
-- | -
-(Appears on: -AwsSqsSource) -
--
AwsSqsSourceSpec defines the desired state of the source.
- -Field | -Description | -
---|---|
-queueUrl
-
-string
-
- |
-
- QueueURL of the SQS queue that we will poll from. - |
-
-awsCredsSecret
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
-(Optional)
- AwsCredsSecret is the credential to use to poll the AWS SQS - |
-
-annotations
-
-map[string]string
-
- |
-
-(Optional)
- Annotations to add to the pod, mostly used for Kube2IAM role - |
-
-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. This is where events will be received. - |
-
-serviceAccountName
-
-string
-
- |
-
- ServiceAccoutName is the name of the ServiceAccount that will be used to -run the Receive Adapter Deployment. - |
-
-(Appears on: -AwsSqsSource) -
--
AwsSqsSourceStatus defines the observed state of the source.
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -CamelSourceSpec) -
--
CamelSourceOriginSpec is the integration flow to run
- -Field | -Description | -
---|---|
-integration
-
-github.com/apache/camel-k/pkg/apis/camel/v1.IntegrationSpec
-
- |
-
- Integration is a kind of source that contains a Camel K integration - |
-
-flow
-
-
-Flow
-
-
- |
-
- Flow is a kind of source that contains a single Camel YAML flow route - |
-
-(Appears on: -CamelSource) -
--
CamelSourceSpec defines the desired state of CamelSource
- -Field | -Description | -
---|---|
-source
-
-
-CamelSourceOriginSpec
-
-
- |
-
- Source is the reference to the integration flow to run. - |
-
-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. - |
-
-(Appears on: -CamelSource) -
--
CamelSourceStatus defines the observed state of CamelSource
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of inherits duck/v1alpha1 Status, which currently provides: -* ObservedGeneration - the ‘Generation’ of the Service that was last processed by the controller. -* Conditions - the latest available observations of a resource’s current state. - |
-
-sinkUri
-
-string
-
- |
-
-(Optional)
- SinkURI is the current active sink URI that has been configured for the CamelSource. - |
-
-(Appears on: -CouchDbSource) -
--
CouchDbSourceSpec defines the desired state of CouchDbSource
- -Field | -Description | -
---|---|
-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/duck/v1.Destination
-
- |
-
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. - |
-
-(Appears on: -CouchDbSource) -
--
CouchDbSourceStatus defines the observed state of CouchDbSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
string
alias)-(Appears on: -CouchDbSourceSpec) -
--
FeedType is the type of Feed
- -map[string]interface{}
alias)-(Appears on: -CamelSourceOriginSpec) -
--
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL
- --(Appears on: -GitHubSource) -
--
GitHubSourceSpec defines the desired state of GitHubSource
- -Field | -Description | -
---|---|
-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 GitHubSource exists. - |
-
-ownerAndRepository
-
-string
-
- |
-
- OwnerAndRepository is the GitHub owner/org and repository to -receive events from. The repository may be left off to receive -events from an entire organization. -Examples: -myuser/project -myorganization - |
-
-eventTypes
-
-[]string
-
- |
-
- EventType is the type of event to receive from GitHub. These -correspond to the “Webhook event name” values listed at -https://developer.github.com/v3/activity/events/types/ - ie -“pull_request” - |
-
-accessToken
-
-
-SecretValueFromSource
-
-
- |
-
- AccessToken is the Kubernetes secret containing the GitHub -access token - |
-
-secretToken
-
-
-SecretValueFromSource
-
-
- |
-
- SecretToken is the Kubernetes secret containing the GitHub -secret token - |
-
-githubAPIURL
-
-string
-
- |
-
-(Optional)
- API URL if using github enterprise (default https://api.github.com) - |
-
-secure
-
-bool
-
- |
-
-(Optional)
- Secure can be set to true to configure the webhook to use https, -or false to use http. Omitting it relies on the scheme of the -Knative Service created (e.g. if auto-TLS is enabled it should -do the right thing). - |
-
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -GitHubSource) -
--
GitHubSourceStatus defines the observed state of GitHubSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-webhookIDKey
-
-string
-
- |
-
- WebhookIDKey is the ID of the webhook registered with GitHub - |
-
-(Appears on: -GitLabSource) -
--
GitLabSourceSpec defines the desired state of GitLabSource
- -Field | -Description | -
---|---|
-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 GitLabSource exists. - |
-
-projectUrl
-
-string
-
- |
-
- ProjectUrl is the url of the GitLab project for which we are interested -to receive events from. -Examples: -https://gitlab.com/gitlab-org/gitlab-foss - |
-
-eventTypes
-
-[]string
-
- |
-
- EventType is the type of event to receive from Gitlab. These -correspond to supported events to the add project hook -https://docs.gitlab.com/ee/api/projects.html#add-project-hook - |
-
-accessToken
-
-
-SecretValueFromSource
-
-
- |
-
- AccessToken is the Kubernetes secret containing the GitLab -access token - |
-
-secretToken
-
-
-SecretValueFromSource
-
-
- |
-
- SecretToken is the Kubernetes secret containing the GitLab -secret token - |
-
-sslverify
-
-bool
-
- |
-
- SslVerify if true configure webhook so the ssl verification is done when triggering the hook - |
-
-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. - |
-
-(Appears on: -GitLabSource) -
--
GitLabSourceStatus defines the observed state of GitLabSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-Id
-
-string
-
- |
-
- ID of the project hook registered with GitLab - |
-
@@ -3509,1079 +2039,8 @@ Source.
--(Appears on: -PrometheusSource) -
--
PrometheusSourceSpec defines the desired state of PrometheusSource
- -Field | -Description | -
---|---|
-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 - |
-
-authTokenFile
-
-string
-
- |
-
-(Optional)
- The name of the file containing the authenication token - |
-
-caCertConfigMap
-
-string
-
- |
-
-(Optional)
- The name of the config map containing the CA certificate of the -Prometheus service’s signer. - |
-
-schedule
-
-string
-
- |
-
- A crontab-formatted schedule for running the PromQL query - |
-
-step
-
-string
-
- |
-
-(Optional)
- Query resolution step width in duration format or float number of seconds. -Prometheus duration strings are of the form [0-9]+[smhdwy]. - |
-
-sink
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-(Optional)
- Sink is a reference to an object that will resolve to a host -name to use as the sink. - |
-
-(Appears on: -PrometheusSource) -
--
PrometheusSourceStatus defines the observed state of PrometheusSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -GitHubSourceSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-(Appears on: -GitLabSourceSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
GitHubBinding 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.
Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-bindings.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-GitHubBinding |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-GitHubBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-GitHubBindingStatus
-
-
- |
-- | -
-
GitLabBinding 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.
Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-bindings.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-GitLabBinding |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-GitLabBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-GitLabBindingStatus
-
-
- |
-- | -
-(Appears on: -GitHubBinding) -
--
GitHubBindingSpec holds the desired state of the GitHubBinding (from the client).
- -Field | -Description | -
---|---|
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-accessToken
-
-
-SecretValueFromSource
-
-
- |
-
- AccessToken is the Kubernetes secret containing the GitHub -access token - |
-
-(Appears on: -GitHubBinding) -
--
GitHubBindingStatus communicates the observed state of the GitHubBinding (from the controller).
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of |
-
-(Appears on: -GitLabBinding) -
--
GitLabBindingSpec holds the desired state of the GitLabBinding (from the client).
- -Field | -Description | -
---|---|
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-accessToken
-
-
-SecretValueFromSource
-
-
- |
-
- AccessToken is the Kubernetes secret containing the GitLab -access token - |
-
-(Appears on: -GitLabBinding) -
--
GitLabBindingStatus communicates the observed state of the GitLabBinding (from the controller).
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaBindingSpec, -KafkaSourceSpec) -
--
-Field | -Description | -
---|---|
-bootstrapServers
-
-[]string
-
- |
-
- Bootstrap servers are the Kafka servers the consumer will connect to. - |
-
-net
-
-
-KafkaNetSpec
-
-
- |
-- | -
-
KafkaBinding is the Schema for the kafkasources API.
- -Field | -Description | -||||
---|---|---|---|---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-KafkaBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-KafkaBindingStatus
-
-
- |
-- | -
-(Appears on: -KafkaBinding) -
--
KafkaBindingSpec defines the desired state of the KafkaBinding.
- -Field | -Description | -
---|---|
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-KafkaAuthSpec
-
-
-KafkaAuthSpec
-
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaBinding) -
--
KafkaBindingStatus defines the observed state of KafkaBinding.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of |
-
-(Appears on: -KafkaAuthSpec) -
--
-Field | -Description | -
---|---|
-sasl
-
-
-KafkaSASLSpec
-
-
- |
-- | -
-tls
-
-
-KafkaTLSSpec
-
-
- |
-- | -
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -KafkaNetSpec) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -GitLabBindingSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-(Appears on: -GitHubBindingSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-(Appears on: -KafkaSASLSpec, -KafkaTLSSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
Generated with gen-crd-api-reference-docs
-on git commit 9683a047
.
+on git commit ef8b78ed
.
Packages:
-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
- -Field | -Description | -||||
---|---|---|---|---|---|
-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. -- -
|
-||||
-status
-
-
-ChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
InMemoryChannel is a resource representing an in memory channel
- -Field | -Description | -||
---|---|---|---|
-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. -- -
|
-||
-status
-
-
-InMemoryChannelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Channel. This data may be out of -date. - |
-
-
Subscription routes events received on a Channel to a DNS name and -corresponds to the subscriptions.channels.knative.dev CRD.
- -Field | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
-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
-
-
- |
-
- - -
|
-||||||||
-status
-
-
-SubscriptionStatus
-
-
- |
-- | -
-
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not -specify any implementation.
- --(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.
- -Field | -Description | -
---|---|
-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 Channel conforms to ChannelableSpec - |
-
-(Appears on: -Channel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to ChannelableStatus - |
-
-channel
-
-knative.dev/pkg/apis/duck/v1.KReference
-
- |
-
- Channel is an KReference to the Channel CRD backing this Channel. - |
-
-(Appears on: -ChannelSpec, -ParallelSpec, -SequenceSpec) -
--
-Field | -Description | -
---|---|
-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 is an internal only version that includes ObjectMeta so that -we can easily create new Channels off of it.
- -Field | -Description | -
---|---|
-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. -- - |
-
-(Appears on: -InMemoryChannel) -
--
InMemoryChannelSpec defines which subscribers have expressed interest in -receiving events from this InMemoryChannel. -arguments for a Channel.
- -Field | -Description | -
---|---|
-ChannelableSpec
-
-
-ChannelableSpec
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(Appears on: -InMemoryChannel) -
--
ChannelStatus represents the current state of a Channel.
- -Field | -Description | -
---|---|
-ChannelableStatus
-
-
-ChannelableStatus
-
-
- |
-
-
-(Members of Channel conforms to Duck type Channelable. - |
-
-(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
- -Field | -Description | -
---|---|
-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 - |
-
-(Appears on: -Subscription) -
--
SubscriptionStatus (computed) for a subscription
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SubscriptionStatus) -
--
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this -Subscription.
- -Field | -Description | -
---|---|
-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. - |
-
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -Field | -Description | -||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-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
-
-
- |
-
- - -
|
-||||||||||||
-status
-
-
-ApiServerSourceStatus
-
-
- |
-- | -
-
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.
Field | -Description | -||||
---|---|---|---|---|---|
-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
-
-
- |
-
- - -
|
-||||
-status
-
-
-SinkBindingStatus
-
-
- |
-- | -
-(Appears on: -ApiServerSourceSpec) -
--
ApiServerResource defines the resource to watch
- -Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -Field | -Description | -
---|---|
-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.
- |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of |
-
-BindingSpec
-
-knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
-
- |
-
-
-(Members of |
-
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of |
-
-
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
- -Resource Types: --
ApiServerSource is the Schema for the apiserversources API
- -Field | -Description | -||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||||||||
-kind
-string
- |
-ApiServerSource |
-||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||
-spec
-
-
-ApiServerSourceSpec
-
-
- |
-
- - -
|
-||||||||||
-status
-
-
-ApiServerSourceStatus
-
-
- |
-- | -
-
ContainerSource is the Schema for the containersources API
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||
-kind
-string
- |
-ContainerSource |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ContainerSourceSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-ContainerSourceStatus
-
-
- |
-- | -
-
PingSource is the Schema for the PingSources API.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||||
-kind
-string
- |
-PingSource |
-||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-PingSourceSpec
-
-
- |
-
- - -
|
-||||||
-status
-
-
-PingSourceStatus
-
-
- |
-- | -
-
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.
Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.knative.dev/v1alpha2
-
- |
-||||
-kind
-string
- |
-SinkBinding |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-SinkBindingSpec
-
-
- |
-
- - -
|
-||||
-status
-
-
-SinkBindingStatus
-
-
- |
-- | -
-(Appears on: -ApiServerSourceSpec, -ApiServerSourceSpec) -
--
APIVersionKind is an APIVersion and Kind tuple.
- -Field | -Description | -
---|---|
-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 - |
-
-(Appears on: -ApiServerSourceSpec) -
--
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
- -Field | -Description | -
---|---|
-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 - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceSpec defines the desired state of ApiServerSource
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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.
- |
-
-serviceAccountName
-
-string
-
- |
-
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this -source. Defaults to default if not set. - |
-
-(Appears on: -ApiServerSource) -
--
ApiServerSourceStatus defines the observed state of ApiServerSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -ContainerSource) -
--
ContainerSourceSpec defines the desired state of ContainerSource
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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 - |
-
-(Appears on: -ContainerSource) -
--
ContainerSourceStatus defines the observed state of ContainerSource
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -PingSource) -
--
PingSourceSpec defines the desired state of the PingSource.
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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 |
-
-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”. - |
-
-(Appears on: -PingSource) -
--
PingSourceStatus defines the observed state of PingSource.
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SinkBinding) -
--
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
- -Field | -Description | -
---|---|
-SourceSpec
-
-knative.dev/pkg/apis/duck/v1.SourceSpec
-
- |
-
-
-(Members of 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/v1alpha1.BindingSpec
-
- |
-
-
-(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: -* Subject - Subject references the resource(s) whose “runtime contract” -should be augmented by Binding implementations. - |
-
-(Appears on: -SinkBinding) -
--
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
- -Field | -Description | -
---|---|
-SourceStatus
-
-knative.dev/pkg/apis/duck/v1.SourceStatus
-
- |
-
-
-(Members of 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. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: - --
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-configs.internal.knative.dev/v1alpha1
-
- |
-||||
-kind
-string
- |
-ConfigMapPropagation |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ConfigMapPropagationSpec
-
-
- |
-
- Spec defines the desired state of the ConfigMapPropagation -- -
|
-||||
-status
-
-
-ConfigMapPropagationStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the EventType. -This data may be out of date. - |
-
-(Appears on: -ConfigMapPropagation) -
--
-Field | -Description | -
---|---|
-originalNamespace
-
-string
-
- |
-
- OriginalNamespace is the namespace where the original configMaps are in - |
-
-selector
-
-
-Kubernetes meta/v1.LabelSelector
-
-
- |
-
-(Optional)
- Selector only selects original configMaps with corresponding labels - |
-
-(Appears on: -ConfigMapPropagation) -
--
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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. - |
-
-copyConfigmaps
-
-
-[]ConfigMapPropagationStatusCopyConfigMap
-
-
- |
-
-(Optional)
- CopyConfigMaps is the status for each copied configmap. - |
-
-(Appears on: -ConfigMapPropagationStatus) -
--
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
- -Field | -Description | -
---|---|
-name
-
-string
-
- |
-
- Name is copy configmap’s name - |
-
-source
-
-string
-
- |
-
- Source is “originalNamespace/originalConfigMapName” - |
-
-operation
-
-string
-
- |
-
- Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop - |
-
-ready
-
-string
-
- |
-
- Ready represents the operation is ready or not - |
-
-reason
-
-string
-
- |
-
- Reason indicates reasons if the operation is not ready - |
-
-resourceVersionFromSource
-
-string
-
- |
-
- ResourceVersion is the resourceVersion of original configmap - |
-
Package v1 is the v1 version of the API.
@@ -2847,8 +148,8 @@ ChannelableStatus(Appears on: -ChannelSpec, -Channelable, +ChannelSpec, +Channelable, InMemoryChannelSpec)
@@ -2897,8 +198,8 @@ DeliverySpec
(Appears on: -ChannelStatus, -Channelable, +ChannelStatus, +Channelable, InMemoryChannelStatus)
@@ -2977,13 +278,11 @@ Failed messages are delivered here.
(Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, +BrokerSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, SubscriptionSpec)
@@ -3165,8 +464,7 @@ configured as to be compatible with Subscribable contract.
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, +ChannelableSpec, Subscribable)
@@ -3199,8 +497,7 @@ configured as to be compatible with Subscribable contract.
(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, +ChannelableStatus, Subscribable)
@@ -3316,8 +613,7 @@ DeliverySpec
(Appears on: -SubscribableStatus, -SubscribableStatus) +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -3490,8 +786,8 @@ ChannelableStatus(Appears on: -ChannelSpec, -Channelable, +ChannelSpec, +Channelable, InMemoryChannelSpec)
@@ -3540,8 +836,8 @@ DeliverySpec
(Appears on: -ChannelStatus, -Channelable, +ChannelStatus, +Channelable, InMemoryChannelStatus)
@@ -3620,14 +916,14 @@ Failed messages are delivered here.
(Appears on: -BrokerSpec, -ChannelableCombinedSpec, -ChannelableSpec, -ChannelableSpec, -ParallelBranch, -SequenceStep, -SubscriberSpec, -SubscriberSpec, +BrokerSpec, +ChannelableCombinedSpec, +ChannelableSpec, +ChannelableSpec, +ParallelBranch, +SequenceStep, +SubscriberSpec, +SubscriberSpec, SubscriptionSpec)
@@ -3809,8 +1105,8 @@ configured as to be compatible with Subscribable contract.
(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, +ChannelableCombinedSpec, +ChannelableSpec, Subscribable)
@@ -3843,8 +1139,8 @@ configured as to be compatible with Subscribable contract.
(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, +ChannelableCombinedStatus, +ChannelableStatus, Subscribable)
@@ -3960,8 +1256,8 @@ DeliverySpec
(Appears on: -SubscribableStatus, -SubscribableStatus) +SubscribableStatus, +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -4510,1767 +1806,6 @@ knative.dev/pkg/apis.URL-
Package v1beta1 is the v1beta1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-ParallelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on: -ParallelSpec) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Parallel) -
--
-Field | -Description | -
---|---|
-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 - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 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} - |
-
-(Appears on: -ParallelBranchStatus) -
--
-Field | -Description | -
---|---|
-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 defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-SequenceStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Sequence) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 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} - |
-
-(Appears on: -SequenceSpec) -
--
-Field | -Description | -
---|---|
-Destination
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
-
Package v1alpha1 is the v1alpha1 version of the API.
- -Resource Types: --
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.
- -Field | -Description | -||||
---|---|---|---|---|---|
-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. -- -
|
-||||
-status
-
-
-ChannelableStatus
-
-
- |
-- | -
-
ChannelableCombined is a skeleton type wrapping Subscribable and Addressable of -v1alpha1, v1beta1 and v1 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.
- -Field | -Description | -||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||||||
-status
-
-
-ChannelableCombinedStatus
-
-
- |
-- | -
-(Appears on: -ChannelableCombined) -
--
ChannelableSpec contains Spec of the Channelable object
- -Field | -Description | -
---|---|
-SubscribableTypeSpec
-
-
-SubscribableTypeSpec
-
-
- |
-
-
-(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. - |
-
-SubscribableSpec
-
-
-SubscribableSpec
-
-
- |
-
-
-(Members of SubscribableSpec is for the v1beta1 spec compatibility. - |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery -for the v1beta1 spec compatibility. - |
-
-SubscribableSpecv1
-
-
-SubscribableSpec
-
-
- |
-
-
-(Members of SubscribableSpecv1 is for the v1 spec compatibility. - |
-
-deliveryv1
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- DeliverySpecv1 contains options controlling the event delivery -for the v1 spec compatibility. - |
-
-(Appears on: -ChannelableCombined) -
--
ChannelableStatus contains the Status of a Channelable object.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableTypeStatus
-
-
-SubscribableTypeStatus
-
-
- |
-
-
-(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status - |
-
-SubscribableStatus
-
-
-SubscribableStatus
-
-
- |
-
-
-(Members of SubscribableStatus is the v1beta1 part of the Subscribers status. - |
-
-SubscribableStatusv1
-
-
-SubscribableStatus
-
-
- |
-
-
-(Members of SubscribableStatusv1 is the v1 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 - |
-
-(Appears on: -Channelable) -
--
ChannelableSpec contains Spec of the Channelable object
- -Field | -Description | -
---|---|
-SubscribableTypeSpec
-
-
-SubscribableTypeSpec
-
-
- |
-
-
-(Members of |
-
-delivery
-
-
-DeliverySpec
-
-
- |
-
-(Optional)
- DeliverySpec contains options controlling the event delivery - |
-
-(Appears on: -Channelable) -
--
ChannelableStatus contains the Status of a Channelable object.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 is the part where the Channelable fulfills the Addressable contract. - |
-
-SubscribableTypeStatus
-
-
-SubscribableTypeStatus
-
-
- |
-
-
-(Members of 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 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.
- -Field | -Description | -
---|---|
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-
-(Appears on: -SubscribableTypeSpec) -
--
Subscribable is the schema for the subscribable portion of the spec -section of the resource.
- -Field | -Description | -
---|---|
-subscribers
-
-
-[]SubscriberSpec
-
-
- |
-
- This is the list of subscriptions for this subscribable. - |
-
-(Appears on: -SubscribableTypeStatus) -
--
SubscribableStatus is the schema for the subscribable’s status portion of the status -section of the resource.
- -Field | -Description | -
---|---|
-subscribers
-
-
-[]SubscriberStatus
-
-
- |
-
- This is the list of subscription’s statuses for this channel. - |
-
-subscribersv1
-
-
-[]SubscriberStatus
-
-
- |
-
- This is the list of subscription’s statuses for this channel. - |
-
-
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.
- -Field | -Description | -||
---|---|---|---|
-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. -- -
|
-||
-status
-
-
-SubscribableTypeStatus
-
-
- |
-
- SubscribableTypeStatus is the part where SubscribableStatus object is -configured as to be compatible with Subscribable contract. - |
-
-(Appears on: -ChannelableCombinedSpec, -ChannelableSpec, -SubscribableType) -
--
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
- -Field | -Description | -
---|---|
-subscribable
-
-
-Subscribable
-
-
- |
-- | -
-(Appears on: -ChannelableCombinedStatus, -ChannelableStatus, -SubscribableType) -
--
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
- -Field | -Description | -
---|---|
-subscribableStatus
-
-
-SubscribableStatus
-
-
- |
-- | -
-(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
- -Field | -Description | -
---|---|
-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) - | -
-deliveryv1
-
-
-DeliverySpec
-
-
- |
--(Optional) - | -
Package v1beta1 is the v1beta1 version of the API.
@@ -7042,839 +2577,6 @@ knative.dev/pkg/apis.URL-
Package v1 is the v1 version of the API.
- -Resource Types: --
Parallel defines conditional branches that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-ParallelStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Parallel. This data may be out of -date. - |
-
-(Appears on: -ParallelSpec) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -ParallelStatus) -
--
ParallelBranchStatus represents the current state of a Parallel branch
- -Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -ParallelBranchStatus, -ParallelStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Parallel) -
--
-Field | -Description | -
---|---|
-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 - |
-
-(Appears on: -Parallel) -
--
ParallelStatus represents the current state of a Parallel.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 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} - |
-
-(Appears on: -ParallelBranchStatus) -
--
-Field | -Description | -
---|---|
-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 defines a sequence of Subscribers that will be wired in -series through Channels and Subscriptions.
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-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. -- -
|
-||||||
-status
-
-
-SequenceStatus
-
-
- |
-
-(Optional)
- Status represents the current state of the Sequence. This data may be out of -date. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Sequence) -
--
-Field | -Description | -
---|---|
-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. - |
-
-(Appears on: -Sequence) -
--
SequenceStatus represents the current state of a Sequence.
- -Field | -Description | -
---|---|
-Status
-
-knative.dev/pkg/apis/duck/v1.Status
-
- |
-
-
-(Members of 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 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} - |
-
-(Appears on: -SequenceSpec) -
--
-Field | -Description | -
---|---|
-Destination
-
-knative.dev/pkg/apis/duck/v1.Destination
-
- |
-
-
-(Members of 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. - |
-
-(Appears on: -SequenceStatus) -
--
-Field | -Description | -
---|---|
-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. - |
-
Package v1 is the v1 version of the API.
@@ -8340,8 +3042,8 @@ knative.dev/pkg/apis/duck/v1.KReference(Appears on: -ChannelSpec, -ParallelSpec, +ChannelSpec, +ParallelSpec, SequenceSpec)
@@ -8693,6 +3395,576 @@ knative.dev/pkg/apis.URL
+
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
+ +Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
+ +Field | +Description | +||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||||||||||
+status
+
+
+ApiServerSourceStatus
+
+
+ |
++ | +
+
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.
Field | +Description | +||||
---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+SinkBindingStatus
+
+
+ |
++ | +
+(Appears on: +ApiServerSourceSpec) +
++
ApiServerResource defines the resource to watch
+ +Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+ +Field | +Description | +
---|---|
+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.
+ |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of |
+
+BindingSpec
+
+knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
+
+ |
+
+
+(Members of |
+
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of |
+
Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.
@@ -9741,7 +5013,4624 @@ Source.+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: + ++
ConfigMapPropagation is used to propagate configMaps from original namespace to current namespace
+ +Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+configs.internal.knative.dev/v1alpha1
+
+ |
+||||
+kind
+string
+ |
+ConfigMapPropagation |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+ConfigMapPropagationSpec
+
+
+ |
+
+ Spec defines the desired state of the ConfigMapPropagation ++ +
|
+||||
+status
+
+
+ConfigMapPropagationStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the EventType. +This data may be out of date. + |
+
+(Appears on: +ConfigMapPropagation) +
++
+Field | +Description | +
---|---|
+originalNamespace
+
+string
+
+ |
+
+ OriginalNamespace is the namespace where the original configMaps are in + |
+
+selector
+
+
+Kubernetes meta/v1.LabelSelector
+
+
+ |
+
+(Optional)
+ Selector only selects original configMaps with corresponding labels + |
+
+(Appears on: +ConfigMapPropagation) +
++
ConfigMapPropagationStatus represents the current state of a ConfigMapPropagation.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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. + |
+
+copyConfigmaps
+
+
+[]ConfigMapPropagationStatusCopyConfigMap
+
+
+ |
+
+(Optional)
+ CopyConfigMaps is the status for each copied configmap. + |
+
+(Appears on: +ConfigMapPropagationStatus) +
++
ConfigMapPropagationStatusCopyConfigMap represents the status of a copied configmap
+ +Field | +Description | +
---|---|
+name
+
+string
+
+ |
+
+ Name is copy configmap’s name + |
+
+source
+
+string
+
+ |
+
+ Source is “originalNamespace/originalConfigMapName” + |
+
+operation
+
+string
+
+ |
+
+ Operation represents the operation CMP takes for this configmap. The operations are copy|delete|stop + |
+
+ready
+
+string
+
+ |
+
+ Ready represents the operation is ready or not + |
+
+reason
+
+string
+
+ |
+
+ Reason indicates reasons if the operation is not ready + |
+
+resourceVersionFromSource
+
+string
+
+ |
+
+ ResourceVersion is the resourceVersion of original configmap + |
+
+
Package v1alpha1 is the v1alpha1 version of the API.
+ +Resource Types: ++
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.
+ +Field | +Description | +||||
---|---|---|---|---|---|
+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. ++ +
|
+||||
+status
+
+
+ChannelableStatus
+
+
+ |
++ | +
+
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.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+ChannelableCombinedStatus
+
+
+ |
++ | +
+(Appears on: +ChannelableCombined) +
++
ChannelableSpec contains Spec of the Channelable object
+ +Field | +Description | +
---|---|
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of SubscribableTypeSpec is for the v1alpha1 spec compatibility. + |
+
+SubscribableSpec
+
+
+SubscribableSpec
+
+
+ |
+
+
+(Members of SubscribableSpec is for the v1beta1 spec compatibility. + |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery + |
+
+(Appears on: +ChannelableCombined) +
++
ChannelableStatus contains the Status of a Channelable object.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of SubscribableTypeStatus is the v1alpha1 part of the Subscribers status + |
+
+SubscribableStatus
+
+
+SubscribableStatus
+
+
+ |
+
+
+(Members of 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 + |
+
+(Appears on: +Channelable) +
++
ChannelableSpec contains Spec of the Channelable object
+ +Field | +Description | +
---|---|
+SubscribableTypeSpec
+
+
+SubscribableTypeSpec
+
+
+ |
+
+
+(Members of |
+
+delivery
+
+
+DeliverySpec
+
+
+ |
+
+(Optional)
+ DeliverySpec contains options controlling the event delivery + |
+
+(Appears on: +Channelable) +
++
ChannelableStatus contains the Status of a Channelable object.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 is the part where the Channelable fulfills the Addressable contract. + |
+
+SubscribableTypeStatus
+
+
+SubscribableTypeStatus
+
+
+ |
+
+
+(Members of 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 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.
+ +Field | +Description | +
---|---|
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+
+(Appears on: +SubscribableTypeSpec) +
++
Subscribable is the schema for the subscribable portion of the spec +section of the resource.
+ +Field | +Description | +
---|---|
+subscribers
+
+
+[]SubscriberSpec
+
+
+ |
+
+ This is the list of subscriptions for this subscribable. + |
+
+(Appears on: +SubscribableTypeStatus) +
++
SubscribableStatus is the schema for the subscribable’s status portion of the status +section of the resource.
+ +Field | +Description | +
---|---|
+subscribers
+
+
+[]SubscriberStatus
+
+
+ |
+
+ This is the list of subscription’s statuses for this channel. + |
+
+
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.
+ +Field | +Description | +||
---|---|---|---|
+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. ++ +
|
+||
+status
+
+
+SubscribableTypeStatus
+
+
+ |
+
+ SubscribableTypeStatus is the part where SubscribableStatus object is +configured as to be compatible with Subscribable contract. + |
+
+(Appears on: +ChannelableCombinedSpec, +ChannelableSpec, +SubscribableType) +
++
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
+ +Field | +Description | +
---|---|
+subscribable
+
+
+Subscribable
+
+
+ |
++ | +
+(Appears on: +ChannelableCombinedStatus, +ChannelableStatus, +SubscribableType) +
++
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
+ +Field | +Description | +
---|---|
+subscribableStatus
+
+
+SubscribableStatus
+
+
+ |
++ | +
+(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
+ +Field | +Description | +
---|---|
+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) + | +
+
Package v1 is the v1 version of the API.
+ +Resource Types: ++
Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+ParallelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Parallel. This data may be out of +date. + |
+
+(Appears on: +ParallelSpec) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +ParallelStatus) +
++
ParallelBranchStatus represents the current state of a Parallel branch
+ +Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Parallel) +
++
+Field | +Description | +
---|---|
+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 + |
+
+(Appears on: +Parallel) +
++
ParallelStatus represents the current state of a Parallel.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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} + |
+
+(Appears on: +ParallelBranchStatus) +
++
+Field | +Description | +
---|---|
+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 defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+SequenceStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Sequence) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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} + |
+
+(Appears on: +SequenceSpec) +
++
+Field | +Description | +
---|---|
+Destination
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: ++
Parallel defines conditional branches that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+ParallelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Parallel. This data may be out of +date. + |
+
+(Appears on: +ParallelSpec) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +ParallelStatus) +
++
ParallelBranchStatus represents the current state of a Parallel branch
+ +Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +ParallelBranchStatus, +ParallelStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Parallel) +
++
+Field | +Description | +
---|---|
+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 + |
+
+(Appears on: +Parallel) +
++
ParallelStatus represents the current state of a Parallel.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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} + |
+
+(Appears on: +ParallelBranchStatus) +
++
+Field | +Description | +
---|---|
+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 defines a sequence of Subscribers that will be wired in +series through Channels and Subscriptions.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+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. ++ +
|
+||||||
+status
+
+
+SequenceStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Sequence. This data may be out of +date. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Sequence) +
++
+Field | +Description | +
---|---|
+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. + |
+
+(Appears on: +Sequence) +
++
SequenceStatus represents the current state of a Sequence.
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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 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} + |
+
+(Appears on: +SequenceSpec) +
++
+Field | +Description | +
---|---|
+Destination
+
+knative.dev/pkg/apis/duck/v1.Destination
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SequenceStatus) +
++
+Field | +Description | +
---|---|
+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. + |
+
+
Package v1beta1 is the v1beta1 version of the API.
+ +Resource Types: ++
Channel represents a generic Channel. It is normally used when we want a Channel, but don’t need a specific Channel implementation.
+ +Field | +Description | +||||
---|---|---|---|---|---|
+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. ++ +
|
+||||
+status
+
+
+ChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
InMemoryChannel is a resource representing an in memory channel
+ +Field | +Description | +||
---|---|---|---|
+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. ++ +
|
+||
+status
+
+
+InMemoryChannelStatus
+
+
+ |
+
+(Optional)
+ Status represents the current state of the Channel. This data may be out of +date. + |
+
+
Subscription routes events received on a Channel to a DNS name and +corresponds to the subscriptions.channels.knative.dev CRD.
+ +Field | +Description | +||||||||
---|---|---|---|---|---|---|---|---|---|
+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
+
+
+ |
+
+ + +
|
+||||||||
+status
+
+
+SubscriptionStatus
+
+
+ |
++ | +
+
ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not +specify any implementation.
+ ++(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.
+ +Field | +Description | +
---|---|
+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 Channel conforms to ChannelableSpec + |
+
+(Appears on: +Channel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to ChannelableStatus + |
+
+channel
+
+knative.dev/pkg/apis/duck/v1.KReference
+
+ |
+
+ Channel is an KReference to the Channel CRD backing this Channel. + |
+
+(Appears on: +ChannelSpec, +ParallelSpec, +SequenceSpec) +
++
+Field | +Description | +
---|---|
+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 is an internal only version that includes ObjectMeta so that +we can easily create new Channels off of it.
+ +Field | +Description | +
---|---|
+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. ++ + |
+
+(Appears on: +InMemoryChannel) +
++
InMemoryChannelSpec defines which subscribers have expressed interest in +receiving events from this InMemoryChannel. +arguments for a Channel.
+ +Field | +Description | +
---|---|
+ChannelableSpec
+
+
+ChannelableSpec
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(Appears on: +InMemoryChannel) +
++
ChannelStatus represents the current state of a Channel.
+ +Field | +Description | +
---|---|
+ChannelableStatus
+
+
+ChannelableStatus
+
+
+ |
+
+
+(Members of Channel conforms to Duck type Channelable. + |
+
+(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
+ +Field | +Description | +
---|---|
+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 + |
+
+(Appears on: +Subscription) +
++
SubscriptionStatus (computed) for a subscription
+ +Field | +Description | +
---|---|
+Status
+
+knative.dev/pkg/apis/duck/v1.Status
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SubscriptionStatus) +
++
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this +Subscription.
+ +Field | +Description | +
---|---|
+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. + |
+
+
Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group
+ +Resource Types: ++
ApiServerSource is the Schema for the apiserversources API
+ +Field | +Description | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||||||||
+kind
+string
+ |
+ApiServerSource |
+||||||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec
+
+
+ApiServerSourceSpec
+
+
+ |
+
+ + +
|
+||||||||||
+status
+
+
+ApiServerSourceStatus
+
+
+ |
++ | +
+
ContainerSource is the Schema for the containersources API
+ +Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||
+kind
+string
+ |
+ContainerSource |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+ContainerSourceSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+ContainerSourceStatus
+
+
+ |
++ | +
+
PingSource is the Schema for the PingSources API.
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||||
+kind
+string
+ |
+PingSource |
+||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+PingSourceSpec
+
+
+ |
+
+ + +
|
+||||||
+status
+
+
+PingSourceStatus
+
+
+ |
++ | +
+
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.
Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+sources.knative.dev/v1alpha2
+
+ |
+||||
+kind
+string
+ |
+SinkBinding |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+SinkBindingSpec
+
+
+ |
+
+ + +
|
+||||
+status
+
+
+SinkBindingStatus
+
+
+ |
++ | +
+(Appears on: +ApiServerSourceSpec, +ApiServerSourceSpec) +
++
APIVersionKind is an APIVersion and Kind tuple.
+ +Field | +Description | +
---|---|
+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 + |
+
+(Appears on: +ApiServerSourceSpec) +
++
APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.
+ +Field | +Description | +
---|---|
+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 + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceSpec defines the desired state of ApiServerSource
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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.
+ |
+
+serviceAccountName
+
+string
+
+ |
+
+(Optional)
+ ServiceAccountName is the name of the ServiceAccount to use to run this +source. Defaults to default if not set. + |
+
+(Appears on: +ApiServerSource) +
++
ApiServerSourceStatus defines the observed state of ApiServerSource
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +ContainerSource) +
++
ContainerSourceSpec defines the desired state of ContainerSource
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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 + |
+
+(Appears on: +ContainerSource) +
++
ContainerSourceStatus defines the observed state of ContainerSource
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +PingSource) +
++
PingSourceSpec defines the desired state of the PingSource.
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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 |
+
+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”. + |
+
+(Appears on: +PingSource) +
++
PingSourceStatus defines the observed state of PingSource.
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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. + |
+
+(Appears on: +SinkBinding) +
++
SinkBindingSpec holds the desired state of the SinkBinding (from the client).
+ +Field | +Description | +
---|---|
+SourceSpec
+
+knative.dev/pkg/apis/duck/v1.SourceSpec
+
+ |
+
+
+(Members of 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/v1alpha1.BindingSpec
+
+ |
+
+
+(Members of inherits duck/v1alpha1 BindingSpec, which currently provides: +* Subject - Subject references the resource(s) whose “runtime contract” +should be augmented by Binding implementations. + |
+
+(Appears on: +SinkBinding) +
++
SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).
+ +Field | +Description | +
---|---|
+SourceStatus
+
+knative.dev/pkg/apis/duck/v1.SourceStatus
+
+ |
+
+
+(Members of 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 9f3fb3ff
.
+on git commit 74b9bed2
.
Packages:
-
-Resource Types: --
Configuration represents the “floating HEAD” of a linear history of Revisions. -Users create new Revisions by updating the Configuration’s spec. -The “latest created” revision’s name is available under status, as is the -“latest ready” revision’s name. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1beta1
-
- |
-||
-kind
-string
- |
-Configuration |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-ConfigurationSpec
-
-
- |
-
-(Optional)
- - -
|
-||
-status
-
-
-ConfigurationStatus
-
-
- |
--(Optional) - | -
-
Revision is an immutable snapshot of code and configuration. A revision -references a container image. Revisions are created by updates to a -Configuration.
-See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
- -Field | -Description | -||||||
---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1beta1
-
- |
-||||||
-kind
-string
- |
-Revision |
-||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||
-spec
-
-
-RevisionSpec
-
-
- |
-
-(Optional)
- - -
|
-||||||
-status
-
-
-RevisionStatus
-
-
- |
--(Optional) - | -
-
Route is responsible for configuring ingress over a collection of Revisions. -Some of the Revisions a Route distributes traffic over may be specified by -referencing the Configuration responsible for creating them; in these cases -the Route is additionally responsible for monitoring the Configuration for -“latest ready revision” changes, and smoothly rolling out latest revisions. -See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route
- -Field | -Description | -||
---|---|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1beta1
-
- |
-||
-kind
-string
- |
-Route |
-||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||
-spec
-
-
-RouteSpec
-
-
- |
-
-(Optional)
- Spec holds the desired state of the Route (from the client). -- -
|
-||
-status
-
-
-RouteStatus
-
-
- |
-
-(Optional)
- Status communicates the observed state of the Route (from the controller). - |
-
-
Service acts as a top-level container that manages a Route and Configuration -which implement a network service. Service exists to provide a singular -abstraction which can be access controlled, reasoned about, and which -encapsulates software lifecycle decisions such as rollout policy and -team resource ownership. Service acts only as an orchestrator of the -underlying Routes and Configurations (much as a kubernetes Deployment -orchestrates ReplicaSets), and its usage is optional but recommended.
-The Service’s controller will track the statuses of its owned Configuration -and Route, reflecting their statuses and conditions as its own.
-See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service
- -Field | -Description | -||||
---|---|---|---|---|---|
-apiVersion
-string |
-
-
-serving.knative.dev/v1beta1
-
- |
-||||
-kind
-string
- |
-Service |
-||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-(Optional)
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||
-spec
-
-
-ServiceSpec
-
-
- |
-
-(Optional)
- - -
|
-||||
-status
-
-
-ServiceStatus
-
-
- |
--(Optional) - | -
@@ -919,8 +466,8 @@ ServiceStatus
(Appears on: -Configuration, Configuration, +Configuration, ServiceSpec)
@@ -954,8 +501,8 @@ RevisionTemplateSpec
(Appears on: -Configuration, -Configuration) +Configuration, +Configuration)
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
@@ -1002,7 +549,7 @@ ConfigurationStatusFields(Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus)
@@ -1046,14 +593,14 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< -
(Appears on: RevisionStatus)
-
ContainerStatuses holds the information of container name and image digest value
+ContainerStatus holds the information of container name and image digest value
containerStatuses
-
-[]ContainerStatuses
+
+[]ContainerStatus
|
@@ -1350,8 +897,8 @@ be provided.
-generation
+DeprecatedGeneration
int64
@@ -2400,10 +1947,10 @@ string
(Appears on: -Configuration, -PinnedType, -ReleaseType, -RunLatestType, +Configuration, +PinnedType, +ReleaseType, +RunLatestType, ServiceSpec) @@ -2532,7 +2079,7 @@ ConfigurationStatusFields (Appears on: -ConfigurationStatus, +ConfigurationStatus, ServiceStatus) @@ -2576,14 +2123,14 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< |
(Appears on: RevisionStatus)
-
ContainerStatuses holds the information of container name and image digest value
+ContainerStatus holds the information of container name and image digest value
containerStatuses
-
-[]ContainerStatuses
+
+[]ContainerStatus
|
@@ -3052,7 +2599,7 @@ environment:
-generation
+DeprecatedGeneration
int64
@@ -3149,7 +2696,7 @@ RouteStatusFields
(Appears on: -RouteStatus, +RouteStatus, ServiceStatus) @@ -3471,7 +3018,7 @@ ConfigurationStatusFields (Appears on: -RouteSpec, +RouteSpec, RouteStatusFields) @@ -3518,7 +3065,460 @@ Ultimately all non-v1 fields will be deprecated. |
+
+Resource Types: ++
Configuration represents the “floating HEAD” of a linear history of Revisions. +Users create new Revisions by updating the Configuration’s spec. +The “latest created” revision’s name is available under status, as is the +“latest ready” revision’s name. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#configuration
+ +Field | +Description | +||
---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
+ |
+||
+kind
+string
+ |
+Configuration |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+ConfigurationSpec
+
+
+ |
+
+(Optional)
+ + +
|
+||
+status
+
+
+ConfigurationStatus
+
+
+ |
++(Optional) + | +
+
Revision is an immutable snapshot of code and configuration. A revision +references a container image. Revisions are created by updates to a +Configuration.
+See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#revision
+ +Field | +Description | +||||||
---|---|---|---|---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
+ |
+||||||
+kind
+string
+ |
+Revision |
+||||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||
+spec
+
+
+RevisionSpec
+
+
+ |
+
+(Optional)
+ + +
|
+||||||
+status
+
+
+RevisionStatus
+
+
+ |
++(Optional) + | +
+
Route is responsible for configuring ingress over a collection of Revisions. +Some of the Revisions a Route distributes traffic over may be specified by +referencing the Configuration responsible for creating them; in these cases +the Route is additionally responsible for monitoring the Configuration for +“latest ready revision” changes, and smoothly rolling out latest revisions. +See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#route
+ +Field | +Description | +||
---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
+ |
+||
+kind
+string
+ |
+Route |
+||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||
+spec
+
+
+RouteSpec
+
+
+ |
+
+(Optional)
+ Spec holds the desired state of the Route (from the client). ++ +
|
+||
+status
+
+
+RouteStatus
+
+
+ |
+
+(Optional)
+ Status communicates the observed state of the Route (from the controller). + |
+
+
Service acts as a top-level container that manages a Route and Configuration +which implement a network service. Service exists to provide a singular +abstraction which can be access controlled, reasoned about, and which +encapsulates software lifecycle decisions such as rollout policy and +team resource ownership. Service acts only as an orchestrator of the +underlying Routes and Configurations (much as a kubernetes Deployment +orchestrates ReplicaSets), and its usage is optional but recommended.
+The Service’s controller will track the statuses of its owned Configuration +and Route, reflecting their statuses and conditions as its own.
+See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service
+ +Field | +Description | +||||
---|---|---|---|---|---|
+apiVersion
+string |
+
+
+serving.knative.dev/v1beta1
+
+ |
+||||
+kind
+string
+ |
+Service |
+||||
+metadata
+
+
+Kubernetes meta/v1.ObjectMeta
+
+
+ |
+
+(Optional)
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||
+spec
+
+
+ServiceSpec
+
+
+ |
+
+(Optional)
+ + +
|
+||||
+status
+
+
+ServiceStatus
+
+
+ |
++(Optional) + | +
Generated with gen-crd-api-reference-docs
-on git commit 427b2bf86
.
+on git commit 0a890efa0
.