mirror of https://github.com/knative/docs.git
11816 lines
322 KiB
XML
11816 lines
322 KiB
XML
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||
<channel>
|
||
<title>Knative – Knative API Reference Documentation</title>
|
||
<link>https://knative.dev/v0.22-docs/reference/api/</link>
|
||
<description>Recent content in Knative API Reference Documentation on Knative</description>
|
||
<generator>Hugo -- gohugo.io</generator>
|
||
|
||
<atom:link href="https://knative.dev/v0.22-docs/reference/api/index.xml" rel="self" type="application/rss+xml" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<item>
|
||
<title>V0.22-Docs: Knative Serving Component</title>
|
||
<link>https://knative.dev/v0.22-docs/reference/api/serving-api/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.22-docs/reference/api/serving-api/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p>Packages:</p>
|
||
<ul>
|
||
<li>
|
||
<a href="#autoscaling.internal.knative.dev%2fv1alpha1">autoscaling.internal.knative.dev/v1alpha1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#serving.knative.dev%2fv1">serving.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#serving.knative.dev%2fv1alpha1">serving.knative.dev/v1alpha1</a>
|
||
</li>
|
||
</ul>
|
||
<h2 id="autoscaling.internal.knative.dev/v1alpha1">autoscaling.internal.knative.dev/v1alpha1</h2>
|
||
<p>
|
||
<p>Package v1alpha1 contains the Autoscaling v1alpha1 API types.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a>
|
||
</li></ul>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler
|
||
</h3>
|
||
<p>
|
||
<p>PodAutoscaler is a Knative abstraction that encapsulates the interface by which Knative
|
||
components instantiate autoscalers. This definition is an abstraction that may be backed
|
||
by multiple definitions. For more information, see the Knative Pluggability presentation:
|
||
<a href="https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit">https://docs.google.com/presentation/d/10KWynvAJYuOEWy69VBa6bHJVCqIsz1TNdEKosNvcpPY/edit</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
autoscaling.internal.knative.dev/v1alpha1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>PodAutoscaler</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec">
|
||
PodAutoscalerSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec holds the desired state of the PodAutoscaler (from the client).</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>containerConcurrency</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerConcurrency specifies the maximum allowed
|
||
in-flight (concurrent) requests per container of the Revision.
|
||
Defaults to <code>0</code> which means unlimited concurrency.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>scaleTargetRef</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ScaleTargetRef defines the /scale-able resource that this PodAutoscaler
|
||
is responsible for quickly right-sizing.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reachability</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.ReachabilityType">
|
||
ReachabilityType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reachability specifies whether or not the <code>ScaleTargetRef</code> can be reached (ie. has a route).
|
||
Defaults to <code>ReachabilityUnknown</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>protocolType</code><br/>
|
||
<em>
|
||
knative.dev/networking/pkg/apis/networking.ProtocolType
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>The application-layer protocol. Matches <code>ProtocolType</code> inferred from the revision spec.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerStatus">
|
||
PodAutoscalerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status communicates the observed state of the PodAutoscaler (from the controller).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.Metric">Metric
|
||
</h3>
|
||
<p>
|
||
<p>Metric represents a resource to configure the metric collector with.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.MetricSpec">
|
||
MetricSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec holds the desired state of the Metric (from the client).</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>stableWindow</code><br/>
|
||
<em>
|
||
time.Duration
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>StableWindow is the aggregation window for metrics in a stable state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>panicWindow</code><br/>
|
||
<em>
|
||
time.Duration
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>PanicWindow is the aggregation window for metrics where quick reactions are needed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>scrapeTarget</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ScrapeTarget is the K8s service that publishes the metric endpoint.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.MetricStatus">
|
||
MetricStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status communicates the observed state of the Metric (from the controller).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.MetricSpec">MetricSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.Metric">Metric</a>)
|
||
</p>
|
||
<p>
|
||
<p>MetricSpec contains all values a metric collector needs to operate.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>stableWindow</code><br/>
|
||
<em>
|
||
time.Duration
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>StableWindow is the aggregation window for metrics in a stable state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>panicWindow</code><br/>
|
||
<em>
|
||
time.Duration
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>PanicWindow is the aggregation window for metrics where quick reactions are needed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>scrapeTarget</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ScrapeTarget is the K8s service that publishes the metric endpoint.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.MetricStatus">MetricStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.Metric">Metric</a>)
|
||
</p>
|
||
<p>
|
||
<p>MetricStatus reflects the status of metric collection for this specific entity.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec">PodAutoscalerSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a>)
|
||
</p>
|
||
<p>
|
||
<p>PodAutoscalerSpec holds the desired state of the PodAutoscaler (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>containerConcurrency</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerConcurrency specifies the maximum allowed
|
||
in-flight (concurrent) requests per container of the Revision.
|
||
Defaults to <code>0</code> which means unlimited concurrency.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>scaleTargetRef</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ScaleTargetRef defines the /scale-able resource that this PodAutoscaler
|
||
is responsible for quickly right-sizing.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reachability</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.ReachabilityType">
|
||
ReachabilityType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reachability specifies whether or not the <code>ScaleTargetRef</code> can be reached (ie. has a route).
|
||
Defaults to <code>ReachabilityUnknown</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>protocolType</code><br/>
|
||
<em>
|
||
knative.dev/networking/pkg/apis/networking.ProtocolType
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>The application-layer protocol. Matches <code>ProtocolType</code> inferred from the revision spec.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerStatus">PodAutoscalerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscaler">PodAutoscaler</a>)
|
||
</p>
|
||
<p>
|
||
<p>PodAutoscalerStatus communicates the observed state of the PodAutoscaler (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ServiceName is the K8s Service name that serves the revision, scaled by this PA.
|
||
The service is created and owned by the ServerlessService object owned by this PA.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metricsServiceName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>MetricsServiceName is the K8s Service name that provides revision metrics.
|
||
The service is managed by the PA object.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>desiredScale</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>DesiredScale shows the current desired number of replicas for the revision.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>actualScale</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ActualScale shows the actual number of replicas for the revision.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable
|
||
</h3>
|
||
<p>
|
||
<p>PodScalable is a duck type that the resources referenced by the
|
||
PodAutoscaler&rsquo;s ScaleTargetRef must implement. They must also
|
||
implement the <code>/scale</code> sub-resource for use with <code>/scale</code> based
|
||
implementations (e.g. HPA), but this further constrains the shape
|
||
the referenced resources may take.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalableSpec">
|
||
PodScalableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>replicas</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>selector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalableStatus">
|
||
PodScalableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalableSpec">PodScalableSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable</a>)
|
||
</p>
|
||
<p>
|
||
<p>PodScalableSpec is the specification for the desired state of a
|
||
PodScalable (or at least our shared portion).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>replicas</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>selector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.PodScalableStatus">PodScalableStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodScalable">PodScalable</a>)
|
||
</p>
|
||
<p>
|
||
<p>PodScalableStatus is the observed state of a PodScalable (or at
|
||
least our shared portion).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>replicas</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="autoscaling.internal.knative.dev/v1alpha1.ReachabilityType">ReachabilityType
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#autoscaling.internal.knative.dev/v1alpha1.PodAutoscalerSpec">PodAutoscalerSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>ReachabilityType is the enumeration type for the different states of reachability
|
||
to the <code>ScaleTarget</code> of a <code>PodAutoscaler</code></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td><p>&#34;Reachable&#34;</p></td>
|
||
<td><p>ReachabilityReachable means the <code>ScaleTarget</code> is reachable, ie. it has an active route.</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;&#34;</p></td>
|
||
<td><p>ReachabilityUnknown means the reachability of the <code>ScaleTarget</code> is unknown.
|
||
Used when the reachability cannot be determined, eg. during activation.</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;Unreachable&#34;</p></td>
|
||
<td><p>ReachabilityUnreachable means the <code>ScaleTarget</code> is not reachable, ie. it does not have an active route.</p>
|
||
</td>
|
||
</tr></tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="serving.knative.dev/v1">serving.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 contains the Serving v1 API types.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#serving.knative.dev/v1.Configuration">Configuration</a>
|
||
</li><li>
|
||
<a href="#serving.knative.dev/v1.Revision">Revision</a>
|
||
</li><li>
|
||
<a href="#serving.knative.dev/v1.Route">Route</a>
|
||
</li><li>
|
||
<a href="#serving.knative.dev/v1.Service">Service</a>
|
||
</li></ul>
|
||
<h3 id="serving.knative.dev/v1.Configuration">Configuration
|
||
</h3>
|
||
<p>
|
||
<p>Configuration represents the &ldquo;floating HEAD&rdquo; of a linear history of Revisions.
|
||
Users create new Revisions by updating the Configuration&rsquo;s spec.
|
||
The &ldquo;latest created&rdquo; revision&rsquo;s name is available under status, as is the
|
||
&ldquo;latest ready&rdquo; revision&rsquo;s name.
|
||
See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration">https://github.com/knative/serving/blob/main/docs/spec/overview.md#configuration</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
serving.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Configuration</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationSpec">
|
||
ConfigurationSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RevisionTemplateSpec">
|
||
RevisionTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Template holds the latest specification for the Revision to be stamped out.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationStatus">
|
||
ConfigurationStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.Revision">Revision
|
||
</h3>
|
||
<p>
|
||
<p>Revision is an immutable snapshot of code and configuration. A revision
|
||
references a container image. Revisions are created by updates to a
|
||
Configuration.</p>
|
||
<p>See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision">https://github.com/knative/serving/blob/main/docs/spec/overview.md#revision</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
serving.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Revision</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RevisionSpec">
|
||
RevisionSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>PodSpec</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podspec-v1-core">
|
||
Kubernetes core/v1.PodSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>PodSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>containerConcurrency</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
|
||
requests per container of the Revision. Defaults to <code>0</code> which means
|
||
concurrency to the application is not limited, and the system decides the
|
||
target concurrency for the autoscaler.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timeoutSeconds</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>TimeoutSeconds is the maximum duration in seconds that the request routing
|
||
layer will wait for a request delivered to a container to begin replying
|
||
(send network traffic). If unspecified, a system default will be provided.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RevisionStatus">
|
||
RevisionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.Route">Route
|
||
</h3>
|
||
<p>
|
||
<p>Route is responsible for configuring ingress over a collection of Revisions.
|
||
Some of the Revisions a Route distributes traffic over may be specified by
|
||
referencing the Configuration responsible for creating them; in these cases
|
||
the Route is additionally responsible for monitoring the Configuration for
|
||
&ldquo;latest ready revision&rdquo; changes, and smoothly rolling out latest revisions.
|
||
See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#route">https://github.com/knative/serving/blob/main/docs/spec/overview.md#route</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
serving.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Route</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteSpec">
|
||
RouteSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec holds the desired state of the Route (from the client).</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>traffic</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.TrafficTarget">
|
||
[]TrafficTarget
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Traffic specifies how to distribute traffic over a collection of
|
||
revisions and configurations.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteStatus">
|
||
RouteStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status communicates the observed state of the Route (from the controller).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.Service">Service
|
||
</h3>
|
||
<p>
|
||
<p>Service acts as a top-level container that manages a Route and Configuration
|
||
which implement a network service. Service exists to provide a singular
|
||
abstraction which can be access controlled, reasoned about, and which
|
||
encapsulates software lifecycle decisions such as rollout policy and
|
||
team resource ownership. Service acts only as an orchestrator of the
|
||
underlying Routes and Configurations (much as a kubernetes Deployment
|
||
orchestrates ReplicaSets), and its usage is optional but recommended.</p>
|
||
<p>The Service&rsquo;s controller will track the statuses of its owned Configuration
|
||
and Route, reflecting their statuses and conditions as its own.</p>
|
||
<p>See also: <a href="https://github.com/knative/serving/blob/main/docs/spec/overview.md#service">https://github.com/knative/serving/blob/main/docs/spec/overview.md#service</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
serving.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Service</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ServiceSpec">
|
||
ServiceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>ConfigurationSpec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationSpec">
|
||
ConfigurationSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ConfigurationSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>ServiceSpec inlines an unrestricted ConfigurationSpec.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>RouteSpec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteSpec">
|
||
RouteSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>RouteSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>ServiceSpec inlines RouteSpec and restricts/defaults its fields
|
||
via webhook. In particular, this spec can only reference this
|
||
Service&rsquo;s configuration and revisions (which also influences
|
||
defaults).</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ServiceStatus">
|
||
ServiceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ConfigurationSpec">ConfigurationSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Configuration">Configuration</a>, <a href="#serving.knative.dev/v1.ServiceSpec">ServiceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>ConfigurationSpec holds the desired state of the Configuration (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RevisionTemplateSpec">
|
||
RevisionTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Template holds the latest specification for the Revision to be stamped out.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ConfigurationStatus">ConfigurationStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Configuration">Configuration</a>)
|
||
</p>
|
||
<p>
|
||
<p>ConfigurationStatus communicates the observed state of the Configuration (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ConfigurationStatusFields</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationStatusFields">
|
||
ConfigurationStatusFields
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ConfigurationStatusFields</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ConfigurationStatusFields">ConfigurationStatusFields
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.ConfigurationStatus">ConfigurationStatus</a>, <a href="#serving.knative.dev/v1.ServiceStatus">ServiceStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ConfigurationStatusFields holds the fields of Configuration&rsquo;s status that
|
||
are not generally shared. This is defined separately and inlined so that
|
||
other types can readily consume these fields via duck typing.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>latestReadyRevisionName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LatestReadyRevisionName holds the name of the latest Revision stamped out
|
||
from this Configuration that has had its &ldquo;Ready&rdquo; condition become &ldquo;True&rdquo;.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>latestCreatedRevisionName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LatestCreatedRevisionName is the last revision that was created from this
|
||
Configuration. It might not be ready yet, for that use LatestReadyRevisionName.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ContainerStatus">ContainerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.RevisionStatus">RevisionStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerStatus holds the information of container name and image digest value</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>name</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>imageDigest</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RevisionSpec">RevisionSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Revision">Revision</a>, <a href="#serving.knative.dev/v1.RevisionTemplateSpec">RevisionTemplateSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>RevisionSpec holds the desired state of the Revision (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>PodSpec</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podspec-v1-core">
|
||
Kubernetes core/v1.PodSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>PodSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>containerConcurrency</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
|
||
requests per container of the Revision. Defaults to <code>0</code> which means
|
||
concurrency to the application is not limited, and the system decides the
|
||
target concurrency for the autoscaler.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timeoutSeconds</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>TimeoutSeconds is the maximum duration in seconds that the request routing
|
||
layer will wait for a request delivered to a container to begin replying
|
||
(send network traffic). If unspecified, a system default will be provided.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RevisionStatus">RevisionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Revision">Revision</a>)
|
||
</p>
|
||
<p>
|
||
<p>RevisionStatus communicates the observed state of the Revision (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceName holds the name of a core Kubernetes Service resource that
|
||
load balances over the pods backing this Revision.
|
||
Deprecated: revision service name is effectively equal to the revision name,
|
||
as per #10540.
|
||
0.23 — stop populating
|
||
0.25 — remove.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>logUrl</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LogURL specifies the generated logging url for this particular revision
|
||
based on the revision url template specified in the controller&rsquo;s config.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>imageDigest</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeprecatedImageDigest holds the resolved digest for the image specified
|
||
within .Spec.Container.Image. The digest is resolved during the creation
|
||
of Revision. This field holds the digest value regardless of whether
|
||
a tag or digest was originally specified in the Container object. It
|
||
may be empty if the image comes from a registry listed to skip resolution.
|
||
If multiple containers specified then DeprecatedImageDigest holds the digest
|
||
for serving container.
|
||
DEPRECATED: Use ContainerStatuses instead.
|
||
TODO(savitaashture) Remove deprecatedImageDigest.
|
||
ref <a href="https://kubernetes.io/docs/reference/using-api/deprecation-policy">https://kubernetes.io/docs/reference/using-api/deprecation-policy</a> for deprecation.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>containerStatuses</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ContainerStatus">
|
||
[]ContainerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerStatuses is a slice of images present in .Spec.Container[*].Image
|
||
to their respective digests and their container name.
|
||
The digests are resolved during the creation of Revision.
|
||
ContainerStatuses holds the container name and image digests
|
||
for both serving and non serving containers.
|
||
ref: <a href="http://bit.ly/image-digests">http://bit.ly/image-digests</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>actualReplicas</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ActualReplicas reflects the amount of ready pods running this revision.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>desiredReplicas</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DesiredReplicas reflects the desired amount of pods running this revision.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RevisionTemplateSpec">RevisionTemplateSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.ConfigurationSpec">ConfigurationSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>RevisionTemplateSpec describes the data a revision should have when created from a template.
|
||
Based on: <a href="https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190">https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190</a></p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RevisionSpec">
|
||
RevisionSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>PodSpec</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podspec-v1-core">
|
||
Kubernetes core/v1.PodSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>PodSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>containerConcurrency</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContainerConcurrency specifies the maximum allowed in-flight (concurrent)
|
||
requests per container of the Revision. Defaults to <code>0</code> which means
|
||
concurrency to the application is not limited, and the system decides the
|
||
target concurrency for the autoscaler.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timeoutSeconds</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>TimeoutSeconds is the maximum duration in seconds that the request routing
|
||
layer will wait for a request delivered to a container to begin replying
|
||
(send network traffic). If unspecified, a system default will be provided.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RouteSpec">RouteSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Route">Route</a>, <a href="#serving.knative.dev/v1.ServiceSpec">ServiceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>RouteSpec holds the desired state of the Route (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>traffic</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.TrafficTarget">
|
||
[]TrafficTarget
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Traffic specifies how to distribute traffic over a collection of
|
||
revisions and configurations.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RouteStatus">RouteStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Route">Route</a>)
|
||
</p>
|
||
<p>
|
||
<p>RouteStatus communicates the observed state of the Route (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>RouteStatusFields</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteStatusFields">
|
||
RouteStatusFields
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>RouteStatusFields</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RouteStatusFields">RouteStatusFields
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.RouteStatus">RouteStatus</a>, <a href="#serving.knative.dev/v1.ServiceStatus">ServiceStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>RouteStatusFields holds the fields of Route&rsquo;s status that
|
||
are not generally shared. This is defined separately and inlined so that
|
||
other types can readily consume these fields via duck typing.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>url</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>URL holds the url that will distribute traffic over the provided traffic targets.
|
||
It generally has the form http[s]://{route-name}.{route-namespace}.{cluster-level-suffix}</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>address</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Addressable
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Address holds the information needed for a Route to be the target of an event.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>traffic</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.TrafficTarget">
|
||
[]TrafficTarget
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Traffic holds the configured traffic distribution.
|
||
These entries will always contain RevisionName references.
|
||
When ConfigurationName appears in the spec, this will hold the
|
||
LatestReadyRevisionName that we last observed.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.RoutingState">RoutingState
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
<p>RoutingState represents states of a revision with regards to serving a route.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td><p>&#34;active&#34;</p></td>
|
||
<td><p>RoutingStateActive is a state for a revision which is actively referenced by a Route.</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;pending&#34;</p></td>
|
||
<td><p>RoutingStatePending is a state after a revision is created, but before
|
||
its routing state has been determined. It is treated like active for the purposes
|
||
of revision garbage collection.</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;reserve&#34;</p></td>
|
||
<td><p>RoutingStateReserve is a state for a revision which is no longer referenced by a Route,
|
||
and is scaled down, but may be rapidly pinned to a route to be made active again.</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;&#34;</p></td>
|
||
<td><p>RoutingStateUnset is the empty value for routing state, this state is unexpected.</p>
|
||
</td>
|
||
</tr></tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ServiceSpec">ServiceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Service">Service</a>)
|
||
</p>
|
||
<p>
|
||
<p>ServiceSpec represents the configuration for the Service object.
|
||
A Service&rsquo;s specification is the union of the specifications for a Route
|
||
and Configuration. The Service restricts what can be expressed in these
|
||
fields, e.g. the Route must reference the provided Configuration;
|
||
however, these limitations also enable friendlier defaulting,
|
||
e.g. Route never needs a Configuration name, and may be defaulted to
|
||
the appropriate &ldquo;run latest&rdquo; spec.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ConfigurationSpec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationSpec">
|
||
ConfigurationSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ConfigurationSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>ServiceSpec inlines an unrestricted ConfigurationSpec.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>RouteSpec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteSpec">
|
||
RouteSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>RouteSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>ServiceSpec inlines RouteSpec and restricts/defaults its fields
|
||
via webhook. In particular, this spec can only reference this
|
||
Service&rsquo;s configuration and revisions (which also influences
|
||
defaults).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.ServiceStatus">ServiceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.Service">Service</a>)
|
||
</p>
|
||
<p>
|
||
<p>ServiceStatus represents the Status stanza of the Service resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ConfigurationStatusFields</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.ConfigurationStatusFields">
|
||
ConfigurationStatusFields
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ConfigurationStatusFields</code> are embedded into this type.)
|
||
</p>
|
||
<p>In addition to inlining ConfigurationSpec, we also inline the fields
|
||
specific to ConfigurationStatus.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>RouteStatusFields</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1.RouteStatusFields">
|
||
RouteStatusFields
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>RouteStatusFields</code> are embedded into this type.)
|
||
</p>
|
||
<p>In addition to inlining RouteSpec, we also inline the fields
|
||
specific to RouteStatus.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1.TrafficTarget">TrafficTarget
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1.RouteSpec">RouteSpec</a>, <a href="#serving.knative.dev/v1.RouteStatusFields">RouteStatusFields</a>)
|
||
</p>
|
||
<p>
|
||
<p>TrafficTarget holds a single entry of the routing table for a Route.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>tag</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Tag is optionally used to expose a dedicated url for referencing
|
||
this target exclusively.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>revisionName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>RevisionName of a specific revision to which to send this portion of
|
||
traffic. This is mutually exclusive with ConfigurationName.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>configurationName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ConfigurationName of a configuration to whose latest revision we will send
|
||
this portion of traffic. When the &ldquo;status.latestReadyRevisionName&rdquo; of the
|
||
referenced configuration changes, we will automatically migrate traffic
|
||
from the prior &ldquo;latest ready&rdquo; revision to the new one. This field is never
|
||
set in Route&rsquo;s status, only its spec. This is mutually exclusive with
|
||
RevisionName.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>latestRevision</code><br/>
|
||
<em>
|
||
bool
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LatestRevision may be optionally provided to indicate that the latest
|
||
ready Revision of the Configuration should be used for this traffic
|
||
target. When provided LatestRevision must be true if RevisionName is
|
||
empty; it must be false when RevisionName is non-empty.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>percent</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Percent indicates that percentage based routing should be used and
|
||
the value indicates the percent of traffic that is be routed to this
|
||
Revision or Configuration. <code>0</code> (zero) mean no traffic, <code>100</code> means all
|
||
traffic.
|
||
When percentage based routing is being used the follow rules apply:
|
||
- the sum of all percent values must equal 100
|
||
- when not specified, the implied value for <code>percent</code> is zero for
|
||
that particular Revision or Configuration</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>url</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>URL displays the URL for accessing named traffic targets. URL is displayed in
|
||
status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and
|
||
a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="serving.knative.dev/v1alpha1">serving.knative.dev/v1alpha1</h2>
|
||
<p>
|
||
<p>Package v1alpha1 contains the v1alpha1 versions of the serving apis.
|
||
Api versions allow the api contract for a resource to be changed while keeping
|
||
backward compatibility by support multiple concurrent versions
|
||
of the same resource</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#serving.knative.dev/v1alpha1.DomainMapping">DomainMapping</a>
|
||
</li></ul>
|
||
<h3 id="serving.knative.dev/v1alpha1.DomainMapping">DomainMapping
|
||
</h3>
|
||
<p>
|
||
<p>DomainMapping is a mapping from a custom hostname to an Addressable.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
serving.knative.dev/v1alpha1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>DomainMapping</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Standard object&rsquo;s metadata.
|
||
More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata</a></p>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1alpha1.DomainMappingSpec">
|
||
DomainMappingSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec is the desired state of the DomainMapping.
|
||
More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</a></p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>ref</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Ref specifies the target of the Domain Mapping.</p>
|
||
<p>The object identified by the Ref must be an Addressable with a URL of the
|
||
form <code>{name}.{namespace}.{domain}</code> where <code>{domain}</code> is the cluster domain,
|
||
and <code>{name}</code> and <code>{namespace}</code> are the name and namespace of a Kubernetes
|
||
Service.</p>
|
||
<p>This contract is satisfied by Knative types such as Knative Services and
|
||
Knative Routes, and by Kubernetes Services.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#serving.knative.dev/v1alpha1.DomainMappingStatus">
|
||
DomainMappingStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status is the current state of the DomainMapping.
|
||
More info: <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status">https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1alpha1.CannotConvertError">CannotConvertError
|
||
</h3>
|
||
<p>
|
||
<p>CannotConvertError is returned when a field cannot be converted.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Message</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>Field</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1alpha1.DomainMappingSpec">DomainMappingSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1alpha1.DomainMapping">DomainMapping</a>)
|
||
</p>
|
||
<p>
|
||
<p>DomainMappingSpec describes the DomainMapping the user wishes to exist.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ref</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Ref specifies the target of the Domain Mapping.</p>
|
||
<p>The object identified by the Ref must be an Addressable with a URL of the
|
||
form <code>{name}.{namespace}.{domain}</code> where <code>{domain}</code> is the cluster domain,
|
||
and <code>{name}</code> and <code>{namespace}</code> are the name and namespace of a Kubernetes
|
||
Service.</p>
|
||
<p>This contract is satisfied by Knative types such as Knative Services and
|
||
Knative Routes, and by Kubernetes Services.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="serving.knative.dev/v1alpha1.DomainMappingStatus">DomainMappingStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#serving.knative.dev/v1alpha1.DomainMapping">DomainMapping</a>)
|
||
</p>
|
||
<p>
|
||
<p>DomainMappingStatus describes the current state of the DomainMapping.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>url</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>URL is the URL of this DomainMapping.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>address</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Addressable
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Address holds the information needed for a DomainMapping to be the target of an event.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<p><em>
|
||
Generated with <code>gen-crd-api-reference-docs</code>
|
||
on git commit <code>813aa6596</code>.
|
||
</em></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</description>
|
||
</item>
|
||
|
||
<item>
|
||
<title>V0.22-Docs: Knative Eventing Component</title>
|
||
<link>https://knative.dev/v0.22-docs/reference/api/eventing/</link>
|
||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||
|
||
<guid>https://knative.dev/v0.22-docs/reference/api/eventing/</guid>
|
||
<description>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p>Packages:</p>
|
||
<ul>
|
||
<li>
|
||
<a href="#duck.knative.dev%2fv1">duck.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#duck.knative.dev%2fv1beta1">duck.knative.dev/v1beta1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#eventing.knative.dev%2fv1">eventing.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#eventing.knative.dev%2fv1beta1">eventing.knative.dev/v1beta1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#flows.knative.dev%2fv1">flows.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#flows.knative.dev%2fv1beta1">flows.knative.dev/v1beta1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#messaging.knative.dev%2fv1">messaging.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#messaging.knative.dev%2fv1beta1">messaging.knative.dev/v1beta1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#sources.knative.dev%2fv1">sources.knative.dev/v1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#sources.knative.dev%2fv1alpha1">sources.knative.dev/v1alpha1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#sources.knative.dev%2fv1alpha2">sources.knative.dev/v1alpha2</a>
|
||
</li>
|
||
<li>
|
||
<a href="#sources.knative.dev%2fv1beta1">sources.knative.dev/v1beta1</a>
|
||
</li>
|
||
<li>
|
||
<a href="#sources.knative.dev%2fv1beta2">sources.knative.dev/v1beta2</a>
|
||
</li>
|
||
</ul>
|
||
<h2 id="duck.knative.dev/v1">duck.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 is the v1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul></ul>
|
||
<h3 id="duck.knative.dev/v1.BackoffPolicyType">BackoffPolicyType
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.DeliverySpec">DeliverySpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>BackoffPolicyType is the type for backoff policies</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td><p>&#34;exponential&#34;</p></td>
|
||
<td><p>Exponential backoff policy</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;linear&#34;</p></td>
|
||
<td><p>Linear backoff policy</p>
|
||
</td>
|
||
</tr></tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.Channelable">Channelable
|
||
</h3>
|
||
<p>
|
||
<p>Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers
|
||
defining compatible resources to embed it. We will typically use this type to deserialize
|
||
Channelable ObjectReferences and access their subscription and address data. This is not a real resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec is the part where the Channelable fulfills the Subscribable contract.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains the default delivery spec for each subscription
|
||
to this Channelable. Each subscription delivery spec, if any, overrides this
|
||
global delivery spec.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.ChannelableSpec">ChannelableSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.Channelable">Channelable</a>, <a href="#messaging.knative.dev/v1.ChannelSpec">ChannelSpec</a>, <a href="#messaging.knative.dev/v1.InMemoryChannelSpec">InMemoryChannelSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelableSpec contains Spec of the Channelable object</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains the default delivery spec for each subscription
|
||
to this Channelable. Each subscription delivery spec, if any, overrides this
|
||
global delivery spec.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.ChannelableStatus">ChannelableStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.Channelable">Channelable</a>, <a href="#messaging.knative.dev/v1.ChannelStatus">ChannelStatus</a>, <a href="#messaging.knative.dev/v1.InMemoryChannelStatus">InMemoryChannelStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelableStatus contains the Status of a Channelable object.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the part where the Channelable fulfills the Addressable contract.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscribableStatus">
|
||
SubscribableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Subscribers is populated with the statuses of each of the Channelable&rsquo;s subscribers.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterChannel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel
|
||
Failed messages are delivered here.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.DeliverySpec">DeliverySpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.ChannelableSpec">ChannelableSpec</a>, <a href="#duck.knative.dev/v1.SubscriberSpec">SubscriberSpec</a>, <a href="#eventing.knative.dev/v1.BrokerSpec">BrokerSpec</a>, <a href="#eventing.knative.dev/v1.TriggerSpec">TriggerSpec</a>, <a href="#eventing.knative.dev/v1beta1.TriggerSpec">TriggerSpec</a>, <a href="#flows.knative.dev/v1.ParallelBranch">ParallelBranch</a>, <a href="#flows.knative.dev/v1.SequenceStep">SequenceStep</a>, <a href="#messaging.knative.dev/v1.SubscriptionSpec">SubscriptionSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>DeliverySpec contains the delivery options for event senders,
|
||
such as channelable and source.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterSink</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterSink is the sink receiving event that could not be sent to
|
||
a destination.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>retry</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Retry is the minimum number of retries the sender should attempt when
|
||
sending an event before moving it to the dead letter sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backoffPolicy</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.BackoffPolicyType">
|
||
BackoffPolicyType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BackoffPolicy is the retry backoff policy (linear, exponential).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backoffDelay</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BackoffDelay is the delay before retrying.
|
||
More information on Duration format:
|
||
- <a href="https://www.iso.org/iso-8601-date-and-time-format.html">https://www.iso.org/iso-8601-date-and-time-format.html</a>
|
||
- <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
|
||
<p>For linear policy, backoff delay is backoffDelay*<numberOfRetries>.
|
||
For exponential policy, backoff delay is backoffDelay*2^<numberOfRetries>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.DeliveryStatus">DeliveryStatus
|
||
</h3>
|
||
<p>
|
||
<p>DeliveryStatus contains the Status of an object supporting delivery options.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterChannel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterChannel is a KReference that is the reference to the native, platform specific channel
|
||
where failed events are sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.Subscribable">Subscribable
|
||
</h3>
|
||
<p>
|
||
<p>Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers
|
||
defining compatible resources to embed it. We will typically use this type to deserialize
|
||
SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscribableSpec is the part where Subscribable object is
|
||
configured as to be compatible with Subscribable contract.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscriberSpec">
|
||
[]SubscriberSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscriptions for this subscribable.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscribableStatus">
|
||
SubscribableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscribableStatus is the part where SubscribableStatus object is
|
||
configured as to be compatible with Subscribable contract.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.SubscribableSpec">SubscribableSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.ChannelableSpec">ChannelableSpec</a>, <a href="#duck.knative.dev/v1.Subscribable">Subscribable</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscriberSpec">
|
||
[]SubscriberSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscriptions for this subscribable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.SubscribableStatus">SubscribableStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.ChannelableStatus">ChannelableStatus</a>, <a href="#duck.knative.dev/v1.Subscribable">Subscribable</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscribableStatus is the schema for the subscribable&rsquo;s status portion of the status
|
||
section of the resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.SubscriberStatus">
|
||
[]SubscriberStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscription&rsquo;s statuses for this channel.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.SubscriberSpec">SubscriberSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.SubscribableSpec">SubscribableSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriberSpec defines a single subscriber to a Subscribable.</p>
|
||
<p>At least one of SubscriberURI and ReplyURI must be present</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>uid</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/types.UID
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UID is used to understand the origin of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>generation</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Generation of the origin of the subscriber with uid:UID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SubscriberURI is the endpoint for the subscriber</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>replyUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ReplyURI is the endpoint for the reply</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains options controlling the event delivery</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1.SubscriberStatus">SubscriberStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1.SubscribableStatus">SubscribableStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriberStatus defines the status of a single subscriber to a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>uid</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/types.UID
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UID is used to understand the origin of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>observedGeneration</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Generation of the origin of the subscriber with uid:UID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
|
||
Kubernetes core/v1.ConditionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Status of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>message</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>A human readable message indicating details of Ready status.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="duck.knative.dev/v1beta1">duck.knative.dev/v1beta1</h2>
|
||
<p>
|
||
<p>Package v1beta1 is the v1beta1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul></ul>
|
||
<h3 id="duck.knative.dev/v1beta1.BackoffPolicyType">BackoffPolicyType
|
||
(<code>string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.DeliverySpec">DeliverySpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>BackoffPolicyType is the type for backoff policies</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr><td><p>&#34;exponential&#34;</p></td>
|
||
<td><p>Exponential backoff policy</p>
|
||
</td>
|
||
</tr><tr><td><p>&#34;linear&#34;</p></td>
|
||
<td><p>Linear backoff policy</p>
|
||
</td>
|
||
</tr></tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.Channelable">Channelable
|
||
</h3>
|
||
<p>
|
||
<p>Channelable is a skeleton type wrapping Subscribable and Addressable in the manner we expect resource writers
|
||
defining compatible resources to embed it. We will typically use this type to deserialize
|
||
Channelable ObjectReferences and access their subscription and address data. This is not a real resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec is the part where the Channelable fulfills the Subscribable contract.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains options controlling the event delivery</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.ChannelableSpec">ChannelableSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.Channelable">Channelable</a>, <a href="#messaging.knative.dev/v1beta1.ChannelSpec">ChannelSpec</a>, <a href="#messaging.knative.dev/v1beta1.InMemoryChannelSpec">InMemoryChannelSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelableSpec contains Spec of the Channelable object</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains options controlling the event delivery</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.ChannelableStatus">ChannelableStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.Channelable">Channelable</a>, <a href="#messaging.knative.dev/v1beta1.ChannelStatus">ChannelStatus</a>, <a href="#messaging.knative.dev/v1beta1.InMemoryChannelStatus">InMemoryChannelStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelableStatus contains the Status of a Channelable object.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the part where the Channelable fulfills the Addressable contract.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>SubscribableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscribableStatus">
|
||
SubscribableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SubscribableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Subscribers is populated with the statuses of each of the Channelable&rsquo;s subscribers.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterChannel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterChannel is a KReference and is set by the channel when it supports native error handling via a channel
|
||
Failed messages are delivered here.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.DeliverySpec">DeliverySpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.ChannelableSpec">ChannelableSpec</a>, <a href="#duck.knative.dev/v1beta1.SubscriberSpec">SubscriberSpec</a>, <a href="#eventing.knative.dev/v1beta1.BrokerSpec">BrokerSpec</a>, <a href="#flows.knative.dev/v1beta1.ParallelBranch">ParallelBranch</a>, <a href="#flows.knative.dev/v1beta1.SequenceStep">SequenceStep</a>, <a href="#messaging.knative.dev/v1beta1.SubscriptionSpec">SubscriptionSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>DeliverySpec contains the delivery options for event senders,
|
||
such as channelable and source.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterSink</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterSink is the sink receiving event that could not be sent to
|
||
a destination.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>retry</code><br/>
|
||
<em>
|
||
int32
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Retry is the minimum number of retries the sender should attempt when
|
||
sending an event before moving it to the dead letter sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backoffPolicy</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.BackoffPolicyType">
|
||
BackoffPolicyType
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BackoffPolicy is the retry backoff policy (linear, exponential).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>backoffDelay</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>BackoffDelay is the delay before retrying.
|
||
More information on Duration format:
|
||
- <a href="https://www.iso.org/iso-8601-date-and-time-format.html">https://www.iso.org/iso-8601-date-and-time-format.html</a>
|
||
- <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
|
||
<p>For linear policy, backoff delay is backoffDelay*<numberOfRetries>.
|
||
For exponential policy, backoff delay is backoffDelay*2^<numberOfRetries>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.DeliveryStatus">DeliveryStatus
|
||
</h3>
|
||
<p>
|
||
<p>DeliveryStatus contains the Status of an object supporting delivery options.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterChannel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeadLetterChannel is a KReference that is the reference to the native, platform specific channel
|
||
where failed events are sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.Subscribable">Subscribable
|
||
</h3>
|
||
<p>
|
||
<p>Subscribable is a skeleton type wrapping Subscribable in the manner we expect resource writers
|
||
defining compatible resources to embed it. We will typically use this type to deserialize
|
||
SubscribableType ObjectReferences and access the Subscription data. This is not a real resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscribableSpec">
|
||
SubscribableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscribableSpec is the part where Subscribable object is
|
||
configured as to be compatible with Subscribable contract.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscriberSpec">
|
||
[]SubscriberSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscriptions for this subscribable.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscribableStatus">
|
||
SubscribableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscribableStatus is the part where SubscribableStatus object is
|
||
configured as to be compatible with Subscribable contract.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.SubscribableSpec">SubscribableSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.ChannelableSpec">ChannelableSpec</a>, <a href="#duck.knative.dev/v1beta1.Subscribable">Subscribable</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscribableSpec shows how we expect folks to embed Subscribable in their Spec field.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscriberSpec">
|
||
[]SubscriberSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscriptions for this subscribable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.SubscribableStatus">SubscribableStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.ChannelableStatus">ChannelableStatus</a>, <a href="#duck.knative.dev/v1beta1.Subscribable">Subscribable</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscribableStatus is the schema for the subscribable&rsquo;s status portion of the status
|
||
section of the resource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscribers</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.SubscriberStatus">
|
||
[]SubscriberStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>This is the list of subscription&rsquo;s statuses for this channel.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.SubscriberSpec">SubscriberSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.SubscribableSpec">SubscribableSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriberSpec defines a single subscriber to a Subscribable.</p>
|
||
<p>At least one of SubscriberURI and ReplyURI must be present</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>uid</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/types.UID
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UID is used to understand the origin of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>generation</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Generation of the origin of the subscriber with uid:UID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SubscriberURI is the endpoint for the subscriber</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>replyUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ReplyURI is the endpoint for the reply</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DeliverySpec contains options controlling the event delivery</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="duck.knative.dev/v1beta1.SubscriberStatus">SubscriberStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#duck.knative.dev/v1beta1.SubscribableStatus">SubscribableStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriberStatus defines the status of a single subscriber to a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>uid</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/types.UID
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>UID is used to understand the origin of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>observedGeneration</code><br/>
|
||
<em>
|
||
int64
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Generation of the origin of the subscriber with uid:UID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core">
|
||
Kubernetes core/v1.ConditionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Status of the subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>message</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>A human readable message indicating details of Ready status.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="eventing.knative.dev/v1">eventing.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 is the v1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#eventing.knative.dev/v1.Broker">Broker</a>
|
||
</li><li>
|
||
<a href="#eventing.knative.dev/v1.Trigger">Trigger</a>
|
||
</li></ul>
|
||
<h3 id="eventing.knative.dev/v1.Broker">Broker
|
||
</h3>
|
||
<p>
|
||
<p>Broker collects a pool of events that are consumable using Triggers. Brokers
|
||
provide a well-known endpoint for event delivery that senders can use with
|
||
minimal knowledge of the event routing strategy. Subscribers use Triggers to
|
||
request delivery of events from a Broker&rsquo;s pool to a specific URL or
|
||
Addressable endpoint.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
eventing.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Broker</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.BrokerSpec">
|
||
BrokerSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Broker.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>config</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Config is a KReference to the configuration that specifies
|
||
configuration options for this Broker. For example, this could be
|
||
a pointer to a ConfigMap.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for each trigger
|
||
to this Broker. Each trigger delivery spec, if any, overrides this
|
||
global delivery spec.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.BrokerStatus">
|
||
BrokerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Broker. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.Trigger">Trigger
|
||
</h3>
|
||
<p>
|
||
<p>Trigger represents a request to have events delivered to a subscriber from a
|
||
Broker&rsquo;s event pool.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
eventing.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Trigger</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.TriggerSpec">
|
||
TriggerSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Trigger.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is the broker that this trigger receives events from.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.TriggerFilter">
|
||
TriggerFilter
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the filter to apply against all events from the Broker. Only events that pass this
|
||
filter will be sent to the Subscriber. If not specified, will default to allowing all events.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber is the addressable that receives events from the Broker that pass the Filter. It
|
||
is required.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for this specific trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.TriggerStatus">
|
||
TriggerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Trigger. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.BrokerSpec">BrokerSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.Broker">Broker</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>config</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Config is a KReference to the configuration that specifies
|
||
configuration options for this Broker. For example, this could be
|
||
a pointer to a ConfigMap.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for each trigger
|
||
to this Broker. Each trigger delivery spec, if any, overrides this
|
||
global delivery spec.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.BrokerStatus">BrokerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.Broker">Broker</a>)
|
||
</p>
|
||
<p>
|
||
<p>BrokerStatus represents the current state of a Broker.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Broker that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>address</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Addressable
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is Addressable. It exposes the endpoint as an URI to get events
|
||
delivered into the Broker mesh.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.TriggerFilter">TriggerFilter
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.TriggerSpec">TriggerSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>attributes</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.TriggerFilterAttributes">
|
||
TriggerFilterAttributes
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Attributes filters events by exact match on event context attributes.
|
||
Each key in the map is compared with the equivalent key in the event
|
||
context. An event passes the filter if all values are equal to the
|
||
specified values.</p>
|
||
<p>Nested context attributes are not supported as keys. Only string values are supported.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.TriggerFilterAttributes">TriggerFilterAttributes
|
||
(<code>map[string]string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.TriggerFilter">TriggerFilter</a>)
|
||
</p>
|
||
<p>
|
||
<p>TriggerFilterAttributes is a map of context attribute names to values for
|
||
filtering by equality. Only exact matches will pass the filter. You can use the value &ldquo;
|
||
to indicate all strings match.</p>
|
||
</p>
|
||
<h3 id="eventing.knative.dev/v1.TriggerSpec">TriggerSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.Trigger">Trigger</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is the broker that this trigger receives events from.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1.TriggerFilter">
|
||
TriggerFilter
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the filter to apply against all events from the Broker. Only events that pass this
|
||
filter will be sent to the Subscriber. If not specified, will default to allowing all events.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber is the addressable that receives events from the Broker that pass the Filter. It
|
||
is required.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for this specific trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1.TriggerStatus">TriggerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1.Trigger">Trigger</a>)
|
||
</p>
|
||
<p>
|
||
<p>TriggerStatus represents the current state of a Trigger.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Trigger that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SubscriberURI is the resolved URI of the receiver for this Trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="eventing.knative.dev/v1beta1">eventing.knative.dev/v1beta1</h2>
|
||
<p>
|
||
<p>Package v1beta1 is the v1beta1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#eventing.knative.dev/v1beta1.Broker">Broker</a>
|
||
</li><li>
|
||
<a href="#eventing.knative.dev/v1beta1.EventType">EventType</a>
|
||
</li><li>
|
||
<a href="#eventing.knative.dev/v1beta1.Trigger">Trigger</a>
|
||
</li></ul>
|
||
<h3 id="eventing.knative.dev/v1beta1.Broker">Broker
|
||
</h3>
|
||
<p>
|
||
<p>Broker collects a pool of events that are consumable using Triggers. Brokers
|
||
provide a well-known endpoint for event delivery that senders can use with
|
||
minimal knowledge of the event routing strategy. Receivers use Triggers to
|
||
request delivery of events from a Broker&rsquo;s pool to a specific URL or
|
||
Addressable endpoint.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
eventing.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Broker</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.BrokerSpec">
|
||
BrokerSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Broker.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>config</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Config is a KReference to the configuration that specifies
|
||
configuration options for this Broker. For example, this could be
|
||
a pointer to a ConfigMap.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for Events within the Broker mesh.
|
||
This includes things like retries, DLQ, etc.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.BrokerStatus">
|
||
BrokerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Broker. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.EventType">EventType
|
||
</h3>
|
||
<p>
|
||
<p>EventType represents a type of event that can be consumed from a Broker.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
eventing.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>EventType</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.EventTypeSpec">
|
||
EventTypeSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the EventType.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>type</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Type represents the CloudEvents type. It is authoritative.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>source</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Source is a URI, it represents the CloudEvents source.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schema</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schema is a URI, it represents the CloudEvents schemaurl extension attribute.
|
||
It may be a JSON schema, a protobuf schema, etc. It is optional.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schemaData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SchemaData allows the CloudEvents schema to be stored directly in the
|
||
EventType. Content is dependent on the encoding. Optional attribute.
|
||
The contents are not validated or manipulated by the system.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>TODO remove <a href="https://github.com/knative/eventing/issues/2750">https://github.com/knative/eventing/issues/2750</a>
|
||
Broker refers to the Broker that can provide the EventType.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>description</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Description is an optional field used to describe the EventType, in any meaningful way.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.EventTypeStatus">
|
||
EventTypeStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the EventType.
|
||
This data may be out of date.
|
||
TODO might be removed <a href="https://github.com/knative/eventing/issues/2750">https://github.com/knative/eventing/issues/2750</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.Trigger">Trigger
|
||
</h3>
|
||
<p>
|
||
<p>Trigger represents a request to have events delivered to a consumer from a
|
||
Broker&rsquo;s event pool.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
eventing.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Trigger</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.TriggerSpec">
|
||
TriggerSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Trigger.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is the broker that this trigger receives events from. If not specified, will default
|
||
to &lsquo;default&rsquo;.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.TriggerFilter">
|
||
TriggerFilter
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the filter to apply against all events from the Broker. Only events that pass this
|
||
filter will be sent to the Subscriber. If not specified, will default to allowing all events.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber is the addressable that receives events from the Broker that pass the Filter. It
|
||
is required.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for this specific trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.TriggerStatus">
|
||
TriggerStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Trigger. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.BrokerSpec">BrokerSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.Broker">Broker</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>config</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Config is a KReference to the configuration that specifies
|
||
configuration options for this Broker. For example, this could be
|
||
a pointer to a ConfigMap.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for Events within the Broker mesh.
|
||
This includes things like retries, DLQ, etc.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.BrokerStatus">BrokerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.Broker">Broker</a>)
|
||
</p>
|
||
<p>
|
||
<p>BrokerStatus represents the current state of a Broker.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>address</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Addressable
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is Addressable. It exposes the endpoint as an URI to get events
|
||
delivered into the Broker mesh.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.EventTypeSpec">EventTypeSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.EventType">EventType</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>type</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Type represents the CloudEvents type. It is authoritative.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>source</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Source is a URI, it represents the CloudEvents source.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schema</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schema is a URI, it represents the CloudEvents schemaurl extension attribute.
|
||
It may be a JSON schema, a protobuf schema, etc. It is optional.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schemaData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SchemaData allows the CloudEvents schema to be stored directly in the
|
||
EventType. Content is dependent on the encoding. Optional attribute.
|
||
The contents are not validated or manipulated by the system.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>TODO remove <a href="https://github.com/knative/eventing/issues/2750">https://github.com/knative/eventing/issues/2750</a>
|
||
Broker refers to the Broker that can provide the EventType.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>description</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Description is an optional field used to describe the EventType, in any meaningful way.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.EventTypeStatus">EventTypeStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.EventType">EventType</a>)
|
||
</p>
|
||
<p>
|
||
<p>EventTypeStatus represents the current state of a EventType.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.TriggerFilter">TriggerFilter
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.TriggerSpec">TriggerSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>attributes</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.TriggerFilterAttributes">
|
||
TriggerFilterAttributes
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Attributes filters events by exact match on event context attributes.
|
||
Each key in the map is compared with the equivalent key in the event
|
||
context. An event passes the filter if all values are equal to the
|
||
specified values.</p>
|
||
<p>Nested context attributes are not supported as keys. Only string values are supported.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.TriggerFilterAttributes">TriggerFilterAttributes
|
||
(<code>map[string]string</code> alias)</p></h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.TriggerFilter">TriggerFilter</a>)
|
||
</p>
|
||
<p>
|
||
<p>TriggerFilterAttributes is a map of context attribute names to values for
|
||
filtering by equality. Only exact matches will pass the filter. You can use the value &ldquo;
|
||
to indicate all strings match.</p>
|
||
</p>
|
||
<h3 id="eventing.knative.dev/v1beta1.TriggerSpec">TriggerSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.Trigger">Trigger</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>broker</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Broker is the broker that this trigger receives events from. If not specified, will default
|
||
to &lsquo;default&rsquo;.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
<a href="#eventing.knative.dev/v1beta1.TriggerFilter">
|
||
TriggerFilter
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the filter to apply against all events from the Broker. Only events that pass this
|
||
filter will be sent to the Subscriber. If not specified, will default to allowing all events.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber is the addressable that receives events from the Broker that pass the Filter. It
|
||
is required.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery contains the delivery spec for this specific trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="eventing.knative.dev/v1beta1.TriggerStatus">TriggerStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#eventing.knative.dev/v1beta1.Trigger">Trigger</a>)
|
||
</p>
|
||
<p>
|
||
<p>TriggerStatus represents the current state of a Trigger.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>SubscriberURI is the resolved URI of the receiver for this Trigger.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="flows.knative.dev/v1">flows.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 is the v1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul></ul>
|
||
<h3 id="flows.knative.dev/v1.Parallel">Parallel
|
||
</h3>
|
||
<p>
|
||
<p>Parallel defines conditional branches that will be wired in
|
||
series through Channels and Subscriptions.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelSpec">
|
||
ParallelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Parallel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>branches</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelBranch">
|
||
[]ParallelBranch
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Branches is the list of Filter/Subscribers pairs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of a case Subscriber gets sent to
|
||
when the case does not have a Reply</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelStatus">
|
||
ParallelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Parallel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelBranch">ParallelBranch
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.ParallelSpec">ParallelSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the expression guarding the branch</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber receiving the event when the filter passes</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of Subscriber of this case gets sent to.
|
||
If not specified, sent the result to the Parallel Reply</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for events to the subscriber
|
||
This includes things like retries, DLQ, etc.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelBranchStatus">ParallelBranchStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.ParallelStatus">ParallelStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ParallelBranchStatus represents the current state of a Parallel branch</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>filterSubscriptionStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelSubscriptionStatus">
|
||
ParallelSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>FilterSubscriptionStatus corresponds to the filter subscription status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filterChannelStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelChannelStatus">
|
||
ParallelChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>FilterChannelStatus corresponds to the filter channel status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberSubscriptionStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelSubscriptionStatus">
|
||
ParallelSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriptionStatus corresponds to the subscriber subscription status.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelChannelStatus">ParallelChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.ParallelBranchStatus">ParallelBranchStatus</a>, <a href="#flows.knative.dev/v1.ParallelStatus">ParallelStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is the reference to the underlying channel.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Channel is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelSpec">ParallelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.Parallel">Parallel</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>branches</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelBranch">
|
||
[]ParallelBranch
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Branches is the list of Filter/Subscribers pairs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of a case Subscriber gets sent to
|
||
when the case does not have a Reply</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelStatus">ParallelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.Parallel">Parallel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ParallelStatus represents the current state of a Parallel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ingressChannelStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelChannelStatus">
|
||
ParallelChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>IngressChannelStatus corresponds to the ingress channel status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>branchStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.ParallelBranchStatus">
|
||
[]ParallelBranchStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>BranchStatuses is an array of corresponding to branch statuses.
|
||
Matches the Spec.Branches array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the starting point to this Parallel. Sending to this
|
||
will target the first subscriber.
|
||
It generally has the form {channel}.{namespace}.svc.{cluster domain name}</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.ParallelSubscriptionStatus">ParallelSubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.ParallelBranchStatus">ParallelBranchStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscription</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscription is the reference to the underlying Subscription.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Subscription is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.Sequence">Sequence
|
||
</h3>
|
||
<p>
|
||
<p>Sequence defines a sequence of Subscribers that will be wired in
|
||
series through Channels and Subscriptions.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceSpec">
|
||
SequenceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Sequence.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>steps</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceStep">
|
||
[]SequenceStep
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Steps is the list of Destinations (processors / functions) that will be called in the order
|
||
provided. Each step has its own delivery options</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of the last Subscriber gets sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceStatus">
|
||
SequenceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Sequence. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.SequenceChannelStatus">SequenceChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.SequenceStatus">SequenceStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is the reference to the underlying channel.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Channel is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.SequenceSpec">SequenceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.Sequence">Sequence</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>steps</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceStep">
|
||
[]SequenceStep
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Steps is the list of Destinations (processors / functions) that will be called in the order
|
||
provided. Each step has its own delivery options</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of the last Subscriber gets sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.SequenceStatus">SequenceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.Sequence">Sequence</a>)
|
||
</p>
|
||
<p>
|
||
<p>SequenceStatus represents the current state of a Sequence.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriptionStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceSubscriptionStatus">
|
||
[]SequenceSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriptionStatuses is an array of corresponding Subscription statuses.
|
||
Matches the Spec.Steps array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1.SequenceChannelStatus">
|
||
[]SequenceChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelStatuses is an array of corresponding Channel statuses.
|
||
Matches the Spec.Steps array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the starting point to this Sequence. Sending to this
|
||
will target the first subscriber.
|
||
It generally has the form {channel}.{namespace}.svc.{cluster domain name}</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.SequenceStep">SequenceStep
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.SequenceSpec">SequenceSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Destination</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Destination</code> are embedded into this type.)
|
||
</p>
|
||
<p>Subscriber receiving the step event</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for events to the subscriber
|
||
This includes things like retries, DLQ, etc.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1.SequenceSubscriptionStatus">SequenceSubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.SequenceStatus">SequenceStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscription</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscription is the reference to the underlying Subscription.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Subscription is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="flows.knative.dev/v1beta1">flows.knative.dev/v1beta1</h2>
|
||
<p>
|
||
<p>Package v1beta1 is the v1beta1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul></ul>
|
||
<h3 id="flows.knative.dev/v1beta1.Parallel">Parallel
|
||
</h3>
|
||
<p>
|
||
<p>Parallel defines conditional branches that will be wired in
|
||
series through Channels and Subscriptions.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelSpec">
|
||
ParallelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Parallel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>branches</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelBranch">
|
||
[]ParallelBranch
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Branches is the list of Filter/Subscribers pairs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of a case Subscriber gets sent to
|
||
when the case does not have a Reply</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelStatus">
|
||
ParallelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Parallel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelBranch">ParallelBranch
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.ParallelSpec">ParallelSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>filter</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Filter is the expression guarding the branch</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscriber receiving the event when the filter passes</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of Subscriber of this case gets sent to.
|
||
If not specified, sent the result to the Parallel Reply</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for events to the subscriber
|
||
This includes things like retries, DLQ, etc.
|
||
Needed for Roundtripping v1alpha1 &lt;-&gt; v1beta1.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelBranchStatus">ParallelBranchStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.ParallelStatus">ParallelStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>ParallelBranchStatus represents the current state of a Parallel branch</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>filterSubscriptionStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelSubscriptionStatus">
|
||
ParallelSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>FilterSubscriptionStatus corresponds to the filter subscription status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>filterChannelStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelChannelStatus">
|
||
ParallelChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>FilterChannelStatus corresponds to the filter channel status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberSubscriptionStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelSubscriptionStatus">
|
||
ParallelSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriptionStatus corresponds to the subscriber subscription status.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelChannelStatus">ParallelChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.ParallelBranchStatus">ParallelBranchStatus</a>, <a href="#flows.knative.dev/v1beta1.ParallelStatus">ParallelStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is the reference to the underlying channel.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Channel is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelSpec">ParallelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.Parallel">Parallel</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>branches</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelBranch">
|
||
[]ParallelBranch
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Branches is the list of Filter/Subscribers pairs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of a case Subscriber gets sent to
|
||
when the case does not have a Reply</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelStatus">ParallelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.Parallel">Parallel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ParallelStatus represents the current state of a Parallel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ingressChannelStatus</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelChannelStatus">
|
||
ParallelChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>IngressChannelStatus corresponds to the ingress channel status.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>branchStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.ParallelBranchStatus">
|
||
[]ParallelBranchStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>BranchStatuses is an array of corresponding to branch statuses.
|
||
Matches the Spec.Branches array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the starting point to this Parallel. Sending to this
|
||
will target the first subscriber.
|
||
It generally has the form {channel}.{namespace}.svc.{cluster domain name}</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.ParallelSubscriptionStatus">ParallelSubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.ParallelBranchStatus">ParallelBranchStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscription</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscription is the reference to the underlying Subscription.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Subscription is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.Sequence">Sequence
|
||
</h3>
|
||
<p>
|
||
<p>Sequence defines a sequence of Subscribers that will be wired in
|
||
series through Channels and Subscriptions.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceSpec">
|
||
SequenceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Sequence.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>steps</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceStep">
|
||
[]SequenceStep
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Steps is the list of Destinations (processors / functions) that will be called in the order
|
||
provided. Each step has its own delivery options</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of the last Subscriber gets sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceStatus">
|
||
SequenceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Sequence. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.SequenceChannelStatus">SequenceChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.SequenceStatus">SequenceStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is the reference to the underlying channel.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Channel is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.SequenceSpec">SequenceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.Sequence">Sequence</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>steps</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceStep">
|
||
[]SequenceStep
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Steps is the list of Destinations (processors / functions) that will be called in the order
|
||
provided. Each step has its own delivery options</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ChannelTemplate specifies which Channel CRD to use. If left unspecified, it is set to the default Channel CRD
|
||
for the namespace (or cluster, in case there are no defaults for the namespace).</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply is a Reference to where the result of the last Subscriber gets sent to.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.SequenceStatus">SequenceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.Sequence">Sequence</a>)
|
||
</p>
|
||
<p>
|
||
<p>SequenceStatus represents the current state of a Sequence.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriptionStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceSubscriptionStatus">
|
||
[]SequenceSubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriptionStatuses is an array of corresponding Subscription statuses.
|
||
Matches the Spec.Steps array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channelStatuses</code><br/>
|
||
<em>
|
||
<a href="#flows.knative.dev/v1beta1.SequenceChannelStatus">
|
||
[]SequenceChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelStatuses is an array of corresponding Channel statuses.
|
||
Matches the Spec.Steps array in the order.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>AddressStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.AddressStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>AddressStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>AddressStatus is the starting point to this Sequence. Sending to this
|
||
will target the first subscriber.
|
||
It generally has the form {channel}.{namespace}.svc.{cluster domain name}</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.SequenceStep">SequenceStep
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.SequenceSpec">SequenceSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Destination</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Destination</code> are embedded into this type.)
|
||
</p>
|
||
<p>Subscriber receiving the step event</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery is the delivery specification for events to the subscriber
|
||
This includes things like retries, DLQ, etc.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="flows.knative.dev/v1beta1.SequenceSubscriptionStatus">SequenceSubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.SequenceStatus">SequenceStatus</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscription</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Subscription is the reference to the underlying Subscription.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ready</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.Condition
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReadyCondition indicates whether the Subscription is ready or not.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="messaging.knative.dev/v1">messaging.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 is the v1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#messaging.knative.dev/v1.Channel">Channel</a>
|
||
</li><li>
|
||
<a href="#messaging.knative.dev/v1.InMemoryChannel">InMemoryChannel</a>
|
||
</li><li>
|
||
<a href="#messaging.knative.dev/v1.Subscription">Subscription</a>
|
||
</li></ul>
|
||
<h3 id="messaging.knative.dev/v1.Channel">Channel
|
||
</h3>
|
||
<p>
|
||
<p>Channel represents a generic Channel. It is normally used when we want a Channel, but don&rsquo;t need a specific Channel implementation.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Channel</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelSpec">
|
||
ChannelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Channel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel.
|
||
This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableSpec</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelStatus">
|
||
ChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Channel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.InMemoryChannel">InMemoryChannel
|
||
</h3>
|
||
<p>
|
||
<p>InMemoryChannel is a resource representing an in memory channel</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>InMemoryChannel</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.InMemoryChannelSpec">
|
||
InMemoryChannelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Channel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.InMemoryChannelStatus">
|
||
InMemoryChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Channel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.Subscription">Subscription
|
||
</h3>
|
||
<p>
|
||
<p>Subscription routes events received on a Channel to a DNS name and
|
||
corresponds to the subscriptions.channels.knative.dev CRD.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Subscription</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.SubscriptionSpec">
|
||
SubscriptionSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Reference to a channel that will be used to create the subscription
|
||
You can specify only the following fields of the ObjectReference:
|
||
- Kind
|
||
- APIVersion
|
||
- Name
|
||
The resource pointed by this ObjectReference must meet the
|
||
contract to the ChannelableSpec duck type. If the resource does not
|
||
meet this contract it will be reflected in the Subscription&rsquo;s status.</p>
|
||
<p>This field is immutable. We have no good answer on what happens to
|
||
the events that are currently in the channel being consumed from
|
||
and what the semantics there should be. For now, you can always
|
||
delete the Subscription and recreate it to point to a different
|
||
channel, giving the user more control over what semantics should
|
||
be used (drain the channel first, possibly have events dropped,
|
||
etc.)</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Subscriber is reference to (optional) function for processing events.
|
||
Events from the Channel will be delivered here and replies are
|
||
sent to a Destination as specified by the Reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply specifies (optionally) how to handle events returned from
|
||
the Subscriber target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery configuration</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.SubscriptionStatus">
|
||
SubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.ChannelDefaulter">ChannelDefaulter
|
||
</h3>
|
||
<p>
|
||
<p>ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not
|
||
specify any implementation.</p>
|
||
</p>
|
||
<h3 id="messaging.knative.dev/v1.ChannelSpec">ChannelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.Channel">Channel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel.
|
||
It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel.
|
||
This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableSpec</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.ChannelStatus">ChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.Channel">Channel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelStatus represents the current state of a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableStatus</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is an KReference to the Channel CRD backing this Channel.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.ChannelTemplateSpec">ChannelTemplateSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1.ParallelSpec">ParallelSpec</a>, <a href="#flows.knative.dev/v1.SequenceSpec">SequenceSpec</a>, <a href="#messaging.knative.dev/v1.ChannelSpec">ChannelSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/runtime.RawExtension
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec defines the Spec to use for each channel created. Passed
|
||
in verbatim to the Channel CRD as Spec section.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.InMemoryChannelSpec">InMemoryChannelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.InMemoryChannel">InMemoryChannel</a>)
|
||
</p>
|
||
<p>
|
||
<p>InMemoryChannelSpec defines which subscribers have expressed interest in
|
||
receiving events from this InMemoryChannel.
|
||
arguments for a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.InMemoryChannelStatus">InMemoryChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.InMemoryChannel">InMemoryChannel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelStatus represents the current state of a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.SubscriptionSpec">SubscriptionSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.Subscription">Subscription</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionSpec specifies the Channel for incoming events, a Subscriber target
|
||
for processing those events and where to put the result of the processing. Only
|
||
From (where the events are coming from) is always required. You can optionally
|
||
only Process the events (results in no output events) by leaving out the Result.
|
||
You can also perform an identity transformation on the incoming events by leaving
|
||
out the Subscriber and only specifying Result.</p>
|
||
<p>The following are all valid specifications:
|
||
channel &ndash;[subscriber]&ndash;&gt; reply
|
||
Sink, no outgoing events:
|
||
channel &ndash; subscriber
|
||
no-op function (identity transformation):
|
||
channel &ndash;&gt; reply</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Reference to a channel that will be used to create the subscription
|
||
You can specify only the following fields of the ObjectReference:
|
||
- Kind
|
||
- APIVersion
|
||
- Name
|
||
The resource pointed by this ObjectReference must meet the
|
||
contract to the ChannelableSpec duck type. If the resource does not
|
||
meet this contract it will be reflected in the Subscription&rsquo;s status.</p>
|
||
<p>This field is immutable. We have no good answer on what happens to
|
||
the events that are currently in the channel being consumed from
|
||
and what the semantics there should be. For now, you can always
|
||
delete the Subscription and recreate it to point to a different
|
||
channel, giving the user more control over what semantics should
|
||
be used (drain the channel first, possibly have events dropped,
|
||
etc.)</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Subscriber is reference to (optional) function for processing events.
|
||
Events from the Channel will be delivered here and replies are
|
||
sent to a Destination as specified by the Reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply specifies (optionally) how to handle events returned from
|
||
the Subscriber target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery configuration</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.SubscriptionStatus">SubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.Subscription">Subscription</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionStatus (computed) for a subscription</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>physicalSubscription</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1.SubscriptionStatusPhysicalSubscription">
|
||
SubscriptionStatusPhysicalSubscription
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>PhysicalSubscription is the fully resolved values that this Subscription represents.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1.SubscriptionStatusPhysicalSubscription">SubscriptionStatusPhysicalSubscription
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1.SubscriptionStatus">SubscriptionStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionStatusPhysicalSubscription represents the fully resolved values for this
|
||
Subscription.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriberURI is the fully resolved URI for spec.subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>replyUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReplyURI is the fully resolved URI for the spec.reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterSinkUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="messaging.knative.dev/v1beta1">messaging.knative.dev/v1beta1</h2>
|
||
<p>
|
||
<p>Package v1beta1 is the v1beta1 version of the API.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#messaging.knative.dev/v1beta1.Channel">Channel</a>
|
||
</li><li>
|
||
<a href="#messaging.knative.dev/v1beta1.InMemoryChannel">InMemoryChannel</a>
|
||
</li><li>
|
||
<a href="#messaging.knative.dev/v1beta1.Subscription">Subscription</a>
|
||
</li></ul>
|
||
<h3 id="messaging.knative.dev/v1beta1.Channel">Channel
|
||
</h3>
|
||
<p>
|
||
<p>Channel represents a generic Channel. It is normally used when we want a Channel, but don&rsquo;t need a specific Channel implementation.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Channel</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelSpec">
|
||
ChannelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Channel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel.
|
||
This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableSpec</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelStatus">
|
||
ChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Channel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.InMemoryChannel">InMemoryChannel
|
||
</h3>
|
||
<p>
|
||
<p>InMemoryChannel is a resource representing an in memory channel</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>InMemoryChannel</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.InMemoryChannelSpec">
|
||
InMemoryChannelSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Spec defines the desired state of the Channel.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.InMemoryChannelStatus">
|
||
InMemoryChannelStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Status represents the current state of the Channel. This data may be out of
|
||
date.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.Subscription">Subscription
|
||
</h3>
|
||
<p>
|
||
<p>Subscription routes events received on a Channel to a DNS name and
|
||
corresponds to the subscriptions.channels.knative.dev CRD.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
messaging.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>Subscription</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.SubscriptionSpec">
|
||
SubscriptionSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Reference to a channel that will be used to create the subscription
|
||
You can specify only the following fields of the ObjectReference:
|
||
- Kind
|
||
- APIVersion
|
||
- Name
|
||
The resource pointed by this ObjectReference must meet the
|
||
contract to the ChannelableSpec duck type. If the resource does not
|
||
meet this contract it will be reflected in the Subscription&rsquo;s status.</p>
|
||
<p>This field is immutable. We have no good answer on what happens to
|
||
the events that are currently in the channel being consumed from
|
||
and what the semantics there should be. For now, you can always
|
||
delete the Subscription and recreate it to point to a different
|
||
channel, giving the user more control over what semantics should
|
||
be used (drain the channel first, possibly have events dropped,
|
||
etc.)</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Subscriber is reference to (optional) function for processing events.
|
||
Events from the Channel will be delivered here and replies are
|
||
sent to a Destination as specified by the Reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply specifies (optionally) how to handle events returned from
|
||
the Subscriber target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery configuration</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.SubscriptionStatus">
|
||
SubscriptionStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.ChannelDefaulter">ChannelDefaulter
|
||
</h3>
|
||
<p>
|
||
<p>ChannelDefaulter sets the default Channel CRD and Arguments on Channels that do not
|
||
specify any implementation.</p>
|
||
</p>
|
||
<h3 id="messaging.knative.dev/v1beta1.ChannelSpec">ChannelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.Channel">Channel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelSpec defines which subscribers have expressed interest in receiving events from this Channel.
|
||
It also defines the ChannelTemplate to use in order to create the CRD Channel backing this Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channelTemplate</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.ChannelTemplateSpec">
|
||
ChannelTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ChannelTemplate specifies which Channel CRD to use to create the CRD Channel backing this Channel.
|
||
This is immutable after creation. Normally this is set by the Channel defaulter, not directly by the user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableSpec</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.ChannelStatus">ChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.Channel">Channel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelStatus represents the current state of a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to ChannelableStatus</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.KReference
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Channel is an KReference to the Channel CRD backing this Channel.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.ChannelTemplateSpec">ChannelTemplateSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#flows.knative.dev/v1beta1.ParallelSpec">ParallelSpec</a>, <a href="#flows.knative.dev/v1beta1.SequenceSpec">SequenceSpec</a>, <a href="#messaging.knative.dev/v1beta1.ChannelSpec">ChannelSpec</a>)
|
||
</p>
|
||
<p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
k8s.io/apimachinery/pkg/runtime.RawExtension
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Spec defines the Spec to use for each channel created. Passed
|
||
in verbatim to the Channel CRD as Spec section.</p>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.InMemoryChannelSpec">InMemoryChannelSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.InMemoryChannel">InMemoryChannel</a>)
|
||
</p>
|
||
<p>
|
||
<p>InMemoryChannelSpec defines which subscribers have expressed interest in
|
||
receiving events from this InMemoryChannel.
|
||
arguments for a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableSpec</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableSpec">
|
||
ChannelableSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.InMemoryChannelStatus">InMemoryChannelStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.InMemoryChannel">InMemoryChannel</a>)
|
||
</p>
|
||
<p>
|
||
<p>ChannelStatus represents the current state of a Channel.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>ChannelableStatus</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.ChannelableStatus">
|
||
ChannelableStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>ChannelableStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>Channel conforms to Duck type Channelable.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.SubscriptionSpec">SubscriptionSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.Subscription">Subscription</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionSpec specifies the Channel for incoming events, a Subscriber target
|
||
for processing those events and where to put the result of the processing. Only
|
||
From (where the events are coming from) is always required. You can optionally
|
||
only Process the events (results in no output events) by leaving out the Result.
|
||
You can also perform an identity transformation on the incoming events by leaving
|
||
out the Subscriber and only specifying Result.</p>
|
||
<p>The following are all valid specifications:
|
||
channel &ndash;[subscriber]&ndash;&gt; reply
|
||
Sink, no outgoing events:
|
||
channel &ndash; subscriber
|
||
no-op function (identity transformation):
|
||
channel &ndash;&gt; reply</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>channel</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectreference-v1-core">
|
||
Kubernetes core/v1.ObjectReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Reference to a channel that will be used to create the subscription
|
||
You can specify only the following fields of the ObjectReference:
|
||
- Kind
|
||
- APIVersion
|
||
- Name
|
||
The resource pointed by this ObjectReference must meet the
|
||
contract to the ChannelableSpec duck type. If the resource does not
|
||
meet this contract it will be reflected in the Subscription&rsquo;s status.</p>
|
||
<p>This field is immutable. We have no good answer on what happens to
|
||
the events that are currently in the channel being consumed from
|
||
and what the semantics there should be. For now, you can always
|
||
delete the Subscription and recreate it to point to a different
|
||
channel, giving the user more control over what semantics should
|
||
be used (drain the channel first, possibly have events dropped,
|
||
etc.)</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>subscriber</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Subscriber is reference to (optional) function for processing events.
|
||
Events from the Channel will be delivered here and replies are
|
||
sent to a Destination as specified by the Reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>reply</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Reply specifies (optionally) how to handle events returned from
|
||
the Subscriber target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>delivery</code><br/>
|
||
<em>
|
||
<a href="#duck.knative.dev/v1beta1.DeliverySpec">
|
||
DeliverySpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Delivery configuration</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.SubscriptionStatus">SubscriptionStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.Subscription">Subscription</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionStatus (computed) for a subscription</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>Status</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.Status
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>Status</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 Status, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current state.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>physicalSubscription</code><br/>
|
||
<em>
|
||
<a href="#messaging.knative.dev/v1beta1.SubscriptionStatusPhysicalSubscription">
|
||
SubscriptionStatusPhysicalSubscription
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>PhysicalSubscription is the fully resolved values that this Subscription represents.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="messaging.knative.dev/v1beta1.SubscriptionStatusPhysicalSubscription">SubscriptionStatusPhysicalSubscription
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#messaging.knative.dev/v1beta1.SubscriptionStatus">SubscriptionStatus</a>)
|
||
</p>
|
||
<p>
|
||
<p>SubscriptionStatusPhysicalSubscription represents the fully resolved values for this
|
||
Subscription.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>subscriberUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>SubscriberURI is the fully resolved URI for spec.subscriber.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>replyUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReplyURI is the fully resolved URI for the spec.reply.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>deadLetterSinkUri</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis.URL
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ReplyURI is the fully resolved URI for the spec.delivery.deadLetterSink.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="sources.knative.dev/v1">sources.knative.dev/v1</h2>
|
||
<p>
|
||
<p>Package v1 contains API Schema definitions for the sources v1 API group.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#sources.knative.dev/v1.ApiServerSource">ApiServerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1.ContainerSource">ContainerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1.SinkBinding">SinkBinding</a>
|
||
</li></ul>
|
||
<h3 id="sources.knative.dev/v1.ApiServerSource">ApiServerSource
|
||
</h3>
|
||
<p>
|
||
<p>ApiServerSource is the Schema for the apiserversources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ApiServerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.ApiServerSourceSpec">
|
||
ApiServerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.ApiServerSourceStatus">
|
||
ApiServerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.ContainerSource">ContainerSource
|
||
</h3>
|
||
<p>
|
||
<p>ContainerSource is the Schema for the containersources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ContainerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.ContainerSourceSpec">
|
||
ContainerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.ContainerSourceStatus">
|
||
ContainerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.SinkBinding">SinkBinding
|
||
</h3>
|
||
<p>
|
||
<p>SinkBinding describes a Binding that is also a Source.
|
||
The <code>sink</code> (from the Source duck) is resolved to a URL and
|
||
then projected into the <code>subject</code> by augmenting the runtime
|
||
contract of the referenced containers to have a <code>K_SINK</code>
|
||
environment variable holding the endpoint to which to send
|
||
cloud events.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>SinkBinding</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.SinkBindingSpec">
|
||
SinkBindingSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.SinkBindingStatus">
|
||
SinkBindingStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.APIVersionKind">APIVersionKind
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKind is an APIVersion and Kind tuple.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.APIVersionKindSelector">APIVersionKindSelector
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>selector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LabelSelector filters this source to objects to those resources pass the
|
||
label selector.
|
||
More info: <a href="http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.ApiServerSourceSpec">ApiServerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceSpec defines the desired state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.ApiServerSourceStatus">ApiServerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceStatus defines the observed state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.ContainerSourceSpec">ContainerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceSpec defines the desired state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.ContainerSourceStatus">ContainerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceStatus defines the observed state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.SinkBindingSpec">SinkBindingSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingSpec holds the desired state of the SinkBinding (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1.SinkBindingStatus">SinkBindingStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="sources.knative.dev/v1alpha1">sources.knative.dev/v1alpha1</h2>
|
||
<p>
|
||
<p>Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#sources.knative.dev/v1alpha1.ApiServerSource">ApiServerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1alpha1.SinkBinding">SinkBinding</a>
|
||
</li></ul>
|
||
<h3 id="sources.knative.dev/v1alpha1.ApiServerSource">ApiServerSource
|
||
</h3>
|
||
<p>
|
||
<p>ApiServerSource is the Schema for the apiserversources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ApiServerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.ApiServerSourceSpec">
|
||
ApiServerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.ApiServerResource">
|
||
[]ApiServerResource
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resources is the list of resources to watch</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>sink</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1beta1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Sink is a reference to an object that will resolve to a domain name to use as the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ceOverrides</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>CloudEventOverrides defines overrides to control the output format and
|
||
modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Mode is the mode the receive adapter controller runs under: Ref or Resource.
|
||
<code>Ref</code> sends only the reference to the resource.
|
||
<code>Resource</code> send the full resource.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.ApiServerSourceStatus">
|
||
ApiServerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.SinkBinding">SinkBinding
|
||
</h3>
|
||
<p>
|
||
<p>SinkBinding describes a Binding that is also a Source.
|
||
The <code>sink</code> (from the Source duck) is resolved to a URL and
|
||
then projected into the <code>subject</code> by augmenting the runtime
|
||
contract of the referenced containers to have a <code>K_SINK</code>
|
||
environment variable holding the endpoint to which to send
|
||
cloud events.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>SinkBinding</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.SinkBindingSpec">
|
||
SinkBindingSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.SinkBindingStatus">
|
||
SinkBindingStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.ApiServerResource">ApiServerResource
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerResource defines the resource to watch</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>labelSelector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>LabelSelector restricts this source to objects with the selected labels
|
||
More info: <a href="http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>controllerSelector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#ownerreference-v1-meta">
|
||
Kubernetes meta/v1.OwnerReference
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>ControllerSelector restricts this source to objects with a controlling owner reference of the specified kind.
|
||
Only apiVersion and kind are used. Both are optional.
|
||
Deprecated: Per-resource owner refs will no longer be supported in
|
||
v1alpha2, please use Spec.Owner as a GKV.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>controller</code><br/>
|
||
<em>
|
||
bool
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>If true, send an event referencing the object controlling the resource
|
||
Deprecated: Per-resource controller flag will no longer be supported in
|
||
v1alpha2, please use Spec.Owner as a GKV.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.ApiServerSourceSpec">ApiServerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceSpec defines the desired state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha1.ApiServerResource">
|
||
[]ApiServerResource
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resources is the list of resources to watch</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>sink</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1beta1.Destination
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Sink is a reference to an object that will resolve to a domain name to use as the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>ceOverrides</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.CloudEventOverrides
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>CloudEventOverrides defines overrides to control the output format and
|
||
modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Mode is the mode the receive adapter controller runs under: Ref or Resource.
|
||
<code>Ref</code> sends only the reference to the resource.
|
||
<code>Resource</code> send the full resource.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.ApiServerSourceStatus">ApiServerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceStatus defines the observed state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.SinkBindingSpec">SinkBindingSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingSpec holds the desired state of the SinkBinding (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha1.SinkBindingStatus">SinkBindingStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="sources.knative.dev/v1alpha2">sources.knative.dev/v1alpha2</h2>
|
||
<p>
|
||
<p>Package v1alpha2 contains API Schema definitions for the sources v1beta1 API group</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#sources.knative.dev/v1alpha2.ApiServerSource">ApiServerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1alpha2.ContainerSource">ContainerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1alpha2.PingSource">PingSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1alpha2.SinkBinding">SinkBinding</a>
|
||
</li></ul>
|
||
<h3 id="sources.knative.dev/v1alpha2.ApiServerSource">ApiServerSource
|
||
</h3>
|
||
<p>
|
||
<p>ApiServerSource is the Schema for the apiserversources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ApiServerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.ApiServerSourceSpec">
|
||
ApiServerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.ApiServerSourceStatus">
|
||
ApiServerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.ContainerSource">ContainerSource
|
||
</h3>
|
||
<p>
|
||
<p>ContainerSource is the Schema for the containersources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ContainerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.ContainerSourceSpec">
|
||
ContainerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.ContainerSourceStatus">
|
||
ContainerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.PingSource">PingSource
|
||
</h3>
|
||
<p>
|
||
<p>PingSource is the Schema for the PingSources API.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>PingSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.PingSourceSpec">
|
||
PingSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cronjob schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>jsonData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>JsonData is json encoded data used as the body of the event posted to
|
||
the sink. Default is empty. If set, datacontenttype will also be set
|
||
to &ldquo;application/json&rdquo;.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.PingSourceStatus">
|
||
PingSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.SinkBinding">SinkBinding
|
||
</h3>
|
||
<p>
|
||
<p>SinkBinding describes a Binding that is also a Source.
|
||
The <code>sink</code> (from the Source duck) is resolved to a URL and
|
||
then projected into the <code>subject</code> by augmenting the runtime
|
||
contract of the referenced containers to have a <code>K_SINK</code>
|
||
environment variable holding the endpoint to which to send
|
||
cloud events.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1alpha2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>SinkBinding</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.SinkBindingSpec">
|
||
SinkBindingSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1alpha1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.SinkBindingStatus">
|
||
SinkBindingStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.APIVersionKind">APIVersionKind
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha1.ApiServerSourceSpec">ApiServerSourceSpec</a>, <a href="#sources.knative.dev/v1alpha2.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKind is an APIVersion and Kind tuple.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.APIVersionKindSelector">APIVersionKindSelector
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>selector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LabelSelector filters this source to objects to those resources pass the
|
||
label selector.
|
||
More info: <a href="http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.ApiServerSourceSpec">ApiServerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceSpec defines the desired state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1alpha2.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.ApiServerSourceStatus">ApiServerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceStatus defines the observed state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.ContainerSourceSpec">ContainerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceSpec defines the desired state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.ContainerSourceStatus">ContainerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceStatus defines the observed state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.PingSourceSpec">PingSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceSpec defines the desired state of the PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cronjob schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>jsonData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>JsonData is json encoded data used as the body of the event posted to
|
||
the sink. Default is empty. If set, datacontenttype will also be set
|
||
to &ldquo;application/json&rdquo;.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.PingSourceStatus">PingSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceStatus defines the observed state of PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.SinkBindingSpec">SinkBindingSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingSpec holds the desired state of the SinkBinding (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1alpha1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1alpha1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1alpha2.SinkBindingStatus">SinkBindingStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1alpha2.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="sources.knative.dev/v1beta1">sources.knative.dev/v1beta1</h2>
|
||
<p>
|
||
<p>Package v1beta1 contains API Schema definitions for the sources v1beta1 API group.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#sources.knative.dev/v1beta1.ApiServerSource">ApiServerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1beta1.ContainerSource">ContainerSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1beta1.PingSource">PingSource</a>
|
||
</li><li>
|
||
<a href="#sources.knative.dev/v1beta1.SinkBinding">SinkBinding</a>
|
||
</li></ul>
|
||
<h3 id="sources.knative.dev/v1beta1.ApiServerSource">ApiServerSource
|
||
</h3>
|
||
<p>
|
||
<p>ApiServerSource is the Schema for the apiserversources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ApiServerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.ApiServerSourceSpec">
|
||
ApiServerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.ApiServerSourceStatus">
|
||
ApiServerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.ContainerSource">ContainerSource
|
||
</h3>
|
||
<p>
|
||
<p>ContainerSource is the Schema for the containersources API</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>ContainerSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.ContainerSourceSpec">
|
||
ContainerSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.ContainerSourceStatus">
|
||
ContainerSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.PingSource">PingSource
|
||
</h3>
|
||
<p>
|
||
<p>PingSource is the Schema for the PingSources API.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>PingSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.PingSourceSpec">
|
||
PingSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cronjob schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timezone</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Timezone modifies the actual time relative to the specified timezone.
|
||
Defaults to the system time zone.
|
||
More general information about time zones: <a href="https://www.iana.org/time-zones">https://www.iana.org/time-zones</a>
|
||
List of valid timezone values: <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>jsonData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>JsonData is json encoded data used as the body of the event posted to
|
||
the sink. Default is empty. If set, datacontenttype will also be set
|
||
to &ldquo;application/json&rdquo;.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.PingSourceStatus">
|
||
PingSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.SinkBinding">SinkBinding
|
||
</h3>
|
||
<p>
|
||
<p>SinkBinding describes a Binding that is also a Source.
|
||
The <code>sink</code> (from the Source duck) is resolved to a URL and
|
||
then projected into the <code>subject</code> by augmenting the runtime
|
||
contract of the referenced containers to have a <code>K_SINK</code>
|
||
environment variable holding the endpoint to which to send
|
||
cloud events.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1beta1
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>SinkBinding</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.SinkBindingSpec">
|
||
SinkBindingSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1beta1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1beta1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.SinkBindingStatus">
|
||
SinkBindingStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.APIVersionKind">APIVersionKind
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKind is an APIVersion and Kind tuple.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.APIVersionKindSelector">APIVersionKindSelector
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ApiServerSourceSpec">ApiServerSourceSpec</a>)
|
||
</p>
|
||
<p>
|
||
<p>APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>APIVersion - the API version of the resource to watch.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Kind of the resource to watch.
|
||
More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>selector</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#labelselector-v1-meta">
|
||
Kubernetes meta/v1.LabelSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>LabelSelector filters this source to objects to those resources pass the
|
||
label selector.
|
||
More info: <a href="http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.ApiServerSourceSpec">ApiServerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceSpec defines the desired state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>resources</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.APIVersionKindSelector">
|
||
[]APIVersionKindSelector
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Resource are the resources this source will track and send related
|
||
lifecycle events from the Kubernetes ApiServer, with an optional label
|
||
selector to help filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>owner</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta1.APIVersionKind">
|
||
APIVersionKind
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ResourceOwner is an additional filter to only track resources that are
|
||
owned by a specific resource type. If ResourceOwner matches Resources[n]
|
||
then Resources[n] is allowed to pass the ResourceOwner filter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>mode</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>EventMode controls the format of the event.
|
||
<code>Reference</code> sends a dataref event type for the resource under watch.
|
||
<code>Resource</code> send the full resource lifecycle event.
|
||
Defaults to <code>Reference</code></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>serviceAccountName</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ServiceAccountName is the name of the ServiceAccount to use to run this
|
||
source. Defaults to default if not set.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.ApiServerSourceStatus">ApiServerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ApiServerSource">ApiServerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ApiServerSourceStatus defines the observed state of ApiServerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.ContainerSourceSpec">ContainerSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceSpec defines the desired state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>template</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podtemplatespec-v1-core">
|
||
Kubernetes core/v1.PodTemplateSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Template describes the pods that will be created</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.ContainerSourceStatus">ContainerSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.ContainerSource">ContainerSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>ContainerSourceStatus defines the observed state of ContainerSource</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.PingSourceSpec">PingSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceSpec defines the desired state of the PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cronjob schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timezone</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Timezone modifies the actual time relative to the specified timezone.
|
||
Defaults to the system time zone.
|
||
More general information about time zones: <a href="https://www.iana.org/time-zones">https://www.iana.org/time-zones</a>
|
||
List of valid timezone values: <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>jsonData</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>JsonData is json encoded data used as the body of the event posted to
|
||
the sink. Default is empty. If set, datacontenttype will also be set
|
||
to &ldquo;application/json&rdquo;.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.PingSourceStatus">PingSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceStatus defines the observed state of PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.SinkBindingSpec">SinkBindingSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingSpec holds the desired state of the SinkBinding (from the client).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>BindingSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1beta1.BindingSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>BindingSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1beta1 BindingSpec, which currently provides:
|
||
* Subject - Subject references the resource(s) whose &ldquo;runtime contract&rdquo;
|
||
should be augmented by Binding implementations.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta1.SinkBindingStatus">SinkBindingStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta1.SinkBinding">SinkBinding</a>)
|
||
</p>
|
||
<p>
|
||
<p>SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<h2 id="sources.knative.dev/v1beta2">sources.knative.dev/v1beta2</h2>
|
||
<p>
|
||
<p>Package v1beta2 contains API Schema definitions for the sources v1beta2 API group.</p>
|
||
</p>
|
||
Resource Types:
|
||
<ul><li>
|
||
<a href="#sources.knative.dev/v1beta2.PingSource">PingSource</a>
|
||
</li></ul>
|
||
<h3 id="sources.knative.dev/v1beta2.PingSource">PingSource
|
||
</h3>
|
||
<p>
|
||
<p>PingSource is the Schema for the PingSources API.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>apiVersion</code><br/>
|
||
string</td>
|
||
<td>
|
||
<code>
|
||
sources.knative.dev/v1beta2
|
||
</code>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>kind</code><br/>
|
||
string
|
||
</td>
|
||
<td><code>PingSource</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>metadata</code><br/>
|
||
<em>
|
||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
||
Kubernetes meta/v1.ObjectMeta
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
Refer to the Kubernetes API documentation for the fields of the
|
||
<code>metadata</code> field.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>spec</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta2.PingSourceSpec">
|
||
PingSourceSpec
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<br/>
|
||
<br/>
|
||
<table>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cron schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timezone</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Timezone modifies the actual time relative to the specified timezone.
|
||
Defaults to the system time zone.
|
||
More general information about time zones: <a href="https://www.iana.org/time-zones">https://www.iana.org/time-zones</a>
|
||
List of valid timezone values: <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>contentType</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContentType is the media type of Data or DataBase64. Default is empty.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>data</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Data is data used as the body of the event posted to the sink. Default is empty.
|
||
Mutually exclusive with DataBase64.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>dataBase64</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DataBase64 is the base64-encoded string of the actual event&rsquo;s body posted to the sink. Default is empty.
|
||
Mutually exclusive with Data.</p>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>status</code><br/>
|
||
<em>
|
||
<a href="#sources.knative.dev/v1beta2.PingSourceStatus">
|
||
PingSourceStatus
|
||
</a>
|
||
</em>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta2.PingSourceSpec">PingSourceSpec
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta2.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceSpec defines the desired state of the PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceSpec</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceSpec
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceSpec</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceSpec, which currently provides:
|
||
* Sink - a reference to an object that will resolve to a domain name or
|
||
a URI directly to use as the sink.
|
||
* CloudEventOverrides - defines overrides to control the output format
|
||
and modifications of the event sent to the sink.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>schedule</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Schedule is the cron schedule. Defaults to <code>* * * * *</code>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>timezone</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>Timezone modifies the actual time relative to the specified timezone.
|
||
Defaults to the system time zone.
|
||
More general information about time zones: <a href="https://www.iana.org/time-zones">https://www.iana.org/time-zones</a>
|
||
List of valid timezone values: <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>contentType</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>ContentType is the media type of Data or DataBase64. Default is empty.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>data</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>Data is data used as the body of the event posted to the sink. Default is empty.
|
||
Mutually exclusive with DataBase64.</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>dataBase64</code><br/>
|
||
<em>
|
||
string
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<em>(Optional)</em>
|
||
<p>DataBase64 is the base64-encoded string of the actual event&rsquo;s body posted to the sink. Default is empty.
|
||
Mutually exclusive with Data.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="sources.knative.dev/v1beta2.PingSourceStatus">PingSourceStatus
|
||
</h3>
|
||
<p>
|
||
(<em>Appears on:</em><a href="#sources.knative.dev/v1beta2.PingSource">PingSource</a>)
|
||
</p>
|
||
<p>
|
||
<p>PingSourceStatus defines the observed state of PingSource.</p>
|
||
</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Field</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>SourceStatus</code><br/>
|
||
<em>
|
||
knative.dev/pkg/apis/duck/v1.SourceStatus
|
||
</em>
|
||
</td>
|
||
<td>
|
||
<p>
|
||
(Members of <code>SourceStatus</code> are embedded into this type.)
|
||
</p>
|
||
<p>inherits duck/v1 SourceStatus, which currently provides:
|
||
* ObservedGeneration - the &lsquo;Generation&rsquo; of the Service that was last
|
||
processed by the controller.
|
||
* Conditions - the latest available observations of a resource&rsquo;s current
|
||
state.
|
||
* SinkURI - the current active sink URI that has been configured for the
|
||
Source.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<hr/>
|
||
<p><em>
|
||
Generated with <code>gen-crd-api-reference-docs</code>
|
||
on git commit <code>8f35d4254</code>.
|
||
</em></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</description>
|
||
</item>
|
||
|
||
</channel>
|
||
</rss>
|