パラメーター	必須または省略可能	デフォルト値	説明
`metadata.name`	必須	なし	他のリソース (ポリシーバインドなど) の対象リファレンスとして使用される API インスタンス識別子。
`metadata.namespace`	省略可能	`default`
`spec.address`	必須	なし	プロトコル、ホスト、ポート、パス (省略可能) を含むプロキシアドレス URL。ベースパスを指定する場合は、どの `rules.path` 属性にも指定されていないパスでなければなりません。サポートされる形式: `protocol://host:port/path` (`path` は省略可能で、`protocol` は `http` または `https`)。
`spec.services`	省略可能	空	指定されたサービスとルートのマップ。
`spec.services[name].address`	必須	なし	サービスアドレス (およびポート)。サポートされる形式: `protocol://host:port` (`protocol` は `http` または `https`)。
`spec.services[name].routes`	省略可能	空	この API インスタンスに設定されているサービスへのルートの配列。空である場合は、サービスへのデフォルトルートが確立され、すべてのトラフィックがルーティングされます。
`spec.services[name].routes[#].config`	省略可能	空	このルートの設定。空の場合は、空の `destinationPath` でデフォルトの設定が適用されます。
`spec.services[name].routes[#].config.destinationPath`	省略可能	空	アップストリームサービスに要求を転送するために先頭に追加するパス。たとえば、「destinationPath: /api/v1」と指定した場合、この API インスタンスへの要求で「/orders」のようなパスを指定すると、要求は「/api/v1/orders」のように上流にルーティングされます。
`spec.services[name].routes[#].rules`	省略可能	空	このルートのルールの配列。「ポリシーバインド」の「spec.rules」を参照してください。
`spec.policies`	省略可能	空	この API インスタンスに適用するポリシーの配列。
`spec.policies[#].policyRef.name`	必須	なし	ポリシー名。
`spec.policies[#].policyRef.namespace`	省略可能	`metadata.namespace` の値	ポリシーが定義される名前空間。提供ポリシーの場合、この項目の値は `default` である必要があります。
`spec.policies[#].config`	省略可能	空	ポリシーの設定。「ポリシーバインド」の「spec.config」を参照してください。`policies[#].config` 項目で環境変数を使用するには、ポリシーバインドの環境変数を参照してください。
`spec.policies[#].rules`	省略可能	空	このポリシーを API インスタンスに適用するためのルールの配列。「ポリシーバインド」の「spec.rules」を参照してください。

:443 両方のサービスはポート 8080 でリスンします。次に例を示します。 curl http://localhost:8080/api/httpbin/get -v curl http://localhost:8080/api/json/users/1 -v

ポートを共有する API のベースパスは競合しない必要があります。たとえば、次のパスの組み合わせは許可されません。

http://0.0.0.0:8080/cats
http://0.0.0.0:8080/cats/dogs

ポートには TLS が適用されます。そのため、ポートを共有するすべての API インスタンスに同じ TLS ポリシーが適用されます。

## [](#policy-binding)ポリシーバインド apiVersion: gateway.mulesoft.com/v1alpha1 kind: PolicyBinding metadata: name: namespace: spec: targetRef: name: namespace: policyRef: name: namespace: config: # optional policy configuration order: # optional policy read order rules: # optional policy rules - path: methods: host: headers:

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`metadata.name`	必須	なし	ポリシーバインドの識別子。
`metadata.namespace`	省略可能	`default`
`spec.targetRef.name`	必須	なし	ポリシーがバインドされる API インスタンスまたはアップストリームサービスの識別子。
`spec.targetRef.namespace`	省略可能	`metadata.namespace` の値	対象が定義される名前空間。
`spec.policyRef.name`	必須	なし	ポリシー名。利用可能なポリシーのリストを参照してください。
`spec.policyRef.namespace`	省略可能	`metadata.namespace` の値	ポリシーが定義される名前空間。提供ポリシーの場合、この項目の値は `default` である必要があります。
`spec.config`	省略可能	空	ポリシーの設定。この項目のコンテンツは、指定されたポリシーに依存します。利用可能なポリシーのリストを参照してください。`config` 項目で環境変数を使用するには、ポリシーバインドの環境変数を参照してください。
`spec.order`	省略可能	50	ポリシー実行チェーン全体におけるポリシーの読み取り順序。
`spec.rules`	省略可能	空	ポリシーが特定の要求に適用されるかどうかを決定するためのルールの配列。これらのルールは OR 形式でチェックされます。最初に True となったルールに従ってポリシーを要求に適合します。各ルールの属性は、AND 形式で適用されます。パスとホストが定義されている場合は、両方が一致しなければルールは True にはなりません。
`spec.rules[#].path`	省略可能	`.*`	要求のパスと一致する正規表現。要求を上流にルーティングする場合は、この正規表現のキャプチャグループを使用して、パスを置き換えます。「path: /api(/.*)」と指定すると、/api/orders というパスが指定された要求は、/orders として上流にルーティングされます。複数のキャプチャグループを指定でき、その場合は、取得されたすべてのサブ文字列が連結されてパスが置き換えられます。
`spec.rules[#].host`	省略可能	`.*`	要求のホストと一致する正規表現。
`spec.rules[#].methods`	省略可能	`.*`	要求のメソッドと一致する正規表現。
`spec.rules[#].headers`	省略可能	空	ヘッダー名と要求に含まれる必要がある値の正規表現のマップ。各エントリのキーは想定されるヘッダー名で、値はヘッダー値と一致する正規表現です。

metadata.name

必須

なし

ポリシーバインドの識別子。

metadata.namespace

省略可能

default

spec.targetRef.name

必須

なし

ポリシーがバインドされる API インスタンスまたはアップストリームサービスの識別子。

spec.targetRef.namespace

省略可能

metadata.namespace の値

対象が定義される名前空間。

spec.policyRef.name

必須

なし

ポリシー名。利用可能なポリシーのリストを参照してください。

spec.policyRef.namespace

省略可能

metadata.namespace の値

ポリシーが定義される名前空間。提供ポリシーの場合、この項目の値は default である必要があります。

spec.config

省略可能

空

ポリシーの設定。この項目のコンテンツは、指定されたポリシーに依存します。利用可能なポリシーのリストを参照してください。config 項目で環境変数を使用するには、ポリシーバインドの環境変数を参照してください。

spec.order

省略可能

ポリシー実行チェーン全体におけるポリシーの読み取り順序。

spec.rules

省略可能

空

ポリシーが特定の要求に適用されるかどうかを決定するためのルールの配列。これらのルールは OR 形式でチェックされます。最初に True となったルールに従ってポリシーを要求に適合します。各ルールの属性は、AND 形式で適用されます。パスとホストが定義されている場合は、両方が一致しなければルールは True にはなりません。

spec.rules[#].path

省略可能

.*

要求のパスと一致する正規表現。

要求を上流にルーティングする場合は、この正規表現のキャプチャグループを使用して、パスを置き換えます。

「path: /api(/.*)」と指定すると、/api/orders というパスが指定された要求は、/orders として上流にルーティングされます。

複数のキャプチャグループを指定でき、その場合は、取得されたすべてのサブ文字列が連結されてパスが置き換えられます。

spec.rules[#].host

省略可能

.*

要求のホストと一致する正規表現。

spec.rules[#].methods

省略可能

.*

要求のメソッドと一致する正規表現。

spec.rules[#].headers

省略可能

空

ヘッダー名と要求に含まれる必要がある値の正規表現のマップ。

各エントリのキーは想定されるヘッダー名で、値はヘッダー値と一致する正規表現です。

### [](#ポリシーバインドの例)ポリシーバインドの例次のリソースは、`route` ポリシーを API インスタンスにバインドして、`rules` で指定されたトラフィックを `Service` 設定スニペットで指定されたプロキシアドレスにルーティングします。 apiVersion: gateway.mulesoft.com/v1alpha1 kind: PolicyBinding metadata: name: hello-flex-gateway-route namespace: e-commerce spec: targetRef: name: hello-flex-gateway-instance policyRef: name: route namespace: default config: destinationRef: name: json namespace: e-commerce rules: - path: /api/json(/.\*) 次のリソースは、`http-basic-authentication-flex` ポリシーを API インスタンスにバインドし、要求に `config.username` と `config.password` で定義されている基本ログイン情報を含めることを必須にします。このポリシーには読み取り順序に `2` の値が与えられます。 apiVersion: gateway.mulesoft.com/v1alpha1 kind: PolicyBinding metadata: name: hello-flex-gateway-auth namespace: e-commerce spec: targetRef: name: hello-flex-gateway-instance namespace: e-commerce policyRef: name: http-basic-authentication-flex namespace: default config: username: chris password: admin order: 2 ### [](#environment-variables)ポリシーバインドの環境変数ポリシーバインドリソースとインラインポリシーバインドの両方で `config` 項目の環境変数がサポートされます。使用可能な環境変数は環境に応じて異なります。環境変数を参照するには、次のようにプレフィックス `$` を付けて環境変数を指定します。 \- policyRef: name: http-basic-authentication-flex config: username: $USERNAME password: $PASSWORD ## [](#サービス)サービス apiVersion: gateway.mulesoft.com/v1alpha1 kind: Service metadata: name: namespace: spec: address:

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`metadata.name`	必須	なし	サービス識別子。
`metadata.namespace`	省略可能	`default`
`spec.address`	必須	なし	プロトコル、ホスト、ポートを含むサービスアドレス URL。サポートされる形式: `protocol://host:port` (`protocol` は `http` または `https`)。

metadata.name

必須

なし

サービス識別子。

metadata.namespace

省略可能

default

spec.address

必須

なし

プロトコル、ホスト、ポートを含むサービスアドレス URL。サポートされる形式: protocol://host:port (protocol は http または https)。

### [](#サービスの例)サービスの例次のリソースは、サービス識別子を記述するメタデータを使用して `Service` を定義しています。`metadata.namespace` 値は `ApiInstance` 設定で指定されている名前空間と一致します。`spec.address` は、API 実装のアドレスです。 apiVersion: gateway.mulesoft.com/v1alpha1 kind: Service metadata: name: json-example namespace: e-commerce spec: address: https://:443/ ## [](#設定)設定 `Configuration` エンティティを作成することによって目的のゲートウェイ状態を定義します。 `Configuration` エンティティは、Flex Gateway 自身のいくつかのランタイム設定 ([ログ](#logging)や[共有ストレージ](#shared-storage)など) を指定します。定義には以下が含まれます。 apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: namespace: spec: logging: # logging configuration sharedStorage: # shared storage configuration

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`metadata.name`	必須	なし	設定エンティティ。
`metadata.namespace`	省略可能	`default`	設定エンティティを特定するための名前空間値。
`spec`	必須	なし	ゲートウェイの特性を定義する設定オブジェクト。オブジェクトには `logging`、`sharedStorage`、`tls` があります。

metadata.name

必須

なし

設定エンティティ。

metadata.namespace

省略可能

default

設定エンティティを特定するための名前空間値。

spec

必須

なし

ゲートウェイの特性を定義する設定オブジェクト。オブジェクトには logging、sharedStorage、tls があります。

### [](#logging)ログ記録 `logging` オブジェクトは、メッセージログポリシーを介してランタイムおよびアクセスログの配信を設定します。ログは、サポートされている Fluent Bit v3.0 出力に配信されます。 ```yaml apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: namespace: spec: logging: outputs: - name: type: parameters: : runtimeLogs: logLevel: outputs: accessLogs: outputs: ```

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`logging.outputs[#].name`	必須	なし	後でランタイムとアクセスログの設定で参照する、この出力の名前。
`logging.outputs[#].type`	必須	なし	Fluent Bit でサポートされる出力種別。Fluent Bit 出力種別については、対象の Fluent Bit バージョンの Fluent Bit のドキュメントを参照してください。
`logging.outputs[#].parameters`	必須	なし	特定の Fluent Bit 出力種別のパラメーターのマップ。Fluent Bit 出力種別のパラメーターについては、対象の Fluent Bit バージョンの Fluent Bit のドキュメントを参照してください。
`logging.accessLogs.outputs`	省略可能	空	アクセスログをリダイレクトする出力名のリスト。
`logging.runtimeLogs.logLevel`	省略可能	`info`	ログの詳細を指定するパラメーター。サポートされる `logLevel` の種別は冗長レベルの高い順にリストされており、`debug`、`info`、`warn`、`error`、`fatal` です。
`logging.runtimeLogs.outputs`	省略可能	空	ランタイムログをリダイレクトする出力名のリスト。

logging.outputs[#].name

必須

なし

後でランタイムとアクセスログの設定で参照する、この出力の名前。

logging.outputs[#].type

必須

なし

Fluent Bit でサポートされる出力種別。Fluent Bit 出力種別については、対象の Fluent Bit バージョンの Fluent Bit のドキュメントを参照してください。

logging.outputs[#].parameters

必須

なし

特定の Fluent Bit 出力種別のパラメーターのマップ。Fluent Bit 出力種別のパラメーターについては、対象の Fluent Bit バージョンの Fluent Bit のドキュメントを参照してください。

logging.accessLogs.outputs

省略可能

空

アクセスログをリダイレクトする出力名のリスト。

logging.runtimeLogs.logLevel

省略可能

info

ログの詳細を指定するパラメーター。サポートされる logLevel の種別は冗長レベルの高い順にリストされており、debug、info、warn、error、fatal です。

logging.runtimeLogs.outputs

省略可能

空

ランタイムログをリダイレクトする出力名のリスト。

値を空白のままにすると、デフォルト値が設定に適用されます。上記のパラメーターに加えて、Flex Gateway にはログ出力用の変数が用意されています。設定されている場合、変数はログ内のそれぞれの出力の 1 つとして表示されます。

変数説明出力

変数	説明	出力
`date`	ログに記録されたイベントの日時	特定の時刻 (例: `17/11/2022-09:48:27AM`)
`logger`	ログに記録されたイベントが発生した Flex Gateway サービス	`flex-gateway-agent`、`flex-gateway-envoy`、または `flex-gateway-fluent`
`level`	ログに記録されたイベントの `Loglevel`	`debug`、`info`、`warn`、`error`、または `fatal`
`kind`	ログ種別	`runtimeLog` または `accessLog`

date

ログに記録されたイベントの日時

特定の時刻 (例: 17/11/2022-09:48:27AM)

logger

ログに記録されたイベントが発生した Flex Gateway サービス

flex-gateway-agent、flex-gateway-envoy、または flex-gateway-fluent

level

ログに記録されたイベントの Loglevel

debug、info、warn、error、または fatal

kind

ログ種別

runtimeLog または accessLog

#### [](#ログの例)ログの例 apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: logging spec: logging: outputs: - name: log-to-file type: file parameters: path: /var/log file: log.txt format: template template: | \[{date}\]\[{logger}\]\[{level}\]\[{kind}\] {message} runtimeLogs: logLevel: info outputs: - log-to-file accessLogs: outputs: - log-to-file ### [](#shared-storage)共有ストレージ `sharedStorage` オブジェクトは、共有ストレージのゲートウェイを設定します。本番ワークフローでは [Redis](https://redis.io/) (最小バージョン 4.0.0) を使用する必要がありますが、その定義は省略可能です。Redis が定義されていない場合、ポート 4000 の共有ストレージサービスを引き続き使用できますが、メモリ内実装が使用されます。必要に応じて、Redis とトランスポート層セキュリティ (TLS) を使用して、機密データを保護し、不正なアクセスを防止して、サービスの信頼性を維持できます。 apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: shared-storage-redis spec: sharedStorage: redis: address: // REQUIRED username: // OPTIONAL password: // OPTIONAL db: // OPTIONAL tls: // OPTIONAL trustedCA: // OPTIONAL certificate: // OPTIONAL keyPassphrase // OPTIONAL key: // REQUIRED crt: // REQUIRED alpn: // OPTIONAL skipValidation: // OPTIONAL minversion: // OPTIONAL maxversion: // OPTIONAL ciphers: // OPTIONAL

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`sharedStorage.redis.address`	必須	なし	`host:port` 形式の Redis インスタンスアドレス。
`sharedStorage.redis.username`	省略可能	空	Redis ユーザー名
`sharedStorage.redis.password`	省略可能	空	Redis ユーザーパスワード
`sharedStorage.redis.db`	省略可能	0	使用する Redis データベース番号
`sharedStorage.redis.tls`	省略可能	空	Redis TLS 設定
`sharedStorage.redis.tls.trustedCA`	省略可能	なし	サーバー証明書を確認する時に使用するルート認証機関
`sharedStorage.redis.tls.certificate`	省略可能	なし	サーバーに提供するクライアント証明書
`sharedStorage.redis.tls.keyPassphrase`	省略可能	`none`	証明書鍵パスフレーズ。指定された場合、DEK-Info ヘッダーが含まれる非公開鍵形式を使用します。未指定の場合、非公開鍵は暗号化できません。
`sharedStorage.redis.tls.certificate.key`	必須	なし	証明書の非公開鍵部分
`sharedStorage.redis.tls.certificate.crt`	必須	なし	証明書の公開鍵部分
`sharedStorage.redis.tls.skipValidation`	省略可能	`false`	true の場合、サーバーによって提供されたすべての証明書が受け入れられます。
`sharedStorage.redis.tls.minversion`	省略可能	`1.2`	許容される最小 TLS バージョン
`sharedStorage.redis.tls.maxversion`	省略可能	`1.3`	許容される最大 TLS バージョン
`sharedStorage.redis.tls.alpn`	省略可能	空のリスト	サポートされているアプリケーションレベルプロトコルの優先リスト (h2、http/1.1 など)。
`sharedStorage.redis.tls.ciphers`	省略可能

sharedStorage.redis.address

必須

なし

host:port 形式の Redis インスタンスアドレス。

sharedStorage.redis.username

省略可能

空

Redis ユーザー名

sharedStorage.redis.password

省略可能

空

Redis ユーザーパスワード

sharedStorage.redis.db

省略可能

使用する Redis データベース番号

sharedStorage.redis.tls

省略可能

空

Redis TLS 設定

sharedStorage.redis.tls.trustedCA

省略可能

なし

サーバー証明書を確認する時に使用するルート認証機関

sharedStorage.redis.tls.certificate

省略可能

なし

サーバーに提供するクライアント証明書

sharedStorage.redis.tls.keyPassphrase

省略可能

none

証明書鍵パスフレーズ。指定された場合、DEK-Info ヘッダーが含まれる非公開鍵形式を使用します。未指定の場合、非公開鍵は暗号化できません。

sharedStorage.redis.tls.certificate.key

必須

なし

証明書の非公開鍵部分

sharedStorage.redis.tls.certificate.crt

必須

なし

証明書の公開鍵部分

sharedStorage.redis.tls.skipValidation

省略可能

false

true の場合、サーバーによって提供されたすべての証明書が受け入れられます。

sharedStorage.redis.tls.minversion

省略可能

1.2

許容される最小 TLS バージョン

sharedStorage.redis.tls.maxversion

省略可能

1.3

許容される最大 TLS バージョン

sharedStorage.redis.tls.alpn

省略可能

空のリスト

サポートされているアプリケーションレベルプロトコルの優先リスト (h2、http/1.1 など)。

sharedStorage.redis.tls.ciphers

省略可能

TLS/Redis では、以下を除いて TLS ポリシーと同じ暗号化がサポートされます。

TLS_RSA_WITH_NULL_SHA
TLS_PSK_WITH_AES_256_CBC_SHA
TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256

**Redis 共有ストレージ例** Redis ストレージサービスは、オブジェクトストアインターフェースと Redis バックエンド間のブリッジとして機能する、REST API オブジェクトストアの実装です。 ```yaml apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: shared-storage-redis spec: sharedStorage: redis: address: redis.e-commerce.svc:6379 username: ecomm-user password: ecomm-pwd-123 DB: 7 ``` **Redis と TLS の共有ストレージ例** 必要に応じて、Redis と TLS を使用してデータを保護し、安全な通信を確保できます。 ```yaml apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: shared-storage-redis spec: sharedStorage: redis: address: internal.redis.com:6379 tls: skipValidation: false minVersion: "1.1" maxVersion: "1.3" alpn: - h2 - http/1.1 ciphers: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 trustedCA: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- certificate: keyPassphrase: "****" key: | -----BEGIN RSA PRIVATE KEY----- ... -----END RSA PRIVATE KEY----- crt: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- ``` **ローカル共有ストレージの例** ローカルストレージサービスは、データをメモリに保存する REST API オブジェクトストアの実装です。Flex Gateway を停止または再起動すると、すべてのデータが失われます。 ```yaml apiVersion: gateway.mulesoft.com/v1alpha1 kind: Configuration metadata: name: rtm-config namespace: sales spec: sharedStorage: local: enabled: true ``` ## [](#examples)例 ### [](#インライン設定の例)インライン設定の例 apiVersion: gateway.mulesoft.com/v1alpha1 kind: ApiInstance metadata: name: api-example spec: address: http://0.0.0.0:8080 services: api-example: address: https://:443/ routes: - rules: - path: /api(/users/.\*) - path: /api(/comments/.\*) config: destinationPath: /v1/apps policies: - policyRef: name: http-basic-authentication-flex config: username: chris password: admin ### [](#リソースベース設定の例)リソースベース設定の例 \--- apiVersion: gateway.mulesoft.com/v1alpha1 kind: ApiInstance metadata: name: ingress-http spec: address: http://0.0.0.0:8080 --- apiVersion: gateway.mulesoft.com/v1alpha1 kind: Service metadata: name: json spec: address: https://:443/ --- apiVersion: gateway.mulesoft.com/v1alpha1 kind: PolicyBinding metadata: name: ingress-http-route spec: targetRef: name: ingress-http policyRef: name: route config: destinationRef: name: json rules: - path: /api(/users/.\*) - path: /api(/comments/.\*) --- apiVersion: gateway.mulesoft.com/v1alpha1 kind: PolicyBinding metadata: name: ingress-http-authentication spec: targetRef: name: ingress-http policyRef: name: http-basic-authentication-flex config: username: chris password: admin