コンテンツにスキップ
|
Kong Gateway
3.8.x
report-issue問題を報告する
旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。

AWS IAMを使用してKong Gateway Amazon RDSデータベースを認証する

Kong Gateway 3.3.x以降では、AWS ID/アクセス管理（IAM）認証を使用して、Kong Gatewayに使用するAWS RDSデータベースに接続できます。このページでは、この機能を使用してデータベース構成とデータベース接続を保護する方法について説明します。

この機能を有効にすると、データベースインスタンスに接続するときにパスワードを使用する必要がなくなります。代わりに、一時的な認証トークンを使用します。AWS IAM は認証を外部で管理するため、データベースにはユーザー認証情報は保存されません。Kong Gateway のデータベースに AWS RDS を使用する場合は、実行中のクラスタでこの機能を有効にできます。これにより、 Kong Gateway（pg_password）と RDS データベース側の両方にデータベースユーザーの認証情報を保存する必要がなくなります。

AWS IAM認証の制限

AWS IAM 認証には、いくつかの制限もあります。この機能を本番環境で使用する前に、以下をそれぞれ確認してください。

  • 従来のKong Gatewayクラスタまたは単一の従来ノードの場合、Kong Gatewayで1秒あたり200件未満の新しいIAMデータベース認証が必要な場合にのみ、IAMデータベース認証を使用します。1秒あたりの接続数を増やすと、スロットリングが発生する可能性があります。認証は、接続が正常に確立された後の各接続の初期化部分でのみ行われます。後続のクエリと通信は認証されません。データベース上の接続確立のTPSをチェックして、この制限が発生していないことを確認します。従来のクラスタでは、各ノードがデータベースへの接続を確立する必要があるため、この制限が発生する可能性が高くなります。詳細については、Amazon RDSユーザーガイドのIAMデータベース認証に関する推奨事項を参照してください。
  • AWS IAM認証を有効にするには、データベースへのSSL接続が必要です。これを行うには、RDSクラスタを正しく構成し、Kong Gateway側で正しいSSL関連の構成を提供する必要があります。以前にSSLを使用していなかった場合は、SSLを有効にすると性能オーバーヘッドも発生します。現在、TLSv1.3はAWS RDSではサポートされていません。
  • Postgres RDSはmTLSをサポートしていないため、AWS IAM認証が有効になっている場合は、Kong GatewayとPostgres RDSデータベース間でmTLSを有効にすることはできません。
  • Kong Gatewayを起動した後に、AWS認証情報に使用する環境変数の値を変更することは できません 。

その他の推奨事項と制限事項については、Amazon RDS ユーザーガイドの「MariaDB、MySQL、および PostgreSQL の IAM データベース認証」を参照してください。

前提条件

AWS IAM認証を有効にする前に、AWS RDSデータベースとKong Gatewayが使用するAWS IAMロールを構成する必要があります。

  • データベースインスタンスでIAMデータベース認証を有効にします。 詳細については、『Amazon RDSユーザーガイド』の「IAMデータベース認証の有効化と無効化」を参照してください。

  • Kong Gatewayインスタンスに IAM ロールを割り当てます。 Kong Gateway は、IAM ロールに使用する AWS 認証情報を自動的に検出して取得できます。

    • EC2 環境を使用する場合は、 EC2 IAM ロールを使用します。

    • ECSクラスタを使用する場合は、 ECSタスクIAMロールを使用します。

    • EKS クラスタを使用する場合は、割り当てられたロールに注釈を付けることができるKubernetesサービスアカウントを構成し、 serviceaccountで定義された IAMロールを使用するようにポッドを構成します。

      serviceaccountで定義されたIAMロールを使用するには、AWS STSサービスへのリクエストが必要です。そのため、ポッド内のKongインスタンスがAWS STSサービスエンドポイントにアクセスできることも確認する必要があります。

      STSリージョンエンドポイントを使用している場合は、AWS_STS_REGIONAL_ENDPOINTSが環境変数で定義されていることを確実にしてください。

    • Kong Gatewayをローカルで実行する場合は、環境変数を使用します。（AWS_ACCESS_KEY_IDとAWS_SECRET_ACCESS_KEYを使用したアクセスキーと秘密鍵の組み合わせ、またはプロフィールと認証情報ファイルの組み合わせ（使用：AWS_PROFILEとAWS_SHARED_CREDENTIALS_FILE

    警告： AWS認証情報の提供に使用した環境変数の値は、Kong Gatewayの起動後には変更 できません 。すべての変更は無視されます。

    • If you want to assume a role, make sure the original IAM role that Kong uses has the correct permission to assume the role of the target IAM role, and the target IAM role has the correct permission to connect to the database using IAM authentication.
    • If you have users with non-public VPC networks and private VPC endpoints (without private DNS names enabled), you can configure an AWS Service Token Service (STS) endpoint globally with vault_aws_sts_endpoint_url or on a custom AWS Vault entity with sts_endpoint_url.

  • IAM ポリシーを Kong Gateway IAM ロールに割り当てます 。詳細については、Amazon RDS ドキュメントの「IAM データベースアクセス用の IAM ポリシーの作成と使用」を参照してください。

  • RDSでデータベースアカウントを作成していることを確認 してください。詳細については、Amazon RDSドキュメントの「PostgreSQL での IAM 認証の使用」を参照してください。

    注:

    • rds_iamロールに割り当てられたデータベースユーザーは、IAMデータベース認証のみを使用できます。
    • データベースを作成し、作成したデータベースユーザーに適切な権限を付与してください。詳細については、「データベースの使用」を参照してください。

AWS IAM 認証の有効化

環境変数またはKong Gateway設定ファイルを使用して、AWS IAM 認証を有効にできます。この機能を読み取り専用モードと読み取り/書き込みモードの両方で有効にすることも、読み取り専用モードのみで有効にすることもできます。

注意： AWS IAM認証が有効になっている場合、 Kong Gatewayは関連するパスワード設定を無視します。読み取り専用モードでのみ認証を有効にしても、読み取り/書き込み関連の構成には影響しないため、 pg_userとpg_password正常に機能します。

AWS IAM 認証を有効にする前に、 kong.confファイルで次の操作を行う必要があります。

  • pg_passwordまたはpg_ro_passwordを削除します。
  • pg_user または pg_ro_user が、IAM ポリシーで定義し、Postgres RDS データベースに作成したユーザー名と一致していることを確認します。

環境変数によるAWS IAM認証の有効化

読み取り/書き込みモードおよび読み取り専用モードでAWS IAM認証を有効にするには、KONG_PG_IAM_AUTH環境変数をonに設定します。

KONG_PG_IAM_AUTH=on

読み取り専用モードでAWS IAM認証を有効にするには、次のように設定します。

KONG_PG_IAM_AUTH=off # This line can be omitted because off is the default value
KONG_PG_RO_IAM_AUTH=on

ロールを引き受ける場合は、次の環境変数も設定します。

# For read-write connections
KONG_PG_IAM_AUTH_ASSUME_ROLE_ARN=<role_arn id="sl-md0000000">
KONG_PG_IAM_AUTH_ROLE_SESSION_NAME=<role_session_name id="sl-md0000000">

# Optional, specify the custom STS endpoint URL used for the IAM assume role
# This value will override the default STS endpoint URL, which should be
# `https://sts.amazonaws.com`, or `https://sts.<region id="sl-md0000000">.amazonaws.com` if
# `AWS_STS_REGIONAL_ENDPOINTS` is set to `regional`(by default).
# If you are not using a private VPC endpoint for STS service, you should
# not specify this value
KONG_PG_IAM_AUTH_STS_ENDPOINT_URL=https://your.endpoint.to.aws.sts.service.amazonaws.com

# For read-only connections, if you need a different role than for read-write
KONG_PG_RO_IAM_AUTH_ASSUME_ROLE_ARN=<role_arn id="sl-md0000000">
KONG_PG_RO_IAM_AUTH_ROLE_SESSION_NAME=<role_session_name id="sl-md0000000">
# Optional, same as KONG_PG_IAM_AUTH_STS_ENDPOINT_URL
KONG_PG_RO_IAM_AUTH_STS_ENDPOINT_URL=https://your.endpoint.to.aws.sts.service.amazonaws.com

構成ファイルで AWS IAM 認証を有効化

kong.confファイルにはpg_iam_authプロパティとpg_ro_iam_authプロパティが含まれています。 環境変数と同様に、読み取り接続と書き込み接続の両方で IAM 認証を有効にする場合、または RDS Postgres データベースへの読み取り専用接続のみを有効にする場合は、それに応じてonに設定できます。

読み取り/書き込みモードでAWS IAM認証を有効にするには、 pg_iam_authをonに設定します。

pg_iam_auth=on

読み取り専用モードでAWS IAM認証を有効にするには、 pg_ro_iam_authをonに設定します。

pg_ro_iam_auth=on

ロールを引き受ける場合は、次の構成パラメータも設定します。

# For read-write connections
pg_iam_auth_assume_role_arn=<role_arn id="sl-md0000000">
pg_iam_auth_role_session_name=<role_session_name id="sl-md0000000">
# Optional, specify the custom STS endpoint URL used for the IAM assume role
# This value will override the default STS endpoint URL, which should be
# `https://sts.amazonaws.com`, or `https://sts.<region id="sl-md0000000">.amazonaws.com` if
# `AWS_STS_REGIONAL_ENDPOINTS` is set to `regional`(by default).
# If you are not using a private VPC endpoint for STS service, you should
# not specify this value
pg_iam_auth_sts_endpoint_url=https://your.endpoint.to.aws.sts.service.amazonaws.com

# For read-only connections, if you need a different role than for read-write
pg_ro_iam_auth_assume_role_arn=<role_arn id="sl-md0000000">
pg_ro_iam_auth_role_session_name=<role_session_name id="sl-md0000000">
# Optional, same as `pg_iam_auth_sts_endpoint_url`
pg_ro_iam_auth_sts_endpoint_url=https://your.endpoint.to.aws.sts.service.amazonaws.com

注： 構成ファイルでAWS IAM認証を有効にする場合、移行コマンドの実行時に機能プロパティで構成ファイルを指定する必要があります。kong migrations bootstrap -c /path/to/kong.confはその一例です。