Eventing API
パッケージ
- duck.knative.dev/v1
- duck.knative.dev/v1alpha1
- duck.knative.dev/v1beta1
- eventing.knative.dev/v1
- eventing.knative.dev/v1alpha1
- eventing.knative.dev/v1beta1
- eventing.knative.dev/v1beta2
- eventing.knative.dev/v1beta3
- flows.knative.dev/v1
- messaging.knative.dev/v1
- sinks.knative.dev/v1alpha1
- sources.knative.dev/v1
- sources.knative.dev/v1beta2
duck.knative.dev/v1
パッケージv1はAPIのv1バージョンです。
リソースタイプ
AppliedEventPoliciesStatus
(表示対象:ChannelableStatus, BrokerStatus, ParallelStatus, SequenceStatus, JobSinkStatus)
AppliedEventPoliciesStatusには、リソースに適用されるポリシーのリストが含まれています。この型は、ステータス構造体に埋め込むことを目的としています。
フィールド | 説明 |
---|---|
policies []AppliedEventPolicyRef |
(オプション)
Policiesには、適用されたEventPoliciesのリストが保持されます |
AppliedEventPolicyRef
(表示対象:AppliedEventPoliciesStatus)
AppliedEventPolicyRefは、EventPolicyへの参照です
フィールド | 説明 |
---|---|
apiVersion string |
適用されたEventPolicyのAPIVersion。これは、リソースがサポートするEventPolicyのバージョンを示します。 |
name string |
適用されたEventPolicyの名前 |
BackoffPolicyType (string
エイリアス)
(表示対象:DeliverySpec)
BackoffPolicyTypeは、バックオフポリシーの型です
値 | 説明 |
---|---|
"exponential" |
指数バックオフポリシー |
"linear" |
線形バックオフポリシー |
Channelable
Channelableは、互換性のあるリソースを定義するリソースライターが埋め込むことを期待する方法で、SubscribableおよびAddressableをラップするスケルトン型です。通常、この型を使用してChannelable ObjectReferencesを逆シリアル化し、サブスクリプションとアドレスデータにアクセスします。これは実際のリソースではありません。
フィールド | 説明 | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec ChannelableSpec |
Specは、ChannelableがSubscribableコントラクトを満たす部分です。
|
||||
status ChannelableStatus |
ChannelableSpec
(表示対象:Channelable, ChannelSpec, InMemoryChannelSpec)
ChannelableSpecには、ChannelableオブジェクトのSpecが含まれています
フィールド | 説明 |
---|---|
SubscribableSpec SubscribableSpec |
( |
delivery DeliverySpec |
(オプション)
DeliverySpecには、このChannelableへの各サブスクリプションのデフォルトの配信仕様が含まれています。各サブスクリプションの配信仕様(存在する場合)は、このグローバル配信仕様をオーバーライドします。 |
ChannelableStatus
(表示対象:Channelable, ChannelStatus, InMemoryChannelStatus)
ChannelableStatusには、ChannelableオブジェクトのStatusが含まれています。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
AddressStatus knative.dev/pkg/apis/duck/v1.AddressStatus |
( AddressStatusは、ChannelableがAddressableコントラクトを満たす部分です。 |
SubscribableStatus SubscribableStatus |
( Subscribersには、Channelableの各サブスクライバーのステータスが設定されます。 |
DeliveryStatus DeliveryStatus |
( DeliveryStatusには、デッドレターシンクアドレスへの解決済みのURL、およびその他の解決済みの配信オプションが含まれています。 |
AppliedEventPoliciesStatus AppliedEventPoliciesStatus |
( AppliedEventPoliciesStatusには、このChannelに適用されるEventPoliciesのリストが含まれています |
DeliverySpec
(表示対象:ChannelableSpec, SubscriberSpec, BrokerSpec, TriggerSpec, ParallelBranch, SequenceStep, SubscriptionSpec)
DeliverySpecには、Channelableやソースなどのイベント送信者の配信オプションが含まれています。
フィールド | 説明 |
---|---|
deadLetterSink knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
DeadLetterSinkは、宛先に送信できなかったイベントを受信するシンクです。 |
retry int32 |
(オプション)
Retryは、送信者がイベントをデッドレターシンクに移動する前に試行する必要がある最小のリトライ回数です。 |
timeout string |
(オプション)
Timeoutは、1回の要求ごとのタイムアウトです。値は0より大きくなければなりません。期間形式の詳細については、以下を参照してください。 - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 注: このAPIは実験的であり、いつでも壊れる可能性があります。詳細については、https://github.com/knative/eventing/issues/5148を参照してください。 |
backoffPolicy BackoffPolicyType |
(オプション)
BackoffPolicyは、リトライバックオフポリシー(線形、指数)です。 |
backoffDelay string |
(オプション)
BackoffDelayは、再試行前の遅延です。期間形式の詳細については、以下を参照してください。 - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 線形ポリシーの場合、バックオフ遅延はbackoffDelay*です |
retryAfterMax string |
(オプション)
RetryAfterMaxは、429および503応答コードを再試行するためのバックオフ時間を計算するときに、"Retry-After"ヘッダーで指定された期間に対するオプションの上限を提供します。値をゼロ("PT0S")に設定すると、"Retry-After"ヘッダー値をまったく尊重しないようにオプトアウトできます。この値は、"Retry"が構成されている場合にのみ有効になり、特定の(チャネル、ソースなど)実装がこの機能を提供することを選択するかどうかにも依存します。 注: このAPIは実験的であり、いつでも変更される可能性があります。この実験的機能がAlpha/Beta段階にある間は、"Retry-After"ヘッダーをサポートするためにオプトインするには、有効な値を指定する必要があります。機能が安定/GAになると、"Retry-After"ヘッダーはデフォルトで尊重され、"Retry-After"ヘッダーのサポートをオプトアウトするために"PT0S"を指定できます。詳細については、https://github.com/knative/eventing/issues/5811を参照してください。 期間形式の詳細については、以下を参照してください。 - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 |
format FormatType |
(オプション)
formatは、Cloud Eventに必要なイベント形式を指定します。次のいずれかの値を指定できます。 - nil: デフォルト値、特定の形式は不要です。- "JSON": イベントが構造化モードである必要があることを示します。- "binary": イベントがバイナリモードである必要があることを示します。 |
DeliveryStatus
(表示対象:ChannelableStatus, BrokerStatus, TriggerStatus, SubscriptionStatusPhysicalSubscription)
DeliveryStatusには、配信オプションをサポートするオブジェクトのステータスが含まれています。この型は、ステータス構造体に埋め込むことを目的としています。
フィールド | 説明 |
---|---|
deadLetterSinkUri knative.dev/pkg/apis.URL |
(オプション)
DeadLetterSinkは、失敗したイベントが送信されるネイティブプラットフォーム固有のチャネルへの参照であるKReferenceです。 |
deadLetterSinkCACerts string |
(オプション)
DeadLetterSinkCACertsは、https://www.rfc-editor.org/rfc/rfc7468に従ったPEM形式の認証局(CA)証明書です。 |
deadLetterSinkAudience string |
(オプション)
DeadLetterSinkAudienceは、DeadLetterSinkのOIDCオーディエンスです |
FormatType (string
エイリアス)
(表示対象:DeliverySpec)
FormatTypeは、配信形式の型です
値 | 説明 |
---|---|
"binary" |
|
"json" |
Subscribable
Subscribableは、互換性のあるリソースを定義するリソースライターが埋め込むことを期待する方法で、Subscribableをラップするスケルトン型です。通常、この型を使用してSubscribableType ObjectReferencesを逆シリアル化し、Subscriptionデータにアクセスします。これは実際のリソースではありません。
フィールド | 説明 | ||
---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||
spec SubscribableSpec |
SubscribableSpecは、SubscribableオブジェクトがSubscribable契約と互換性を持つように構成される部分です。
|
||
status SubscribableStatus |
SubscribableStatusは、SubscribableStatusオブジェクトがSubscribable契約と互換性を持つように構成される部分です。 |
SubscribableSpec
(表示箇所:ChannelableSpec, Subscribable)
SubscribableSpecは、SubscribableをSpecフィールドにどのように埋め込むかを示すものです。
フィールド | 説明 |
---|---|
subscribers []SubscriberSpec |
これは、このsubscribableのサブスクリプションのリストです。 |
SubscribableStatus
(表示箇所:ChannelableStatus, Subscribable)
SubscribableStatusは、リソースのstatusセクションのsubscribableのステータス部分のスキーマです。
フィールド | 説明 |
---|---|
subscribers []SubscriberStatus |
これは、このチャネルのサブスクリプションのステータスのリストです。 |
SubscriberSpec
(表示箇所:SubscribableSpec)
SubscriberSpecは、Subscribableへの単一のサブスクライバーを定義します。
SubscriberURIとReplyURIの少なくとも1つが存在する必要があります
フィールド | 説明 |
---|---|
name string |
(オプション)
Nameは、元のサブスクリプションオブジェクトを識別するために使用されます。 |
uid k8s.io/apimachinery/pkg/types.UID |
(オプション)
UIDは、サブスクライバーの起源を理解するために使用されます。 |
generation int64 |
(オプション)
uid:UIDを持つサブスクライバーの起源のジェネレーション。 |
subscriberUri knative.dev/pkg/apis.URL |
(オプション)
SubscriberURIは、サブスクライバーのエンドポイントです |
subscriberCACerts string |
(オプション)
SubscriberCACertsは、https://www.rfc-editor.org/rfc/rfc7468に従った、subscriberUri用のPEM形式の認証局(CA)証明書です |
subscriberAudience string |
(オプション)
SubscriberAudienceは、subscriberUri用のOIDCオーディエンスです。 |
replyUri knative.dev/pkg/apis.URL |
(オプション)
ReplyURIは、応答のエンドポイントです |
replyCACerts string |
(オプション)
ReplyCACertsは、https://www.rfc-editor.org/rfc/rfc7468に従った、replyUri用のPEM形式の認証局(CA)証明書です。 |
replyAudience string |
(オプション)
ReplyAudienceは、replyUri用のOIDCオーディエンスです。 |
delivery DeliverySpec |
(オプション)
DeliverySpecには、イベント配信を制御するオプションが含まれています |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authには、サブスクリプションのサービスアカウント名が含まれています |
SubscriberStatus
(表示箇所:SubscribableStatus)
SubscriberStatusは、チャネルへの単一のサブスクライバーのステータスを定義します。
フィールド | 説明 |
---|---|
uid k8s.io/apimachinery/pkg/types.UID |
(オプション)
UIDは、サブスクライバーの起源を理解するために使用されます。 |
observedGeneration int64 |
(オプション)
uid:UIDを持つサブスクライバーの起源のジェネレーション。 |
ready Kubernetes core/v1.ConditionStatus |
サブスクライバーのステータス。 |
message string |
(オプション)
Readyステータスの詳細を示す人間が読めるメッセージ。 |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authは、OIDC認証に関する関連情報を提供します。 |
duck.knative.dev/v1alpha1
リソースタイプ
Placeable
(表示箇所:PlaceableStatus)
Placeableは、podNameと仮想レプリカのペアのリストです。各ペアは、仮想レプリカのポッドへの割り当てを表します
フィールド | 説明 |
---|---|
maxAllowedVReplicas int32 |
|
placements []Placement |
PlaceableStatus
(表示箇所:PlaceableType)
フィールド | 説明 |
---|---|
Placeable Placeable |
( |
PlaceableType
PlaceableTypeは、互換性のあるリソースを定義するリソースライターがそれを埋め込むことを期待する方法でPlaceableをラップするスケルトン型です。通常、この型を使用してPlaceable ObjectReferencesを逆シリアル化し、Placeableデータにアクセスします。これは実際のリソースではありません。
フィールド | 説明 |
---|---|
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
status PlaceableStatus |
Placement
(表示箇所:Placeable)
フィールド | 説明 |
---|---|
podName string |
PodNameは、リソースが配置されているポッドの名前です |
vreplicas int32 |
VReplicasは、ポッドに割り当てられた仮想レプリカの数です |
duck.knative.dev/v1beta1
Package v1beta1は、APIのv1beta1バージョンです。
リソースタイプ
BackoffPolicyType (string
エイリアス)
(表示箇所:DeliverySpec)
BackoffPolicyTypeは、バックオフポリシーの型です
値 | 説明 |
---|---|
"exponential" |
指数バックオフポリシー |
"linear" |
線形バックオフポリシー |
Channelable
Channelableは、互換性のあるリソースを定義するリソースライターが埋め込むことを期待する方法で、SubscribableおよびAddressableをラップするスケルトン型です。通常、この型を使用してChannelable ObjectReferencesを逆シリアル化し、サブスクリプションとアドレスデータにアクセスします。これは実際のリソースではありません。
フィールド | 説明 | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec ChannelableSpec |
Specは、ChannelableがSubscribableコントラクトを満たす部分です。
|
||||
status ChannelableStatus |
ChannelableSpec
(表示箇所:Channelable)
ChannelableSpecには、ChannelableオブジェクトのSpecが含まれています
フィールド | 説明 |
---|---|
SubscribableSpec SubscribableSpec |
( |
delivery DeliverySpec |
(オプション)
DeliverySpecには、イベント配信を制御するオプションが含まれています |
ChannelableStatus
(表示箇所:Channelable)
ChannelableStatusには、ChannelableオブジェクトのStatusが含まれています。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
AddressStatus knative.dev/pkg/apis/duck/v1.AddressStatus |
( AddressStatusは、ChannelableがAddressableコントラクトを満たす部分です。 |
SubscribableStatus SubscribableStatus |
( Subscribersには、Channelableの各サブスクライバーのステータスが設定されます。 |
deadLetterChannel knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
DeadLetterChannelはKReferenceであり、チャネルがチャネルを介したネイティブエラー処理をサポートする場合にチャネルによって設定されます。失敗したメッセージはここに配信されます。 |
DeliverySpec
(表示箇所:ChannelableSpec, SubscriberSpec)
DeliverySpecには、Channelableやソースなどのイベント送信者の配信オプションが含まれています。
フィールド | 説明 |
---|---|
deadLetterSink knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
DeadLetterSinkは、宛先に送信できなかったイベントを受信するシンクです。 |
retry int32 |
(オプション)
Retryは、送信者がイベントをデッドレターシンクに移動する前に試行する必要がある最小のリトライ回数です。 |
timeout string |
Timeoutは、各単一リクエストのタイムアウトです。Duration形式の詳細については、以下を参照してください: - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 |
backoffPolicy BackoffPolicyType |
(オプション)
BackoffPolicyは、リトライバックオフポリシー(線形、指数)です。 |
backoffDelay string |
(オプション)
BackoffDelayは、再試行前の遅延です。期間形式の詳細については、以下を参照してください。 - https://www.iso.org/iso-8601-date-and-time-format.html - https://en.wikipedia.org/wiki/ISO_8601 線形ポリシーの場合、バックオフ遅延はbackoffDelay*です |
DeliveryStatus
DeliveryStatusには、配信オプションをサポートするオブジェクトのステータスが含まれています。
フィールド | 説明 |
---|---|
deadLetterChannel knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
DeadLetterChannelは、失敗したイベントが送信されるネイティブなプラットフォーム固有のチャネルへの参照であるKReferenceです。 |
Subscribable
Subscribableは、互換性のあるリソースを定義するリソースライターが埋め込むことを期待する方法で、Subscribableをラップするスケルトン型です。通常、この型を使用してSubscribableType ObjectReferencesを逆シリアル化し、Subscriptionデータにアクセスします。これは実際のリソースではありません。
フィールド | 説明 | ||
---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||
spec SubscribableSpec |
SubscribableSpecは、SubscribableオブジェクトがSubscribable契約と互換性を持つように構成される部分です。
|
||
status SubscribableStatus |
SubscribableStatusは、SubscribableStatusオブジェクトがSubscribable契約と互換性を持つように構成される部分です。 |
SubscribableSpec
(表示箇所:ChannelableSpec, Subscribable)
SubscribableSpecは、SubscribableをSpecフィールドにどのように埋め込むかを示すものです。
フィールド | 説明 |
---|---|
subscribers []SubscriberSpec |
これは、このsubscribableのサブスクリプションのリストです。 |
SubscribableStatus
(表示箇所:ChannelableStatus, Subscribable)
SubscribableStatusは、リソースのstatusセクションのsubscribableのステータス部分のスキーマです。
フィールド | 説明 |
---|---|
subscribers []SubscriberStatus |
これは、このチャネルのサブスクリプションのステータスのリストです。 |
SubscriberSpec
(表示箇所:SubscribableSpec)
SubscriberSpecは、Subscribableへの単一のサブスクライバーを定義します。
SubscriberURIとReplyURIの少なくとも1つが存在する必要があります
フィールド | 説明 |
---|---|
uid k8s.io/apimachinery/pkg/types.UID |
(オプション)
UIDは、サブスクライバーの起源を理解するために使用されます。 |
generation int64 |
(オプション)
uid:UIDを持つサブスクライバーの起源のジェネレーション。 |
subscriberUri knative.dev/pkg/apis.URL |
(オプション)
SubscriberURIは、サブスクライバーのエンドポイントです |
replyUri knative.dev/pkg/apis.URL |
(オプション)
ReplyURIは、応答のエンドポイントです |
delivery DeliverySpec |
(オプション)
DeliverySpecには、イベント配信を制御するオプションが含まれています |
SubscriberStatus
(表示箇所:SubscribableStatus)
SubscriberStatusは、チャネルへの単一のサブスクライバーのステータスを定義します。
フィールド | 説明 |
---|---|
uid k8s.io/apimachinery/pkg/types.UID |
(オプション)
UIDは、サブスクライバーの起源を理解するために使用されます。 |
observedGeneration int64 |
(オプション)
uid:UIDを持つサブスクライバーの起源のジェネレーション。 |
ready Kubernetes core/v1.ConditionStatus |
サブスクライバーのステータス。 |
message string |
(オプション)
Readyステータスの詳細を示す人間が読めるメッセージ。 |
eventing.knative.dev/v1
パッケージv1はAPIのv1バージョンです。
リソースタイプ
Broker
Brokerは、Triggerを使用して消費可能なイベントのプールを収集します。Brokerは、送信者がイベントルーティング戦略を最小限の知識で使用できる、イベント配信のための既知のエンドポイントを提供します。サブスクライバーは、Triggerを使用して、Brokerのプールから特定のURLまたはAddressableエンドポイントへのイベントの配信を要求します。
フィールド | 説明 | ||||
---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1
|
||||
kind string |
Broker |
||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec BrokerSpec |
Specは、Brokerの望ましい状態を定義します。
|
||||
status BrokerStatus |
(オプション)
Statusは、Brokerの現在の状態を表します。このデータは古い可能性があります。 |
Trigger
Triggerは、Brokerのイベントプールからサブスクライバーにイベントを配信する要求を表します。
フィールド | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1
|
||||||||||||
kind string |
Trigger |
||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||
spec TriggerSpec |
Specは、Triggerの望ましい状態を定義します。
|
||||||||||||
status TriggerStatus |
(オプション)
Statusは、Triggerの現在の状態を表します。このデータは古い可能性があります。 |
BrokerSpec
(表示箇所:Broker)
フィールド | 説明 |
---|---|
config knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
Configは、このBrokerの構成オプションを指定する構成へのKReferenceです。たとえば、これはConfigMapへのポインタである可能性があります。 |
delivery DeliverySpec |
(オプション)
Deliveryには、このBrokerへの各トリガーの配信仕様が含まれています。トリガー配信仕様がある場合、このグローバル配信仕様をオーバーライドします。 |
BrokerStatus
(表示箇所:Broker)
BrokerStatusは、Brokerの現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承し、現在、以下を提供しています: * ObservedGeneration - コントローラーによって最後に処理されたBrokerの'Generation'。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。 |
AddressStatus knative.dev/pkg/apis/duck/v1.AddressStatus |
( AddressStatusは、BrokerがAddressable契約を満たす部分です。Brokerメッシュにイベントを配信するためのURIとしてエンドポイントを公開します。 |
DeliveryStatus DeliveryStatus |
( DeliveryStatusには、デッドレターシンクアドレスへの解決済みのURL、およびその他の解決済みの配信オプションが含まれています。 |
AppliedEventPoliciesStatus AppliedEventPoliciesStatus |
( AppliedEventPoliciesStatusには、このBrokerに適用されるEventPoliciesのリストが含まれています |
SubscriptionsAPIFilter
(表示箇所:SubscriptionsAPIFilter, TriggerSpec, EventPolicySpec, ApiServerSourceSpec)
SubscriptionsAPIFilterを使用すると、CloudEvents Subscriptions APIを使用してフィルター式を定義できます。複数のフィルターが指定されている場合は、SubscriptionsAPIFilter.Allと同じセマンティクスが適用されます。フィルター方言または空のオブジェクトが指定されていない場合、フィルターは常にイベントを受け入れます。
フィールド | 説明 |
---|---|
all []SubscriptionsAPIFilter |
(オプション)
Allは、ネストされたすべての式がtrueに評価された場合にtrueに評価されます。少なくとも1つのフィルター式を含める必要があります。 |
any []SubscriptionsAPIFilter |
(オプション)
Anyは、ネストされた式の少なくとも1つがtrueに評価された場合にtrueに評価されます。少なくとも1つのフィルター式を含める必要があります。 |
not SubscriptionsAPIFilter |
(オプション)
Notは、ネストされた式がfalseに評価された場合にtrueに評価されます。 |
exact map[string]string |
(オプション)
Exactは、一致するCloudEvents属性の値がすべて、指定された関連するString値と完全に一致(大文字と小文字を区別)する必要がある場合にtrueと評価されます。キーは、一致するCloudEvents属性の名前であり、それらの値は比較に使用するString値です。フィルター式で指定された属性名と値は、空の文字列であってはなりません。 |
prefix map[string]string |
(オプション)
Prefixは、一致するCloudEvents属性の値がすべて、指定された関連するString値で開始(大文字と小文字を区別)する必要がある場合にtrueと評価されます。キーは、一致するCloudEvents属性の名前であり、それらの値は比較に使用するString値です。フィルター式で指定された属性名と値は、空の文字列であってはなりません。 |
suffix map[string]string |
(オプション)
Suffixは、一致するCloudEvents属性の値がすべて、指定された関連するString値で終了(大文字と小文字を区別)する必要がある場合にtrueと評価されます。キーは、一致するCloudEvents属性の名前であり、それらの値は比較に使用するString値です。フィルター式で指定された属性名と値は、空の文字列であってはなりません。 |
cesql string |
(オプション)
CESQLは、各CloudEventに対してtrueまたはfalseに評価されるCloudEvents SQL式です。 |
TriggerFilter
(表示箇所:TriggerSpec)
フィールド | 説明 |
---|---|
attributes TriggerFilterAttributes |
(オプション)
属性フィルターは、イベントコンテキスト属性の完全一致によってイベントをフィルタリングします。マップ内の各キーは、イベントコンテキスト内の同等のキーと比較されます。すべての値が指定された値と等しい場合、イベントはフィルターを通過します。ネストされたコンテキスト属性はキーとしてサポートされていません。文字列値のみがサポートされています。 |
TriggerFilterAttributes (map[string]string
エイリアス)
(表示場所:TriggerFilter)
TriggerFilterAttributes は、等価性によってフィルタリングするためのコンテキスト属性名と値のマップです。完全一致のみがフィルターを通過します。値「」を使用して、すべての文字列が一致することを示すことができます。
TriggerSpec
(表示場所:Trigger)
フィールド | 説明 |
---|---|
broker string |
Brokerは、このトリガーがイベントを受信するブローカーです。 |
brokerRef knative.dev/pkg/apis/duck/v1.KReference |
BrokerRefは、名前空間を越えた参照に使用されるブローカーです。 |
filter TriggerFilter |
(オプション)
Filterは、Brokerからのすべてのイベントに対して適用するフィルターです。このフィルターを通過するイベントのみが、サブスクライバーに送信されます。指定しない場合は、すべてのイベントを許可するようにデフォルト設定されます。 |
filters []SubscriptionsAPIFilter |
(オプション)
Filtersは、CNCF CloudEvents Subscriptions APIに準拠した実験的なフィールドです。これは、trueまたはfalseに評価されるフィルター式の配列です。配列内のフィルター式がfalseに評価された場合、イベントはサブスクライバーに送信してはなりません。配列内のすべてのフィルター式がtrueに評価された場合、イベントは配信を試みる必要があります。フィルターが存在しないか、空の配列の場合は、trueの値が暗示されます。ユーザーがFilterとFiltersの両方を指定した場合、後者が前者よりも優先されます。これにより、ユーザーは既存の属性ベースのFilterを損なうことなく、新しいFiltersフィールドの効果を試して、既存のTriggerオブジェクトで試すことができます。 |
subscriber knative.dev/pkg/apis/duck/v1.Destination |
Subscriberは、フィルターを通過したBrokerからのイベントを受信するaddressableです。必須です。 |
delivery DeliverySpec |
(オプション)
Deliveryには、この特定のトリガーの配信仕様が含まれています。 |
TriggerStatus
(表示場所:Trigger)
TriggerStatus は、Trigger の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Status を継承します。これは現在、以下の機能を提供します。 * ObservedGeneration - コントローラーによって最後に処理された Trigger の「世代」。 * Conditions - リソースの現在の状態に関する最新の利用可能な観測。 |
subscriberUri knative.dev/pkg/apis.URL |
(オプション)
SubscriberURI は、この Trigger の受信者の解決済み URI です。 |
subscriberCACerts string |
(オプション)
SubscriberCACerts は、https://www.rfc-editor.org/rfc/rfc7468 に準拠した、この Trigger の受信者の PEM 形式の認証局 (CA) 証明書です。 |
subscriberAudience string |
(オプション)
SubscriberAudience は、サブスクライバーの OIDC オーディエンスです。 |
DeliveryStatus DeliveryStatus |
( DeliveryStatusには、デッドレターシンクアドレスへの解決済みのURL、およびその他の解決済みの配信オプションが含まれています。 |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authは、OIDC認証に関する関連情報を提供します。 |
eventing.knative.dev/v1alpha1
パッケージ v1alpha1 は、API の v1alpha1 バージョンです。
リソースタイプ
EventPolicy
EventPolicy は、アドレス指定可能なリソース(Broker、Channel、シンク)のポリシーを表します。
フィールド | 説明 | ||||||
---|---|---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1alpha1
|
||||||
kind string |
EventPolicy |
||||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||
spec EventPolicySpec |
Spec は、EventPolicy の望ましい状態を定義します。
|
||||||
status EventPolicyStatus |
(オプション)
Status は、EventPolicy の現在の状態を表します。このデータは古くなっている可能性があります。 |
EventPolicyFromReference
(表示場所:EventPolicySpecFrom)
フィールド | 説明 |
---|---|
apiVersion string |
参照先の API バージョン。 |
kind string |
参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name string |
参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
namespace string |
(オプション)
参照先の名前空間。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ これはオプションのフィールドであり、省略された場合はそれを保持するオブジェクトにデフォルト設定されます。 |
EventPolicySelector
(表示場所:EventPolicySpecTo)
フィールド | 説明 |
---|---|
LabelSelector Kubernetes meta/v1.LabelSelector |
( |
EventPolicySpec
(表示場所:EventPolicy)
フィールド | 説明 |
---|---|
to []EventPolicySpecTo |
(オプション)
To は、このポリシーが適用されるすべてのリソースをリストします。このリスト内のリソースは、イングレスのように動作し、オーディエンスを持つ必要があります。リソースは、EventPolicy と同じ名前空間に属します。空のリストは、EventPolicies 名前空間内のすべてのリソースに適用されることを意味します。 |
from []EventPolicySpecFrom |
From は、ターゲット(.spec.to)にイベントを送信することを許可されているソースまたは OIDC ID のリストです。 |
filters []SubscriptionsAPIFilter |
(オプション)
Filters は、イベントが受け入れられるかどうかを判断する SubscriptoinsApi フィルターのリストです。これは、true または false に評価されるフィルター式の配列です。配列内のいずれかのフィルター式が false に評価された場合、イベントはターゲットリソースのイングレスを通過しません。フィルターがない場合、フィルターは常に true に評価されることを意味します。 |
EventPolicySpecFrom
(表示場所:EventPolicySpec)
フィールド | 説明 |
---|---|
ref EventPolicyFromReference |
(オプション)
Ref には、ターゲットにイベントを送信することを許可されているリソースへの直接参照が含まれています。 |
sub string |
(オプション)
Sub は、ターゲットにイベントを送信することを許可されている OIDC ID 名を設定します。サフィックスを一致させるために、グロブのようなパターンを設定することもできます。 |
EventPolicySpecTo
(表示場所:EventPolicySpec)
フィールド | 説明 |
---|---|
ref EventPolicyToReference |
(オプション)
Ref には、ターゲットへの直接参照が含まれています。 |
selector EventPolicySelector |
(オプション)
Selector には、ターゲットをグループ化するためのセレクターが含まれています。 |
EventPolicyStatus
(表示場所:EventPolicy)
EventPolicyStatus は、EventPolicy の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
from []string |
From は、.spec.from から解決された OIDC ID のリストです。 |
EventPolicyToReference
(表示場所:EventPolicySpecTo)
フィールド | 説明 |
---|---|
apiVersion string |
参照先の API バージョン。 |
kind string |
参照先の種類。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name string |
参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
eventing.knative.dev/v1beta1
Package v1beta1は、APIのv1beta1バージョンです。
リソースタイプ
EventType
EventType は、Broker から消費できるイベントのタイプを表します。非推奨: 代わりに v1beta2.EventType を使用してください。
フィールド | 説明 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1beta1
|
||||||||||||||
kind string |
EventType |
||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||||
spec EventTypeSpec |
Spec は、EventType の望ましい状態を定義します。
|
||||||||||||||
status EventTypeStatus |
(オプション)
Status は、EventType の現在の状態を表します。このデータは古くなっている可能性があります。 |
EventTypeSpec
(表示場所:EventType)
フィールド | 説明 |
---|---|
type string |
Type は、CloudEvents のタイプを表します。これは権威があります。 |
source knative.dev/pkg/apis.URL |
(オプション)
Source は URI であり、CloudEvents のソースを表します。 |
schema knative.dev/pkg/apis.URL |
(オプション)
Schema は URI であり、CloudEvents の schemaurl 拡張属性を表します。JSON スキーマ、protobuf スキーマなどである可能性があります。オプションです。 |
schemaData string |
(オプション)
SchemaData を使用すると、CloudEvents スキーマを EventType に直接保存できます。コンテンツはエンコーディングによって異なります。オプションの属性です。コンテンツはシステムによって検証または操作されません。 |
broker string |
(オプション)
Broker は、EventType を提供できる Broker を参照します。 |
reference knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
Reference は、属するアドレス指定可能な KReference です。たとえば、これは Broker へのポインタである可能性があります。 |
description string |
(オプション)
Description は、EventType を意味のある方法で記述するために使用されるオプションのフィールドです。 |
EventTypeStatus
(表示場所:EventType)
EventTypeStatus は、EventType の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
eventing.knative.dev/v1beta2
パッケージ v1beta2 は、API の v1beta2 バージョンです。
リソースタイプ
EventType
EventType は、Broker から消費できるイベントのタイプを表します。
フィールド | 説明 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1beta2
|
||||||||||||||
kind string |
EventType |
||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||||
spec EventTypeSpec |
Spec は、EventType の望ましい状態を定義します。
|
||||||||||||||
status EventTypeStatus |
(オプション)
Status は、EventType の現在の状態を表します。このデータは古くなっている可能性があります。 |
EventTypeSpec
(表示場所:EventType)
フィールド | 説明 |
---|---|
type string |
Type は、CloudEvents のタイプを表します。これは権威があります。 |
source knative.dev/pkg/apis.URL |
(オプション)
Source は URI であり、CloudEvents のソースを表します。 |
schema knative.dev/pkg/apis.URL |
(オプション)
Schema は URI であり、CloudEvents の schemaurl 拡張属性を表します。JSON スキーマ、protobuf スキーマなどである可能性があります。オプションです。 |
schemaData string |
(オプション)
SchemaData を使用すると、CloudEvents スキーマを EventType に直接保存できます。コンテンツはエンコーディングによって異なります。オプションの属性です。コンテンツはシステムによって検証または操作されません。 |
broker string |
(オプション)
Broker は、EventType を提供できる Broker を参照します。非推奨: このフィールドは非推奨であり、今後のリリースで削除される予定です。 |
reference knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
Reference は、属するアドレス指定可能な KReference です。たとえば、これは Broker へのポインタである可能性があります。 |
description string |
(オプション)
Description は、EventType を意味のある方法で記述するために使用されるオプションのフィールドです。 |
EventTypeStatus
(表示場所:EventType)
EventTypeStatus は、EventType の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
eventing.knative.dev/v1beta3
パッケージ v1beta3 は、API の v1beta3 バージョンです。
リソースタイプ
EventType
EventType は、Broker から消費できるイベントのタイプを表します。
フィールド | 説明 | ||||||
---|---|---|---|---|---|---|---|
apiVersion string |
eventing.knative.dev/v1beta3
|
||||||
kind string |
EventType |
||||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||
spec EventTypeSpec |
Spec は、EventType の望ましい状態を定義します。
|
||||||
status EventTypeStatus |
(オプション)
Status は、EventType の現在の状態を表します。このデータは古くなっている可能性があります。 |
EventAttributeDefinition
(表示場所:EventTypeSpec)
フィールド | 説明 |
---|---|
name string |
Name は、CloudEvents 属性の名前です。 |
required bool |
Required は、対応する CloudEvents にこの属性を設定する必要があるかどうかを決定します。 |
value string |
Value は、EventType 属性の許容値を表す文字列です。「/apis/v1/namespaces/default/pingsource/ps」のような単一の値である場合もあれば、「/apis/v1/namespaces/{namespace}/pingsource/{sourceName}」のように、許容値のテンプレートである場合もあります。異なる CloudEvents 間で変更される可能性がある文字列値のセクションを指定するには、波括弧 {} と、必要に応じてその間の変数名を使用できます。 |
EventTypeSpec
(表示場所:EventType)
フィールド | 説明 |
---|---|
reference knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
Reference は、属するアドレス指定可能な KReference です。たとえば、これは Broker へのポインタである可能性があります。 |
description string |
(オプション)
Description は、EventType を意味のある方法で記述するために使用されるオプションのフィールドです。 |
attributes []EventAttributeDefinition |
Attributes は、CloudEvent 属性と拡張属性の配列です。 |
EventTypeStatus
(表示場所:EventType)
EventTypeStatus は、EventType の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
flows.knative.dev/v1
パッケージv1はAPIのv1バージョンです。
リソースタイプ
パラレル
Parallel は、Channel と Subscription を介して直列に接続される条件付きブランチを定義します。
フィールド | 説明 | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||
spec ParallelSpec |
Spec は、Parallel の望ましい状態を定義します。
|
||||||
status ParallelStatus |
(オプション)
Status は、Parallel の現在の状態を表します。このデータは古くなっている可能性があります。 |
ParallelBranch
(表示場所:ParallelSpec)
フィールド | 説明 |
---|---|
filter knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
Filter は、ブランチをガードする式です。 |
subscriber knative.dev/pkg/apis/duck/v1.Destination |
フィルターがパスした場合にイベントを受信する Subscriber |
reply knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
Reply は、このケースの Subscriber の結果が送信される場所への参照です。指定しない場合は、結果を Parallel Reply に送信します。 |
delivery DeliverySpec |
(オプション)
Delivery は、サブスクライバーへのイベントの配信仕様です。これには、再試行、DLS などが含まれます。 |
ParallelBranchStatus
(表示場所:ParallelStatus)
ParallelBranchStatus は、Parallel ブランチの現在の状態を表します。
フィールド | 説明 |
---|---|
filterSubscriptionStatus ParallelSubscriptionStatus |
FilterSubscriptionStatus は、フィルターサブスクリプションの状態に対応します。 |
filterChannelStatus ParallelChannelStatus |
FilterChannelStatus は、フィルターチャネルの状態に対応します。 |
subscriberSubscriptionStatus ParallelSubscriptionStatus |
SubscriptionStatus は、サブスクライバーのサブスクリプションの状態に対応します。 |
ParallelChannelStatus
(表示場所:ParallelBranchStatus, ParallelStatus)
フィールド | 説明 |
---|---|
channel Kubernetes core/v1.ObjectReference |
Channel は、基になるチャネルへの参照です。 |
ready knative.dev/pkg/apis.Condition |
ReadyCondition は、Channel が準備完了かどうかを示します。 |
ParallelSpec
(表示場所:Parallel)
フィールド | 説明 |
---|---|
branches []ParallelBranch |
Branches は、Filter/Subscriber ペアのリストです。 |
channelTemplate ChannelTemplateSpec |
(オプション)
ChannelTemplate は、使用する Channel CRD を指定します。指定しない場合、名前空間のデフォルトの Channel CRD(または、名前空間にデフォルトがない場合はクラスター)に設定されます。 |
reply knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
Reply は、ケースに Reply がない場合に、ケースの Subscriber の結果が送信される場所への参照です。 |
ParallelStatus
(表示場所:Parallel)
ParallelStatus は、Parallel の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
ingressChannelStatus ParallelChannelStatus |
IngressChannelStatus は、イングレスチャネルの状態に対応します。 |
branchStatuses []ParallelBranchStatus |
BranchStatuses は、ブランチの状態に対応する配列です。Spec.Branches 配列と順序が一致します。 |
AddressStatus knative.dev/pkg/apis/duck/v1.AddressStatus |
( AddressStatus は、この Parallel の開始点です。ここに送信すると、最初のサブスクライバーがターゲットになります。一般的に、{channel}.{namespace}.svc.{cluster domain name} の形式になります。 |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authは、OIDC認証に関する関連情報を提供します。 |
AppliedEventPoliciesStatus AppliedEventPoliciesStatus |
( AppliedEventPoliciesStatusには、このBrokerに適用されるEventPoliciesのリストが含まれています |
ParallelSubscriptionStatus
(表示場所:ParallelBranchStatus)
フィールド | 説明 |
---|---|
subscription Kubernetes core/v1.ObjectReference |
Subscription は、基になるサブスクリプションへの参照です。 |
ready knative.dev/pkg/apis.Condition |
ReadyCondition は、Subscription が準備完了かどうかを示します。 |
Sequence
Sequence は、Channel と Subscription を介して直列に接続される Subscriber のシーケンスを定義します。
フィールド | 説明 | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||
spec SequenceSpec |
Spec は、Sequence の望ましい状態を定義します。
|
||||||
status SequenceStatus |
(オプション)
Status は、Sequence の現在の状態を表します。このデータは古くなっている可能性があります。 |
SequenceChannelStatus
(表示場所:SequenceStatus)
フィールド | 説明 |
---|---|
channel Kubernetes core/v1.ObjectReference |
Channel は、基になるチャネルへの参照です。 |
ready knative.dev/pkg/apis.Condition |
ReadyCondition は、Channel が準備完了かどうかを示します。 |
SequenceSpec
(表示場所:Sequence)
フィールド | 説明 |
---|---|
steps []SequenceStep |
Steps は、指定された順序で呼び出される宛先(プロセッサ/関数)のリストです。各ステップには、独自の配信オプションがあります。 |
channelTemplate ChannelTemplateSpec |
(オプション)
ChannelTemplate は、使用する Channel CRD を指定します。指定しない場合、名前空間のデフォルトの Channel CRD(または、名前空間にデフォルトがない場合はクラスター)に設定されます。 |
reply knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
Reply は、最後の Subscriber の結果が送信される場所への参照です。 |
SequenceStatus
(表示場所:Sequence)
SequenceStatus は、Sequence の現在の状態を表します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
subscriptionStatuses []SequenceSubscriptionStatus |
(オプション)
SubscriptionStatuses は、対応する Subscription ステータスの配列です。Spec.Steps 配列と順序が一致します。 |
channelStatuses []SequenceChannelStatus |
(オプション)
ChannelStatuses は、対応する Channel ステータスの配列です。Spec.Steps 配列と順序が一致します。 |
address knative.dev/pkg/apis/duck/v1.Addressable |
(オプション)
Address は、この Sequence の開始点です。ここに送信すると、最初のサブスクライバーがターゲットになります。一般的に、{channel}.{namespace}.svc.{cluster domain name} の形式になります。 |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authは、OIDC認証に関する関連情報を提供します。 |
AppliedEventPoliciesStatus AppliedEventPoliciesStatus |
( AppliedEventPoliciesStatusには、このBrokerに適用されるEventPoliciesのリストが含まれています |
SequenceStep
(表示場所:SequenceSpec)
フィールド | 説明 |
---|---|
Destination knative.dev/pkg/apis/duck/v1.Destination |
( ステップイベントを受信する Subscriber |
delivery DeliverySpec |
(オプション)
Delivery は、サブスクライバーへのイベントの配信仕様です。これには、再試行、DLS などが含まれます。 |
SequenceSubscriptionStatus
(表示場所:SequenceStatus)
フィールド | 説明 |
---|---|
subscription Kubernetes core/v1.ObjectReference |
Subscription は、基になるサブスクリプションへの参照です。 |
ready knative.dev/pkg/apis.Condition |
ReadyCondition は、Subscription が準備完了かどうかを示します。 |
messaging.knative.dev/v1
パッケージv1はAPIのv1バージョンです。
リソースタイプ
Channel
Channel は、汎用 Channel を表します。通常、Channel が必要だが、特定の Channel 実装が必要ない場合に使用されます。
フィールド | 説明 | ||||
---|---|---|---|---|---|
apiVersion string |
messaging.knative.dev/v1
|
||||
kind string |
Channel |
||||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec ChannelSpec |
Spec は、Channel の望ましい状態を定義します。
|
||||
status ChannelStatus |
(オプション)
Status は、Channel の現在の状態を表します。このデータは古くなっている可能性があります。 |
InMemoryChannel
InMemoryChannel は、インメモリチャネルを表すリソースです。
フィールド | 説明 | ||
---|---|---|---|
apiVersion string |
messaging.knative.dev/v1
|
||
kind string |
InMemoryChannel |
||
metadata Kubernetes meta/v1.ObjectMeta |
(オプション)metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||
spec InMemoryChannelSpec |
Spec は、Channel の望ましい状態を定義します。
|
||
status InMemoryChannelStatus |
(オプション)
Status は、Channel の現在の状態を表します。このデータは古くなっている可能性があります。 |
Subscription
Subscription は、Channel で受信したイベントを DNS 名にルーティングし、subscriptions.channels.knative.dev CRD に対応します。
フィールド | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|
apiVersion string |
messaging.knative.dev/v1
|
||||||||
kind string |
Subscription |
||||||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||
spec SubscriptionSpec |
|
||||||||
status SubscriptionStatus |
ChannelDefaulter
ChannelDefaulterは、実装を指定しないチャネルに対して、デフォルトのChannel CRDと引数を設定します。
ChannelSpec
(表示場所:Channel)
ChannelSpecは、このチャネルからのイベントの受信に関心を示したサブスクライバーを定義します。また、このチャネルをサポートするCRDチャネルを作成するために使用するChannelTemplateも定義します。
フィールド | 説明 |
---|---|
channelTemplate ChannelTemplateSpec |
(オプション)
ChannelTemplate は、この Channel をバックアップする CRD Channel を作成するために使用する Channel CRD を指定します。これは、作成後に変更できません。通常、これは Channel デフォルト設定ツールによって設定され、ユーザーが直接設定することはありません。 |
ChannelableSpec ChannelableSpec |
( Channel は ChannelableSpec に準拠します。 |
ChannelStatus
(表示場所:Channel)
ChannelStatusは、チャネルの現在の状態を表します。
フィールド | 説明 |
---|---|
ChannelableStatus ChannelableStatus |
( ChannelはChannelableStatusに準拠します |
channel knative.dev/pkg/apis/duck/v1.KReference |
(オプション)
Channelは、このチャネルをサポートするChannel CRDへのKReferenceです。 |
ChannelTemplateSpec
(表示場所:ParallelSpec、SequenceSpec、ChannelSpec)
フィールド | 説明 |
---|---|
spec k8s.io/apimachinery/pkg/runtime.RawExtension |
(オプション)
Specは、作成される各チャネルに使用するSpecを定義します。Channel CRDにSpecセクションとしてそのまま渡されます。 |
ChannelTemplateSpecOption
ChannelTemplateSpecOptionは、ChannelTemplateSpecのオプションの関数です。
InMemoryChannelSpec
(表示場所:InMemoryChannel)
InMemoryChannelSpecは、このInMemoryChannelからのイベントの受信に関心を示したサブスクライバーを定義します。チャネルの引数。
フィールド | 説明 |
---|---|
ChannelableSpec ChannelableSpec |
( Channel は Duck タイプ Channelable に準拠します。 |
InMemoryChannelStatus
(表示場所:InMemoryChannel)
ChannelStatusは、チャネルの現在の状態を表します。
フィールド | 説明 |
---|---|
ChannelableStatus ChannelableStatus |
( Channelは、Duck型ChannelableStatusに準拠します。 |
SubscriptionSpec
(表示場所:Subscription)
SubscriptionSpecは、受信イベントのチャネル、それらのイベントを処理するためのSubscriberターゲット、および処理結果の配置場所を指定します。From(イベントの送信元)のみが常に必須です。Replyを省略することで、オプションでイベントを処理のみ(出力イベントなし)にすることができます。また、Subscriberを省略してReplyのみを指定することで、受信イベントに対して同一変換を実行することもできます。
以下はすべて有効な仕様です。channel –[subscriber]–> reply Sink、出力イベントなし:channel – subscriber no-op関数(同一変換):channel –> reply
フィールド | 説明 |
---|---|
channel knative.dev/pkg/apis/duck/v1.KReference |
サブスクリプションを作成するために使用されるチャネルへの参照。KReference の次のフィールドのみを指定できます。 - Kind - APIVersion - Name - Namespace この KReference によって指されるリソースは、ChannelableSpec ダックタイプのコントラクトを満たす必要があります。リソースがこのコントラクトを満たしていない場合、Subscription のステータスに反映されます。 このフィールドは不変です。現在チャネル内で消費されているイベントと、そのセマンティクスはどうあるべきかについて、良い答えがありません。今のところ、Subscriptionを削除して、別のチャネルを指すように再作成することで、ユーザーは使用するセマンティクスをより細かく制御できます(最初にチャネルをドレインしたり、イベントをドロップしたりするなど)。 |
subscriber knative.dev/pkg/apis/duck/v1.Destination |
Subscriberは、イベントを処理するための関数の参照です。チャネルからのイベントはここに配信され、Replyで指定されたDestinationに返信が送信されます。 |
reply knative.dev/pkg/apis/duck/v1.Destination |
(オプション)
Replyは、Subscriberターゲットから返されたイベントの処理方法を(オプションで)指定します。 |
delivery DeliverySpec |
(オプション)
配信設定 |
SubscriptionStatus
(表示場所:Subscription)
SubscriptionのSubscriptionStatus(計算済み)
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( duck/v1 Statusを継承します。これにより、現在、次のものが提供されます。 * ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態の最新の利用可能な観測。 |
physicalSubscription SubscriptionStatusPhysicalSubscription |
PhysicalSubscriptionは、このSubscriptionが表す完全に解決された値です。 |
auth knative.dev/pkg/apis/duck/v1.AuthStatus |
(オプション)
Authは、OIDC認証に関する関連情報を提供します。 |
SubscriptionStatusPhysicalSubscription
(表示場所:SubscriptionStatus)
SubscriptionStatusPhysicalSubscriptionは、このSubscriptionの完全に解決された値を表します。
フィールド | 説明 |
---|---|
subscriberUri knative.dev/pkg/apis.URL |
(オプション)
SubscriberURIは、spec.subscriberの完全に解決されたURIです。 |
subscriberCACerts string |
(オプション)
SubscriberCACertsは、spec.subscriberの解決されたURIのhttps://www.rfc-editor.org/rfc/rfc7468に従ったPEM形式の認証局(CA)証明書です。 |
subscriberAudience string |
(オプション)
SubscriberAudienceは、spec.subscriberの解決されたURIのOIDCオーディエンスです。 |
replyUri knative.dev/pkg/apis.URL |
(オプション)
ReplyURIは、spec.replyの完全に解決されたURIです。 |
replyCACerts string |
(オプション)
ReplyCACertsは、spec.replyの解決されたURIのhttps://www.rfc-editor.org/rfc/rfc7468に従ったPEM形式の認証局(CA)証明書です。 |
replyAudience string |
(オプション)
ReplyAudienceは、spec.replyの解決されたURIのOIDCオーディエンスです。 |
DeliveryStatus DeliveryStatus |
( DeliveryStatusには、デッドレターシンクアドレスへの解決済みのURL、およびその他の解決済みの配信オプションが含まれています。 |
sinks.knative.dev/v1alpha1
パッケージv1alpha1には、sources v1alpha1 APIグループのAPIスキーマ定義が含まれています。
リソースタイプ
JobSink
JobSinkは、JobSink APIのスキーマです。
フィールド | 説明 | ||
---|---|---|---|
apiVersion string |
sinks.knative.dev/v1alpha1
|
||
kind string |
JobSink |
||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||
spec JobSinkSpec |
|
||
status JobSinkStatus |
JobSinkSpec
(表示場所:JobSink)
JobSinkSpecは、JobSinkの必要な状態を定義します。
フィールド | 説明 |
---|---|
job Kubernetes batch/v1.Job |
(オプション)
イベントが発生したときに実行するジョブ。 |
JobSinkStatus
(表示場所:JobSink)
JobSinkStatusは、JobSinkの観測された状態を定義します。
フィールド | 説明 |
---|---|
Status knative.dev/pkg/apis/duck/v1.Status |
( |
AddressStatus knative.dev/pkg/apis/duck/v1.AddressStatus |
( AddressStatusは、JobSinkがAddressable契約を満たす部分です。イベントを配信するためのエンドポイントをURIとして公開します。 |
job JobStatus |
(オプション) |
AppliedEventPoliciesStatus AppliedEventPoliciesStatus |
( AppliedEventPoliciesStatusには、このJobSinkに適用されるEventPoliciesのリストが含まれています。 |
JobStatus
(表示場所:JobSinkStatus)
フィールド | 説明 |
---|---|
selector string |
sources.knative.dev/v1
パッケージv1には、sources v1 APIグループのAPIスキーマ定義が含まれています。
リソースタイプ
ApiServerSource
ApiServerSourceは、apiserversources APIのスキーマです
フィールド | 説明 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
sources.knative.dev/v1
|
||||||||||||||
kind string |
ApiServerSource |
||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||||
spec ApiServerSourceSpec |
|
||||||||||||||
status ApiServerSourceStatus |
ContainerSource
ContainerSourceは、containersources APIのスキーマです
フィールド | 説明 | ||||
---|---|---|---|---|---|
apiVersion string |
sources.knative.dev/v1
|
||||
kind string |
ContainerSource |
||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec ContainerSourceSpec |
|
||||
status ContainerSourceStatus |
PingSource
PingSourceは、PingSources APIのスキーマです。
フィールド | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
sources.knative.dev/v1
|
||||||||||||
kind string |
PingSource |
||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||
spec PingSourceSpec |
|
||||||||||||
status PingSourceStatus |
SinkBinding
SinkBindingは、ソースでもあるバインディングを記述します。 sink
(ソースダックから)はURLに解決され、参照されるコンテナのランタイム契約を、クラウドイベントを送信するエンドポイントを保持するK_SINK
環境変数を追加することで、subject
に投影されます。
フィールド | 説明 | ||||
---|---|---|---|---|---|
apiVersion string |
sources.knative.dev/v1
|
||||
kind string |
SinkBinding |
||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||
spec SinkBindingSpec |
|
||||
status SinkBindingStatus |
APIVersionKind
(表示場所:ApiServerSourceSpec)
APIVersionKindは、APIVersionとKindのタプルです。
フィールド | 説明 |
---|---|
apiVersion string |
APIVersion - 監視するリソースのAPIバージョン。 |
kind string |
監視するリソースの種類。詳細:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
APIVersionKindSelector
(表示場所:ApiServerSourceSpec)
APIVersionKindSelectorは、LabelSelectorを使用したAPIVersion Kindのタプルです。
フィールド | 説明 |
---|---|
apiVersion string |
APIVersion - 監視するリソースのAPIバージョン。 |
kind string |
監視するリソースの種類。詳細:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
selector Kubernetes meta/v1.LabelSelector |
(オプション)
LabelSelectorは、このソースをラベルセレクターに合格したオブジェクトにフィルタリングします。詳細:http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
ApiServerSourceSpec
(表示場所:ApiServerSource)
ApiServerSourceSpecは、ApiServerSourceの必要な状態を定義します
フィールド | 説明 |
---|---|
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec |
( duck/v1 SourceSpecを継承します。現在、以下を提供しています。* Sink - ドメイン名またはURIを直接解決してシンクとして使用するオブジェクトへの参照。* CloudEventOverrides - シンクに送信されるイベントの出力形式と変更を制御するためのオーバーライドを定義します。 |
resources []APIVersionKindSelector |
Resourceは、このソースが追跡し、Kubernetes ApiServerから関連するライフサイクルイベントを送信するリソースであり、オプションのラベルセレクターを使用してフィルター処理に役立てます。 |
owner APIVersionKind |
(オプション)
ResourceOwnerは、特定のリソースタイプによって所有されているリソースのみを追跡するための追加のフィルターです。ResourceOwnerがResources [n]と一致する場合、Resources [n]はResourceOwnerフィルターを通過できます。 |
mode string |
(オプション)
EventModeは、イベントの形式を制御します。 |
serviceAccountName string |
(オプション)
ServiceAccountNameは、このソースを実行するために使用するServiceAccountの名前です。設定されていない場合は、デフォルトでdefaultになります。 |
namespaceSelector Kubernetes meta/v1.LabelSelector |
(オプション)
NamespaceSelectorは、ソースで監視する必要がある名前空間をキャプチャするためのラベルセレクターです。 |
filters []SubscriptionsAPIFilter |
(オプション)
Filtersは、CNCF CloudEventsサブスクリプションAPIに準拠する実験的なフィールドです。これは、trueまたはfalseに評価されるフィルター式の配列です。配列内のいずれかのフィルター式がfalseと評価された場合、イベントをシンクに送信してはなりません。配列内のすべてのフィルター式がtrueと評価された場合、イベントの配信を試みる必要があります。フィルターがない場合、または空の配列の場合は、trueの値が暗黙的に指定されます。 |
ApiServerSourceStatus
(表示場所:ApiServerSource)
ApiServerSourceStatusは、ApiServerSourceの観測された状態を定義します
フィールド | 説明 |
---|---|
SourceStatus knative.dev/pkg/apis/duck/v1.SourceStatus |
( duck/v1 SourceStatusを継承します。現在、以下を提供しています。* ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。* SinkURI - ソースに構成されている現在アクティブなシンクURI。 |
namespaces []string |
Namespacesは、ApiServerSourceによって現在監視されている名前空間を示します |
ContainerSourceSpec
(表示場所:ContainerSource)
ContainerSourceSpecは、ContainerSourceの必要な状態を定義します
フィールド | 説明 |
---|---|
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec |
( duck/v1 SourceSpecを継承します。現在、以下を提供しています。* Sink - ドメイン名またはURIを直接解決してシンクとして使用するオブジェクトへの参照。* CloudEventOverrides - シンクに送信されるイベントの出力形式と変更を制御するためのオーバーライドを定義します。 |
template Kubernetes core/v1.PodTemplateSpec |
Templateは、作成されるポッドを記述します |
ContainerSourceStatus
(表示場所:ContainerSource)
ContainerSourceStatusは、ContainerSourceの観測された状態を定義します
フィールド | 説明 |
---|---|
SourceStatus knative.dev/pkg/apis/duck/v1.SourceStatus |
( duck/v1 SourceStatusを継承します。現在、以下を提供しています。* ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。* SinkURI - ソースに構成されている現在アクティブなシンクURI。 |
PingSourceSpec
(表示場所:PingSource)
PingSourceSpecは、PingSourceの必要な状態を定義します。
フィールド | 説明 |
---|---|
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec |
( duck/v1 SourceSpecを継承します。現在、以下を提供しています。* Sink - ドメイン名またはURIを直接解決してシンクとして使用するオブジェクトへの参照。* CloudEventOverrides - シンクに送信されるイベントの出力形式と変更を制御するためのオーバーライドを定義します。 |
schedule string |
(オプション)
Scheduleは、cronスケジュールです。デフォルトは |
timezone string |
Timezoneは、指定されたタイムゾーンを基準にして実際の時間を変更します。デフォルトはシステムタイムゾーンです。タイムゾーンに関する一般的な情報:https://www.iana.org/time-zones 有効なタイムゾーン値のリスト:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
contentType string |
(オプション)
ContentTypeは、DataまたはDataBase64のメディアタイプです。デフォルトは空です。 |
data string |
(オプション)
Dataは、シンクに投稿されたイベントの本文として使用されるデータです。デフォルトは空です。DataBase64と相互に排他的です。 |
dataBase64 string |
(オプション)
DataBase64は、シンクに投稿された実際のイベントの本文のbase64エンコードされた文字列です。デフォルトは空です。Dataと相互に排他的です。 |
PingSourceStatus
(表示場所:PingSource)
PingSourceStatusは、PingSourceの観測された状態を定義します。
フィールド | 説明 |
---|---|
SourceStatus knative.dev/pkg/apis/duck/v1.SourceStatus |
( duck/v1 SourceStatusを継承します。現在、以下を提供しています。* ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。* SinkURI - ソースに構成されている現在アクティブなシンクURI。 |
SinkBindingSpec
(表示場所:SinkBinding)
SinkBindingSpecは、SinkBindingの必要な状態(クライアントから)を保持します。
フィールド | 説明 |
---|---|
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec |
( duck/v1 SourceSpecを継承します。現在、以下を提供しています。* Sink - ドメイン名またはURIを直接解決してシンクとして使用するオブジェクトへの参照。* CloudEventOverrides - シンクに送信されるイベントの出力形式と変更を制御するためのオーバーライドを定義します。 |
BindingSpec knative.dev/pkg/apis/duck/v1.BindingSpec |
( duck/v1 BindingSpecを継承します。現在、以下を提供しています。* Subject - Subjectは、Binding実装によって「ランタイム契約」を拡張する必要があるリソースを参照します。 |
SinkBindingStatus
(表示場所:SinkBinding)
SinkBindingStatusは、SinkBindingの観測された状態(コントローラーから)を伝えます。
フィールド | 説明 |
---|---|
SourceStatus knative.dev/pkg/apis/duck/v1.SourceStatus |
( duck/v1 SourceStatusを継承します。現在、以下を提供しています。* ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。* SinkURI - ソースに構成されている現在アクティブなシンクURI。 |
oidcTokenSecretName string |
OIDCTokenSecretNameは、このSinkBindingのOIDC認証用のトークンを含むシークレットの名前です |
sources.knative.dev/v1beta2
パッケージv1beta2には、sources v1beta2 APIグループのAPIスキーマ定義が含まれています。
リソースタイプ
PingSource
PingSourceは、PingSources APIのスキーマです。
フィールド | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string |
sources.knative.dev/v1beta2
|
||||||||||||
kind string |
PingSource |
||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
metadata フィールドのフィールドについては、Kubernetes APIドキュメントを参照してください。 |
||||||||||||
spec PingSourceSpec |
|
||||||||||||
status PingSourceStatus |
PingSourceSpec
(参照元:PingSource)
PingSourceSpecは、PingSourceの必要な状態を定義します。
フィールド | 説明 |
---|---|
SourceSpec knative.dev/pkg/apis/duck/v1.SourceSpec |
( duck/v1 SourceSpecを継承します。現在、以下を提供しています。* Sink - ドメイン名またはURIを直接解決してシンクとして使用するオブジェクトへの参照。* CloudEventOverrides - シンクに送信されるイベントの出力形式と変更を制御するためのオーバーライドを定義します。 |
schedule string |
(オプション)
Scheduleは、cronスケジュールです。デフォルトは |
timezone string |
Timezoneは、指定されたタイムゾーンを基準にして実際の時間を変更します。デフォルトはシステムタイムゾーンです。タイムゾーンに関する一般的な情報:https://www.iana.org/time-zones 有効なタイムゾーン値のリスト:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
contentType string |
(オプション)
ContentTypeは、DataまたはDataBase64のメディアタイプです。デフォルトは空です。 |
data string |
(オプション)
Dataは、シンクに投稿されたイベントの本文として使用されるデータです。デフォルトは空です。DataBase64と相互に排他的です。 |
dataBase64 string |
(オプション)
DataBase64は、シンクに投稿された実際のイベントの本文のbase64エンコードされた文字列です。デフォルトは空です。Dataと相互に排他的です。 |
PingSourceStatus
(参照元:PingSource)
PingSourceStatusは、PingSourceの観測された状態を定義します。
フィールド | 説明 |
---|---|
SourceStatus knative.dev/pkg/apis/duck/v1.SourceStatus |
( duck/v1 SourceStatusを継承します。現在、以下を提供しています。* ObservedGeneration - コントローラーによって最後に処理されたサービスの「Generation」。* Conditions - リソースの現在の状態に関する最新の利用可能な観測。* SinkURI - ソースに構成されている現在アクティブなシンクURI。 |
gen-crd-api-reference-docs
で生成。