---
title: "APISIX Ingressはカスタムプラグインをどのようにサポートするか - API7.ai"
description: "如何扩展您的K8s Ingress功能？Ingress-NGINX的功能有限，而APISIX Ingress则提供了多种简单的方法来满足您的需求。"
url: "https://api7.ai/ja/blog/how-does-apisix-ingress-support-custom-plugins"
---

[Blog](https://api7.ai/ja/blog)

[Products](https://api7.ai/ja/category/products)[Technology](https://api7.ai/ja/category/technology)[Ecosystem](https://api7.ai/ja/category/ecosystem)[Case Study](https://api7.ai/ja/category/usercase)[Team & Community](https://api7.ai/ja/category/community)

Search

⌘ + K

[Blog](https://api7.ai/blog)

Products

# APISIX Ingressはカスタムプラグインをどのようにサポートするか

API7.ai

October 11, 2022

[Products](https://api7.ai/category/products)

## Ingress & Ingress Controller

IngressはKubernetesのAPIオブジェクトの1つです。クラスター内のサービスへの外部アクセスを管理し、通常はHTTP/HTTPSを扱います。

クライアントはIngressルールに従って、クライアントリクエストをKubernetesクラスターのサービスまたは特定の`Pod`にルーティングできます。

![k8s\_cluster.png](https://static.api7.ai/2022/10/09/634279b097d82.png?imageMogr2/format/webp)

以下はIngressリソースの例です：

```
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: apisix-gateway
spec:
  rules:
    - host: apisix.apache.org
      http:
        paths:
          - backend:
              service:
                name: apisix-gateway
                port:
                  number: 80
            path: /
            pathType: Exact
```

上記の例には以下の内容が含まれています：

- `metadata.name`: Ingressリソースの名前
- `spec.rules[].host`: 外部アクセスに使用されるドメイン
- `spec.rules[].http.paths[].backend`: クラスター内のサービスに関する情報を記述
- `spec.rules[].http.paths[].path`: クラスター内のサービスへの外部アクセスに使用されるパスを記述
- `spec.rules[].http.paths[].pathType`: クラスター内のサービスへの外部アクセスを管理するためのパスタイプを記述

上記の例から、**Ingressリソースの仕様は比較的シンプル**であることがわかります。

IngressはKubernetes内のリソース定義であり、それ自体ではトラフィックを処理できません。そのため、Ingressリソースを有効にするためには、コントローラーを使用してこれらのIngressリソースを処理する必要があります。これがIngressコントローラーです。

Ingressコントローラーは、Kubernetesクラスター内のリソース変更を監視し、Ingressリソースルールをデータ層のプロキシルールに変換します。これにより、データ層がトラフィックを処理できるようになります。

**実際の本番環境では、さまざまな種類のクライアントリクエストが存在します。例えば、Ingressリソースは認証やURIリライトなどの一般的な機能を直接記述できません。では、これらの要件をどのように満たすのでしょうか？**

## Ingress-NGINXは拡張機能をどのようにサポートするか？

まず、Kubernetesエコシステム内のIngress-NGINXコントローラーの例を使用して、拡張機能の使用方法を説明します。

Ingress-NGINXでは、`Annotation`を使用してIngressリソースに必要な拡張機能を記述できます。例えば：

```
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/enable-cors: "true"
    nginx.ingress.kubernetes.io/cors-allow-origin: https://foo.com,https://bar.com
    nginx.ingress.kubernetes.io/cors-allow-headers: x-foo-1,x-foo-2
    nginx.ingress.kubernetes.io/cors-allow-methods: GET,POST,PUT
  name: nginx-ingress
spec:
  rules:
    - host: kubernetes.github.io
      http:
        paths:
          - path: /ingress
            pathType: Exact
            backend:
              service:
                name: nginx
                port:
                  number: 80
```

上記の設定により、CORSが有効になります。

**IngressリソースにAnnotationを追加するのは比較的簡単ですが、Ingress-NGINXコントローラーがこれらのAnnotationを完全にサポートしている必要があります。そうでない場合、設定は有効になりません。Ingress-NGINXコントローラーの未開発の機能を使用する必要がある場合、カスタム開発を行う必要があります。**

以下のセクションでは、Apache APISIX Ingressコントローラーを使用してこれらの要件を満たす方法について説明します。

## APISIX Ingressでプラグインを使用する

[Apache APISIX Ingress](https://github.com/apache/apisix-ingress-controller)は、トラフィック処理や特定のシナリオに対する顧客のさまざまな要件を満たすためにプラグインを利用します。現在、80以上のすぐに使用できるプラグインがあり、ユーザーは新しい機能をサポートするためにカスタムプラグインを開発できます。

![apisix.PNG](https://static.api7.ai/2022/10/09/6341c29869628.png?imageMogr2/format/webp)

カスタムプラグインを開発する方法はいくつかあります：

- ユーザーはLuaを使用してプラグインを開発でき、これらのプラグインはAPISIX内部で実行されます。
- ユーザーは他のプログラミング言語を使用してプラグインを開発することもできます。このメカニズムは「プラグインランナー」と呼ばれ、このメカニズムで開発されたプラグインは「外部プラグイン」と呼ばれます。

プラグイン開発に関する公式ドキュメントを参照してください：

- プラグイン開発: <https://apisix.apache.org/docs/apisix/plugin-develop/>
- 外部プラグイン開発: <https://apisix.apache.org/docs/apisix/external-plugin/>

APISIX IngressでLuaを使用してプラグインを開発する3つの方法を紹介します。

### 純粋なCRDモード

APISIX Ingressコントローラーは、独自に設計されたCRD仕様をサポートしており、ルーティングルールで直接[プラグイン](https://api7.ai/blog/how-to-build-an-apache-apisix-plugin-from-0-to-1)を有効にできます（内部プラグインまたはカスタムプラグイン）。例えば：

```
apiVersion: apisix.apache.org/v2beta3
kind: ApisixRoute
metadata:
  name: httpbin-route
spec:
  http:
    - name: rule1
      match:
        hosts:
          - apisix.apache.org
        paths:
          - /apisix-ingress
      backends:
        - serviceName: apisix-gateway
          servicePort: 80
      plugins:
        - name: cors
          enable: true
          config:
            allow_origins: http://foo.bar.org
            allow_methods: "GET,POST"
            max_age: 3600
            expose_headers: x-foo,x-baz
            allow_headers: x-from-ingress
            allow_credential: true
```

ユーザーは上記の設定を使用してルーティングルールを作成でき、このルートでCORSプラグインが有効になります。

**この方法はAPISIX Ingressで最もネイティブにサポートされており、APISIXとうまく連携します。また、ユーザーが新しいカスタムプラグインを追加する場合、APISIX Ingressを再開発する必要がないため、ユーザーは直接使用できます。**

### CRD + Ingress Annotationsモード

CRD + Ingress Annotationsを使用してAPISIX Ingressの機能を拡張することもできます。例えば：

```
apiVersion: apisix.apache.org/v2
kind: ApisixPluginConfig
metadata:
  name: cors-plugin
spec:
  plugins:
    - name: cors
      enable: true
      config:
        allow_origins: http://foo.bar.org
        allow_methods: "GET,POST"
        max_age: 3600
        expose_headers: x-foo,x-baz
        allow_headers: x-from-ingress
        allow_credential: true
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: apisix
    k8s.apisix.apache.org/plugin-config-name: cors-plugin
  name: apisix-ingress
spec:
  rules:
    - host: apisix.apache.org
      http:
        paths:
          - path: /apisix-ingress
            pathType: Exact
            backend:
              service:
                name: apisix-gateway
                port:
                  number: 80
```

上記の設定を使用して、`cors-plugin`というプラグイン設定を独立して作成し、Ingressリソースの`k8s.apisix.apache.org/plugin-config-name: cors-plugin`を使用してそれを参照できます。実際の効果は最初の設定とほぼ同じで、対応するルートでCORSプラグインが有効になります。

このモードでは、プラグイン設定は独立したリソースと見なすことができ、複数のIngressリソースで共有することもできます。同様に、カスタム開発は必要ありません。

### Ingress Annotationsモード

Ingressリソースのセマンティクスが限られているため、通常は`annotations`を使用してリソースオブジェクトに追加情報を追加します。これはIngressの機能を拡張する最も一般的な方法です。例えば：

```
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: apisix
    k8s.apisix.apache.org/enable-cors: "true"
    k8s.apisix.apache.org/cors-allow-origin: https://foo.com,https://bar.com
    k8s.apisix.apache.org/cors-allow-headers: x-foo-1,x-foo-2
    k8s.apisix.apache.org/cors-allow-methods: GET,POST,PUT
  name: apisix-ingress
spec:
  rules:
    - host: apisix.apache.org
      http:
        paths:
          - path: /apisix-ingress
            pathType: Exact
            backend:
              service:
                name: apisix-gateway
                port:
                  number: 80
```

上記の設定により、IngressリソースにCORS関連の追加情報が追加されます。APISIX Ingressコントローラーはこの情報を識別し、データ層の設定に変換してIngressリソースの機能を拡張します。

**ただし、このモードでは、APISIX IngressコントローラーがすでにこれらのAnnotationを処理できることを確認する必要があります。そうでない場合、カスタム開発を行う必要があります。**

カスタム開発を行う必要がある場合は、以下のドキュメントを参照してください：

- APISIX Ingressコントローラーの使用方法: <https://apisix.apache.org/docs/ingress-controller/contribute/>

## 結論

この記事では、主にIngressリソースに関連する仕様と、Ingressリソースの機能を拡張する方法について紹介しました。例えば、Ingress-NGINXでは通常、Annotationを使用して機能を拡張するしかありません。しかし、[Apache APISIX Ingress](https://api7.ai/blog/apisix-ingress-integrates-with-service-discovery)では、高度な要件やより多くのシナリオを満たすために3つの設定モードがあります。さらに、ほとんどの場合、ユーザーはカスタム[プラグイン](https://api7.ai/blog/how-to-implement-plugin-orchestration-in-api-gateway)に対してカスタム開発を行う必要はありません。

Tags:

[APISIX Ingress Controller](https://api7.ai/tags/apisix-ingress-controller)

[Comparison to Competitors](https://api7.ai/tags/comparison-to-competitors)

[Plugin](https://api7.ai/tags/plugin)

Share article link

Share

Related Posts

[![cert-managerとHashiCorp Vaultを使用して証明書を管理する方法](https://static.api7.ai/uploads/2024/09/06/JAQ52Kr5_Manage%20Certificates.png)](https://api7.ai/blog/how-to-use-cert-manager-and-vault-to-manage-certifications)

## [cert-managerとHashiCorp Vaultを使用して証明書を管理する方法](https://api7.ai/blog/how-to-use-cert-manager-and-vault-to-manage-certifications)

[![APISIX、Prometheus、KEDAを使用してKubernetesでアプリケーションを弾力的にスケーリングする](https://static.api7.ai/uploads/2023/02/14/xFy6kdMH_Technology%20%E6%A8%A1%E6%9D%BF2%20%285%29.png)](https://api7.ai/blog/apisix-autoscale-applications-in-kubernetes)

## [APISIX、Prometheus、KEDAを使用してKubernetesでアプリケーションを弾力的にスケーリングする](https://api7.ai/blog/apisix-autoscale-applications-in-kubernetes)

Table of Contents

- [Ingress & Ingress Controller](#ingress--ingress-controller)

- [Ingress-NGINXは拡張機能をどのようにサポートするか？](#ingress-nginx%E3%81%AF%E6%8B%A1%E5%BC%B5%E6%A9%9F%E8%83%BD%E3%82%92%E3%81%A9%E3%81%AE%E3%82%88%E3%81%86%E3%81%AB%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B%E3%81%8B)

- [APISIX Ingressでプラグインを使用する](#apisix-ingress%E3%81%A7%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%E3%82%92%E4%BD%BF%E7%94%A8%E3%81%99%E3%82%8B)

  - [純粋なCRDモード](#%E7%B4%94%E7%B2%8B%E3%81%AAcrd%E3%83%A2%E3%83%BC%E3%83%89)
  - [CRD + Ingress Annotationsモード](#crd--ingress-annotations%E3%83%A2%E3%83%BC%E3%83%89)
  - [Ingress Annotationsモード](#ingress-annotations%E3%83%A2%E3%83%BC%E3%83%89)

- [結論](#%E7%B5%90%E8%AB%96)

## Related Posts

[![なぜAPISIX Ingress ControllerはNGINX Ingress Controllerよりも優れているのか？](https://static.api7.ai/2023/01/05/63b6900e1d793.png)](https://api7.ai/ja/blog/apisix-ingress-vs-ingress-nginx)

Products

December 6, 2022

#### [なぜAPISIX Ingress ControllerはNGINX Ingress Controllerよりも優れているのか？](https://api7.ai/ja/blog/apisix-ingress-vs-ingress-nginx)

This article mainly compares the basic functionalities of APISIX Ingress and Ingress NGINX. APISIX Ingress is better than Ingress NGINX in terms of scalability, extensibility, and functionality.

[APISIX Ingress Controller](https://api7.ai/tags/apisix-ingress-controller)

[Kubernetes](https://api7.ai/tags/kubernetes)

[Traefik](https://api7.ai/tags/traefik)

[![APISIX Ingress ControllerがTraefikよりも優れた選択肢である理由](https://static.api7.ai/uploads/2024/09/06/ldwwEzTf_APISIX%20Ingress%20Controller-3.png)](https://api7.ai/ja/blog/apisix-ingress-better-than-traefik)

Products

November 4, 2022

#### [APISIX Ingress ControllerがTraefikよりも優れた選択肢である理由](https://api7.ai/ja/blog/apisix-ingress-better-than-traefik)

本記事では、APISIX IngressがTraefikと比較して優れている理由を紹介します。

[APISIX Ingress Controller](https://api7.ai/tags/apisix-ingress-controller)

[Kubernetes](https://api7.ai/tags/kubernetes)

[Traefik](https://api7.ai/tags/traefik)

[![なぜAPISIX Ingress ControllerはEmissary-ingressよりも優れた選択肢なのか？](https://static.api7.ai/uploads/2024/12/24/CLpj341F_apisix-ingress-controller-vs-emissary.png)](https://api7.ai/ja/blog/apisix-ingress-vs-emissary-ingress)

Products

March 17, 2023

#### [なぜAPISIX Ingress ControllerはEmissary-ingressよりも優れた選択肢なのか？](https://api7.ai/ja/blog/apisix-ingress-vs-emissary-ingress)

本記事では、APISIX Ingress ControllerとEmissary-ingressのパフォーマンスを、スケーラビリティやサービスディスカバリー統合など、複数の次元から比較しています。

[APISIX Ingress Controller](https://api7.ai/tags/apisix-ingress-controller)

[Kubernetes](https://api7.ai/tags/kubernetes)

[Emissary-Ingress](https://api7.ai/tags/emissary-ingress)
