Share via

Application Gateway for Containers の Kubernetes 用の API 仕様

  • [アーティクル]

パッケージ

パッケージ v1 は、この API の v1 バージョンです。

alb.networking.azure.io/v1

このドキュメントでは、alb.networking.azure.io/v1 の各リソースの種類を定義します。

リソースの種類:

AffinityType (string alias)

(出現箇所:SessionAffinity)

AffinityType は、サービスのアフィニティの種類を定義します

値 説明

"application-cookie"

AffinityTypeApplicationCookie は、アプリケーション Cookie のセッション アフィニティの種類です

"managed-cookie"

AffinityTypeManagedCookie は、マネージド Cookie のセッション アフィニティの種類です

AlbConditionReason (string alias)

AlbConditionReason は、Application Gateway for Containers リソースで特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

AlbReasonAccepted は、Application Gateway for Containers リソースがコントローラーによって受け入れられていることを示します。

"Ready"

AlbReasonDeploymentReady は、Application Gateway for Containers リソースのデプロイの状態を示します。

"InProgress"

AlbReasonInProgress は、Application Gateway for Containers リソースが作成、更新、または削除されている最中であるかどうかを示します。

AlbConditionType (string alias)

AlbConditionType は、Application Gateway for Containers リソースに関連付けられている状態の種類です。 この種類は、AlbStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

AlbConditionTypeAccepted は、Application Gateway for Containers リソースがコントローラーによって受け入れられているかどうかを示します。

"Deployment"

AlbConditionTypeDeployment は、Application Gateway for Containers リソースのデプロイの状態を示します。

AlbSpec

(出現箇所:ApplicationLoadBalancer)

AlbSpec は、Application Gateway for Containers リソースの仕様を定義します。

フィールド 説明
associations
[]string

associations は、Application Gateway for Containers リソースが関連付けられているサブネット リソース ID です。

AlbStatus

(出現箇所:ApplicationLoadBalancer)

AlbStatus は、Application Gateway for Containers リソースの観察された状態を定義します。

フィールド 説明
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

既知の状態の種類は次のとおりです。

  • “承認済み”
  • “Ready”

ApplicationLoadBalancer

ApplicationLoadBalancer は、Application Gateway for Containers リソースのスキーマです。

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
AlbSpec

spec は、Application Gateway for Containers リソースの仕様です。



associations
[]string

associations は、Application Gateway for Containers リソースが関連付けられているサブネット リソース ID です。
status
AlbStatus

status は、Application Gateway for Containers リソースの現在の状態を定義します。

BackendTLSPolicy

BackendTLSPolicy は、BackendTLSPolicys API のスキーマです

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
BackendTLSPolicySpec

spec は、BackendTLSPolicy 仕様です。



targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
BackendTLSPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
BackendTLSPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。
status
BackendTLSPolicyStatus

status は、BackendTLSPolicy の現在の状態を定義します。

BackendTLSPolicyConditionReason (string alias)

BackendTLSPolicyConditionReason は、BackendTLSPolicy の特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

BackendTLSPolicyReasonAccepted は、指定された BackendTLSPolicy が正しく構成されている場合に BackendTLSPolicyConditionReason を Accepted に設定するために使用されます

"InvalidBackendTLSPolicy"

BackendTLSPolicyReasonInvalid は、BackendTLSPolicy が受け入れられ’ない場合の理由です

"InvalidCertificateRef"

BackendTLSPolicyReasonInvalidCertificateRef は、無効な証明書が参照されている場合に使用されます

"InvalidGroup"

BackendTLSPolicyReasonInvalidGroup は、group が無効な場合に使用されます

"InvalidKind"

BackendTLSPolicyReasonInvalidKind は、kind/group が無効な場合に使用されます

"InvalidName"

BackendTLSPolicyReasonInvalidName は、name が無効な場合に使用されます

"InvalidSecret"

BackendTLSPolicyReasonInvalidSecret は、Secret が無効な場合に使用されます

"InvalidService"

BackendTLSPolicyReasonInvalidService は、Service が無効な場合に使用されます

"NoTargetReference"

BackendTLSPolicyReasonNoTargetReference は、ターゲット参照がない場合に使用されます

"OverrideNotSupported"

BackendTLSPolicyReasonOverrideNotSupported は、オーバーライドがサポートされていない場合に使用されます

"RefNotPermitted"

BackendTLSPolicyReasonRefNotPermitted は、参照が許可されて’いない場合に使用されます

"SectionNamesNotPermitted"

BackendTLSPolicyReasonSectionNamesNotPermitted は、セクション名が許可されていない場合に使用されます

BackendTLSPolicyConditionType (string alias)

BackendTLSPolicyConditionType は、BackendTLSPolicy に関連付けられている状態の種類です。 この種類は、BackendTLSPolicyStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

BackendTLSPolicyConditionAccepted は、BackendTLSPolicyConditionType を Accepted に設定するために使用されます

"ResolvedRefs"

BackendTLSPolicyConditionResolvedRefs は、BackendTLSPolicyCondition を ResolvedRefs に設定するために使用されます

BackendTLSPolicyConfig

(出現箇所:BackendTLSPolicySpec)

BackendTLSPolicyConfig は、バックエンド TLS ポリシーのポリシー仕様を定義します。

フィールド 説明
CommonTLSPolicy
CommonTLSPolicy

(CommonTLSPolicy のメンバーはこの種類に埋め込まれます)。
sni
string 		(省略可)

sni は、バックエンドへの TLS 接続に使用するサーバー名です。
ports
[]BackendTLSPolicyPort

ports は、このポリシーが適用されるポートの一覧を指定します。
clientCertificateRef
Gateway API .SecretObjectReference 		(省略可)

ClientCertificateRef は、バックエンドへの TLS 接続に使用するクライアント証明書への参照です。

BackendTLSPolicyPort

(出現箇所:BackendTLSPolicyConfig)

BackendTLSPolicyPort は、バックエンドへの TLS 接続に使用するポートを定義します

フィールド 説明
port
int

port は、バックエンドへの TLS 接続に使用するポートです。

BackendTLSPolicySpec

(出現箇所:BackendTLSPolicy)

BackendTLSPolicySpec は、BackendTLSPolicy の目的の状態を定義します

フィールド 説明
targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
BackendTLSPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
BackendTLSPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。

BackendTLSPolicyStatus

(出現箇所:BackendTLSPolicy)

BackendTLSPolicyStatus は、BackendTLSPolicy の観察された状態を定義します。

フィールド 説明
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

conditions は、BackendTLSPolicy の現在の状態を表します。

実装では、オペレーターやツールが BackendTLSPolicy の状態を表すために共通のボキャブラリに集中できるように、BackendTLSPolicyConditionType と BackendTLSPolicyConditionReason の定数を使用して BackendTLSPolicy の状態を表すようにする必要があります。

既知の状態の種類は次のとおりです。

  • “承認済み”

CommonTLSPolicy

(出現箇所:BackendTLSPolicyConfig)

CommonTLSPolicy は、CommonTLSPolicy API のスキーマです

フィールド 説明
verify
CommonTLSPolicyVerify 		(省略可)

verify は、バックエンド証明書を検証するためのオプションを示します

CommonTLSPolicyVerify

(出現箇所:CommonTLSPolicy)

CommonTLSPolicyVerify は、CommonTLSPolicyVerify API のスキーマを定義します

フィールド 説明
caCertificateRef
Gateway API .SecretObjectReference

CaCertificateRef は、バックエンドのピア証明書を検証するために使用される CA 証明書です。
subjectAltName
string

SubjectAltName は、バックエンドのピア証明書を検証するために使用されるサブジェクトの別名です。

CustomTargetRef

(出現箇所:BackendTLSPolicySpec、FrontendTLSPolicySpec、HealthCheckPolicySpec、RoutePolicySpec)

CustomTargetRef は、Kubernetes コア API の一部では’ないカスタム リソースへの参照です。

フィールド 説明
PolicyTargetReference
Gateway API .PolicyTargetReference

(PolicyTargetReference のメンバーはこの種類に埋め込まれます)。
sectionNames
[]string 		(省略可)

SectionNames は、ターゲット リソース内のセクションの名前です。 指定しない場合、この targetRef はリソース全体を対象とします。 以下のリソースでは、SectionNames は次のように解釈されます。

  • ゲートウェイ: リスナー名
  • サービス: ポート名

SectionNames が指定されているが、対象となるオブジェクトに存在しない場合、ポリシーのアタッチは失敗し、ポリシーの実装ではポリシーの状態に ResolvedRefs または類似の状態が記録されます。

FrontendTLSPolicy

FrontendTLSPolicy は、FrontendTLSPolicy API のスキーマです

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
FrontendTLSPolicySpec

spec は、FrontendTLSPolicy 仕様です。



targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
default
FrontendTLSPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。
override
FrontendTLSPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
status
FrontendTLSPolicyStatus

status は、FrontendTLSPolicy の現在の状態を定義します。

FrontendTLSPolicyConditionReason (string alias)

FrontendTLSPolicyConditionReason は、FrontendTLSPolicy の特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

FrontendTLSPolicyReasonAccepted は、指定された FrontendTLSPolicy が正しく構成されている場合に FrontendTLSPolicyConditionReason を Accepted に設定するために使用されます

"InvalidFrontendTLSPolicy"

FrontendTLSPolicyReasonInvalid は、FrontendTLSPolicy が受け入れられ’ない場合の理由です

"InvalidGateway"

FrontendTLSPolicyReasonInvalidGateway は、gateway が無効な場合に使用されます

"InvalidGroup"

FrontendTLSPolicyReasonInvalidGroup は、group が無効な場合に使用されます

"InvalidKind"

FrontendTLSPolicyReasonInvalidKind は、kind/group が無効な場合に使用されます

"InvalidName"

FrontendTLSPolicyReasonInvalidName は、name が無効な場合に使用されます

"InvalidPolicyName"

FrontendTLSPolicyReasonInvalidPolicyName は、policy name が無効な場合に使用されます

"InvalidPolicyType"

FrontendTLSPolicyReasonInvalidPolicyType は、policy type が無効な場合に使用されます

"NoTargetReference"

FrontendTLSPolicyReasonNoTargetReference は、ターゲット参照がない場合に使用されます

"OverrideNotSupported"

FrontendTLSPolicyReasonOverrideNotSupported は、オーバーライドがサポートされていない場合に使用されます

"RefNotPermitted"

FrontendTLSPolicyReasonRefNotPermitted は、参照が許可されて’いない場合に使用されます

"SectionNamesNotPermitted"

FrontendTLSPolicyReasonSectionNamesNotPermitted は、セクション名が許可されていない場合に使用されます

FrontendTLSPolicyConditionType (string alias)

FrontendTLSPolicyConditionType は、FrontendTLSPolicy に関連付けられている状態の種類です。 この種類は、FrontendTLSPolicyStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

FrontendTLSPolicyConditionAccepted は、FrontendTLSPolicyCondition を Accepted に設定するために使用されます

"ResolvedRefs"

FrontendTLSPolicyConditionResolvedRefs は、FrontendTLSPolicyCondition を ResolvedRefs に設定するために使用されます

FrontendTLSPolicyConfig

(出現箇所:FrontendTLSPolicySpec)

FrontendTLSPolicyConfig は、フロントエンド TLS ポリシーのポリシー仕様を定義します。

フィールド 説明
policyType
PolicyType

type は、ポリシーの種類です。

FrontendTLSPolicySpec

(出現箇所:FrontendTLSPolicy)

FrontendTLSPolicySpec は、FrontendTLSPolicy の目的の状態を定義します

フィールド 説明
targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
default
FrontendTLSPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。
override
FrontendTLSPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。

FrontendTLSPolicyStatus

(出現箇所:FrontendTLSPolicy)

FrontendTLSPolicyStatus は、FrontendTLSPolicy の観察された状態を定義します。

フィールド 説明
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

conditions は、FrontendTLSPolicy の現在の状態を表します。

実装では、オペレーターやツールが FrontendTLSPolicy の状態を表すために共通のボキャブラリに集中できるように、FrontendTLSPolicyConditionType と FrontendTLSPolicyConditionReason の定数を使用して FrontendTLSPolicy の状態を表すようにする必要があります。

既知の状態の種類は次のとおりです。

  • “承認済み”

FrontendTLSPolicyType (string alias)

(出現箇所:PolicyType)

FrontendTLSPolicyType は、フロントエンド TLS ポリシーの種類です。

値 説明

"predefined"

PredefinedFrontendTLSPolicyType は、定義済みのフロントエンド TLS ポリシーの種類です。

FrontendTLSPolicyTypeName (string alias)

(出現箇所:PolicyType)

FrontendTLSPolicyName は、フロントエンド TLS ポリシーの名前です。

Value 説明

"2023-06"

PredefinedPolicy202306 は、ポリシー “2023-06” の定義済みフロントエンド TLS ポリシーの名前です。

"2023-06-S"

PredefinedPolicy202306Strict は、ポリシー “2023-06-S” の定義済みフロントエンド TLS ポリシーの名前です。 これは、ポリシー “2023-06” の厳密なバージョンです。

HTTPHeader

(出現箇所:HeaderFilter)

HTTPHeader は、RFC 7230 で定義された HTTP ヘッダー名と値を表します。

フィールド 説明
name
HTTPHeaderName

Name は、一致する HTTP ヘッダーの名前です。 Name が一致するかどうかを判断する際、大文字と小文字を区別しないものである必要があります。 (https://tools.ietf.org/html/rfc7230#section-3.2 参照)。

複数のエントリで同等のヘッダー名が指定される場合、同等の名前を持つ最初のエントリを一致のために考慮する必要があります。 同等のヘッダー名を持つ以降のエントリは無視する必要があります。 ヘッダー名の大文字と小文字は区別されないため、“foo” と “Foo” は同等とみなされます。
value
string

値は、一致する HTTP ヘッダーの値です。

HTTPHeaderName (string エイリアス)

(出現箇所:HTTPHeader)

HTTPHeaderName は、HTTP ヘッダーの名前です。

有効な値は、次のとおりです。

  • “承認”
  • “Set-Cookie”

無効な値は次のとおりです。

  • ”:method” - “:” は無効な文字です。 これは、HTTP/2 疑似ヘッダーは現在この型ではサポートされていないことを意味します。
  • ”/invalid” - “/ ” は無効な文字です

HTTPMatch

(出現箇所:HTTPSpecifiers)

HTTPMatch は、HealthCheck チェックに使用する HTTP マッチャーを定義します。

フィールド 説明
body
string 		(省略可)

body は、HealthCheck チェックに使用する HTTP 本文マッチャーを定義します。
statusCodes
[]StatusCodes 		(省略可)

statusCodes は、HealthCheck チェックに使用する HTTP 状態コード マッチャーを定義します。

HTTPPathModifier

(出現箇所:Redirect、URLRewriteFilter)

HTTPPathModifier はパス修飾子の構成を定義します。

フィールド 説明
type
HTTPPathModifierType

Type はパス修飾子の種類を定義します。 API の将来のリリースでは、Type が追加される可能性があります。

この列挙型に値を追加することができますが、不明な値がクラッシュを引き起こさないように実装する必要があります。

ここで不明な値は、実装がルールの Accepted Condition を false に設定する必要があります
replaceFullPath
string 		(省略可)

ReplacePrefixMatch では、再書き込みやリダイレクトの際に要求の完全なパスを置き換える値が指定されます。
replacePrefixMatch
string 		(省略可)

ReplacePrefixMatch では、再書き込みやリダイレクトの際に要求のプレフィックスの一致を置き換える値が指定されます。 たとえば、“/foo” のプレフィックスの一致を持つ “/foo/bar” への要求と “/xyz” の ReplacePrefixMatch は、“/xyz/bar” に修正されます。

これは PathPrefix の一致の種類の動作と一致します。 これは、完全なパスの要素に一致します。 パス要素は、/ 区切りで分割されたパスのラベルの一覧を指します。 指定すると、末尾の / は無視されます。 たとえば、パス /abc、/abc/、/abc/def はすべてプレフィックス /abc に一致しますが、パス /abcd は一致しません。

ReplacePrefixMatch は PathPrefix HTTPRouteMatch とのみ互換性があります。 同じ HTTPRouteRule で他の HTTPRouteMatch 型を使用すると、実装でルートの Accepted Condition が status: False に設定されます。

要求パス プレフィックスの一致 プレフィックスの置換 変更されたパス
/foo/bar /foo /xyz /xyz/bar
/foo/bar /foo /xyz/ /xyz/bar
/foo/bar /foo/ /xyz /xyz/bar
/foo/bar /foo/ /xyz/ /xyz/bar
/foo /foo /xyz /xyz
/foo/ /foo /xyz /xyz/
/foo/bar /foo   /bar
/foo/ /foo   /
/foo /foo   /
/foo/ /foo / /
/foo /foo / /

HTTPPathModifierType (string エイリアス)

(出現箇所:HTTPPathModifier)

HTTPPathModifierType は、パスのリダイレクトや書き換えの種類を定義します。

Value 説明

"ReplaceFullPath"

FullPathHTTPPathModifier は、完全なパスを、指定した値に置き換えます。

"ReplacePrefixMatch"

PrefixMatchHTTPPathModifier は、プレフィックスのパスを置換値に置き換えます。 たとえば、“/foo” のプレフィックスの一致を持つ、ReplacePrefixMatch の置換が “/bar” のパスは、照合要求で “/foo” が “/bar” に置き換えられます。

これは PathPrefix の一致の種類の動作と一致します。 これは、完全なパスの要素に一致します。 パス要素は、/ 区切りで分割されたパスのラベルの一覧を指します。 指定すると、末尾の / は無視されます。 たとえば、パス /abc、/abc/、/abc/def はすべてプレフィックス /abc に一致しますが、パス /abcd は一致しません。

HTTPSpecifiers

(出現箇所:HealthCheckPolicyConfig)

HTTPSpecifiers は、HTTP HealthCheck チェック仕様のスキーマを定義します

フィールド 説明
host
string 		(省略可)

host は、HealthCheck チェックに使用するホスト ヘッダーの値です。
path
string 		(省略可)

path は、HealthCheck チェックに使用するパスです。
match
HTTPMatch 		(省略可)

match は、HealthCheck チェックに使用する HTTP マッチャーを定義します。

HeaderFilter

(出現箇所:IngressRewrites)

HeaderFilter は、HTTP 要求や応答のヘッダーを変更するフィルターを定義します。 指定されたヘッダー名に対するアクションは 1 つしか許可されません。 1 つのヘッダー名に対して同じか異なる種類の複数のアクションを指定するフィルターは無効であり、拒否されます。 ヘッダーに複数の値を設定または追加する構成では、それぞれの値をコンマで区切る RFC 7230 ヘッダー値の書式を使用する必要があります。

フィールド 説明
set
[]HTTPHeader 		(省略可)

Set は、アクションの前に指定されたヘッダー (名前、値) で要求を上書きします。

入力: GET /foo HTTP/1.1 my-header: foo

構成: set: - name: “my-header” value: “bar”

出力: GET /foo HTTP/1.1 my-header: bar
add
[]HTTPHeader 		(省略可)

Add は、アクションの前に指定されたヘッダー (名前、値) を要求に追加します。 これは、ヘッダー名に関連付けられた既存の値に追加されます。

入力: GET /foo HTTP/1.1 my-header: foo

構成: add: - name: “my-header” value: “bar,baz”

出力: GET /foo HTTP/1.1 my-header: foo,bar,baz
remove
[]string 		(省略可)

Remove は、アクションの前に指定されたヘッダーを HTTP 要求から削除します。 Remove の値は HTTP ヘッダー名の一覧です。 ヘッダー名は大文字と小文字が区別されません (https://datatracker.ietf.org/doc/html/rfc2616#section-4.2) を参照)。

入力: GET /foo HTTP/1.1 my-header1: foo my-header2: bar my-header3: baz

構成: remove: [“my-header1”, “my-header3”]

出力: GET /foo HTTP/1.1 my-header2: bar

HeaderName (string エイリアス)

HeaderName はヘッダーまたはクエリ パラメーターの名前です。

HealthCheckPolicy

HealthCheckPolicy は、HealthCheckPolicy API のスキーマです

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
HealthCheckPolicySpec

spec は、HealthCheckPolicy 仕様です。



targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
HealthCheckPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
HealthCheckPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。
status
HealthCheckPolicyStatus

status は、HealthCheckPolicy の現在の状態を定義します。

HealthCheckPolicyConditionReason (string alias)

HealthCheckPolicyConditionReason は、HealthCheckPolicy の特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

HealthCheckPolicyReasonAccepted は、指定された HealthCheckPolicy が正しく構成されている場合に HealthCheckPolicyConditionReason を Accepted に設定するために使用されます

"InvalidHealthCheckPolicy"

HealthCheckPolicyReasonInvalid は、HealthCheckPolicy が受け入れられ’ない場合の理由です

"InvalidGroup"

HealthCheckPolicyReasonInvalidGroup は、group が無効な場合に使用されます

"InvalidKind"

HealthCheckPolicyReasonInvalidKind は、kind/group が無効な場合に使用されます

"InvalidName"

HealthCheckPolicyReasonInvalidName は、name が無効な場合に使用されます

"InvalidPort"

HealthCheckPolicyReasonInvalidPort は、port が無効な場合に使用されます

"InvalidService"

HealthCheckPolicyReasonInvalidService は、Service が無効な場合に使用されます

"NoTargetReference"

HealthCheckPolicyReasonNoTargetReference は、ターゲット参照がない場合に使用されます

"OverrideNotSupported"

HealthCheckPolicyReasonOverrideNotSupported は、オーバーライドがサポートされていない場合に使用されます

"RefNotPermitted"

HealthCheckPolicyReasonRefNotPermitted は、参照が許可されて’いない場合に使用されます

"SectionNamesNotPermitted"

HealthCheckPolicyReasonSectionNamesNotPermitted は、セクション名が許可されていない場合に使用されます

HealthCheckPolicyConditionType (string alias)

HealthCheckPolicyConditionType は、HealthCheckPolicy に関連付けられている状態の種類です。 この種類は、HealthCheckPolicyStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

HealthCheckPolicyConditionAccepted は、HealthCheckPolicyConditionType を Accepted に設定するために使用されます

"ResolvedRefs"

HealthCheckPolicyConditionResolvedRefs は、HealthCheckPolicyCondition を ResolvedRefs に設定するために使用されます

HealthCheckPolicyConfig

(出現箇所:HealthCheckPolicySpec)

HealthCheckPolicyConfig は、HealthCheck チェック仕様のスキーマを定義します

フィールド 説明
interval
Kubernetes meta/v1.Duration 		(省略可)

interval は、HealthCheck チェック間の秒数です。
timeout
Kubernetes meta/v1.Duration 		(省略可)

timeout は、HealthCheck チェックが失敗したと見なされるまでの秒数です。
unhealthyThreshold
int32 		(省略可)

UnhealthyThreshold は、連続して失敗した HealthCheck チェックの回数です
healthyThreshold
int32 		(省略可)

HealthyThreshold は、連続して成功した HealthCheck チェックの回数です
http
HTTPSpecifiers 		(省略可)

HTTP は、ターゲット リソースの HealthCheck に関する HTTP 制約仕様を定義します。

HealthCheckPolicySpec

(出現箇所:HealthCheckPolicy)

HealthCheckPolicySpec は、HealthCheckPolicy の目的の状態を定義します

フィールド 説明
targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
HealthCheckPolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
HealthCheckPolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。

HealthCheckPolicyStatus

(出現箇所:HealthCheckPolicy)

HealthCheckPolicyStatus は、HealthCheckPolicy の観察された状態を定義します。

フィールド 説明
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

conditions は、HealthCheckPolicy の現在の状態を表します。

実装では、オペレーターやツールが HealthCheckPolicy の状態を表すために共通のボキャブラリに集中できるように、HealthCheckPolicyConditionType と HealthCheckPolicyConditionReason の定数を使用して HealthCheckPolicy の状態を表すようにする必要があります。

既知の状態の種類は次のとおりです。

  • “承認済み”

IngressBackendPort

(出現箇所:IngressBackendSettings)

IngressBackendPort は、バックエンド上のポートを表します。 name と number のうちの 1 つだけを定義する必要があります。

フィールド 説明
port
int32 		(省略可)

Port はバックエンド サービスのポートを示します
name
string 		(省略可)

name は、バックエンド サービス上のポートの名前を参照している必要があります
protocol
Protocol

protocol は、“HTTP” と “HTTPS” のどちらかである必要があります

IngressBackendSettingStatus

(出現箇所:IngressExtensionStatus)

IngressBackendSettingStatus は、BackendSetting の状態を表します

フィールド 説明
service
string

service は、この状態が表す BackendSetting を識別します。
validationErrors
[]string 		(省略可)

errors は、この設定に関連するエラーの一覧です
valid
bool

valid は、この BackendSetting に検証エラーが存在しないことを示します

IngressBackendSettings

(出現箇所:IngressExtensionSpec)

IngressBackendSettings は、バックエンド サービスの拡張された構成オプションを示します

フィールド 説明
service
string

service は、この構成が適用されるバックエンド サービスの名前です
ports
[]IngressBackendPort 		(省略可)

ports を使用すると、バックエンド サービスが HTTP と HTTPS のどちらでリッスンしているかを示すことができます
trustedRootCertificate
string 		(省略可)

TrustedRootCertificate を使用すると、HTTPS として指定されたポートでバックエンドに通信しているときに、ゲートウェイで信頼する証明書を指定できます
sessionAffinity
SessionAffinity 		(省略可)

SessionAffinity を使用すると、クライアント要求を常に同じバックエンドに渡すことができます
timeouts
IngressTimeouts 		(省略可)

timeouts は、イングレスに適用される一連のタイムアウト パラメーターを定義します

IngressExtension

IngressExtension は、IngressExtension API のスキーマです

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
IngressExtensionSpec

spec は、IngressExtension 仕様です。



rules
[]IngressRuleSetting 		(省略可)

rules はホストごとの規則を定義します
backendSettings
[]IngressBackendSettings 		(省略可)

BackendSettings は、イングレス サービス バックエンドの一連の構成オプションを定義します
status
IngressExtensionStatus

IngressExtensionConditionReason (string alias)

IngressExtensionConditionReason は、IngressExtension の特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

IngressExtensionReasonAccepted は、IngressExtensionConditionAccepted を Accepted に設定するために使用されます

"HasValidationErrors"

IngressExtensionReasonHasErrors は、いくつかの検証エラーがあることを示します

"NoValidationErrors"

IngressExtensionReasonNoErrors は、検証エラーがないことを示します

"PartiallyAcceptedWithErrors"

IngressExtensionReasonPartiallyAccepted は、IngressExtensionConditionAccepted を Accepted (ただし、致命的でない検証エラーを含む) に設定するために使用されます

IngressExtensionConditionType (string alias)

IngressExtensionConditionType は、IngressExtension に関連付けられている状態の種類です。 この種類は、IngressExtensionStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

IngressExtensionConditionAccepted は、IngressExtension がコントローラーによって受け入れられている (調整された) かどうかを示します

"Errors"

IngressExtensionConditionErrors は、拡張機能に検証またはビルド エラーがあるかどうかを示します

IngressExtensionSpec

(出現箇所:IngressExtension)

IngressExtensionSpec は、IngressExtension の目的の構成を定義します

フィールド 説明
rules
[]IngressRuleSetting 		(省略可)

rules はホストごとの規則を定義します
backendSettings
[]IngressBackendSettings 		(省略可)

BackendSettings は、イングレス サービス バックエンドの一連の構成オプションを定義します

IngressExtensionStatus

(出現箇所:IngressExtension)

IngressExtensionStatus は、IngressExtension の現在の状態を表します

フィールド 説明
rules
[]IngressRuleStatus 		(省略可)

rules には、各 Rule に関する詳細な状態情報が含まれます
backendSettings
[]IngressBackendSettingStatus 		(省略可)

BackendSettings には、各 BackendSettings に関する詳細な状態情報があります
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

conditions は、IngressExtension の現在の状態を表します。 既知の状態の種類は次のとおりです。

  • “承認済み”
  • “エラー”

IngressRewrites

(出現箇所:IngressRuleSetting)

IngressRewrites には、Rule でサポートされるさまざまな再書き込みが用意されています

フィールド 説明
type
RewriteType

Type は、再書き込みの種類を指定します
requestHeaderModifier
HeaderFilter 		(省略可)

RequestHeaderModifier は、要求ヘッダーを変更するスキーマを定義します。
responseHeaderModifier
HeaderFilter 		(省略可)

RequestHeaderModifier は、応答ヘッダーを変更するスキーマを定義します。
urlRewrite
URLRewriteFilter 		(省略可)

URLRewrite は、転送中に要求を変更するスキーマを定義します。

IngressRuleSetting

(出現箇所:IngressExtensionSpec)

IngressRuleSetting は、Rule の構成オプションを示します

フィールド 説明
host
string

host は、どの規則がこれらの設定の影響を受けるかを識別するために、同じホスト名を持つイングレス規則と照合するために使用されます
additionalHostnames
[]string 		(省略可)

AdditionalHostnames は、リッスンする追加のホスト名を指定します
rewrites
[]IngressRewrites 		(省略可)

Rewrites は、Rule の再書き換えを定義します
requestRedirect
Redirect 		(省略可)

RequestRedirect は、Rule のリダイレクト動作を定義します

IngressRuleStatus

(出現箇所:IngressExtensionStatus)

IngressRuleStatus は、Rule の状態を記述します

フィールド 説明
host
string

host は、この状態が表す Rule を識別します
validationErrors
[]string 		(省略可)

errors は、この設定に関連するエラーの一覧です
valid
bool 		(省略可)

valid は、この Rule に検証エラーが存在しないことを示します

IngressTimeouts

(出現箇所:IngressBackendSettings)

IngressTimeouts を使用すると、イングレスのタイムアウト プロパティを構成できます

フィールド 説明
requestTimeout
Kubernetes meta/v1.Duration 		(省略可)

requestTimeout は、バックエンド サービスに要求を転送しているときに、ロード バランサーによって使用されるタイムアウトを定義します

PolicyType

(出現箇所:FrontendTLSPolicyConfig)

PolicyType は、ポリシーの種類です。

フィールド 説明
name
FrontendTLSPolicyTypeName

name は、ポリシーの名前です。
type
FrontendTLSPolicyType

PredefinedFrontendTLSPolicyType は、定義済みのフロントエンド TLS ポリシーの種類です。

PortNumber (int32 エイリアス)

(出現箇所:Redirect)

PortNumber はネットワーク ポートを定義します。

PreciseHostname (string エイリアス)

(出現箇所:Redirect、URLRewriteFilter)

PreciseHostname は、ネットワーク ホストの完全修飾ドメイン名です。 これは、ホスト名の RFC1123 の定義と一致しますが、数値の IP アドレスは許可されないという 1 つの注目すべき例外があります。

RFC1035 と RFC1123 に従って、label は小文字の英数字または ‘-’ で構成する必要があり、先頭と末尾には英数字を使用する必要があります。 その他の符号は許可されていません。

Protocol (string alias)

(出現箇所:IngressBackendPort)

Protocol は、特定のプロパティに使用されるプロトコルを定義します。 有効な Protocol の値は次のとおりです。

  • HTTP
  • HTTPS
  • TCP
値 説明

"HTTP"

HTTP は、サービスで HTTP を使用することを示します

"HTTPS"

HTTPS は、サービスで HTTPS を使用することを示します

"TCP"

TCP は、サービスでプレーン TCP を使用することを示します

リダイレクト

(出現箇所:IngressRuleSetting)

Redirect は、要求をリダイレクトするフィルターを定義します。 これは、URLRewriteFilter を持つ同じ規則で使用することはできません。

フィールド 説明
scheme
string 		(省略可)

Scheme は、応答の Location ヘッダーの値で使用されるスキームです。 空の場合、要求のスキームが使用されます。
hostname
PreciseHostname 		(省略可)

Hostname は、応答の Location ヘッダーの値に使用されるホスト名です。 空の場合、要求の Host ヘッダーのホスト名が使用されます。
path
HTTPPathModifier 		(省略可)

Path は、着信要求のパスを変更するために使用されるパラメーターを定義します。 変更されたパスは、Location ヘッダーを構成するために使用されます。 空の場合、要求パスがそのまま使用されます。
port
PortNumber 		(省略可)

Port は、応答の Location ヘッダーの値で使用されるポートです。

Port が指定されていない場合、リダイレクト ポートは次の規則を使用して派生する必要があります。

  • リダイレクト スキームが空でない場合、リダイレクト ポートはリダイレクト スキームに関連付けられた既知のポートである必要があります。 具体的には、“http” はポート 80、“https” はポート 443 です。 リダイレクト スキームに既知のポートがない場合、ゲートウェイのリスナー ポートを使用する必要があります。
  • リダイレクト スキームが空の場合、リダイレクト ポートはゲートウェイ リスナー ポートである必要があります。

次のような場合、実装で ‘Location’ ヘッダーにポート番号を追加することはできません。

  • HTTP (それが Listener プロトコルで決定されるか Scheme フィールドで決定されるかは関係ありません) が使用され、"かつ" ポート 80 が使用される Location ヘッダー。
  • HTTPS (それが Listener プロトコルで決定されるか Scheme フィールドで決定されるかは関係ありません) が使用され、"かつ" ポート 443 が使用される Location ヘッダー。
statusCode
int 		(省略可)

StatusCode は、応答で使用される HTTP 状態コードです。

この列挙型に値を追加することができますが、不明な値がクラッシュを引き起こさないように実装する必要があります。

RewriteType (string エイリアス)

(出現箇所:IngressRewrites)

RewriteType は、再書き込みの種類を指定します

Value 説明

"RequestHeaderModifier"

RequestHeaderModifier は、HTTP 要求がアップストリーム ターゲットに送信される前に HTTP ヘッダーを追加または削除するために使用できます。

"ResponseHeaderModifier"

ResponseHeaderModifier は、HTTP 応答がクライアントに送信される前に HTTP ヘッダーを追加または削除するために使用できます。

"URLRewrite"

URLRewrite は、転送中に要求を変更するために使用できます。

RoutePolicy

RoutePolicy は、RoutePolicy API のスキーマです

フィールド 説明
metadata
Kubernetes meta/v1.ObjectMeta 		(省略可)

オブジェクトのメタデータ。

metadata フィールドのフィールドについては、Kubernetes API のドキュメントを参照してください。
spec
RoutePolicySpec

spec は、RoutePolicy 仕様です。



targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
RoutePolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
RoutePolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。
status
RoutePolicyStatus

status は、RoutePolicy の現在の状態を定義します。

RoutePolicyConditionReason (string alias)

RoutePolicyConditionReason は、RoutePolicy の特定の状態の種類がなぜ生成されたかを説明する一連の理由を定義します。

Value 説明

"Accepted"

RoutePolicyReasonAccepted は、指定された RoutePolicy が正しく構成されている場合に RoutePolicyConditionReason を Accepted に設定するために使用されます

"InvalidRoutePolicy"

RoutePolicyReasonInvalid は、RoutePolicy が受け入れられ’ない場合の理由です

"InvalidGroup"

RoutePolicyReasonInvalidGroup は、group が無効な場合に使用されます

"InvalidHTTPRoute"

RoutePolicyReasonInvalidHTTPRoute は、HTTPRoute が無効な場合に使用されます

"InvalidKind"

RoutePolicyReasonInvalidKind は、kind/group が無効な場合に使用されます

"InvalidName"

RoutePolicyReasonInvalidName は、name が無効な場合に使用されます

"NoTargetReference"

RoutePolicyReasonNoTargetReference は、ターゲット参照がない場合に使用されます

"OverrideNotSupported"

RoutePolicyReasonOverrideNotSupported は、オーバーライドがサポートされていない場合に使用されます

"RefNotPermitted"

RoutePolicyReasonRefNotPermitted は、参照が許可されて’いない場合に使用されます

"SectionNamesNotPermitted"

RoutePolicyReasonSectionNamesNotPermitted は、セクション名が許可されていない場合に使用されます

RoutePolicyConditionType (string alias)

RoutePolicyConditionType は、RoutePolicy に関連付けられている状態の種類です。 この種類は、RoutePolicyStatus.Conditions フィールドで使用する必要があります。

値 説明

"Accepted"

RoutePolicyConditionAccepted は、RoutePolicyConditionType を Accepted に設定するために使用されます

"ResolvedRefs"

RoutePolicyConditionResolvedRefs は、RoutePolicyCondition を ResolvedRefs に設定するために使用されます

RoutePolicyConfig

(出現箇所:RoutePolicySpec)

RoutePolicyConfig は、RoutePolicy 仕様のスキーマを定義します。 これにより、* タイムアウト * セッション アフィニティの属性の仕様が可能になります

フィールド 説明
timeouts
RouteTimeouts 		(省略可)

ターゲット リソースのカスタム timeouts タイムアウト。
sessionAffinity
SessionAffinity

sessionAffinity は、セッション アフィニティ仕様のスキーマを定義します

RoutePolicySpec

(出現箇所:RoutePolicy)

RoutePolicySpec は、RoutePolicy の目的の状態を定義します

フィールド 説明
targetRef
CustomTargetRef

TargetRef は、ポリシーの適用先の API オブジェクトを識別します。
override
RoutePolicyConfig 		(省略可)

override は、階層内の対象となるリソースの下にアタッチされているポリシー構成をオーバーライドする必要があるポリシー構成を定義します。

注: オーバーライドは現在サポートされていないため、検証エラーが発生します。 オーバーライドのサポートは、将来のリリースで追加されます。
default
RoutePolicyConfig 		(省略可)

default は、対象となるリソースの既定のポリシー構成を定義します。

RoutePolicyStatus

(出現箇所:RoutePolicy)

RoutePolicyStatus は、RoutePolicy の観察された状態を定義します。

フィールド 説明
conditions
[]Kubernetes meta/v1.Condition 		(省略可)

conditions は、RoutePolicy の現在の状態を表します。

実装では、オペレーターやツールが RoutePolicy の状態を表すために共通のボキャブラリに集中できるように、RoutePolicyConditionType と RoutePolicyConditionReason の定数を使用して RoutePolicy の状態を表すようにする必要があります。

既知の状態の種類は次のとおりです。

  • “承認済み”

RouteTimeouts

(出現箇所:RoutePolicyConfig)

RouteTimeouts は、タイムアウト仕様のスキーマを定義します

フィールド 説明
routeTimeout
Kubernetes meta/v1.Duration 		(省略可)

routeTimeout は、ルートのタイムアウトです。

SessionAffinity

(出現箇所:IngressBackendSettings、RoutePolicyConfig)

sessionAffinity は、セッション アフィニティ仕様のスキーマを定義します

フィールド 説明
affinityType
AffinityType
cookieName
string 		(省略可)
cookieDuration
Kubernetes meta/v1.Duration 		(省略可)

StatusCodes

(出現箇所:HTTPMatch)

statusCodes は、HealthCheck チェックに使用する HTTP 状態コード マッチャーを定義します。

フィールド 説明
start
int32 		(省略可)

start は、HealthCheck チェックに使用する状態コードの範囲の開始を定義します。 これは包含値です。
end
int32 		(省略可)

end は、HealthCheck チェックに使用する状態コードの範囲の終了を定義します。 これは包含値です。

URLRewriteFilter

(出現箇所:IngressRewrites)

URLRewriteFilter は、転送中に要求を変更するフィルターを定義します。 1 つの規則で使用できるフィルターは、最大でも 1 つです。 これは、sslRedirect を持つ同じ規則で使用することはできません。

フィールド 説明
hostname
PreciseHostname 		(省略可)

Hostname は、転送中にホスト ヘッダーの値を置き換えるために使用される値です。
path
HTTPPathModifier 		(省略可)

Path はパスの再書き込みを定義します。