From ce2b4cb945cc0dec4e5f37832027e28222f3c412 Mon Sep 17 00:00:00 2001
From: RichieEscarez Packages:
Package v1alpha1 is the v1alpha1 version of the API.build.knative.dev
+build.knative.dev/v1alpha1
Build represents a build of a container image. A Build is made up of a @@ -66,7 +66,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
BuildSpec
@@ -93,8 +93,8 @@ to migrate
source
-
-github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
+
+SourceSpec
sources
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
+
+[]SourceSpec
template
-
-github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec
+
+TemplateInstantiationSpec
Status
-
+
BuildSpecStatus
@@ -240,7 +240,7 @@ BuildSpecStatus
status
-
+
BuildStatus
@@ -250,7 +250,7 @@ BuildStatus
-
BuildTemplate is a template that can used to easily create Builds.
@@ -298,7 +298,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
BuildTemplateSpec
@@ -325,8 +325,8 @@ to migrate
parameters
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
+
+[]ParameterSpec
ClusterBuildTemplate is a template that can used to easily create Builds.
@@ -415,7 +415,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
BuildTemplateSpec
@@ -442,8 +442,8 @@ to migrate
parameters
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
+
+[]ParameterSpec
(Appears on: -TemplateInstantiationSpec) +TemplateInstantiationSpec)
ArgumentSpec defines the actual values to use to populate a template’s @@ -526,20 +526,20 @@ string -
string
alias)(Appears on: -BuildStatus) +BuildStatus)
BuildProvider defines a build execution implementation.
-
BuildSpec is the spec for a Build resource.
@@ -570,8 +570,8 @@ to migratesource
-
-github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
+
+SourceSpec
sources
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec
+
+[]SourceSpec
template
-
-github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec
+
+TemplateInstantiationSpec
Status
-
+
BuildSpecStatus
@@ -712,20 +712,20 @@ BuildSpecStatus
-string
alias)(Appears on: -BuildSpec) +BuildSpec)
BuildSpecStatus defines the build spec status the user can provide
-
BuildStatus is the status for a Build resource
@@ -757,7 +757,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.Statusbuilder
-
+
BuildProvider
@@ -770,8 +770,8 @@ BuildProvider
cluster
-
-github.com/knative/build/pkg/apis/build/v1alpha1.ClusterSpec
+
+ClusterSpec
google
-
-github.com/knative/build/pkg/apis/build/v1alpha1.GoogleSpec
+
+GoogleSpec
BuildTemplateInterface is implemented by BuildTemplate and ClusterBuildTemplate
-(Appears on: -BuildTemplate, -ClusterBuildTemplate) +BuildTemplate, +ClusterBuildTemplate)
BuildTemplateSpec is the spec for a BuildTemplate.
@@ -891,8 +891,8 @@ to migrateparameters
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec
+
+[]ParameterSpec
(Appears on: -BuildStatus) +BuildStatus)
ClusterSpec provides information about the on-cluster build, if applicable.
@@ -971,11 +971,11 @@ string -(Appears on: -SourceSpec) +SourceSpec)
GCSSourceSpec describes source input to the Build in the form of an archive, @@ -993,7 +993,7 @@ or a source manifest describing files to fetch.
type
-
+
GCSSourceType
@@ -1015,20 +1015,20 @@ string
-string
alias)(Appears on: -GCSSourceSpec) +GCSSourceSpec)
GCSSourceType defines a type of GCS source fetch.
-(Appears on: -SourceSpec) +SourceSpec)
GitSourceSpec describes a Git repo source input to the Build.
@@ -1067,11 +1067,11 @@ information. -(Appears on: -BuildStatus) +BuildStatus)
GoogleSpec provides information about the GCB build, if applicable.
@@ -1097,11 +1097,11 @@ string -(Appears on: -BuildTemplateSpec) +BuildTemplateSpec)
ParameterSpec defines the possible parameters that can be populated in a @@ -1151,11 +1151,11 @@ the build does not specify the value for this parameter.
-(Appears on: -BuildSpec) +BuildSpec)
SourceSpec defines the input to the Build
@@ -1172,8 +1172,8 @@ the build does not specify the value for this parameter.git
-
-github.com/knative/build/pkg/apis/build/v1alpha1.GitSourceSpec
+
+GitSourceSpec
gcs
-
-github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceSpec
+
+GCSSourceSpec
Template is an interface for accessing the BuildTemplateSpec from various forms of template (namespace-/cluster-scoped).
-(Appears on: -BuildSpec) +BuildSpec)
TemplateInstantiationSpec specifies how a BuildTemplate is instantiated into @@ -1298,7 +1298,7 @@ The template is assumed to exist in the Build’s namespace.
kind
-
+
TemplateKind
@@ -1313,8 +1313,8 @@ or ClusterBuildTemplate. If nothing is specified, the default if is BuildTemplat
arguments
-
-[][]github.com/knative/build/pkg/apis/build/v1alpha1.ArgumentSpec
+
+[]ArgumentSpec
string
alias)(Appears on: -TemplateInstantiationSpec) +TemplateInstantiationSpec)
TemplateKind defines the type of BuildTemplate used by the build.
diff --git a/docs/reference/eventing/eventing-contrib-resources.md b/docs/reference/eventing/eventing-contrib-resources.md index c0e7e3b3aef..84d46071270 100644 --- a/docs/reference/eventing/eventing-contrib-resources.md +++ b/docs/reference/eventing/eventing-contrib-resources.md @@ -1,33 +1,29 @@Packages:
-
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types:-
CamelSource is the Schema for the camelsources API
+AwsSqsSource is the Schema for the AWS SQS API
CamelSource |
+AwsSqsSource |
|||||||||
@@ -72,8 +68,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-CamelSourceSpec
+
+AwsSqsSourceSpec
|
@@ -83,56 +79,53 @@ CamelSourceSpec
-source
+queueUrl
-
-CamelSourceOriginSpec
-
+string
|
- Source is the reference to the integration flow to run. +QueueURL of the SQS queue that we will poll from. |
-serviceAccountName
+awsCredsSecret
-string
+
+Kubernetes core/v1.SecretKeySelector
+
|
-(Optional)
- DEPRECATED: moved inside the specific CamelSourceOriginSpec -ServiceAccountName is the name of the ServiceAccount to use to run this -source. +AwsCredsSecret is the credential to use to poll the AWS SQS |
-image
+sink
-string
+
+Kubernetes core/v1.ObjectReference
+
|
(Optional)
- DEPRECATED: use the context field in CamelSourceOriginSpec -Image is an optional base image used to run the source. +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. |
-sink
+serviceAccountName
-
-Kubernetes core/v1.ObjectReference
-
+string
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +ServiceAccoutName is the name of the ServiceAccount that will be used to +run the Receive Adapter Deployment. |
status
-
-CamelSourceStatus
+
+AwsSqsSourceStatus
-(Appears on: -CamelSourceOriginSpec) -
-+
CamelSource is the Schema for the camelsources API
-uri
-
-string
-
- |
-
- URI is a Camel component URI to use as starting point (e.g. “timer:tick?period=2s”) - |
-|
-properties
-
-map[string]string
-
- |
-- | -|
-serviceAccountName
-
-string
-
- |
+
-(Optional)
- ServiceAccountName is the name of the ServiceAccount to use to run this source. +
+sources.eventing.knative.dev/v1alpha1
+
|
|
-context
-
+kind
string
-
- |
-
-(Optional)
- The Camel K context to use when running the source |
+CamelSource |
-(Appears on: -CamelSourceSpec) -
--
CamelSourceOriginSpec is the integration flow to run
- -Field | -Description | -
---|---|
-component
+metadata
-
-github.com/knative/eventing-contrib/camel/source/pkg/apis/sources/v1alpha1.CamelSourceOriginComponentSpec
+
+Kubernetes meta/v1.ObjectMeta
|
- Component is a kind of source that directly references a Camel component +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
-integration
+spec
-github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec
+
+CamelSourceSpec
+
|
- Integration is a kind of source that contains a Camel K integration - |
-
-(Appears on: -CamelSource) -
--
CamelSourceSpec defines the desired state of CamelSource
- +Field | -Description | -
---|---|
source
-
+
CamelSourceOriginSpec
@@ -329,62 +256,27 @@ Kubernetes core/v1.ObjectReference
Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-(Appears on: -CamelSource) -
--
CamelSourceStatus defines the observed state of CamelSource
- -Field | -Description | -
---|---|
-Status
-
-
-github.com/knative/pkg/apis/duck/v1alpha1.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
+status
-string
+
+CamelSourceStatus
+
|
-(Optional)
- SinkURI is the current active sink URI that has been configured for the CamelSource. |
-
AwsSqsSource is the Schema for the AWS SQS API
+GcpPubSubSource is the Schema for the gcppubsubsources API.
AwsSqsSource |
+GcpPubSubSource |
|||||||||||
@@ -429,8 +321,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-AwsSqsSourceSpec
+
+GcpPubSubSourceSpec
|
@@ -440,26 +332,42 @@ AwsSqsSourceSpec
-queueUrl
+gcpCredsSecret
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
+ GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used +to create or delete the Subscription, only to poll it. The value of the secret entry must be +a service account key in the JSON format (see +https://cloud.google.com/iam/docs/creating-managing-service-account-keys). + |
+
+googleCloudProject
string
|
- QueueURL of the SQS queue that we will poll from. +GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in. |
-awsCredsSecret
+topic
-
-Kubernetes core/v1.SecretKeySelector
-
+string
|
- AwsCredsSecret is the credential to use to poll the AWS SQS +Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the +unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not +‘projects/my-gcp-project/topics/laconia’. |
(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. +Sink is a reference to an object that will resolve to a domain name to use as the sink. + |
+|
+transformer
+
+
+Kubernetes core/v1.ObjectReference
+
+
+ |
+
+(Optional)
+ Transformer is a reference to an object that will resolve to a domain name to use as the transformer. |
- ServiceAccoutName is the name of the ServiceAccount that will be used to -run the Receive Adapter Deployment. +ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. |
status
-
-AwsSqsSourceStatus
+
+GcpPubSubSourceStatus
-(Appears on: -AwsSqsSource) -
--
AwsSqsSourceSpec defines the desired state of the source.
+GitHubSource is the Schema for the githubsources API
-queueUrl
-
-string
-
+apiVersion
+string |
+
+
+sources.eventing.knative.dev/v1alpha1
+
|
+||||||||||||||||||
- QueueURL of the SQS queue that we will poll from. +kind
+string
|
+GitHubSource |
||||||||||||||||||
-awsCredsSecret
+metadata
-
-Kubernetes core/v1.SecretKeySelector
+
+Kubernetes meta/v1.ObjectMeta
|
- AwsCredsSecret is the credential to use to poll the AWS SQS +Refer to the Kubernetes API documentation for the fields of the +metadata field.
|
||||||||||||||||||
-sink
+spec
-
-Kubernetes core/v1.ObjectReference
+
+GitHubSourceSpec
|
+ + +
AwsSqsSourceStatus ---(Appears on: -AwsSqsSource) - -- AwsSqsSourceStatus defines the observed state of the source. - -
|
+||||||||||||||||||
+status
+
+
+GitHubSourceStatus
+
+
+ |
+
-
GcpPubSubSource is the Schema for the gcppubsubsources API.
+KafkaSource is the Schema for the kafkasources API.
GcpPubSubSource |
+KafkaSource |
||||||||||||
@@ -674,8 +661,8 @@ Refer to the Kubernetes API documentation for the fields of the |
spec
-
-GcpPubSubSourceSpec
+
+KafkaSourceSpec
|
@@ -685,61 +672,52 @@ GcpPubSubSourceSpec
-gcpCredsSecret
+bootstrapServers
-
-Kubernetes core/v1.SecretKeySelector
-
+string
|
- GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used -to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format (see -https://cloud.google.com/iam/docs/creating-managing-service-account-keys. +Bootstrap servers are the Kafka servers the consumer will connect to. |
-googleCloudProject
+topics
string
|
- GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in. +Topic topics to consume messages from |
-topic
+consumerGroup
string
|
- Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the -unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not -‘projects/my-gcp-project/topics/laconia’. +ConsumerGroupID is the consumer group ID. |
-sink
+net
-
-Kubernetes core/v1.ObjectReference
+
+KafkaSourceNetSpec
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-transformer
+sink
Kubernetes core/v1.ObjectReference
@@ -748,7 +726,7 @@ Kubernetes core/v1.ObjectReference
|
(Optional)
- Transformer is a reference to an object that will resolve to a domain name to use as the transformer. +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
+resources
+
+
+KafkaResourceSpec
+
+
+ |
+
+ Resource limits and Request specifications of the Receive Adapter Deployment + |
+
status
-
-GcpPubSubSourceStatus
+
+KafkaSourceStatus
(Appears on: -GcpPubSubSource) +AwsSqsSource)
-
GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.
+AwsSqsSourceSpec defines the desired state of the source.
-gcpCredsSecret
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used -to create or delete the Subscription, only to poll it. The value of the secret entry must be -a service account key in the JSON format (see -https://cloud.google.com/iam/docs/creating-managing-service-account-keys. - |
-
-googleCloudProject
-
-string
-
- |
-
- GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in. - |
-
-topic
+queueUrl
string
|
- Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the -unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not -‘projects/my-gcp-project/topics/laconia’. +QueueURL of the SQS queue that we will poll from. |
-sink
+awsCredsSecret
-
-Kubernetes core/v1.ObjectReference
+
+Kubernetes core/v1.SecretKeySelector
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain name to use as the sink. +AwsCredsSecret is the credential to use to poll the AWS SQS |
-transformer
+sink
Kubernetes core/v1.ObjectReference
@@ -862,7 +823,8 @@ Kubernetes core/v1.ObjectReference
|
(Optional)
- Transformer is a reference to an object that will resolve to a domain name to use as the transformer. +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. |
- ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive -Adapter Deployment. +ServiceAccoutName is the name of the ServiceAccount that will be used to +run the Receive Adapter Deployment. |
(Appears on: -GcpPubSubSource) +AwsSqsSource)
-
GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.
+AwsSqsSourceStatus defines the observed state of the source.
(Optional)
- SinkURI is the current active sink URI that has been configured for the GcpPubSubSource. +SinkURI is the current active sink URI that has been configured for the source. + |
+
+
+
+(Appears on: +CamelSourceOriginSpec) +
++
+Field | +Description | +
---|---|
+uri
+
+string
+
+ |
+
+ URI is a Camel component URI to use as starting point (e.g. “timer:tick?period=2s”) |
-transformerUri
+properties
+
+map[string]string
+
+ |
++ | +
+serviceAccountName
string
|
(Optional)
- TransformerURI is the current active transformer URI that has been configured for the GcpPubSubSource. +ServiceAccountName is the name of the ServiceAccount to use to run this source. + |
+
+context
+
+string
+
+ |
+
+(Optional)
+ The Camel K context to use when running the source |
-
GitHubSource is the Schema for the githubsources API
+(Appears on: +CamelSourceSpec) + ++
CamelSourceOriginSpec is the integration flow to run
-apiVersion
-string |
+
-
-sources.eventing.knative.dev/v1alpha1
-
+Component is a kind of source that directly references a Camel component |
|
-kind
-string
+integration
+
+github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec
+
|
-GitHubSource |
+
+ Integration is a kind of source that contains a Camel K integration + |
+
+(Appears on: +CamelSource) +
++
CamelSourceSpec defines the desired state of CamelSource
+ +Field | +Description |
---|---|
-metadata
+source
-
-Kubernetes meta/v1.ObjectMeta
+
+CamelSourceOriginSpec
|
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+Source is the reference to the integration flow to run. |
-spec
+serviceAccountName
-
-GitHubSourceSpec
+string
+
+ |
+
+(Optional)
+ DEPRECATED: moved inside the specific CamelSourceOriginSpec +ServiceAccountName is the name of the ServiceAccount to use to run this +source. + |
+
+image
+
+string
+
+ |
+
+(Optional)
+ DEPRECATED: use the context field in CamelSourceOriginSpec +Image is an optional base image used to run the source. + |
+
+sink
+
+
+Kubernetes core/v1.ObjectReference
|
- - +(Optional) + Sink is a reference to an object that will resolve to a domain name to use as the sink. + |
+
+(Appears on: +CamelSource) +
++
CamelSourceStatus defines the observed state of CamelSource
+Field | +Description | +
---|---|
-serviceAccountName
+Status
+
+
+github.com/knative/pkg/apis/duck/v1alpha1.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)
- 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. +SinkURI is the current active sink URI that has been configured for the CamelSource. |
+(Appears on: +GcpPubSubSource) +
++
GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.
+ +Field | +Description | +
---|---|
-ownerAndRepository
+gcpCredsSecret
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
+ GcpCredsSecret is the credential to use to poll the GCP PubSub Subscription. It is not used +to create or delete the Subscription, only to poll it. The value of the secret entry must be +a service account key in the JSON format (see +https://cloud.google.com/iam/docs/creating-managing-service-account-keys. + |
+
+googleCloudProject
string
|
- 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 +GoogleCloudProject is the ID of the Google Cloud Project that the PubSub Topic exists in. |
-eventTypes
+topic
-[]string
+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” +Topic is the ID of the GCP PubSub Topic to Subscribe to. It must be in the form of the +unique identifier within the project, not the entire name. E.g. it must be ‘laconia’, not +‘projects/my-gcp-project/topics/laconia’. |
-accessToken
+sink
-
-SecretValueFromSource
+
+Kubernetes core/v1.ObjectReference
|
- AccessToken is the Kubernetes secret containing the GitHub -access token +(Optional) +Sink is a reference to an object that will resolve to a domain name to use as the sink. |
-secretToken
+transformer
-
-SecretValueFromSource
+
+Kubernetes core/v1.ObjectReference
|
- SecretToken is the Kubernetes secret containing the GitHub -secret token +(Optional) +Transformer is a reference to an object that will resolve to a domain name to use as the transformer. |
-sink
+serviceAccountName
+
+string
+
+ |
+
+ ServiceAccoutName is the name of the ServiceAccount that will be used to run the Receive +Adapter Deployment. + |
+
+(Appears on: +GcpPubSubSource) +
++
GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.
+ +Field | +Description | +
---|---|
+Status
-
-Kubernetes core/v1.ObjectReference
+
+github.com/knative/pkg/apis/duck/v1alpha1.Status
|
-(Optional)
- Sink is a reference to an object that will resolve to a domain -name to use as the sink. +
+(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. |
-githubAPIURL
+sinkUri
string
|
(Optional)
- API URL if using github enterprise (default https://api.github.com) +SinkURI is the current active sink URI that has been configured for the GcpPubSubSource. |
-secure
+transformerUri
-bool
+string
|
(Optional)
- Secure can be set to true to configure the webhook to use https. - |
-
status
-
-
-GitHubSourceStatus
-
-
-TransformerURI is the current active transformer URI that has been configured for the GcpPubSubSource.
(Appears on: -GitHubSource) +GitHubSource)
GitHubSourceSpec defines the desired state of GitHubSource
@@ -1193,7 +1344,7 @@ correspond to the “Webhook event name” values listed ataccessToken
-
+
SecretValueFromSource
@@ -1207,7 +1358,7 @@ access token
secretToken
-
+
SecretValueFromSource
@@ -1258,11 +1409,11 @@ bool
-(Appears on: -GitHubSource) +GitHubSource)
GitHubSourceStatus defines the observed state of GitHubSource
@@ -1319,202 +1470,11 @@ for the GitHubSource. --(Appears on: -GitHubSourceSpec) -
--
SecretValueFromSource represents the source of a secret value
- -Field | -Description | -
---|---|
-secretKeyRef
-
-
-Kubernetes core/v1.SecretKeySelector
-
-
- |
-
- The Secret key to select from. - |
-
-
KafkaSource is the Schema for the kafkasources API.
- -Field | -Description | -||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-apiVersion
-string |
-
-
-sources.eventing.knative.dev/v1alpha1
-
- |
-||||||||||||||
-kind
-string
- |
-KafkaSource |
-||||||||||||||
-metadata
-
-
-Kubernetes meta/v1.ObjectMeta
-
-
- |
-
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
- |
-||||||||||||||
-spec
-
-
-KafkaSourceSpec
-
-
- |
-
- - -
|
-||||||||||||||
-status
-
-
-KafkaSourceStatus
-
-
- |
-- | -
(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)
@@ -1548,11 +1508,11 @@ string -
(Appears on: -KafkaResourceSpec) +KafkaResourceSpec)
@@ -1586,11 +1546,11 @@ string -
(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)
@@ -1606,7 +1566,7 @@ string
requests
-
+
KafkaRequestsSpec
@@ -1618,7 +1578,7 @@ KafkaRequestsSpec
limits
-
+
KafkaLimitsSpec
@@ -1628,11 +1588,11 @@ KafkaLimitsSpec
-(Appears on: -KafkaSourceSpec) +KafkaSourceSpec)
@@ -1648,7 +1608,7 @@ KafkaLimitsSpec
sasl
-
+
KafkaSourceSASLSpec
@@ -1660,7 +1620,7 @@ KafkaSourceSASLSpec
tls
-
+
KafkaSourceTLSSpec
@@ -1670,11 +1630,11 @@ KafkaSourceTLSSpec
-(Appears on: -KafkaSourceNetSpec) +KafkaSourceNetSpec)
@@ -1700,7 +1660,7 @@ bool
user
-
+
SecretValueFromSource
@@ -1714,7 +1674,7 @@ SecretValueFromSource
password
-
+
SecretValueFromSource
@@ -1726,11 +1686,11 @@ SecretValueFromSource
-(Appears on: -KafkaSource) +KafkaSource)
KafkaSourceSpec defines the desired state of the KafkaSource.
@@ -1780,7 +1740,7 @@ stringnet
-
+
KafkaSourceNetSpec
@@ -1818,7 +1778,7 @@ Adapter Deployment.
resources
-
+
KafkaResourceSpec
@@ -1829,11 +1789,11 @@ KafkaResourceSpec
-(Appears on: -KafkaSource) +KafkaSource)
KafkaSourceStatus defines the observed state of KafkaSource.
@@ -1878,11 +1838,11 @@ string -(Appears on: -KafkaSourceNetSpec) +KafkaSourceNetSpec)
@@ -1908,7 +1868,7 @@ bool
cert
-
+
SecretValueFromSource
@@ -1922,7 +1882,7 @@ SecretValueFromSource
key
-
+
SecretValueFromSource
@@ -1936,7 +1896,7 @@ SecretValueFromSource
caCert
-
+
SecretValueFromSource
@@ -1948,12 +1908,44 @@ SecretValueFromSource
-+(Appears on: +KafkaSourceSASLSpec, +KafkaSourceTLSSpec) +
++
SecretValueFromSource represents the source of a secret value
+ +Field | +Description | +
---|---|
+secretKeyRef
+
+
+Kubernetes core/v1.SecretKeySelector
+
+
+ |
+
+ The Secret key to select from. + |
+
(Appears on: -KafkaSourceSASLSpec, -KafkaSourceTLSSpec) +GitHubSourceSpec)
SecretValueFromSource represents the source of a secret value
diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index 84b1ceef628..72e5f585343 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -1,29 +1,29 @@Packages:
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 @@ -73,7 +73,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ChannelableSpec
@@ -87,7 +87,7 @@ ChannelableSpec
SubscribableTypeSpec
-
+
SubscribableTypeSpec
@@ -105,7 +105,7 @@ SubscribableTypeSpec
status
-
+
ChannelableStatus
@@ -115,7 +115,7 @@ ChannelableStatus
-
SubscribableType is a skeleton type wrapping Subscribable in the manner we expect resource writers @@ -165,7 +165,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SubscribableTypeSpec
@@ -180,8 +180,8 @@ configured as to be compatible with Subscribable contract.
subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
status
-
+
SubscribableTypeStatus
@@ -207,11 +207,11 @@ configured as to be compatible with Subscribable contract.
-(Appears on: -Channelable) +Channelable)
ChannelableSpec contains Spec of the Channelable object
@@ -228,7 +228,7 @@ configured as to be compatible with Subscribable contract.SubscribableTypeSpec
-
+
SubscribableTypeSpec
@@ -241,11 +241,11 @@ SubscribableTypeSpec
-(Appears on: -Channelable) +Channelable)
ChannelableStatus contains the Status of a Channelable object.
@@ -296,7 +296,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.AddressStatusSubscribableTypeStatus
-
+
SubscribableTypeStatus
@@ -310,13 +310,13 @@ SubscribableTypeStatus
-(Appears on: -ChannelSpec, -InMemoryChannelSpec, -SubscribableTypeSpec) +ChannelSpec, +InMemoryChannelSpec, +SubscribableTypeSpec)
Subscribable is the schema for the subscribable portion of the spec @@ -334,8 +334,8 @@ section of the resource.
subscribers
-
-[][]github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscriberSpec
+
+[]SubscriberSpec
(Appears on: -SubscribableTypeStatus) +SubscribableTypeStatus)
SubscribableStatus is the schema for the subscribable’s status portion of the status @@ -367,8 +367,8 @@ section of the resource.
subscribers
-
-[][]github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscriberStatus
+
+[]SubscriberStatus
(Appears on: -SubscribableType, -ChannelableSpec) +SubscribableType, +ChannelableSpec)
SubscribableTypeSpec shows how we expect folks to embed Subscribable in their Spec field.
@@ -400,8 +400,8 @@ section of the resource.subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
(Appears on: -SubscribableType, -ChannelStatus, -ChannelableStatus, -InMemoryChannelStatus) +SubscribableType, +ChannelStatus, +ChannelableStatus, +InMemoryChannelStatus)
SubscribableTypeStatus shows how we expect folks to embed Subscribable in their Status field.
@@ -434,8 +434,8 @@ github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribablesubscribablestatus
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableStatus
+
+SubscribableStatus
(Appears on: -Subscribable) +Subscribable)
SubscriberSpec defines a single subscriber to a Subscribable. @@ -527,11 +527,11 @@ string -
(Appears on: -SubscribableStatus) +SubscribableStatus)
SubscriberStatus defines the status of a single subscriber to a Channel.
@@ -597,25 +597,25 @@ string
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types:
Broker collects a pool of events that are consumable using Triggers. Brokers @@ -668,7 +668,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
BrokerSpec
@@ -682,8 +682,8 @@ BrokerSpec
channelTemplate
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ChannelSpec
+
+ChannelSpec
channelTemplateSpec
-
+
ChannelTemplateSpec
@@ -715,7 +715,7 @@ Broker.
status
-
+
BrokerStatus
@@ -728,7 +728,7 @@ date.
-
Channel is an abstract resource that implements the Addressable contract. @@ -779,7 +779,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ChannelSpec
@@ -834,8 +834,8 @@ provisions this Channel.
subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
status
-
+
ChannelStatus
@@ -863,7 +863,7 @@ date.
-
ClusterChannelProvisioner encapsulates a provisioning strategy for the @@ -913,7 +913,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ClusterChannelProvisionerSpec
@@ -945,7 +945,7 @@ in the future
status
-
+
ClusterChannelProvisionerStatus
@@ -957,7 +957,7 @@ ClusterChannelProvisionerStatus
-@@ -1005,7 +1005,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
EventTypeSpec
@@ -1080,7 +1080,7 @@ string
status
-
+
EventTypeStatus
@@ -1093,7 +1093,7 @@ This data may be out of date.
-
Subscription routes events received on a Channel to a DNS name and @@ -1142,7 +1142,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SubscriptionSpec
@@ -1189,8 +1189,8 @@ etc.)
subscriber
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+SubscriberSpec
reply
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ReplyStrategy
+
+ReplyStrategy
status
-
+
SubscriptionStatus
@@ -1233,7 +1233,7 @@ SubscriptionStatus
-
Trigger represents a request to have events delivered to a consumer from a @@ -1283,7 +1283,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
TriggerSpec
@@ -1309,8 +1309,8 @@ to ‘default’.
filter
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilter
+
+TriggerFilter
subscriber
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+SubscriberSpec
status
-
+
TriggerStatus
@@ -1354,11 +1354,11 @@ date.
-(Appears on: -Broker) +Broker)
@@ -1374,8 +1374,8 @@ date.
channelTemplate
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ChannelSpec
+
+ChannelSpec
channelTemplateSpec
-
+
ChannelTemplateSpec
@@ -1402,11 +1402,11 @@ Broker.
-(Appears on: -Broker) +Broker)
BrokerStatus represents the current state of a Broker.
@@ -1481,18 +1481,18 @@ Kubernetes core/v1.ObjectReference -
ChannelProvisionerDefaulter sets the default Provisioner and Arguments on Channels that do not specify any Provisioner.
-(Appears on: -Channel, -BrokerSpec) +Channel, +BrokerSpec)
ChannelSpec specifies the Provisioner backing a channel and the configuration @@ -1551,8 +1551,8 @@ provisions this Channel.
subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
(Appears on: -Channel) +Channel)
ChannelStatus represents the current state of a Channel.
@@ -1629,7 +1629,7 @@ k8s.io/apimachinery/pkg/runtime.RawExtensionSubscribableTypeStatus
-
+
SubscribableTypeStatus
@@ -1642,11 +1642,11 @@ SubscribableTypeStatus
-(Appears on: -BrokerSpec) +BrokerSpec)
This should be duck so that Broker can also use this
@@ -1702,7 +1702,7 @@ structs. -
Internal version of ChannelTemplateSpec that includes ObjectMeta so that @@ -1774,11 +1774,11 @@ structs.
-(Appears on: -ClusterChannelProvisioner) +ClusterChannelProvisioner)
ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.
@@ -1808,11 +1808,11 @@ in the future -(Appears on: -ClusterChannelProvisioner) +ClusterChannelProvisioner)
ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource
@@ -1845,11 +1845,11 @@ github.com/knative/pkg/apis/duck/v1beta1.Status -(Appears on: -EventType) +EventType)
@@ -1921,11 +1921,11 @@ string -
(Appears on: -EventType) +EventType)
EventTypeStatus represents the current state of a EventType.
@@ -1958,15 +1958,15 @@ github.com/knative/pkg/apis/duck/v1beta1.Status --
(Appears on: -SubscriptionSpec) +SubscriptionSpec)
ReplyStrategy specifies the handling of the SubscriberSpec’s returned replies. @@ -2002,13 +2002,13 @@ it will be reflected in the Subscription’s status.
-(Appears on: -SequenceSpec, -SubscriptionSpec, -TriggerSpec) +SequenceSpec, +SubscriptionSpec, +TriggerSpec)
SubscriberSpec specifies the reference to an object that’s expected to @@ -2093,11 +2093,11 @@ string -
(Appears on: -Subscription) +Subscription)
SubscriptionSpec specifies the Channel for incoming events, a Subscriber target @@ -2159,8 +2159,8 @@ etc.)
subscriber
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+SubscriberSpec
reply
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ReplyStrategy
+
+ReplyStrategy
(Appears on: -Subscription) +Subscription)
SubscriptionStatus (computed) for a subscription
@@ -2227,7 +2227,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusphysicalSubscription
-
+
SubscriptionStatusPhysicalSubscription
@@ -2238,11 +2238,11 @@ SubscriptionStatusPhysicalSubscription
-(Appears on: -SubscriptionStatus) +SubscriptionStatus)
SubscriptionStatusPhysicalSubscription represents the fully resolved values for this @@ -2280,11 +2280,11 @@ string -
(Appears on: -TriggerSpec) +TriggerSpec)
@@ -2300,8 +2300,8 @@ string
sourceAndType
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilterSourceAndType
+
+TriggerFilterSourceAndType
(Appears on: -TriggerFilter) +TriggerFilter)
TriggerFilterSourceAndType filters events based on exact matches on the cloud event’s type and @@ -2351,11 +2351,11 @@ string -
(Appears on: -Trigger) +Trigger)
@@ -2383,8 +2383,8 @@ to ‘default’.
filter
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilter
+
+TriggerFilter
subscriber
-
-github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+SubscriberSpec
(Appears on: -Trigger) +Trigger)
TriggerStatus represents the current state of a Trigger.
@@ -2459,15 +2459,15 @@ string
Package v1alpha1 is the v1alpha1 version of the API.
Resource Types: -
InMemoryChannel is a resource representing an in memory channel
@@ -2516,7 +2516,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
InMemoryChannelSpec
@@ -2530,8 +2530,8 @@ InMemoryChannelSpec
subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
status
-
+
InMemoryChannelStatus
@@ -2559,11 +2559,11 @@ date.
-(Appears on: -SequenceSpec) +SequenceSpec)
This should be duck so that Broker can also use this
@@ -2595,7 +2595,7 @@ in verbatim to the Channel CRD as Spec section. -
Internal version of ChannelTemplateSpec that includes ObjectMeta so that @@ -2643,11 +2643,11 @@ in verbatim to the Channel CRD as Spec section.
-(Appears on: -InMemoryChannel) +InMemoryChannel)
InMemoryChannelSpec defines which subscribers have expressed interest in @@ -2666,8 +2666,8 @@ arguments for a Channel.
subscribable
-
-github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable
+
+Subscribable
(Appears on: -InMemoryChannel) +InMemoryChannel)
ChannelStatus represents the current state of a Channel.
@@ -2735,7 +2735,7 @@ provided targets from inside the cluster.SubscribableTypeStatus
-
+
SubscribableTypeStatus
@@ -2749,7 +2749,7 @@ SubscribableTypeStatus
-
Sequence defines a sequence of Subscribers that will be wired in @@ -2782,7 +2782,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
SequenceSpec
@@ -2796,8 +2796,8 @@ SequenceSpec
steps
-
-[][]github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+[]SubscriberSpec
channelTemplate
-
+
ChannelTemplateSpec
@@ -2847,7 +2847,7 @@ it will be reflected in the Subscription’s status.
status
-
+
SequenceStatus
@@ -2860,11 +2860,11 @@ date.
-(Appears on: -SequenceStatus) +SequenceStatus)
@@ -2902,11 +2902,11 @@ github.com/knative/pkg/apis.Condition -
(Appears on: -Sequence) +Sequence)
@@ -2922,8 +2922,8 @@ github.com/knative/pkg/apis.Condition
steps
-
-[][]github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec
+
+[]SubscriberSpec
channelTemplate
-
+
ChannelTemplateSpec
@@ -2968,11 +2968,11 @@ it will be reflected in the Subscription’s status.
-(Appears on: -Sequence) +Sequence)
SequenceStatus represents the current state of a Sequence.
@@ -3007,8 +3007,8 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusSubscriptionStatuses
-
-[][]github.com/knative/eventing/pkg/apis/messaging/v1alpha1.SequenceSubscriptionStatus
+
+[]SequenceSubscriptionStatus
ChannelStatuses
-
-[][]github.com/knative/eventing/pkg/apis/messaging/v1alpha1.SequenceChannelStatus
+
+[]SequenceChannelStatus
(Appears on: -SequenceStatus) +SequenceStatus)
@@ -3094,19 +3094,19 @@ github.com/knative/pkg/apis.Condition
Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group
Resource Types: -
ApiServerSource is the Schema for the apiserversources API
@@ -3154,7 +3154,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
ApiServerSourceSpec
@@ -3167,8 +3167,8 @@ ApiServerSourceSpec
resources
-
-[][]github.com/knative/eventing/pkg/apis/sources/v1alpha1.ApiServerResource
+
+[]ApiServerResource
status
-
+
ApiServerSourceStatus
@@ -3233,7 +3233,7 @@ ApiServerSourceStatus
-
ContainerSource is the Schema for the containersources API
@@ -3281,7 +3281,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
ContainerSourceSpec
@@ -3383,7 +3383,7 @@ Kubernetes core/v1.ObjectReference
status
-
+
ContainerSourceStatus
@@ -3393,7 +3393,7 @@ ContainerSourceStatus
-
CronJobSource is the Schema for the cronjobsources API.
@@ -3441,7 +3441,7 @@ Refer to the Kubernetes API documentation for the fields of thespec
-
+
CronJobSourceSpec
@@ -3502,7 +3502,7 @@ Adapter Deployment.
resources
-
+
CronJobResourceSpec
@@ -3518,7 +3518,7 @@ CronJobResourceSpec
status
-
+
CronJobSourceStatus
@@ -3528,11 +3528,11 @@ CronJobSourceStatus
-(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)
ApiServerResource defines the resource to watch
@@ -3581,11 +3581,11 @@ bool -(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceSpec defines the desired state of ApiServerSource
@@ -3602,8 +3602,8 @@ boolresources
-
-[][]github.com/knative/eventing/pkg/apis/sources/v1alpha1.ApiServerResource
+
+[]ApiServerResource
(Appears on: -ApiServerSource) +ApiServerSource)
ApiServerSourceStatus defines the observed state of ApiServerSource
@@ -3702,11 +3702,11 @@ string -(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceSpec defines the desired state of ContainerSource
@@ -3807,11 +3807,11 @@ Kubernetes core/v1.ObjectReference -(Appears on: -ContainerSource) +ContainerSource)
ContainerSourceStatus defines the observed state of ContainerSource
@@ -3856,11 +3856,11 @@ string -(Appears on: -CronJobResourceSpec) +CronJobResourceSpec)
@@ -3894,11 +3894,11 @@ string -
(Appears on: -CronJobResourceSpec) +CronJobResourceSpec)
@@ -3932,11 +3932,11 @@ string -
(Appears on: -CronJobSourceSpec) +CronJobSourceSpec)
@@ -3952,7 +3952,7 @@ string
requests
-
+
CronJobRequestsSpec
@@ -3964,7 +3964,7 @@ CronJobRequestsSpec
limits
-
+
CronJobLimitsSpec
@@ -3974,11 +3974,11 @@ CronJobLimitsSpec
-(Appears on: -CronJobSource) +CronJobSource)
CronJobSourceSpec defines the desired state of the CronJobSource.
@@ -4043,7 +4043,7 @@ Adapter Deployment.resources
-
+
CronJobResourceSpec
@@ -4054,11 +4054,11 @@ CronJobResourceSpec
-(Appears on: -CronJobSource) +CronJobSource)
CronJobSourceStatus defines the observed state of CronJobSource.
diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 3762de4cbd7..7c537247f95 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -1,26 +1,26 @@Packages:
Resource Types: -
PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative @@ -72,7 +72,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
PodAutoscalerSpec
@@ -103,7 +103,7 @@ not be used - use metadata.generation
concurrencyModel
-
+
RevisionRequestConcurrencyModelType
@@ -117,7 +117,7 @@ RevisionRequestConcurrencyModelType
containerConcurrency
-
+
RevisionContainerConcurrencyType
@@ -175,7 +175,7 @@ github.com/knative/serving/pkg/apis/networking.ProtocolType
status
-
+
PodAutoscalerStatus
@@ -187,11 +187,11 @@ PodAutoscalerStatus
-(Appears on: -PodAutoscaler) +PodAutoscaler)
PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).
@@ -224,7 +224,7 @@ not be used - use metadata.generationconcurrencyModel
-
+
RevisionRequestConcurrencyModelType
@@ -238,7 +238,7 @@ RevisionRequestConcurrencyModelType
containerConcurrency
-
+
RevisionContainerConcurrencyType
@@ -291,11 +291,11 @@ github.com/knative/serving/pkg/apis/networking.ProtocolType
-(Appears on: -PodAutoscaler) +PodAutoscaler)
PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).
@@ -346,7 +346,7 @@ The service is managed by the PA object. -
PodScalable is a duck type that the resources referenced by the @@ -381,7 +381,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
PodScalableSpec
@@ -431,7 +431,7 @@ Kubernetes core/v1.PodTemplateSpec
status
-
+
PodScalableStatus
@@ -441,11 +441,11 @@ PodScalableStatus
-(Appears on: -PodScalable) +PodScalable)
PodScalableSpec is the specification for the desired state of a @@ -495,11 +495,11 @@ Kubernetes core/v1.PodTemplateSpec -
(Appears on: -PodScalable) +PodScalable)
PodScalableStatus is the observed state of a PodScalable (or at @@ -526,20 +526,20 @@ int32
Resource Types:
Certificate is responsible for provisioning a SSL certificate for the @@ -592,7 +592,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
CertificateSpec
@@ -634,7 +634,7 @@ string
status
-
+
CertificateStatus
@@ -647,7 +647,7 @@ More info: ClusterIngress
+
ClusterIngress is a collection of rules that allow inbound connections to reach the @@ -702,7 +702,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
IngressSpec
@@ -734,8 +734,8 @@ not be used - use metadata.generation
tls
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS
+
+[]IngressTLS
rules
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule
+
+[]IngressRule
visibility
-
+
IngressVisibility
@@ -782,7 +782,7 @@ IngressVisibility
status
-
+
IngressStatus
@@ -795,7 +795,7 @@ More info: Ingress
+
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined @@ -850,7 +850,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
IngressSpec
@@ -882,8 +882,8 @@ not be used - use metadata.generation
tls
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS
+
+[]IngressTLS
rules
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule
+
+[]IngressRule
visibility
-
+
IngressVisibility
@@ -930,7 +930,7 @@ IngressVisibility
status
-
+
IngressStatus
@@ -943,7 +943,7 @@ More info: ServerlessService
+
ServerlessService is a proxy for the K8s service objects containing the @@ -997,7 +997,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ServerlessServiceSpec
@@ -1013,7 +1013,7 @@ More info:
+
ServerlessServiceOperationMode
@@ -1055,7 +1055,7 @@ serving imports networking, so just use string.
status
-
+
ServerlessServiceStatus
@@ -1068,11 +1068,11 @@ More info: CertificateSpec
+(Appears on: -Certificate) +Certificate)
CertificateSpec defines the desired state of a Certificate
.
(Appears on: -Certificate) +Certificate)
CertificateStatus defines the observed state of a Certificate
.
http01Challenges
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTP01Challenge
+
+[]HTTP01Challenge
(Appears on: -CertificateStatus) +CertificateStatus)
HTTP01Challenge defines the status of a HTTP01 challenge that a certificate needs @@ -1241,11 +1241,11 @@ k8s.io/apimachinery/pkg/util/intstr.IntOrString -
(Appears on: -HTTPIngressRuleValue) +HTTPIngressRuleValue)
HTTPIngressPath associates a path regex with a backend. Incoming URLs matching @@ -1281,8 +1281,8 @@ traffic to the backend.
splits
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressBackendSplit
+
+[]IngressBackendSplit
retries
-
-github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPRetry
+
+HTTPRetry
(Appears on: -IngressRule) +IngressRule)
HTTPIngressRuleValue is a list of http selectors pointing to backends. @@ -1362,8 +1362,8 @@ or ‘#’.
paths
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPIngressPath
+
+[]HTTPIngressPath
(Appears on: -HTTPIngressPath) +HTTPIngressPath)
HTTPRetry describes the retry policy to use when a HTTP request fails.
@@ -1417,11 +1417,11 @@ Kubernetes meta/v1.Duration -(Appears on: -IngressBackendSplit) +IngressBackendSplit)
IngressBackend describes all endpoints for a given service and port.
@@ -1470,11 +1470,11 @@ k8s.io/apimachinery/pkg/util/intstr.IntOrString -(Appears on: -HTTPIngressPath) +HTTPIngressPath)
IngressBackendSplit describes all endpoints for a given service and port.
@@ -1491,7 +1491,7 @@ k8s.io/apimachinery/pkg/util/intstr.IntOrStringIngressBackend
-
+
IngressBackend
@@ -1532,11 +1532,11 @@ before forwarding a request to the destination service.
-(Appears on: -IngressSpec) +IngressSpec)
IngressRule represents the rules mapping the paths under a specified host to @@ -1578,8 +1578,8 @@ If multiple matching Hosts were provided, the first rule will take precedent.
http
-
-github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPIngressRuleValue
+
+HTTPIngressRuleValue
(Appears on: -ClusterIngress, -Ingress) +ClusterIngress, +Ingress)
IngressSpec describes the Ingress the user wishes to exist.
@@ -1634,8 +1634,8 @@ not be used - use metadata.generationtls
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS
+
+[]IngressTLS
rules
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule
+
+[]IngressRule
visibility
-
+
IngressVisibility
@@ -1677,12 +1677,12 @@ IngressVisibility
-(Appears on: -ClusterIngress, -Ingress) +ClusterIngress, +Ingress)
IngressStatus describe the current state of the Ingress.
@@ -1714,8 +1714,8 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusloadBalancer
-
-github.com/knative/serving/pkg/apis/networking/v1alpha1.LoadBalancerStatus
+
+LoadBalancerStatus
(Appears on: -IngressSpec) +IngressSpec)
IngressTLS describes the transport layer security associated with an Ingress.
@@ -1808,21 +1808,21 @@ Defaults totls.key
.
-string
alias)(Appears on: -IngressSpec) +IngressSpec)
IngressVisibility describes whether the Ingress should be exposed to public gateways or not.
-(Appears on: -LoadBalancerStatus) +LoadBalancerStatus)
LoadBalancerIngressStatus represents the status of a load-balancer ingress point: @@ -1890,11 +1890,11 @@ bool -
(Appears on: -IngressStatus) +IngressStatus)
LoadBalancerStatus represents the status of a load-balancer.
@@ -1911,8 +1911,8 @@ boolingress
-
-[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.LoadBalancerIngressStatus
+
+[]LoadBalancerIngressStatus
string
alias)(Appears on: -ServerlessServiceSpec) +ServerlessServiceSpec)
ServerlessServiceOperationMode is an enumeration of the modes of operation for the ServerlessService.
-(Appears on: -ServerlessService) +ServerlessService)
ServerlessServiceSpec describes the ServerlessService.
@@ -1955,7 +1955,7 @@ for the ServerlessService.mode
-
+
ServerlessServiceOperationMode
@@ -1992,11 +1992,11 @@ serving imports networking, so just use string.
-(Appears on: -ServerlessService) +ServerlessService)
ServerlessServiceStatus describes the current state of the ServerlessService.
@@ -2053,20 +2053,20 @@ load balances over the user service pods backing this Revision.Resource Types: -
Configuration represents the “floating HEAD” of a linear history of Revisions, @@ -2120,7 +2120,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ConfigurationSpec
@@ -2164,8 +2164,8 @@ perform to produce the Revision’s container image.
revisionTemplate
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec
+
+RevisionTemplateSpec
template
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec
+
+RevisionTemplateSpec
status
-
+
ConfigurationStatus
@@ -2212,7 +2212,7 @@ ConfigurationStatus
-
Revision is an immutable snapshot of code and configuration. A revision @@ -2265,7 +2265,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RevisionSpec
@@ -2280,7 +2280,7 @@ RevisionSpec
RevisionSpec
-
+
RevisionSpec
@@ -2311,7 +2311,7 @@ not be used - use metadata.generation
servingState
-
+
DeprecatedRevisionServingStateType
@@ -2328,7 +2328,7 @@ updated by the system.
concurrencyModel
-
+
RevisionRequestConcurrencyModelType
@@ -2396,7 +2396,7 @@ environment:
status
-
+
RevisionStatus
@@ -2408,7 +2408,7 @@ RevisionStatus
-
Route is responsible for configuring ingress over a collection of Revisions. @@ -2462,7 +2462,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RouteSpec
@@ -2493,8 +2493,8 @@ not be used - use metadata.generation
traffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget
+
+[]TrafficTarget
status
-
+
RouteStatus
@@ -2522,7 +2522,7 @@ RouteStatus
-
Service acts as a top-level container that manages a set of Routes and @@ -2580,7 +2580,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ServiceSpec
@@ -2610,8 +2610,8 @@ not be used - use metadata.generation
runLatest
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RunLatestType
+
+RunLatestType
pinned
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.PinnedType
+
+PinnedType
manual
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.ManualType
+
+ManualType
release
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.ReleaseType
+
+ReleaseType
ConfigurationSpec
-
+
ConfigurationSpec
@@ -2691,7 +2691,7 @@ be deprecated, and then dropped in v1beta1.
RouteSpec
-
+
RouteSpec
@@ -2709,7 +2709,7 @@ RouteSpec
status
-
+
ServiceStatus
@@ -2720,7 +2720,7 @@ ServiceStatus
-
CannotConvertError is returned when a field cannot be converted.
@@ -2755,15 +2755,15 @@ string -(Appears on: -Configuration, -PinnedType, -ReleaseType, -RunLatestType, -ServiceSpec) +Configuration, +PinnedType, +ReleaseType, +RunLatestType, +ServiceSpec)
ConfigurationSpec holds the desired state of the Configuration (from the client).
@@ -2809,8 +2809,8 @@ perform to produce the Revision’s container image.revisionTemplate
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec
+
+RevisionTemplateSpec
template
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec
+
+RevisionTemplateSpec
(Appears on: -Configuration) +Configuration)
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
@@ -2876,7 +2876,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusConfigurationStatusFields
-
+
ConfigurationStatusFields
@@ -2889,12 +2889,12 @@ ConfigurationStatusFields
-(Appears on: -ConfigurationStatus, -ServiceStatus) +ConfigurationStatus, +ServiceStatus)
ConfigurationStatusFields holds all of the non-duckv1beta1.Status status fields of a Route. @@ -2937,31 +2937,31 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< -
string
alias)(Appears on: -RevisionSpec) +RevisionSpec)
DeprecatedRevisionServingStateType is an enumeration of the levels of serving readiness of the Revision. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting
-(Appears on: -ServiceSpec) +ServiceSpec)
ManualType contains the options for configuring a manual service. See ServiceSpec for more details.
-(Appears on: -ServiceSpec) +ServiceSpec)
PinnedType is DEPRECATED. ReleaseType should be used instead. To get the behavior of PinnedType set @@ -2992,7 +2992,7 @@ to a different service type.
configuration
-
+
ConfigurationSpec
@@ -3004,11 +3004,11 @@ ConfigurationSpec
-(Appears on: -ServiceSpec) +ServiceSpec)
ReleaseType contains the options for slowly releasing revisions. See ServiceSpec for @@ -3053,7 +3053,7 @@ revision. Valid values are between 0 and 99 inclusive.
configuration
-
+
ConfigurationSpec
@@ -3066,24 +3066,24 @@ come from a single configuration.
-string
alias)(Appears on: -PodAutoscalerSpec, -RevisionSpec) +PodAutoscalerSpec, +RevisionSpec)
RevisionRequestConcurrencyModelType is an enumeration of the concurrency models supported by a Revision. DEPRECATED in favor of RevisionContainerConcurrencyType.
-(Appears on: -Revision, -RevisionTemplateSpec) +Revision, +RevisionTemplateSpec)
RevisionSpec holds the desired state of the Revision (from the client).
@@ -3100,7 +3100,7 @@ DEPRECATED in favor of RevisionContainerConcurrencyType.RevisionSpec
-
+
RevisionSpec
@@ -3131,7 +3131,7 @@ not be used - use metadata.generation
servingState
-
+
DeprecatedRevisionServingStateType
@@ -3148,7 +3148,7 @@ updated by the system.
concurrencyModel
-
+
RevisionRequestConcurrencyModelType
@@ -3211,11 +3211,11 @@ environment:
-(Appears on: -Revision) +Revision)
RevisionStatus communicates the observed state of the Revision (from the controller).
@@ -3287,11 +3287,11 @@ may be empty if the image comes from a registry listed to skip resolution. -(Appears on: -ConfigurationSpec) +ConfigurationSpec)
RevisionTemplateSpec describes the data a revision should have when created from a template. @@ -3324,7 +3324,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RevisionSpec
@@ -3338,7 +3338,7 @@ RevisionSpec
RevisionSpec
-
+
RevisionSpec
@@ -3369,7 +3369,7 @@ not be used - use metadata.generation
servingState
-
+
DeprecatedRevisionServingStateType
@@ -3386,7 +3386,7 @@ updated by the system.
concurrencyModel
-
+
RevisionRequestConcurrencyModelType
@@ -3452,12 +3452,12 @@ environment:
-(Appears on: -Route, -ServiceSpec) +Route, +ServiceSpec)
RouteSpec holds the desired state of the Route (from the client).
@@ -3490,8 +3490,8 @@ not be used - use metadata.generationtraffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget
+
+[]TrafficTarget
RouteStatus communicates the observed state of the Route (from the controller).
@@ -3538,7 +3538,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusRouteStatusFields
-
+
RouteStatusFields
@@ -3551,12 +3551,12 @@ RouteStatusFields
-(Appears on: -RouteStatus, -ServiceStatus) +RouteStatus, +ServiceStatus)
RouteStatusFields holds all of the non-duckv1beta1.Status status fields of a Route. @@ -3630,8 +3630,8 @@ github.com/knative/pkg/apis/duck/v1alpha1.Addressable
traffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget
+
+[]TrafficTarget
(Appears on: -ServiceSpec) +ServiceSpec)
RunLatestType contains the options for always having a route to the latest configuration. See @@ -3667,7 +3667,7 @@ ServiceSpec for more details.
configuration
-
+
ConfigurationSpec
@@ -3679,11 +3679,11 @@ ConfigurationSpec
-(Appears on: -Service) +Service)
ServiceSpec represents the configuration for the Service object. Exactly one @@ -3719,8 +3719,8 @@ not be used - use metadata.generation
runLatest
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.RunLatestType
+
+RunLatestType
pinned
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.PinnedType
+
+PinnedType
manual
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.ManualType
+
+ManualType
release
-
-github.com/knative/serving/pkg/apis/serving/v1alpha1.ReleaseType
+
+ReleaseType
ConfigurationSpec
-
+
ConfigurationSpec
@@ -3800,7 +3800,7 @@ be deprecated, and then dropped in v1beta1.
RouteSpec
-
+
RouteSpec
@@ -3813,11 +3813,11 @@ RouteSpec
-(Appears on: -Service) +Service)
ServiceStatus represents the Status stanza of the Service resource.
@@ -3849,7 +3849,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusRouteStatusFields
-
+
RouteStatusFields
@@ -3864,7 +3864,7 @@ RouteStatusFields
ConfigurationStatusFields
-
+
ConfigurationStatusFields
@@ -3877,12 +3877,12 @@ ConfigurationStatusFields
-(Appears on: -RouteSpec, -RouteStatusFields) +RouteSpec, +RouteStatusFields)
TrafficTarget holds a single entry of the routing table for a Route.
@@ -3912,7 +3912,7 @@ target exclusively. It has the form: {name}.${route.status.domain}TrafficTarget
-
+
TrafficTarget
@@ -3928,20 +3928,20 @@ Ultimately all non-v1beta1 fields will be deprecated.
Resource Types: -
Configuration represents the “floating HEAD” of a linear history of Revisions. @@ -3994,7 +3994,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ConfigurationSpec
@@ -4008,7 +4008,7 @@ ConfigurationSpec
template
-
+
RevisionTemplateSpec
@@ -4025,7 +4025,7 @@ RevisionTemplateSpec
status
-
+
ConfigurationStatus
@@ -4036,7 +4036,7 @@ ConfigurationStatus
-
Revision is an immutable snapshot of code and configuration. A revision @@ -4088,7 +4088,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RevisionSpec
@@ -4117,7 +4117,7 @@ Kubernetes core/v1.PodSpec
containerConcurrency
-
+
RevisionContainerConcurrencyType
@@ -4150,7 +4150,7 @@ be provided.
status
-
+
RevisionStatus
@@ -4161,7 +4161,7 @@ RevisionStatus
-
Route is responsible for configuring ingress over a collection of Revisions. @@ -4215,7 +4215,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RouteSpec
@@ -4230,8 +4230,8 @@ RouteSpec
traffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget
+
+[]TrafficTarget
status
-
+
RouteStatus
@@ -4260,7 +4260,7 @@ RouteStatus
-
Service acts as a top-level container that manages a Route and Configuration @@ -4318,7 +4318,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
ServiceSpec
@@ -4332,7 +4332,7 @@ ServiceSpec
ConfigurationSpec
-
+
ConfigurationSpec
@@ -4348,7 +4348,7 @@ ConfigurationSpec
RouteSpec
-
+
RouteSpec
@@ -4370,7 +4370,7 @@ defaults).
status
-
+
ServiceStatus
@@ -4381,12 +4381,12 @@ ServiceStatus
-(Appears on: -Configuration, -ServiceSpec) +Configuration, +ServiceSpec)
ConfigurationSpec holds the desired state of the Configuration (from the client).
@@ -4403,7 +4403,7 @@ ServiceStatustemplate
-
+
RevisionTemplateSpec
@@ -4415,11 +4415,11 @@ RevisionTemplateSpec
-(Appears on: -Configuration) +Configuration)
ConfigurationStatus communicates the observed state of the Configuration (from the controller).
@@ -4451,7 +4451,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusConfigurationStatusFields
-
+
ConfigurationStatusFields
@@ -4464,12 +4464,12 @@ ConfigurationStatusFields
-(Appears on: -ConfigurationStatus, -ServiceStatus) +ConfigurationStatus, +ServiceStatus)
ConfigurationStatusFields holds the fields of Configuration’s status that @@ -4512,24 +4512,24 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< -
int64
alias)(Appears on: -PodAutoscalerSpec, -RevisionSpec) +PodAutoscalerSpec, +RevisionSpec)
RevisionContainerConcurrencyType is an integer expressing the maximum number of in-flight (concurrent) requests.
-(Appears on: -Revision, -RevisionSpec, -RevisionTemplateSpec) +Revision, +RevisionSpec, +RevisionTemplateSpec)
RevisionSpec holds the desired state of the Revision (from the client).
@@ -4561,7 +4561,7 @@ Kubernetes core/v1.PodSpeccontainerConcurrency
-
+
RevisionContainerConcurrencyType
@@ -4589,11 +4589,11 @@ be provided.
-(Appears on: -Revision) +Revision)
RevisionStatus communicates the observed state of the Revision (from the controller).
@@ -4665,11 +4665,11 @@ may be empty if the image comes from a registry listed to skip resolution. -(Appears on: -ConfigurationSpec) +ConfigurationSpec)
RevisionTemplateSpec describes the data a revision should have when created from a template. @@ -4702,7 +4702,7 @@ Refer to the Kubernetes API documentation for the fields of the
spec
-
+
RevisionSpec
@@ -4731,7 +4731,7 @@ Kubernetes core/v1.PodSpec
containerConcurrency
-
+
RevisionContainerConcurrencyType
@@ -4762,12 +4762,12 @@ be provided.
-(Appears on: -Route, -ServiceSpec) +Route, +ServiceSpec)
RouteSpec holds the desired state of the Route (from the client).
@@ -4784,8 +4784,8 @@ be provided.traffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget
+
+[]TrafficTarget
RouteStatus communicates the observed state of the Route (from the controller).
@@ -4833,7 +4833,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusRouteStatusFields
-
+
RouteStatusFields
@@ -4846,12 +4846,12 @@ RouteStatusFields
-(Appears on: -RouteStatus, -ServiceStatus) +RouteStatus, +ServiceStatus)
RouteStatusFields holds the fields of Route’s status that @@ -4897,8 +4897,8 @@ github.com/knative/pkg/apis/duck/v1beta1.Addressable
traffic
-
-[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget
+
+[]TrafficTarget
(Appears on: -Service) +Service)
ServiceSpec represents the configuration for the Service object. @@ -4939,7 +4939,7 @@ the appropriate “run latest” spec.
ConfigurationSpec
-
+
ConfigurationSpec
@@ -4955,7 +4955,7 @@ ConfigurationSpec
RouteSpec
-
+
RouteSpec
@@ -4972,11 +4972,11 @@ defaults).
-(Appears on: -Service) +Service)
ServiceStatus represents the Status stanza of the Service resource.
@@ -5008,7 +5008,7 @@ github.com/knative/pkg/apis/duck/v1beta1.StatusConfigurationStatusFields
-
+
ConfigurationStatusFields
@@ -5025,7 +5025,7 @@ specific to ConfigurationStatus.
RouteStatusFields
-
+
RouteStatusFields
@@ -5040,13 +5040,13 @@ specific to RouteStatus.
-(Appears on: -RouteSpec, -RouteStatusFields, -TrafficTarget) +RouteSpec, +RouteStatusFields, +TrafficTarget)
TrafficTarget holds a single entry of the routing table for a Route.