Container Service for Kubernetes:NGINX Ingress O&Mの基本

NGINX設定ファイルの構造を次に示します。

次のコードは、いくつかの一般的なディレクティブとディレクティブブロックを含むサンプルnginx.confファイルを示しています。

# the number of worker processes to use
worker_processes 4;

# include additional configuration files
include /etc/nginx/conf.d/*.conf;

http {
  # HTTP server settings
  server {
    # listen on port 80
    listen 80;

    # server name
    server_name www.example.com;

    # default location
    location / {
      # root directory
      root /var/www/html;

      # index file
      index index.html;
    }
  }
}

この例では：

• worker_processes: NGINXによって使用されるワーカープロセスの数を指定するディレクティブ。

• include: 含める他の構成ファイルを指定するディレクティブ。

• server: 特定のサーバーの設定を構成するブロック。

• location: NGINXサーバーのルートURLであるデフォルトの場所の設定を構成するブロック。

詳細については、「NGINX公式ドキュメント」をご参照ください。

次のセクションでは、NGINX構成ファイルの最も重要な部分について説明します。

指令ブロック

HTTPブロック

HTTPブロックは、HTTPサーバのグローバルパラメータを構成する。 パラメーターには、実行するワーカープロセスの数、許可される最大接続数、およびログ設定が含まれます。 次のコードは、HTTPブロックのサンプルを示しています。

http {
    worker_processes 4;  
    worker_rlimit_nofile 8192; 
    client_max_body_size 128m; 

    access_log /var/log/nginx/access.log; 
    error_log /var/log/nginx/error.log; 

    server {
        ...
    }
}

この例では、HTTPブロックは、ワーカープロセスの数、許可されたファイル記述子の最大数、クライアント要求に許可された最大ボディサイズ、およびアクセスログファイルとエラーログファイルの場所を指定します。 ServerブロックはHTTPブロックの下にネストされ、特定のwebサーバーの設定を指定します。

サーバーブロック

サーバブロックは、特定のドメイン名またはドメイン名のグループに対するトラフィック要求の処理規則を定義する。 同じサーバーでホストされている複数のWebサイトとアプリケーションに対して、異なる設定と動作を構成できます。

次のコードは、サンプルのServerブロックを示しています。

server {
    listen 80;
    server_name www.example.com;

    location / {
        root /var/www/html/example;
        index index.html index.htm;
    }

    location /app {
        proxy_pass http://localhost:3000;
    }

    error_page 500 502 503 504 /50x.html;
    location = /50x.html {
        root /usr/share/nginx/html;
    }
}

この例では、サーバは、ポート80上のドメイン名www.example.comの暗号化されていないトラフィックのみを処理する。

• listenは、サーバーがポート80で受信接続をリッスンすることを指定します。

• server_nameは、Serverブロックが処理するドメイン名を指定します。

• listenとserver_nameは、サーバーがトラフィックをリッスンおよび処理するドメイン名とポートを指定するために一緒に使用されます。

server_name

仮想ホストのドメイン名を指定します。

server_name name1 name2 name3

# example:
server_name www.example.com;

ドメイン名の指定には、次の4つの一致モードがサポートされています。

• 完全一致: server_name www.example.com

• ワイルドカードの一致 (ワイルドカードを使用してサブドメインを示す): server_name * .example.com

• ワイルドカードの一致 (トップレベルドメインを示すために使用されるワイルドカード): server_name www.example.*

• 正規表現一致: server_name ~ ^ www\.example\.*$

リスト内の4つのマッチングモードは、降順で優先順位が付けられる。

位置ブロック

Locationブロックは、特定のURLパスまたはURLパターンのサーバーのリクエスト処理ルールを設定します。 Webサイトやアプリケーションのさまざまな部分に基づいて、特定のディレクトリに静的ファイルを提供したり、別のサーバーにリクエストをプロキシしたりするなど、さまざまな動作を定義できます。

次のコードは、ロケーションブロックのサンプルを示しています。

server {
    ...

    location / {
        root /var/www/html/example;
        index index.html index.htm;
    }

    location /app {
        proxy_pass http://localhost:3000;
    }

    error_page 500 502 503 504 /50x.html;
    location = /50x.html {
        root /usr/share/nginx/html;
    }
}

この例では：

• /Locationブロックは、WebサイトのルートURLへのリクエストが、/var/www/html/exampleディレクトリにファイルを提供することによって処理されることを指定します。

• /app Locationブロックは、/app URLへのリクエストがポート3000のlocalhostにプロキシされることを指定します。

• /50x.html Locationブロックは、サーバーが特定のファイルを提供することによってサーバーエラーを処理する方法を指定します。

複数のLocationブロックが存在する場合、リクエストは、Locationブロックマッチングルールと優先度に基づいて最初にマッチングされたLocationブロックによってキャプチャされ、処理されます。

一致ルール連結の構文:

• location [ = | ~ | ~ * | ^ ~ ] uri { ... }

• location @ name { ... }

一致するルールの優先順位は、= > ^ ~ > ~ > ~ *> 文字が使用されていない降順です。

例：

# Default general match. This matching rule applies to a request with no Location block hitting other matching rules.
location = / {
}
# Prefix match.
location ^~ /xx/ {
     # If a request prefixed with /xx/ is matched, the search is stopped. 
}
# Prefix match without a regular expression.
location  /uri {
}

location / {
     # Match all requests because all requests start with /. However, Location blocks defined by using regular expressions and those with longer prefix matches are prioritized to be matched. 
}

# Regular expression match.
location ~*.(gif|jpg|jpeg)$ {
     # Match any request that ends with gif, jpg, or jpeg. 
}

NGINX Ingressは、長さの降順でホストの複数のIngressパスをソートします。 詳細については、「Ingressパスのマッチング」および「Nginxサーバーと位置ブロックの選択アルゴリズムの理解」をご参照ください。

ディレクティブ継承とオーバーライド

NGINX構成では、ディレクティブは、外部コンテキストから内部コンテキストへの継承メカニズムに従います。 内部の子コンテキストは、その外部の親コンテキストから構成ディレクティブを継承する。 たとえば、http{} コンテキストで指定されたディレクティブは、ネストされたすべてのserver{} およびlocation{} コンテキストに継承されます。 同様に、server{} コンテキストで指定されたディレクティブは、ネストされたすべてのlocation{} コンテキストに継承されます。 ディレクティブが親コンテキストと子コンテキストの両方で指定されている場合、子コンテキストの構成は、親コンテキストの構成と組み合わせるのではなく、オーバーライドされることに注意してください。

例：

http {
    add_header X-HTTP-LEVEL-HEADER 1;
    add_header X-ANOTHER-HTTP-LEVEL-HEADER 1;

    server {
        listen 8080;
        location / {
            return 200 "OK";
        } 
    }

    server {
        listen 8081;
        add_header X-SERVER-LEVEL-HEADER 1;

        location / {
            return 200 "OK";
        }

        location /test {
            add_header X-LOCATION-LEVEL-HEADER 1;
            return 200 "OK";
        }

        location /correct {
            add_header X-HTTP-LEVEL-HEADER 1;
            add_header X-ANOTHER-HTTP-LEVEL-HEADER 1;

            add_header X-SERVER-LEVEL-HEADER 1;
            add_header X-LOCATION-LEVEL-HEADER 1;
            return 200 "OK";
        } 
    }
}

NGINXのリバースプロキシ設定

proxy_pass

NGINXのリバースプロキシ設定により、NGINXは、クライアント要求をリッスンして1つ以上のバックエンドサーバーに転送するプロキシサーバーとして動作できます。 これにより、NGINXはリクエストを受信し、処理のために適切なバックエンドサーバーにルーティングできます。 NGINXをリバースプロキシとして設定するには、NGINX設定ファイルのLocationブロックでproxi_passディレクティブを使用します。

例：

server {
    listen 80;
    server_name www.example.com;

    location / {
        proxy_pass http://localhost:3000;
    }
}

この例では、/Locationブロックは、ドメイン名www.example.comへのすべての要求がポート3000上のローカルホストにプロキシされることを指定します。 これは、NGINXがローカルホストのポート3000で実行されるサーバーにリクエストを受信して転送することを意味します。

proxy_set_ヘッダー

proxy_set_headerディレクティブを使用して、プロキシ要求に追加する追加のヘッダーを指定できます。

例：

server {
    listen 80;
    server_name www.example.com;

    location / {
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_pass http://localhost:3000;
    }
}

この例では、proxy_set_headerディレクティブは、HostヘッダーとX-Real-IPヘッダーをプロキシリクエストに追加し、着信リクエストのホスト名とIPアドレスをそれぞれの値に設定します。 これらのヘッダーは、アップストリームサーバーがリクエストに関する正確な情報を確実に受信するために役立ちます。

一般的なNGINXディレクティブ

一般的なNGINXコマンド