Kong Gateway (Enterprise および OSS) のインストール手順 - Amazon Linux


  Amazon Linux 用に最新の Kong Gateway パッケージをダウンロードしてください。
  - Kong Gateway (Enterprise): Amazon Linux 1 または Amazon Linux 2 (バージョン 2.6.0.0)
  - Kong Gateway (OSS): Amazon Linux 2
  (最新の Kong Gateway バージョン:2.6.0.0)
  すべての Amazon Linux 1 および Amazon Linux 2 用パッケージの一覧は以下をご参照ください。
  - Amazon Linux 1
  - Amazon Linux 2

Kong Gateway (Enterprise) ソフトウェアは、Kong Software License Agreement が適用されます。Kong Gateway (OSS) は Apache 2.0 ライセンスで提供されています。

必要項目

- ルートまたはルートと同等のアクセス権を持つサポート対象システム
- Kong の license.json ファイル (Enterprise のみ)

インストール手順

    Kong Gateway (Enterprise/OSS) をインストールする準備

    手動でパッケージをダウンロードした場合は、「Kong Gateway (Enterprise/OSS) をインストール」に進みます。

  1. オプション 1. パッケージ経由でダウンロード

    RPM ファイルをダウンロードするには、Kong Gateway のパッケージ タイプ (Enterprise または OSS) を選択し、以下のコマンドを使用します。

    ## Kong Gateway
    curl -Lo kong-enterprise-edition-2.6.0.0.amzn2.noarch.rpm "https://download.konghq.com/gateway-2.x-amazonlinux-2/Packages/k/kong-enterprise-edition-2.6.0.0.amzn2.noarch.rpm"
    ## Kong Gateway (OSS)
    curl -Lo kong-2.6.0.aws.amd64.rpm "https://download.konghq.com/gateway-2.x-amazonlinux-2/Packages/k/kong-2.6.0.aws.amd64.rpm"
  2. オプション 2. YUM 経由でダウンロード

    Yum リポジトリ ファイルをダウンロードするには、Kong Gateway のパッケージ タイプを選択し、以下のコマンドを使用します。

    ## Kong Gateway
    curl https://download.konghq.com/gateway-2.x-amazonlinux-2/config.repo | sudo tee /etc/yum.repos.d/kong-enterprise-edition.repo
    ## Kong Gateway (OSS)
    curl https://download.konghq.com/gateway-2.x-amazonlinux-2/config.repo | sudo tee /etc/yum.repos.d/kong.repo

    Kong Gateway (Enterprise/OSS) をインストール

  1. ダウンロード済みの RPM パッケージを使用

    RPM ファイルをインストールするには、Kong Gateway のパッケージ タイプを選択し、以下のコマンドを使用します。

    ## Kong Gateway
    sudo yum install -y kong-enterprise-edition-2.6.0.0.amzn2.noarch.rpm
    ## Kong Gateway (OSS)
    sudo yum --nogpgcheck install -y kong-2.6.0.aws.amd64.rpm
  2. YUM リポジトリ ファイルを使用

    Yum リポジトリ ファイルをインストールするには、Kong Gateway のパッケージ タイプを選択し、以下のコマンドを使用します。

    ## Kong Gateway
    sudo yum install -y kong-enterprise-edition
    ## Kong Gateway (OSS)
    sudo yum --nogpgcheck install -y kong

    Config の設定

    Kong Gateway には、公式パッケージのいずれかで Kong Gateway をインストールした場合、/etc/kong/kong.conf.default にあるデフォルトの構成プロパティ ファイルが付属しています。この構成ファイルは、起動時に Kong Gateway の構成プロパティを設定するために使用されます。

    Kong Gateway では、Kong Gateway の構成済みエンティティすべての構成プロパティを保存するために、データベースまたは yaml 宣言型構成ファイルの 2 つのオプションを提供します。Kong Gateway を起動する前に、データストアへの参照を使用して kong.conf.default 構成プロパティ ファイルを更新する必要があります。

    kong.conf.default ファイルに記載されているデフォルトのプロパティを変更して Kong Gateway を構成するには、ファイルのコピーを作成して名前を変更してください (例:kong.conf)。その後、更新して同じ場所に保存してください。

    データストアに接続するように Kong Gateway を構成する方法の詳細については、Configuration property Reference (英語) の Datastore セクションを参照してください。

  1. オプション 1. データベースの使用

    まず、kong.conf 構成ファイルを使用して Kong Gateway を構成し、データベースに接続できるようにする必要があります。

    データベースに接続するために Kong Gateway を構成する方法の詳細については、Configuration property Reference (英語) の Datastore セクションをご参照ください。

    Kong Gateway は、データストアとして PostgreSQL および Cassandra 両方をサポートしています。

    Postgres を使用している場合は、Kong Gateway を起動する前に、以下のようにデータベースとユーザーをプロビジョニングします。

    CREATE USER kong; CREATE DATABASE kong OWNER kong;

    次に、以下のコマンドで、Kong Gateway migrations を実行します。

    kong migrations bootstrap -c {PATH_TO_KONG.CONF_FILE}

    ※ 古いバージョンの PostgreSQL ではデフォルトで ident 認証を使用し、新しいバージョン (PSQL 10+) では scram-sha-256 を使用します。ローカルでデータベースと通信できるようにするには、PostgreSQL の構成ファイルの認証方法を md5 に変更してください。

  2. オプション 2. yaml 宣言型構成ファイルの使用

    Kong Gateway のすべての構成済みエンティティの構成プロパティを yaml 宣言型構成ファイル (DB レスモード) に保存する場合は、kong.yml ファイルを作成し、kong.conf 構成ファイルを更新して kong.yml ファイルへのファイル パスを含める必要があります。

    まず、以下のコマンドを実行すると、現在のフォルダに kong.yml 宣言型構成ファイルが生成されます。

    kong config init

    生成された kong.yml ファイルには、ファイルを使用して Kong Gateway を構成する方法が記載されています。

    次に、kong.conf 構成ファイルを使用して Kong Gateway を構成し、宣言型構成ファイルを認識させる必要があります。

    次の例のように、データベース (database) オプションを off に、declarative_config オプションを kong.yml ファイルのパスに設定します。

    database = off
    declarative_config = {PATH_TO_KONG.CONF_FILE}

    Seed Super Admin (Enterprise のみ)

    初回起動時に Super Admin にパスワードを設定することをおすすめします。これにより、必要に応じて後からロールベースのアクセス制御 (RBAC) を使用することができます。

  1. 環境変数に Super Admin のパスワードを設定し、安全な場所に保管してください。次のコマンドを使用して移行を実行し、Kong データベースを準備します。

    KONG_PASSWORD={PASSWORD} kong migrations bootstrap -c {PATH_TO_KONG.CONF_FILE}
  2. Kong Gateway を起動します。

    kong start -c {PATH_TO_KONG.CONF_FILE}
  3. Kong Gateway が動作していることを確認します。

    curl -i -X GET --url http://{DNS_OR_IP}:8001/services

    HTTP/1.1 200 OK メッセージが表示されます。

    Kong Gateway の起動

    ※ Kong を起動すると、Nginx の master プロセスは root として実行され、worker プロセスはデフォルトで kong として実行されます。これが望ましい動作でない場合は、Kong を起動する前に Nginx master プロセスを切り替えて、組み込みの kong ユーザーまたはカスタムの非ルート ユーザーで実行することができます。詳細は、「非ルート ユーザーでの Kong の実行」(英語) をご参照ください。

  1. 以下のコマンドで Kong Gateway を起動します。

    kong start -c {PATH_TO_KONG.CONF_FILE}

    インストールを確認する

    すべてが成功すると、Kong Gateway が実行されていることを知らせるメッセージ (Kong Started) が表示されるはずです。

    デフォルトでは、以下のポートでリッスンします。

    :8000 - クライアントからの HTTP トラフィックをリッスンするポートで、アップストリーム サービスに転送します。
    :8443 - HTTPS トラフィックの受信をリッスンするポートです。このポートは、HTTPS トラフィックのみを想定している点を除き、:8000 ポートと同様の動作をします。また、kong.conf 構成ファイルで無効にすることができます。
    :8001 - 設定に使用される Admin API がリッスンするポートです。
    :8444 - Admin API が HTTPS トラフィックをリッスンするポートです。

    インストール後の設定

    Kong Manager の有効化と構成 (OSS のみ)

  1. Kong Gateway のグラフィカル ユーザー インターフェース (GUI) である Kong Manager にアクセスするには、kong.conf 構成ファイルの admin_gui_url プロパティを、システムの DNS または IP アドレスに更新します。例えば、以下のようになります。

    admin_gui_url = http://{DNS_OR_IP}:8002

    この設定は、オペレーティング システム (OS) のホストに到達するネットワーク パスに名前解決する必要があります。

  2. kong.conf ファイル内の Admin API 設定を更新して、OS ホスト上の必要なネットワーク インターフェイスをリッスンします。0.0.0.0:8001 と設定すると、利用可能なすべてのネットワーク インターフェイスのポート 8001 をリッスンします。

    ※ 以下の設定は、あらゆるソースからのリクエストをlisten するデフォルトの admin_listen 設定を上書きするため、本番環境以外での使用のみを目的としています。これらの設定は、インターネットに直接接続されている環境では使用しないでください。
    本番環境で admin_listen ポートをインターネットに公開する必要がある場合は、認証を通して保護してください。

    設定例は以下になります。

    admin_listen = 0.0.0.0:8001, 0.0.0.0:8444 ssl

    以下の設定例のように、ネットワーク インターフェースを個別に表示することもできます。

     admin_listen = 0.0.0.0:8001, 0.0.0.0:8444 ssl, 127.0.0.1:8001, 127.0.0.1:8444 ssl
  3. 設定を有効にするには、以下のコマンドで Kong Gateway を再起動してください。

     kong restart -c {PATH_TO_KONG.CONF_FILE}
  4. ポート 8002 で Kong Manager にアクセスします。

    ライセンスのデプロイ (Enterprise のみ)

    Enterprise サブスクリプションをお持ちの場合は、手順 (英語) に従ってライセンスを展開してください。

    Dev Portal の有効化

  1. kong.conf ファイルで portal プロパティを on に設定し、portal_gui_host プロパティに Amazon Linux システムの DNS または IP アドレスを設定して、Dev Portal を有効にします。例えば、以下のようになります。

    portal = on
    portal_gui_host = {DNS_OR_IP}:8003
  2. 設定を有効にするには、以下のコマンドで Kong Gateway を再起動してください。

    kong restart -c {PATH_TO_KONG.CONF_FILE}
  3. ワークスペースの Dev Portal を有効にするには、以下のコマンドを実行し、DNSorIP を更新して OS システムの IP または有効な DNS を反映させます。

    curl -X PATCH http://{DNS_OR_IP}:8001/workspaces/default \
    --data "config.portal=true"
  4. 次の URL を使用して、デフォルトのワークスペースの Dev Portal にアクセスします (独自の DNS または IP を代用します)。

    http://{DNS_OR_IP}:8003/default

    サポート (Enterprise のみ)

    HTTP/1.1 200 OK メッセージを受信しなかった場合、またはセットアップを完了するためのサポートが必要な場合は、サポートの連絡先に連絡するか、サポート ポータルに移動してください。

    次のステップ

    Kong Enterprise を最大限に活用するために、Kong Enterprise 一連の Getting Started ガイドをお読みください。

デモの依頼

製品の詳細、ライセンス体系、デモの依頼など、お気軽にお問い合わせください。