From c2200923a3c8321c2eca3a3d20ce33becef49180 Mon Sep 17 00:00:00 2001 From: Richie Escarez Date: Fri, 28 Jun 2019 09:50:56 -0700 Subject: [PATCH 1/3] new 07 API with eventing-contrib --- docs/reference/build.md | 152 +- .../eventing/eventing-contrib-api.md | 13 +- .../eventing/eventing-contrib-resources.md | 2020 +++++++++++++++++ docs/reference/eventing/eventing.md | 432 ++-- docs/reference/serving.md | 590 ++--- 5 files changed, 2608 insertions(+), 599 deletions(-) create mode 100644 docs/reference/eventing/eventing-contrib-resources.md diff --git a/docs/reference/build.md b/docs/reference/build.md index 6c6de68eb11..f4eebd5b52f 100644 --- a/docs/reference/build.md +++ b/docs/reference/build.md @@ -10,13 +10,13 @@

Resource Types: -

Build +

Build

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
- -SourceSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec @@ -107,8 +107,8 @@ SourceSpec sources
- -[]SourceSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec @@ -163,8 +163,8 @@ string template
- -TemplateInstantiationSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec @@ -223,7 +223,7 @@ Kubernetes core/v1.Affinity Status
- + BuildSpecStatus @@ -240,7 +240,7 @@ BuildSpecStatus status
- + BuildStatus @@ -250,7 +250,7 @@ BuildStatus -

BuildTemplate +

BuildTemplate

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 the spec
- + BuildTemplateSpec @@ -325,8 +325,8 @@ to migrate

parameters
- -[]ParameterSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec @@ -367,7 +367,7 @@ steps of the build.

-

ClusterBuildTemplate +

ClusterBuildTemplate

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 the spec
- + BuildTemplateSpec @@ -442,8 +442,8 @@ to migrate

parameters
- -[]ParameterSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec @@ -484,11 +484,11 @@ steps of the build.

-

ArgumentSpec +

ArgumentSpec

(Appears on: -TemplateInstantiationSpec) +TemplateInstantiationSpec)

ArgumentSpec defines the actual values to use to populate a template’s @@ -526,20 +526,20 @@ string -

BuildProvider +

BuildProvider (string alias)

(Appears on: -BuildStatus) +BuildStatus)

BuildProvider defines a build execution implementation.

-

BuildSpec +

BuildSpec

(Appears on: -Build) +Build)

BuildSpec is the spec for a Build resource.

@@ -570,8 +570,8 @@ to migrate

source
- -SourceSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec @@ -584,8 +584,8 @@ SourceSpec sources
- -[]SourceSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.SourceSpec @@ -640,8 +640,8 @@ string template
- -TemplateInstantiationSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.TemplateInstantiationSpec @@ -700,7 +700,7 @@ Kubernetes core/v1.Affinity Status
- + BuildSpecStatus @@ -712,20 +712,20 @@ BuildSpecStatus -

BuildSpecStatus +

BuildSpecStatus (string alias)

(Appears on: -BuildSpec) +BuildSpec)

BuildSpecStatus defines the build spec status the user can provide

-

BuildStatus +

BuildStatus

(Appears on: -Build) +Build)

BuildStatus is the status for a Build resource

@@ -757,7 +757,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.Status builder
- + BuildProvider @@ -770,8 +770,8 @@ BuildProvider cluster
- -ClusterSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.ClusterSpec @@ -784,8 +784,8 @@ ClusterSpec google
- -GoogleSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.GoogleSpec @@ -850,17 +850,17 @@ Kubernetes meta/v1.Time -

BuildTemplateInterface +

BuildTemplateInterface

BuildTemplateInterface is implemented by BuildTemplate and ClusterBuildTemplate

-

BuildTemplateSpec +

BuildTemplateSpec

(Appears on: -BuildTemplate, -ClusterBuildTemplate) +BuildTemplate, +ClusterBuildTemplate)

BuildTemplateSpec is the spec for a BuildTemplate.

@@ -891,8 +891,8 @@ to migrate

parameters
- -[]ParameterSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.ParameterSpec @@ -930,11 +930,11 @@ steps of the build.

-

ClusterSpec +

ClusterSpec

(Appears on: -BuildStatus) +BuildStatus)

ClusterSpec provides information about the on-cluster build, if applicable.

@@ -971,11 +971,11 @@ string -

GCSSourceSpec +

GCSSourceSpec

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

GCSSourceType +

GCSSourceType (string alias)

(Appears on: -GCSSourceSpec) +GCSSourceSpec)

GCSSourceType defines a type of GCS source fetch.

-

GitSourceSpec +

GitSourceSpec

(Appears on: -SourceSpec) +SourceSpec)

GitSourceSpec describes a Git repo source input to the Build.

@@ -1067,11 +1067,11 @@ information.

-

GoogleSpec +

GoogleSpec

(Appears on: -BuildStatus) +BuildStatus)

GoogleSpec provides information about the GCB build, if applicable.

@@ -1097,11 +1097,11 @@ string -

ParameterSpec +

ParameterSpec

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

-

SourceSpec +

SourceSpec

(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
- -GitSourceSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.GitSourceSpec @@ -1186,8 +1186,8 @@ GitSourceSpec gcs
- -GCSSourceSpec + +github.com/knative/build/pkg/apis/build/v1alpha1.GCSSourceSpec @@ -1258,17 +1258,17 @@ TargetPath should not be set for custom source.

-

Template +

Template

Template is an interface for accessing the BuildTemplateSpec from various forms of template (namespace-/cluster-scoped).

-

TemplateInstantiationSpec +

TemplateInstantiationSpec

(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
- -[]ArgumentSpec + +[][]github.com/knative/build/pkg/apis/build/v1alpha1.ArgumentSpec @@ -1341,11 +1341,11 @@ This will override any of the template’s steps environment variables.

-

TemplateKind +

TemplateKind (string alias)

(Appears on: -TemplateInstantiationSpec) +TemplateInstantiationSpec)

TemplateKind defines the type of BuildTemplate used by the build.

diff --git a/docs/reference/eventing/eventing-contrib-api.md b/docs/reference/eventing/eventing-contrib-api.md index bccdaaa2cdb..fdfb78040e1 100644 --- a/docs/reference/eventing/eventing-contrib-api.md +++ b/docs/reference/eventing/eventing-contrib-api.md @@ -3,17 +3,6 @@ title: "Eventing-contrib Resources" linkTitle: "Eventing-contrib API" weight: 50 type: "docs" -aliases: - - /docs/reference/eventing/eventing-contrib-resources/ --- -The API definitions for the Eventing resources that conform to Knative Eventing -are located in the -[`knative/eventing-contrib`](https://github.com/knative/eventing-contrib/tree/release-0.7/) -repo: - -- [`awssqs` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/awssqs/pkg/apis/sources/v1alpha1) -- [`camel` source](https://github.com/knative/eventing-contrib/tree/release-0.7/camel/source/pkg/apis/sources/v1alpha1) -- [`gcppubsub` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/gcppubsub/pkg/apis/sources/v1alpha1) -- [`github` source](https://github.com/knative/eventing-contrib/tree/release-0.7/contrib/github/pkg/apis/sources/v1alpha1) -- [`kafka` source](https://github.com/knative/eventing-contrib/tree/release-0.7/kafka/source/pkg/apis/sources/v1alpha1) +{{% readfile file="eventing-contrib-resources.md" relative="true" %}} diff --git a/docs/reference/eventing/eventing-contrib-resources.md b/docs/reference/eventing/eventing-contrib-resources.md new file mode 100644 index 00000000000..2a5c70a3f2c --- /dev/null +++ b/docs/reference/eventing/eventing-contrib-resources.md @@ -0,0 +1,2020 @@ +

Packages:

+ +

sources.eventing.knative.dev

+

+

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

+

+Resource Types: + +

CamelSource +

+

+

CamelSource is the Schema for the camelsources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.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 + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+source
+ + +CamelSourceOriginSpec + + +		 +

Source is the reference to the integration flow to run.

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

+
+
+status
+ + +CamelSourceStatus + + +		 +
+

CamelSourceOriginComponentSpec +

+

+(Appears on: +CamelSourceOriginSpec) +

+

+

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

+
+context
+ +string + +		 +(Optional) +

The Camel K context to use when running the source

+
+

CamelSourceOriginSpec +

+

+(Appears on: +CamelSourceSpec) +

+

+

CamelSourceOriginSpec is the integration flow to run

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+component
+ + +github.com/knative/eventing-contrib/camel/source/pkg/apis/sources/v1alpha1.CamelSourceOriginComponentSpec + + +		 +

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

+
+integration
+ +github.com/apache/camel-k/pkg/apis/camel/v1alpha1.IntegrationSpec + +		 +

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

+
+

CamelSourceSpec +

+

+(Appears on: +CamelSource) +

+

+

CamelSourceSpec defines the desired state of CamelSource

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+source
+ + +CamelSourceOriginSpec + + +		 +

Source is the reference to the integration flow to run.

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

+
+

CamelSourceStatus +

+

+(Appears on: +CamelSource) +

+

+

CamelSourceStatus defines the observed state of CamelSource

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ + +github.com/knative/pkg/apis/duck/v1alpha1.Status + + +		 +

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

+

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

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

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

+
+
+

sources.eventing.knative.dev

+

+

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

+

+Resource Types: + +

AwsSqsSource +

+

+

AwsSqsSource is the Schema for the AWS SQS API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.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 + + +		 +
+
+ + + + + + + + + + + + + + + + + +
+queueUrl
+ +string + +		 +

QueueURL of the SQS queue that we will poll from.

+
+awsCredsSecret
+ + +Kubernetes core/v1.SecretKeySelector + + +		 +

AwsCredsSecret is the credential to use to poll the AWS SQS

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

+
+
+status
+ + +AwsSqsSourceStatus + + +		 +
+

AwsSqsSourceSpec +

+

+(Appears on: +AwsSqsSource) +

+

+

AwsSqsSourceSpec defines the desired state of the source.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+queueUrl
+ +string + +		 +

QueueURL of the SQS queue that we will poll from.

+
+awsCredsSecret
+ + +Kubernetes core/v1.SecretKeySelector + + +		 +

AwsCredsSecret is the credential to use to poll the AWS SQS

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

+
+

AwsSqsSourceStatus +

+

+(Appears on: +AwsSqsSource) +

+

+

AwsSqsSourceStatus defines the observed state of the source.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ + +github.com/knative/pkg/apis/duck/v1alpha1.Status + + +		 +

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

+

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

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

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

+
+
+

sources.eventing.knative.dev

+

+

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

+

+Resource Types: + +

GcpPubSubSource +

+

+

GcpPubSubSource is the Schema for the gcppubsubsources API.

+

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

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

+
+googleCloudProject
+ +string + +		 +

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

+
+topic
+ +string + +		 +

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

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

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

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+
+status
+ + +GcpPubSubSourceStatus + + +		 +
+

GcpPubSubSourceSpec +

+

+(Appears on: +GcpPubSubSource) +

+

+

GcpPubSubSourceSpec defines the desired state of the GcpPubSubSource.

+

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

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

+
+googleCloudProject
+ +string + +		 +

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

+
+topic
+ +string + +		 +

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

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

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

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+

GcpPubSubSourceStatus +

+

+(Appears on: +GcpPubSubSource) +

+

+

GcpPubSubSourceStatus defines the observed state of GcpPubSubSource.

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ + +github.com/knative/pkg/apis/duck/v1alpha1.Status + + +		 +

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

+

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

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

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

+
+transformerUri
+ +string + +		 +(Optional) +

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

+
+
+

sources.eventing.knative.dev

+

+

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

+

+Resource Types: + +

GitHubSource +

+

+

GitHubSource is the Schema for the githubsources API

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+apiVersion
+string		 + +sources.eventing.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 + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+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

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

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

+
+
+status
+ + +GitHubSourceStatus + + +		 +
+

GitHubSourceSpec +

+

+(Appears on: +GitHubSource) +

+

+

GitHubSourceSpec defines the desired state of GitHubSource

+

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

ServiceAccountName holds the name of the Kubernetes service account +as which the underlying K8s resources should be run. If unspecified +this will default to the “default” service account for the namespace +in which the 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

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

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

+
+

GitHubSourceStatus +

+

+(Appears on: +GitHubSource) +

+

+

GitHubSourceStatus defines the observed state of GitHubSource

+

+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ + +github.com/knative/pkg/apis/duck/v1alpha1.Status + + +		 +

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

+

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

+
+webhookIDKey
+ +string + +		 +

WebhookIDKey is the ID of the webhook registered with GitHub

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

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

+
+

SecretValueFromSource +

+

+(Appears on: +GitHubSourceSpec) +

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+
+

sources.eventing.knative.dev

+

+

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

+

+Resource Types: + +

KafkaSource +

+

+

KafkaSource is the Schema for the kafkasources API.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+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 + + +		 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+bootstrapServers
+ +string + +		 +

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

+
+topics
+ +string + +		 +

Topic topics to consume messages from

+
+consumerGroup
+ +string + +		 +

ConsumerGroupID is the consumer group ID.

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +KafkaResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+
+status
+ + +KafkaSourceStatus + + +		 +
+

KafkaLimitsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

KafkaRequestsSpec +

+

+(Appears on: +KafkaResourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+cpu
+ +string + +		 +
+memory
+ +string + +		 +
+

KafkaResourceSpec +

+

+(Appears on: +KafkaSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+requests
+ + +KafkaRequestsSpec + + +		 +
+limits
+ + +KafkaLimitsSpec + + +		 +
+

KafkaSourceNetSpec +

+

+(Appears on: +KafkaSourceSpec) +

+

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+sasl
+ + +KafkaSourceSASLSpec + + +		 +
+tls
+ + +KafkaSourceTLSSpec + + +		 +
+

KafkaSourceSASLSpec +

+

+(Appears on: +KafkaSourceNetSpec) +

+

+

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

User is the Kubernetes secret containing the SASL username.

+
+password
+ + +SecretValueFromSource + + +		 +(Optional) +

Password is the Kubernetes secret containing the SASL password.

+
+

KafkaSourceSpec +

+

+(Appears on: +KafkaSource) +

+

+

KafkaSourceSpec defines the desired state of the KafkaSource.

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+bootstrapServers
+ +string + +		 +

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

+
+topics
+ +string + +		 +

Topic topics to consume messages from

+
+consumerGroup
+ +string + +		 +

ConsumerGroupID is the consumer group ID.

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

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

+
+serviceAccountName
+ +string + +		 +

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

+
+resources
+ + +KafkaResourceSpec + + +		 +

Resource limits and Request specifications of the Receive Adapter Deployment

+
+

KafkaSourceStatus +

+

+(Appears on: +KafkaSource) +

+

+

KafkaSourceStatus defines the observed state of KafkaSource.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+Status
+ + +github.com/knative/pkg/apis/duck/v1alpha1.Status + + +		 +

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

+

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

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

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

+
+

KafkaSourceTLSSpec +

+

+(Appears on: +KafkaSourceNetSpec) +

+

+

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

Cert is the Kubernetes secret containing the client certificate.

+
+key
+ + +SecretValueFromSource + + +		 +(Optional) +

Key is the Kubernetes secret containing the client key.

+
+caCert
+ + +SecretValueFromSource + + +		 +(Optional) +

CACert is the Kubernetes secret containing the server CA cert.

+
+

SecretValueFromSource +

+

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

+

+

SecretValueFromSource represents the source of a secret value

+

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

The Secret key to select from.

+
+
+

+Generated with gen-crd-api-reference-docs +on git commit 641f98fe. +

diff --git a/docs/reference/eventing/eventing.md b/docs/reference/eventing/eventing.md index ddd36d3a29d..84b1ceef628 100644 --- a/docs/reference/eventing/eventing.md +++ b/docs/reference/eventing/eventing.md @@ -19,11 +19,11 @@

Resource Types: -

Channelable +

Channelable

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 +

SubscribableType

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
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -195,7 +195,7 @@ Subscribable status
- + SubscribableTypeStatus @@ -207,11 +207,11 @@ configured as to be compatible with Subscribable contract.

-

ChannelableSpec +

ChannelableSpec

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

ChannelableStatus +

ChannelableStatus

(Appears on: -Channelable) +Channelable)

ChannelableStatus contains the Status of a Channelable object.

@@ -296,7 +296,7 @@ github.com/knative/pkg/apis/duck/v1alpha1.AddressStatus SubscribableTypeStatus
- + SubscribableTypeStatus @@ -310,13 +310,13 @@ SubscribableTypeStatus -

Subscribable +

Subscribable

(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
- -[]SubscriberSpec + +[][]github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscriberSpec @@ -345,11 +345,11 @@ section of the resource.

-

SubscribableStatus +

SubscribableStatus

(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
- -[]SubscriberStatus + +[][]github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscriberStatus @@ -378,12 +378,12 @@ section of the resource.

-

SubscribableTypeSpec +

SubscribableTypeSpec

(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
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -410,14 +410,14 @@ Subscribable -

SubscribableTypeStatus +

SubscribableTypeStatus

(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 @@ Subscribable subscribablestatus
- -SubscribableStatus + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.SubscribableStatus @@ -444,11 +444,11 @@ SubscribableStatus -

SubscriberSpec +

SubscriberSpec

(Appears on: -Subscribable) +Subscribable)

SubscriberSpec defines a single subscriber to a Subscribable. @@ -527,11 +527,11 @@ string -

SubscriberStatus +

SubscriberStatus

(Appears on: -SubscribableStatus) +SubscribableStatus)

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

@@ -603,19 +603,19 @@ string

Resource Types: -

Broker +

Broker

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
- -ChannelSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ChannelSpec @@ -698,7 +698,7 @@ Channel for the namespace will be used.

channelTemplateSpec
- + ChannelTemplateSpec @@ -715,7 +715,7 @@ Broker.

status
- + BrokerStatus @@ -728,7 +728,7 @@ date.

-

Channel +

Channel

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
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -850,7 +850,7 @@ Subscribable status
- + ChannelStatus @@ -863,7 +863,7 @@ date.

-

ClusterChannelProvisioner +

ClusterChannelProvisioner

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 -

EventType +

EventType

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

Subscription

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
- -SubscriberSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -1205,8 +1205,8 @@ sent to a channel as specified by the Reply.

reply
- -ReplyStrategy + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ReplyStrategy @@ -1223,7 +1223,7 @@ the Subscriber target.

status
- + SubscriptionStatus @@ -1233,7 +1233,7 @@ SubscriptionStatus -

Trigger +

Trigger

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
- -TriggerFilter + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilter @@ -1324,8 +1324,8 @@ filter will be sent to the Subscriber. If not specified, will default to allowin subscriber
- -SubscriberSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -1341,7 +1341,7 @@ is required.

status
- + TriggerStatus @@ -1354,11 +1354,11 @@ date.

-

BrokerSpec +

BrokerSpec

(Appears on: -Broker) +Broker)

@@ -1374,8 +1374,8 @@ date.

channelTemplate
- -ChannelSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ChannelSpec @@ -1390,7 +1390,7 @@ Channel for the namespace will be used.

channelTemplateSpec
- + ChannelTemplateSpec @@ -1402,11 +1402,11 @@ Broker.

-

BrokerStatus +

BrokerStatus

(Appears on: -Broker) +Broker)

BrokerStatus represents the current state of a Broker.

@@ -1481,18 +1481,18 @@ Kubernetes core/v1.ObjectReference -

ChannelProvisionerDefaulter +

ChannelProvisionerDefaulter

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

-

ChannelSpec +

ChannelSpec

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

ChannelSpec specifies the Provisioner backing a channel and the configuration @@ -1551,8 +1551,8 @@ provisions this Channel.

subscribable
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -1562,11 +1562,11 @@ Subscribable -

ChannelStatus +

ChannelStatus

(Appears on: -Channel) +Channel)

ChannelStatus represents the current state of a Channel.

@@ -1629,7 +1629,7 @@ k8s.io/apimachinery/pkg/runtime.RawExtension SubscribableTypeStatus
- + SubscribableTypeStatus @@ -1642,11 +1642,11 @@ SubscribableTypeStatus -

ChannelTemplateSpec +

ChannelTemplateSpec

(Appears on: -BrokerSpec) +BrokerSpec)

This should be duck so that Broker can also use this

@@ -1702,7 +1702,7 @@ structs.

-

ChannelTemplateSpecInternal +

ChannelTemplateSpecInternal

Internal version of ChannelTemplateSpec that includes ObjectMeta so that @@ -1774,11 +1774,11 @@ structs.

-

ClusterChannelProvisionerSpec +

ClusterChannelProvisionerSpec

(Appears on: -ClusterChannelProvisioner) +ClusterChannelProvisioner)

ClusterChannelProvisionerSpec is the spec for a ClusterChannelProvisioner resource.

@@ -1808,11 +1808,11 @@ in the future

-

ClusterChannelProvisionerStatus +

ClusterChannelProvisionerStatus

(Appears on: -ClusterChannelProvisioner) +ClusterChannelProvisioner)

ClusterChannelProvisionerStatus is the status for a ClusterChannelProvisioner resource

@@ -1845,11 +1845,11 @@ github.com/knative/pkg/apis/duck/v1beta1.Status -

EventTypeSpec +

EventTypeSpec

(Appears on: -EventType) +EventType)

@@ -1921,11 +1921,11 @@ string -

EventTypeStatus +

EventTypeStatus

(Appears on: -EventType) +EventType)

EventTypeStatus represents the current state of a EventType.

@@ -1958,15 +1958,15 @@ github.com/knative/pkg/apis/duck/v1beta1.Status -

HasSpec +

HasSpec

-

ReplyStrategy +

ReplyStrategy

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

-

SubscriberSpec +

SubscriberSpec

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

SubscriberSpec specifies the reference to an object that’s expected to @@ -2093,11 +2093,11 @@ string -

SubscriptionSpec +

SubscriptionSpec

(Appears on: -Subscription) +Subscription)

SubscriptionSpec specifies the Channel for incoming events, a Subscriber target @@ -2159,8 +2159,8 @@ etc.)

subscriber
- -SubscriberSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -2175,8 +2175,8 @@ sent to a channel as specified by the Reply.

reply
- -ReplyStrategy + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.ReplyStrategy @@ -2188,11 +2188,11 @@ the Subscriber target.

-

SubscriptionStatus +

SubscriptionStatus

(Appears on: -Subscription) +Subscription)

SubscriptionStatus (computed) for a subscription

@@ -2227,7 +2227,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status physicalSubscription
- + SubscriptionStatusPhysicalSubscription @@ -2238,11 +2238,11 @@ SubscriptionStatusPhysicalSubscription -

SubscriptionStatusPhysicalSubscription +

SubscriptionStatusPhysicalSubscription

(Appears on: -SubscriptionStatus) +SubscriptionStatus)

SubscriptionStatusPhysicalSubscription represents the fully resolved values for this @@ -2280,11 +2280,11 @@ string -

TriggerFilter +

TriggerFilter

(Appears on: -TriggerSpec) +TriggerSpec)

@@ -2300,8 +2300,8 @@ string sourceAndType
- -TriggerFilterSourceAndType + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilterSourceAndType @@ -2310,11 +2310,11 @@ TriggerFilterSourceAndType -

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 -

TriggerSpec +

TriggerSpec

(Appears on: -Trigger) +Trigger)

@@ -2383,8 +2383,8 @@ to ‘default’.

filter
- -TriggerFilter + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.TriggerFilter @@ -2398,8 +2398,8 @@ filter will be sent to the Subscriber. If not specified, will default to allowin subscriber
- -SubscriberSpec + +github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -2410,11 +2410,11 @@ is required.

-

TriggerStatus +

TriggerStatus

(Appears on: -Trigger) +Trigger)

TriggerStatus represents the current state of a Trigger.

@@ -2465,9 +2465,9 @@ string

Resource Types: -

InMemoryChannel +

InMemoryChannel

InMemoryChannel is a resource representing an in memory channel

@@ -2516,7 +2516,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + InMemoryChannelSpec @@ -2530,8 +2530,8 @@ InMemoryChannelSpec subscribable
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -2546,7 +2546,7 @@ Subscribable status
- + InMemoryChannelStatus @@ -2559,11 +2559,11 @@ date.

-

ChannelTemplateSpec +

ChannelTemplateSpec

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

-

ChannelTemplateSpecInternal +

ChannelTemplateSpecInternal

Internal version of ChannelTemplateSpec that includes ObjectMeta so that @@ -2643,11 +2643,11 @@ in verbatim to the Channel CRD as Spec section.

-

InMemoryChannelSpec +

InMemoryChannelSpec

(Appears on: -InMemoryChannel) +InMemoryChannel)

InMemoryChannelSpec defines which subscribers have expressed interest in @@ -2666,8 +2666,8 @@ arguments for a Channel.

subscribable
- -Subscribable + +github.com/knative/eventing/pkg/apis/duck/v1alpha1.Subscribable @@ -2677,11 +2677,11 @@ Subscribable -

InMemoryChannelStatus +

InMemoryChannelStatus

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

Sequence

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
- -[]SubscriberSpec + +[][]github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -2810,7 +2810,7 @@ provided.

channelTemplate
- + ChannelTemplateSpec @@ -2847,7 +2847,7 @@ it will be reflected in the Subscription’s status.

status
- + SequenceStatus @@ -2860,11 +2860,11 @@ date.

-

SequenceChannelStatus +

SequenceChannelStatus

(Appears on: -SequenceStatus) +SequenceStatus)

@@ -2902,11 +2902,11 @@ github.com/knative/pkg/apis.Condition -

SequenceSpec +

SequenceSpec

(Appears on: -Sequence) +Sequence)

@@ -2922,8 +2922,8 @@ github.com/knative/pkg/apis.Condition steps
- -[]SubscriberSpec + +[][]github.com/knative/eventing/pkg/apis/eventing/v1alpha1.SubscriberSpec @@ -2936,7 +2936,7 @@ provided.

channelTemplate
- + ChannelTemplateSpec @@ -2968,11 +2968,11 @@ it will be reflected in the Subscription’s status.

-

SequenceStatus +

SequenceStatus

(Appears on: -Sequence) +Sequence)

SequenceStatus represents the current state of a Sequence.

@@ -3007,8 +3007,8 @@ github.com/knative/pkg/apis/duck/v1beta1.Status SubscriptionStatuses
- -[]SequenceSubscriptionStatus + +[][]github.com/knative/eventing/pkg/apis/messaging/v1alpha1.SequenceSubscriptionStatus @@ -3021,8 +3021,8 @@ Matches the Spec.Steps array in the order.

ChannelStatuses
- -[]SequenceChannelStatus + +[][]github.com/knative/eventing/pkg/apis/messaging/v1alpha1.SequenceChannelStatus @@ -3051,11 +3051,11 @@ It generally has the form {channel}.{namespace}.svc.{cluster domain name}

-

SequenceSubscriptionStatus +

SequenceSubscriptionStatus

(Appears on: -SequenceStatus) +SequenceStatus)

@@ -3100,13 +3100,13 @@ github.com/knative/pkg/apis.Condition

Resource Types: -

ApiServerSource +

ApiServerSource

ApiServerSource is the Schema for the apiserversources API

@@ -3154,7 +3154,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ApiServerSourceSpec @@ -3167,8 +3167,8 @@ ApiServerSourceSpec resources
- -[]ApiServerResource + +[][]github.com/knative/eventing/pkg/apis/sources/v1alpha1.ApiServerResource @@ -3223,7 +3223,7 @@ string status
- + ApiServerSourceStatus @@ -3233,7 +3233,7 @@ ApiServerSourceStatus -

ContainerSource +

ContainerSource

ContainerSource is the Schema for the containersources API

@@ -3281,7 +3281,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + ContainerSourceSpec @@ -3383,7 +3383,7 @@ Kubernetes core/v1.ObjectReference status
- + ContainerSourceStatus @@ -3393,7 +3393,7 @@ ContainerSourceStatus -

CronJobSource +

CronJobSource

CronJobSource is the Schema for the cronjobsources API.

@@ -3441,7 +3441,7 @@ Refer to the Kubernetes API documentation for the fields of the spec
- + CronJobSourceSpec @@ -3502,7 +3502,7 @@ Adapter Deployment.

resources
- + CronJobResourceSpec @@ -3518,7 +3518,7 @@ CronJobResourceSpec status
- + CronJobSourceStatus @@ -3528,11 +3528,11 @@ CronJobSourceStatus -

ApiServerResource +

ApiServerResource

(Appears on: -ApiServerSourceSpec) +ApiServerSourceSpec)

ApiServerResource defines the resource to watch

@@ -3581,11 +3581,11 @@ bool -

ApiServerSourceSpec +

ApiServerSourceSpec

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceSpec defines the desired state of ApiServerSource

@@ -3602,8 +3602,8 @@ bool resources
- -[]ApiServerResource + +[][]github.com/knative/eventing/pkg/apis/sources/v1alpha1.ApiServerResource @@ -3653,11 +3653,11 @@ string -

ApiServerSourceStatus +

ApiServerSourceStatus

(Appears on: -ApiServerSource) +ApiServerSource)

ApiServerSourceStatus defines the observed state of ApiServerSource

@@ -3702,11 +3702,11 @@ string -

ContainerSourceSpec +

ContainerSourceSpec

(Appears on: -ContainerSource) +ContainerSource)

ContainerSourceSpec defines the desired state of ContainerSource

@@ -3807,11 +3807,11 @@ Kubernetes core/v1.ObjectReference -

ContainerSourceStatus +

ContainerSourceStatus

(Appears on: -ContainerSource) +ContainerSource)

ContainerSourceStatus defines the observed state of ContainerSource

@@ -3856,11 +3856,11 @@ string -

CronJobLimitsSpec +

CronJobLimitsSpec

(Appears on: -CronJobResourceSpec) +CronJobResourceSpec)

@@ -3894,11 +3894,11 @@ string -

CronJobRequestsSpec +

CronJobRequestsSpec

(Appears on: -CronJobResourceSpec) +CronJobResourceSpec)

@@ -3932,11 +3932,11 @@ string -

CronJobResourceSpec +

CronJobResourceSpec

(Appears on: -CronJobSourceSpec) +CronJobSourceSpec)

@@ -3952,7 +3952,7 @@ string requests
- + CronJobRequestsSpec @@ -3964,7 +3964,7 @@ CronJobRequestsSpec limits
- + CronJobLimitsSpec @@ -3974,11 +3974,11 @@ CronJobLimitsSpec -

CronJobSourceSpec +

CronJobSourceSpec

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

CronJobSourceStatus +

CronJobSourceStatus

(Appears on: -CronJobSource) +CronJobSource)

CronJobSourceStatus defines the observed state of CronJobSource.

diff --git a/docs/reference/serving.md b/docs/reference/serving.md index eb07e8edf25..89b5f2d9f03 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -18,9 +18,9 @@

Resource Types: -

PodAutoscaler +

PodAutoscaler

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 -

PodAutoscalerSpec +

PodAutoscalerSpec

(Appears on: -PodAutoscaler) +PodAutoscaler)

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

@@ -224,7 +224,7 @@ not be used - use metadata.generation

concurrencyModel
- + RevisionRequestConcurrencyModelType @@ -238,7 +238,7 @@ RevisionRequestConcurrencyModelType containerConcurrency
- + RevisionContainerConcurrencyType @@ -291,11 +291,11 @@ github.com/knative/serving/pkg/apis/networking.ProtocolType -

PodAutoscalerStatus +

PodAutoscalerStatus

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

PodScalable

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 -

PodScalableSpec +

PodScalableSpec

(Appears on: -PodScalable) +PodScalable)

PodScalableSpec is the specification for the desired state of a @@ -495,11 +495,11 @@ Kubernetes core/v1.PodTemplateSpec -

PodScalableStatus +

PodScalableStatus

(Appears on: -PodScalable) +PodScalable)

PodScalableStatus is the observed state of a PodScalable (or at @@ -531,15 +531,15 @@ int32

Resource Types: -

Certificate +

Certificate

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

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
- -[]IngressTLS + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS @@ -752,8 +752,8 @@ ingress supports SNI.

rules
- -[]IngressRule + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule @@ -766,7 +766,7 @@ ingress supports SNI.

visibility
- + IngressVisibility @@ -782,7 +782,7 @@ IngressVisibility status
- + IngressStatus @@ -795,7 +795,7 @@ More info: Ingress +

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
- -[]IngressTLS + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS @@ -900,8 +900,8 @@ ingress supports SNI.

rules
- -[]IngressRule + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule @@ -914,7 +914,7 @@ ingress supports SNI.

visibility
- + IngressVisibility @@ -930,7 +930,7 @@ IngressVisibility status
- + IngressStatus @@ -943,7 +943,7 @@ More info: ServerlessService +

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 +

CertificateSpec

(Appears on: -Certificate) +Certificate)

CertificateSpec defines the desired state of a Certificate.

@@ -1110,11 +1110,11 @@ string -

CertificateStatus +

CertificateStatus

(Appears on: -Certificate) +Certificate)

CertificateStatus defines the observed state of a Certificate.

@@ -1165,8 +1165,8 @@ by this resource in spec.secretName.

http01Challenges
- -[]HTTP01Challenge + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTP01Challenge @@ -1177,11 +1177,11 @@ in order to get the TLS certificate..

-

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 -

HTTPIngressPath +

HTTPIngressPath

(Appears on: -HTTPIngressRuleValue) +HTTPIngressRuleValue)

HTTPIngressPath associates a path regex with a backend. Incoming URLs matching @@ -1281,8 +1281,8 @@ traffic to the backend.

splits
- -[]IngressBackendSplit + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressBackendSplit @@ -1324,8 +1324,8 @@ Kubernetes meta/v1.Duration retries
- -HTTPRetry + +github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPRetry @@ -1337,11 +1337,11 @@ HTTPRetry -

HTTPIngressRuleValue +

HTTPIngressRuleValue

(Appears on: -IngressRule) +IngressRule)

HTTPIngressRuleValue is a list of http selectors pointing to backends. @@ -1362,8 +1362,8 @@ or ‘#’.

paths
- -[]HTTPIngressPath + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPIngressPath @@ -1374,11 +1374,11 @@ or ‘#’.

-

HTTPRetry +

HTTPRetry

(Appears on: -HTTPIngressPath) +HTTPIngressPath)

HTTPRetry describes the retry policy to use when a HTTP request fails.

@@ -1417,11 +1417,11 @@ Kubernetes meta/v1.Duration -

IngressBackend +

IngressBackend

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

IngressBackendSplit +

IngressBackendSplit

(Appears on: -HTTPIngressPath) +HTTPIngressPath)

IngressBackendSplit describes all endpoints for a given service and port.

@@ -1491,7 +1491,7 @@ k8s.io/apimachinery/pkg/util/intstr.IntOrString IngressBackend
- + IngressBackend @@ -1532,11 +1532,11 @@ before forwarding a request to the destination service.

-

IngressRule +

IngressRule

(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
- -HTTPIngressRuleValue + +github.com/knative/serving/pkg/apis/networking/v1alpha1.HTTPIngressRuleValue @@ -1590,12 +1590,12 @@ rule is satisfied, the request is routed to the specified backend.

-

IngressSpec +

IngressSpec

(Appears on: -ClusterIngress, -Ingress) +ClusterIngress, +Ingress)

IngressSpec describes the Ingress the user wishes to exist.

@@ -1634,8 +1634,8 @@ not be used - use metadata.generation

tls
- -[]IngressTLS + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressTLS @@ -1652,8 +1652,8 @@ ingress supports SNI.

rules
- -[]IngressRule + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.IngressRule @@ -1666,7 +1666,7 @@ ingress supports SNI.

visibility
- + IngressVisibility @@ -1677,12 +1677,12 @@ IngressVisibility -

IngressStatus +

IngressStatus

(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.Status loadBalancer
- -LoadBalancerStatus + +github.com/knative/serving/pkg/apis/networking/v1alpha1.LoadBalancerStatus @@ -1726,11 +1726,11 @@ LoadBalancerStatus -

IngressTLS +

IngressTLS

(Appears on: -IngressSpec) +IngressSpec)

IngressTLS describes the transport layer security associated with an Ingress.

@@ -1808,21 +1808,21 @@ Defaults to tls.key.

-

IngressVisibility +

IngressVisibility (string alias)

(Appears on: -IngressSpec) +IngressSpec)

IngressVisibility describes whether the Ingress should be exposed to public gateways or not.

-

LoadBalancerIngressStatus +

LoadBalancerIngressStatus

(Appears on: -LoadBalancerStatus) +LoadBalancerStatus)

LoadBalancerIngressStatus represents the status of a load-balancer ingress point: @@ -1890,11 +1890,11 @@ bool -

LoadBalancerStatus +

LoadBalancerStatus

(Appears on: -IngressStatus) +IngressStatus)

LoadBalancerStatus represents the status of a load-balancer.

@@ -1911,8 +1911,8 @@ bool ingress
- -[]LoadBalancerIngressStatus + +[][]github.com/knative/serving/pkg/apis/networking/v1alpha1.LoadBalancerIngressStatus @@ -1924,21 +1924,21 @@ Traffic intended for the service should be sent to these ingress points.

-

ServerlessServiceOperationMode +

ServerlessServiceOperationMode (string alias)

(Appears on: -ServerlessServiceSpec) +ServerlessServiceSpec)

ServerlessServiceOperationMode is an enumeration of the modes of operation for the ServerlessService.

-

ServerlessServiceSpec +

ServerlessServiceSpec

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

-

ServerlessServiceStatus +

ServerlessServiceStatus

(Appears on: -ServerlessService) +ServerlessService)

ServerlessServiceStatus describes the current state of the ServerlessService.

@@ -2058,15 +2058,15 @@ load balances over the user service pods backing this Revision.

Resource Types: -

Configuration +

Configuration

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
- -RevisionTemplateSpec + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec @@ -2182,8 +2182,8 @@ DEPRECATED Use Template instead.

template
- -RevisionTemplateSpec + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec @@ -2200,7 +2200,7 @@ be stamped out.

status
- + ConfigurationStatus @@ -2212,7 +2212,7 @@ ConfigurationStatus -

Revision +

Revision

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 +

Route

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
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget @@ -2510,7 +2510,7 @@ not be used - use metadata.generation

status
- + RouteStatus @@ -2522,7 +2522,7 @@ RouteStatus -

Service +

Service

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
- -RunLatestType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RunLatestType @@ -2626,8 +2626,8 @@ from the supplied configuration running.

pinned
- -PinnedType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.PinnedType @@ -2640,8 +2640,8 @@ PinnedType manual
- -ManualType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.ManualType @@ -2656,8 +2656,8 @@ from the limited capabilities of Service to the full power of Route.

release
- -ReleaseType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.ReleaseType @@ -2671,7 +2671,7 @@ to be split between two revisions. This type replaces the deprecated Pinned type 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 +

CannotConvertError

CannotConvertError is returned when a field cannot be converted.

@@ -2755,15 +2755,15 @@ string -

ConfigurationSpec +

ConfigurationSpec

(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
- -RevisionTemplateSpec + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec @@ -2827,8 +2827,8 @@ DEPRECATED Use Template instead.

template
- -RevisionTemplateSpec + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RevisionTemplateSpec @@ -2840,11 +2840,11 @@ be stamped out.

-

ConfigurationStatus +

ConfigurationStatus

(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.Status ConfigurationStatusFields
- + ConfigurationStatusFields @@ -2889,12 +2889,12 @@ ConfigurationStatusFields -

ConfigurationStatusFields +

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

DeprecatedRevisionServingStateType +

DeprecatedRevisionServingStateType (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

-

ManualType +

ManualType

(Appears on: -ServiceSpec) +ServiceSpec)

ManualType contains the options for configuring a manual service. See ServiceSpec for more details.

-

PinnedType +

PinnedType

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

ReleaseType +

ReleaseType

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

-

RevisionRequestConcurrencyModelType +

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

-

RevisionSpec +

RevisionSpec

(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: -

RevisionStatus +

RevisionStatus

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

-

RevisionTemplateSpec +

RevisionTemplateSpec

(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: -

RouteSpec +

RouteSpec

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

traffic
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget @@ -3502,11 +3502,11 @@ not be used - use metadata.generation

-

RouteStatus +

RouteStatus

(Appears on: -Route) +Route)

RouteStatus communicates the observed state of the Route (from the controller).

@@ -3538,7 +3538,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status RouteStatusFields
- + RouteStatusFields @@ -3551,12 +3551,12 @@ RouteStatusFields -

RouteStatusFields +

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
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1alpha1.TrafficTarget @@ -3645,11 +3645,11 @@ LatestReadyRevisionName that we last observed.

-

RunLatestType +

RunLatestType

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

ServiceSpec +

ServiceSpec

(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
- -RunLatestType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.RunLatestType @@ -3735,8 +3735,8 @@ from the supplied configuration running.

pinned
- -PinnedType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.PinnedType @@ -3749,8 +3749,8 @@ PinnedType manual
- -ManualType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.ManualType @@ -3765,8 +3765,8 @@ from the limited capabilities of Service to the full power of Route.

release
- -ReleaseType + +github.com/knative/serving/pkg/apis/serving/v1alpha1.ReleaseType @@ -3780,7 +3780,7 @@ to be split between two revisions. This type replaces the deprecated Pinned type ConfigurationSpec
- + ConfigurationSpec @@ -3800,7 +3800,7 @@ be deprecated, and then dropped in v1beta1.

RouteSpec
- + RouteSpec @@ -3813,11 +3813,11 @@ RouteSpec -

ServiceStatus +

ServiceStatus

(Appears on: -Service) +Service)

ServiceStatus represents the Status stanza of the Service resource.

@@ -3849,7 +3849,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status RouteStatusFields
- + RouteStatusFields @@ -3864,7 +3864,7 @@ RouteStatusFields ConfigurationStatusFields
- + ConfigurationStatusFields @@ -3877,12 +3877,12 @@ ConfigurationStatusFields -

TrafficTarget +

TrafficTarget

(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 @@ -3933,15 +3933,15 @@ Ultimately all non-v1beta1 fields will be deprecated.

Resource Types: -

Configuration +

Configuration

Configuration represents the “floating HEAD” of a linear history of Revisions. @@ -3964,7 +3964,7 @@ See also: + ConfigurationSpec @@ -4008,7 +4008,7 @@ ConfigurationSpec template
- + RevisionTemplateSpec @@ -4025,7 +4025,7 @@ RevisionTemplateSpec status
- + ConfigurationStatus @@ -4036,7 +4036,7 @@ ConfigurationStatus -

Revision +

Revision

Revision is an immutable snapshot of code and configuration. A revision @@ -4058,7 +4058,7 @@ Configuration.

string -serving.knative.dev/v1alpha1 +serving.knative.dev/v1beta1 @@ -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 +

Route

Route is responsible for configuring ingress over a collection of Revisions. @@ -4185,7 +4185,7 @@ See also: + RouteSpec @@ -4230,8 +4230,8 @@ RouteSpec traffic
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget @@ -4248,7 +4248,7 @@ revisions and configurations.

status
- + RouteStatus @@ -4260,7 +4260,7 @@ RouteStatus -

Service +

Service

Service acts as a top-level container that manages a Route and Configuration @@ -4288,7 +4288,7 @@ and Route, reflecting their statuses and conditions as its own.

string -serving.knative.dev/v1alpha1 +serving.knative.dev/v1beta1 @@ -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 -

ConfigurationSpec +

ConfigurationSpec

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

ConfigurationSpec holds the desired state of the Configuration (from the client).

@@ -4403,7 +4403,7 @@ ServiceStatus template
- + RevisionTemplateSpec @@ -4415,11 +4415,11 @@ RevisionTemplateSpec -

ConfigurationStatus +

ConfigurationStatus

(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.Status ConfigurationStatusFields
- + ConfigurationStatusFields @@ -4464,12 +4464,12 @@ ConfigurationStatusFields -

ConfigurationStatusFields +

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

RevisionContainerConcurrencyType +

RevisionContainerConcurrencyType (int64 alias)

(Appears on: -PodAutoscalerSpec, -RevisionSpec) +PodAutoscalerSpec, +RevisionSpec)

RevisionContainerConcurrencyType is an integer expressing the maximum number of in-flight (concurrent) requests.

-

RevisionSpec +

RevisionSpec

(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.PodSpec containerConcurrency
- + RevisionContainerConcurrencyType @@ -4589,11 +4589,11 @@ be provided.

-

RevisionStatus +

RevisionStatus

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

-

RevisionTemplateSpec +

RevisionTemplateSpec

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

-

RouteSpec +

RouteSpec

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

RouteSpec holds the desired state of the Route (from the client).

@@ -4784,8 +4784,8 @@ be provided.

traffic
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget @@ -4797,11 +4797,11 @@ revisions and configurations.

-

RouteStatus +

RouteStatus

(Appears on: -Route) +Route)

RouteStatus communicates the observed state of the Route (from the controller).

@@ -4833,7 +4833,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status RouteStatusFields
- + RouteStatusFields @@ -4846,12 +4846,12 @@ RouteStatusFields -

RouteStatusFields +

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
- -[]TrafficTarget + +[][]github.com/knative/serving/pkg/apis/serving/v1beta1.TrafficTarget @@ -4912,11 +4912,11 @@ LatestReadyRevisionName that we last observed.

-

ServiceSpec +

ServiceSpec

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

-

ServiceStatus +

ServiceStatus

(Appears on: -Service) +Service)

ServiceStatus represents the Status stanza of the Service resource.

@@ -5008,7 +5008,7 @@ github.com/knative/pkg/apis/duck/v1beta1.Status ConfigurationStatusFields
- + ConfigurationStatusFields @@ -5025,7 +5025,7 @@ specific to ConfigurationStatus.

RouteStatusFields
- + RouteStatusFields @@ -5040,13 +5040,13 @@ specific to RouteStatus.

-

TrafficTarget +

TrafficTarget

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

TrafficTarget holds a single entry of the routing table for a Route.

From c24d3da4842f744502c1d8fd3062a88521178550 Mon Sep 17 00:00:00 2001 From: Richie Escarez Date: Fri, 28 Jun 2019 14:35:10 -0700 Subject: [PATCH 2/3] manually fix HTML links and dup pkgs --- .../eventing/eventing-contrib-resources.md | 62 +++++-------------- docs/reference/serving.md | 50 +++++++-------- 2 files changed, 40 insertions(+), 72 deletions(-) diff --git a/docs/reference/eventing/eventing-contrib-resources.md b/docs/reference/eventing/eventing-contrib-resources.md index 2a5c70a3f2c..c0e7e3b3aef 100644 --- a/docs/reference/eventing/eventing-contrib-resources.md +++ b/docs/reference/eventing/eventing-contrib-resources.md @@ -3,18 +3,6 @@
  • sources.eventing.knative.dev
    • -
  • -sources.eventing.knative.dev -
    • -
  • -sources.eventing.knative.dev -
    • -
  • -sources.eventing.knative.dev -
    • -
  • -sources.eventing.knative.dev -

    • sources.eventing.knative.dev

    @@ -23,6 +11,18 @@ Resource Types:

    CamelSource

    @@ -381,14 +381,6 @@ string
    -

    sources.eventing.knative.dev

    -

    -

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

    -

    -Resource Types: -

    AwsSqsSource

    @@ -634,14 +626,6 @@ string

    -

    sources.eventing.knative.dev

    -

    -

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

    -

    -Resource Types: -

    GcpPubSubSource

    @@ -712,7 +696,7 @@ 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).

    +https://cloud.google.com/iam/docs/creating-managing-service-account-keys.

    @@ -826,7 +810,7 @@ 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).

    +https://cloud.google.com/iam/docs/creating-managing-service-account-keys.

    @@ -957,14 +941,6 @@ string
    -

    sources.eventing.knative.dev

    -

    -

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

    -

    -Resource Types: -

    GitHubSource

    @@ -1376,14 +1352,6 @@ Kubernetes core/v1.SecretKeySelector

    -

    sources.eventing.knative.dev

    -

    -

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

    -

    -Resource Types: -

    KafkaSource

    @@ -1984,7 +1952,7 @@ SecretValueFromSource

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

    diff --git a/docs/reference/serving.md b/docs/reference/serving.md index 89b5f2d9f03..3762de4cbd7 100644 --- a/docs/reference/serving.md +++ b/docs/reference/serving.md @@ -7,10 +7,10 @@ networking.internal.knative.dev

  • -serving.knative.dev +serving.knative.dev (v1alpha1)
  • -serving.knative.dev +serving.knative.dev (v1beta1)

    • autoscaling.internal.knative.dev

    @@ -1594,7 +1594,7 @@ rule is satisfied, the request is routed to the specified backend.

    (Appears on: -ClusterIngress, +ClusterIngress, Ingress)

    @@ -1681,7 +1681,7 @@ IngressVisibility

    (Appears on: -ClusterIngress, +ClusterIngress, Ingress)

    @@ -2053,7 +2053,7 @@ load balances over the user service pods backing this Revision.

    -

    serving.knative.dev

    +

    serving.knative.dev (v1alpha1)

    Resource Types: @@ -2759,10 +2759,10 @@ string

    (Appears on: -Configuration, -PinnedType, -ReleaseType, -RunLatestType, +Configuration, +PinnedType, +ReleaseType, +RunLatestType, ServiceSpec)

    @@ -2893,7 +2893,7 @@ ConfigurationStatusFields

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

    @@ -3070,7 +3070,7 @@ come from a single configuration.

    (string alias)

    (Appears on: -PodAutoscalerSpec, +PodAutoscalerSpec, RevisionSpec)

    @@ -3082,7 +3082,7 @@ DEPRECATED in favor of RevisionContainerConcurrencyType.

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

    @@ -3456,7 +3456,7 @@ environment:

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

    @@ -3555,7 +3555,7 @@ RouteStatusFields

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

    @@ -3881,7 +3881,7 @@ ConfigurationStatusFields

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

    @@ -3928,7 +3928,7 @@ Ultimately all non-v1beta1 fields will be deprecated.

    -

    serving.knative.dev

    +

    serving.knative.dev (v1beta1)

    Resource Types: @@ -4385,7 +4385,7 @@ ServiceStatus

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

    @@ -4468,7 +4468,7 @@ ConfigurationStatusFields

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

    @@ -4516,7 +4516,7 @@ Configuration. It might not be ready yet, for that use LatestReadyRevisionName.< (int64 alias)

    (Appears on: -PodAutoscalerSpec, +PodAutoscalerSpec, RevisionSpec)

    @@ -4527,8 +4527,8 @@ in-flight (concurrent) requests.

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

    @@ -4766,7 +4766,7 @@ be provided.

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

    @@ -4850,7 +4850,7 @@ RouteStatusFields

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

    @@ -5044,8 +5044,8 @@ specific to RouteStatus.

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

    From c97f3eb7dd9c4b19ef473b8263fa70084aa279a4 Mon Sep 17 00:00:00 2001 From: Richie Escarez Date: Fri, 28 Jun 2019 15:14:24 -0700 Subject: [PATCH 3/3] update readme to mention manual updates --- docs/reference/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/reference/README.md b/docs/reference/README.md index 994abd78f84..9c4bfd5e39a 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -88,6 +88,12 @@ To generate a version of the API: 1. Copy the generated API files into the `docs/reference` directory of your knative/docs clone. +1. IMPORTANT: There are some limitations to the build script that require + manual changes to the HTML. For the `serving.md` and + `eventing-contrib-resources.md`, you must manually fix the `Packages` lists. + Details for the required manual changes are in + [PR 1552](https://github.com/knative/docs/pull/1552#issuecomment-506891983). + You can now perform the necessary steps to open a PR, complete a review, and merge the new API files into the appropriate branch of the `knative/docs` repo. See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for details