--- title: Deployment modes keywords: - API Gateway - Apache APISIX - APISIX deployment modes description: Documentation about the three deployment modes of Apache APISIX. --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; APISIX has three different deployment modes for different production use cases. The table below summarises the deployment modes: | Deployment mode | Roles | Description | |-----------------|----------------------------|---------------------------------------------------------------------------------------------------------------------| | traditional | traditional | Data plane and control plane are deployed together. `enable_admin` attribute should be disabled manually. | | decoupled | data_plane / control_plane | Data plane and control plane are deployed independently. | | standalone | data_plane / traditional | The `data_plane` mode loads configuration from a local YAML / JSON file, while the traditional mode expects configuration through Admin API. | Each of these deployment modes are explained in detail below. ## Traditional In the traditional deployment mode, one instance of APISIX will be both the `data_plane` and the `control_plane`. An example configuration of the traditional deployment mode is shown below: ```yaml title="conf/config.yaml" apisix: node_listen: - port: 9080 deployment: role: traditional role_traditional: config_provider: etcd admin: admin_listen: port: 9180 etcd: host: - http://${etcd_IP}:${etcd_Port} prefix: /apisix timeout: 30 #END ``` The instance of APISIX deployed as the traditional role will: 1. Listen on port `9080` to handle user requests, controlled by `node_listen`. 2. Listen on port `9180` to handle Admin API requests, controlled by `admin_listen`. ## Decoupled In the decoupled deployment mode the `data_plane` and `control_plane` instances of APISIX are deployed separately, i.e., one instance of APISIX is configured to be a *data plane* and the other to be a *control plane*. The instance of APISIX deployed as the data plane will: Once the service is started, it will handle the user requests. The example below shows the configuration of an APISIX instance as *data plane* in the decoupled mode: ```yaml title="conf/config.yaml" deployment: role: data_plane role_data_plane: config_provider: etcd #END ``` The instance of APISIX deployed as the control plane will: 1. Listen on port `9180` and handle Admin API requests. The example below shows the configuration of an APISIX instance as *control plane* in the decoupled mode: ```yaml title="conf/config.yaml" deployment: role: control_plane role_control_plane: config_provider: etcd etcd: host: - https://${etcd_IP}:${etcd_Port} prefix: /apisix timeout: 30 #END ``` ## Standalone Turning on the APISIX node in Standalone mode will no longer use the default etcd as the configuration center. This method is more suitable for two types of users: 1. Kubernetes(k8s)：Declarative API that dynamically updates the routing rules with a full yaml configuration. 2. Different configuration centers: There are many implementations of the configuration center, such as Consul, etc., using the full yaml file for intermediate conversion. ### Modes Now, we have two standalone running modes, file-driven and API-driven. #### File-driven The file-driven mode is the kind APISIX has always supported. The routing rules in the `conf/apisix.yaml` file are loaded into memory immediately after the APISIX node service starts. At each interval (default: 1 second), APISIX checks for updates to the file. If changes are detected, it reloads the rules. *Note*: Reloading and updating routing rules are all hot memory updates. There is no replacement of working processes, since it's a hot update. This requires us to set the APISIX role to data plane. That is, set `deployment.role` to `data_plane` and `deployment.role_data_plane.config_provider` to `yaml`. Refer to the example below: ```yaml deployment: role: data_plane role_data_plane: config_provider: yaml ``` You can also provide the configuration in JSON format by placing it in `conf/apisix.json`. Before proceeding, you should change the `deployment.role_data_plane.config_provider` to `json`. Refer to the example below: ```yaml deployment: role: data_plane role_data_plane: config_provider: json ``` This makes it possible to disable the Admin API and discover configuration changes and reloads based on the local file system. #### API-driven (Experimental) > This mode is experimental, please do not rely on it in your production environment. > We use it to validate certain specific workloads and if it is appropriate we will turn it into an officially supported feature, otherwise it will be removed. ##### Overview API-driven mode is an emerging paradigm for standalone deployment, where routing rules are stored entirely in memory rather than in a configuration file. Updates must be made through the dedicated Standalone Admin API. Each update replaces the full configuration and takes effect immediately through hot updates, without requiring a restart. ##### Configuration To enable this mode, set the APISIX role to `traditional` (to start both the API gateway and the Admin API endpoint) and use the YAML config provider. Example configuration: ```yaml deployment: role: traditional role_traditional: config_provider: yaml ``` This disables the local file source of configuration in favor of the API. When APISIX starts, it uses an empty configuration until updated via the API. ##### API Endpoints * `conf_version` by resource type Use `_conf_version` to indicate the client’s current version for each resource type (e.g. routes, upstreams, services, etc.). ```json { "routes_conf_version": 12, "upstreams_conf_version": 102, "routes": [], "upstreams": [] } ``` APISIX compares each provided `_conf_version` against its in-memory `_conf_version` for that resource type. If the provided `_conf_version` is: - **Greater than** the current `conf_version`, APISIX will **rebuild/reset** that resource type’s data to match your payload. - **Equal to** the current `conf_version`, APISIX treats the resource as **unchanged** and **ignores** it (no data is rebuilt). - **Less than** the current `conf_version`, APISIX considers your update **stale** and **rejects** the request for that resource type with a **400 Bad Request**. * `modifiedIndex` by individual resource Allow setting an index for each resource. APISIX compares this index to its modifiedIndex to determine whether to accept the update. ##### Example 1. get configuration ```shell curl -X GET http://127.0.0.1:9180/apisix/admin/configs \ -H "X-API-KEY: " \ -H "Accept: application/json" ## or application/yaml ``` This returns the current configuration in JSON or YAML format. ```json { "consumer_groups_conf_version": 0, "consumers_conf_version": 0, "global_rules_conf_version": 0, "plugin_configs_conf_version": 0, "plugin_metadata_conf_version": 0, "protos_conf_version": 0, "routes_conf_version": 0, "secrets_conf_version": 0, "services_conf_version": 0, "ssls_conf_version": 0, "upstreams_conf_version": 0 } ``` 2. full update ```shell curl -X PUT http://127.0.0.1:9180/apisix/admin/configs \ -H "X-API-KEY: " \ -H "Content-Type: application/json" ## or application/yaml \ -d '{}' ``` 3. update based on resource type In APISIX memory, the current configuration is: ```json { "routes_conf_version": 1000, "upstreams_conf_version": 1000, } ``` Update the previous upstreams configuration by setting a higher version number, such as 1001, to replace the current version 1000: ```shell curl -X PUT http://127.0.0.1:9180/apisix/admin/configs \ -H "X-API-KEY: ${API_KEY}" \ -H "Content-Type: application/json" \ -d ' { "routes_conf_version": 1000, "upstreams_conf_version": 1001, "routes": [ { "modifiedIndex": 1000, "id": "r1", "uri": "/hello", "upstream_id": "u1" } ], "upstreams": [ { "modifiedIndex": 1001, "id": "u1", "nodes": { "127.0.0.1:1980": 1, "127.0.0.1:1980": 1 }, "type": "roundrobin" } ] }' ``` :::note These APIs apply the same security requirements as the Admin API, including API key, TLS/mTLS, CORS, and IP allowlist. The API accepts input in the same format as the file-based mode, supporting both JSON and YAML. Unlike the file-based mode, the API does not rely on the `#END` suffix, as HTTP guarantees input integrity. ::: ### How to configure rules #### To `config_provider: yaml` All of the rules are stored in one file which named `conf/apisix.yaml`, APISIX checks if this file has any change **every second**. If the file is changed & it ends with `#END`, APISIX loads the rules from this file and updates its memory. Here is a mini example: ```yaml routes: - uri: /hello upstream: nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` *WARNING*: APISIX will not load the rules into memory from file `conf/apisix.yaml` if there is no `#END` at the end. Environment variables can also be used like so: ```yaml routes: - uri: /hello upstream: nodes: "${{UPSTREAM_ADDR}}": 1 type: roundrobin #END ``` *WARNING*: When using docker to deploy APISIX in standalone mode. New environment variables added to `apisix.yaml` while APISIX has been initialized will only take effect after a reload. More information about using environment variables can be found [here](./admin-api.md#using-environment-variables). #### To `config_provider: json` All of the rules are stored in one file which named `conf/apisix.json`, APISIX checks if this file has any change **every second**. If the file is changed, APISIX loads the rules from this file and updates its memory. Here is a mini example: ```json { "routes": [ { "uri": "/hello", "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } } ] } ``` *WARNING*: when using `conf/apisix.json`, the `#END` marker is not required, as APISIX can directly parse and validate the JSON structure. ### How to configure Route Single Route： ```yaml routes: - uri: /hello upstream: nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` ```json { "routes": [ { "uri": "/hello", "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } } ] } ``` Multiple Routes： ```yaml routes: - uri: /hello upstream: nodes: "127.0.0.1:1980": 1 type: roundrobin - uri: /hello2 upstream: nodes: "127.0.0.1:1981": 1 type: roundrobin #END ``` ```json { "routes": [ { "uri": "/hello", "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } }, { "uri": "/hello2", "upstream": { "nodes": { "127.0.0.1:1981": 1 }, "type": "roundrobin" } } ] } ``` ### How to configure Route + Service ```yaml routes: - uri: /hello service_id: 1 services: - id: 1 upstream: nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` ```json { "routes": [ { "uri": "/hello", "service_id": 1 } ], "services": [ { "id": 1, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } } ] } ``` ### How to configure Route + Upstream ```yaml routes: - uri: /hello upstream_id: 1 upstreams: - id: 1 nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` ```json { "routes": [ { "uri": "/hello", "upstream_id": 1 } ], "upstreams": [ { "id": 1, "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } ] } ``` ### How to configure Route + Service + Upstream ```yaml routes: - uri: /hello service_id: 1 services: - id: 1 upstream_id: 2 upstreams: - id: 2 nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` ```json { "routes": [ { "uri": "/hello", "service_id": 1 } ], "services": [ { "id": 1, "upstream_id": 2 } ], "upstreams": [ { "id": 2, "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } ] } ``` ### How to configure Plugins ```yaml # plugins listed here will be hot reloaded and override the boot configuration plugins: - name: ip-restriction - name: jwt-auth - name: mqtt-proxy stream: true # set 'stream' to true for stream plugins #END ``` ```json { "plugins": [ { "name": "ip-restriction" }, { "name": "jwt-auth" }, { "name": "mqtt-proxy", "stream": true } ] } ``` ### How to configure Plugin Configs ```yaml plugin_configs: - id: 1 plugins: response-rewrite: body: "hello\n" routes: - id: 1 uri: /hello plugin_config_id: 1 upstream: nodes: "127.0.0.1:1980": 1 type: roundrobin #END ``` ```json { "plugin_configs": [ { "id": 1, "plugins": { "response-rewrite": { "body": "hello\n" } } } ], "routes": [ { "id": 1, "uri": "/hello", "plugin_config_id": 1, "upstream": { "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } } ] } ``` ### How to enable SSL ```yaml ssls: - cert: | -----BEGIN CERTIFICATE----- MIIDrzCCApegAwIBAgIJAI3Meu/gJVTLMA0GCSqGSIb3DQEBCwUAMG4xCzAJBgNV BAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA8GA1UEBwwISGFuZ3pob3UxDTAL BgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl ci5sb2NhbDAeFw0yMDEwMjgwMzMzMDJaFw0yMTEwMjgwMzMzMDJaMG4xCzAJBgNV BAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA0GA1UEBwwISGFuZ3pob3UxDTAL BgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl ci5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ/qwxCR7g5S s9+VleopkLi5pAszEkHYOBpwF/hDeRdxU0I0e1zZTdTlwwPy2vf8m3kwoq6fmNCt tdUUXh5Wvgi/2OA8HBBzaQFQL1Av9qWwyES5cx6p0ZBwIrcXQIsl1XfNSUpQNTSS D44TGduXUIdeshukPvMvLWLezynf2/WlgVh/haWtDG99r/Gj3uBdjl0m/xGvKvIv NFy6EdgG9fkwcIalutjrUnGl9moGjwKYu4eXW2Zt5el0d1AHXUsqK4voe0p+U2Nz quDmvxteXWdlsz8o5kQT6a4DUtWhpPIfNj9oZfPRs3LhBFQ74N70kVxMOCdec1lU bnFzLIMGlz0CAwEAAaNQME4wHQYDVR0OBBYEFFHeljijrr+SPxlH5fjHRPcC7bv2 MB8GA1UdIwQYMBaAFFHeljijrr+SPxlH5fjHRPcC7bv2MAwGA1UdEwQFMAMBAf8w DQYJKoZIhvcNAQELBQADggEBAG6NNTK7sl9nJxeewVuogCdMtkcdnx9onGtCOeiQ qvh5Xwn9akZtoLMVEdceU0ihO4wILlcom3OqHs9WOd6VbgW5a19Thh2toxKidHz5 rAaBMyZsQbFb6+vFshZwoCtOLZI/eIZfUUMFqMXlEPrKru1nSddNdai2+zi5rEnM HCot43+3XYuqkvWlOjoi9cP+C4epFYrxpykVbcrtbd7TK+wZNiK3xtDPnVzjdNWL geAEl9xrrk0ss4nO/EreTQgS46gVU+tLC+b23m2dU7dcKZ7RDoiA9bdVc4a2IsaS 2MvLL4NZ2nUh8hAEHiLtGMAV3C6xNbEyM07hEpDW6vk6tqk= -----END CERTIFICATE----- key: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCf6sMQke4OUrPf lZXqKZC4uaQLMxJB2DgacBf4Q3kXcVNCNHtc2U3U5cMD8tr3/Jt5MKKun5jQrbXV FF4eVr4Iv9jgPBwQc2kBUC9QL/alsMhEuXMeqdGQcCK3F0CLJdV3zUlKUDU0kg+O Exnbl1CHXrIbpD7zLy1i3s8p39v1pYFYf4WlrQxvfa/xo97gXY5dJv8RryryLzRc uhHYBvX5MHCGpbrY61JxpfZqBo8CmLuHl1tmbeXpdHdQB11LKiuL6HtKflNjc6rg 5r8bXl1nZbM/KOZEE+muA1LVoaTyHzY/aGXz0bNy4QRUO+De9JFcTDgnXnNZVG5x cyyDBpc9AgMBAAECggEAatcEtehZPJaCeClPPF/Cwbe9YoIfe4BCk186lHI3z7K1 5nB7zt+bwVY0AUpagv3wvXoB5lrYVOsJpa9y5iAb3GqYMc/XDCKfD/KLea5hwfcn BctEn0LjsPVKLDrLs2t2gBDWG2EU+udunwQh7XTdp2Nb6V3FdOGbGAg2LgrSwP1g 0r4z14F70oWGYyTQ5N8UGuyryVrzQH525OYl38Yt7R6zJ/44FVi/2TvdfHM5ss39 SXWi00Q30fzaBEf4AdHVwVCRKctwSbrIOyM53kiScFDmBGRblCWOxXbiFV+d3bjX gf2zxs7QYZrFOzOO7kLtHGua4itEB02497v+1oKDwQKBgQDOBvCVGRe2WpItOLnj SF8iz7Sm+jJGQz0D9FhWyGPvrN7IXGrsXavA1kKRz22dsU8xdKk0yciOB13Wb5y6 yLsr/fPBjAhPb4h543VHFjpAQcxpsH51DE0b2oYOWMmz+rXGB5Jy8EkP7Q4njIsc 2wLod1dps8OT8zFx1jX3Us6iUQKBgQDGtKkfsvWi3HkwjFTR+/Y0oMz7bSruE5Z8 g0VOHPkSr4XiYgLpQxjbNjq8fwsa/jTt1B57+By4xLpZYD0BTFuf5po+igSZhH8s QS5XnUnbM7d6Xr/da7ZkhSmUbEaMeHONSIVpYNgtRo4bB9Mh0l1HWdoevw/w5Ryt L/OQiPhfLQKBgQCh1iG1fPh7bbnVe/HI71iL58xoPbCwMLEFIjMiOFcINirqCG6V LR91Ytj34JCihl1G4/TmWnsH1hGIGDRtJLCiZeHL70u32kzCMkI1jOhFAWqoutMa 7obDkmwraONIVW/kFp6bWtSJhhTQTD4adI9cPCKWDXdcCHSWj0Xk+U8HgQKBgBng t1HYhaLzIZlP/U/nh3XtJyTrX7bnuCZ5FhKJNWrYjxAfgY+NXHRYCKg5x2F5j70V be7pLhxmCnrPTMKZhik56AaTBOxVVBaYWoewhUjV4GRAaK5Wc8d9jB+3RizPFwVk V3OU2DJ1SNZ+W2HBOsKrEfwFF/dgby6i2w6MuAP1AoGBAIxvxUygeT/6P0fHN22P zAHFI4v2925wYdb7H//D8DIADyBwv18N6YH8uH7L+USZN7e4p2k8MGGyvTXeC6aX IeVtU6fH57Ddn59VPbF20m8RCSkmBvSdcbyBmqlZSBE+fKwCliKl6u/GH0BNAWKz r8yiEiskqRmy7P7MY9hDmEbG -----END PRIVATE KEY----- snis: - "yourdomain.com" #END ``` ```json { "ssls": [ { "cert": "-----BEGIN CERTIFICATE-----\nMIIDrzCCApegAwIBAgIJAI3Meu/gJVTLMA0GCSqGSIb3DQEBCwUAMG4xCzAJBgNV\nBAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA8GA1UEBwwISGFuZ3pob3UxDTAL\nBgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl\nci5sb2NhbDAeFw0yMDEwMjgwMzMzMDJaFw0yMTEwMjgwMzMzMDJaMG4xCzAJBgNV\nBAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA8GA1UEBwwISGFuZ3pob3UxDTAL\nBgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl\nci5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ/qwxCR7g5S\ns9+VleopkLi5pAszEkHYOBpwF/hDeRdxU0I0e1zZTdTlwwPy2vf8m3kwoq6fmNCt\ntdUUXh5Wvgi/2OA8HBBzaQFQL1Av9qWwyES5cx6p0ZBwIrcXQIsl1XfNSUpQNTSS\nD44TGduXUIdeshukPvMvLWLezynf2/WlgVh/haWtDG99r/Gj3uBdjl0m/xGvKvIv\nNFy6EdgG9fkwcIalutjrUnGl9moGjwKYu4eXW2Zt5el0d1AHXUsqK4voe0p+U2Nz\nquDmvxteXWdlsz8o5kQT6a4DUtWhpPIfNj9oZfPRs3LhBFQ74N70kVxMOCdec1lU\nbnFzLIMGlz0CAwEAAaNQME4wHQYDVR0OBBYEFFHeljijrr+SPxlH5fjHRPcC7bv2\nMB8GA1UdIwQYMBaAFFHeljijrr+SPxlH5fjHRPcC7bv2MAwGA1UdEwQFMAMBAf8w\nDQYJKoZIhvcNAQELBQADggEBAG6NNTK7sl9nJxeewVuogCdMtkcdnx9onGtCOeiQ\nqvh5Xwn9akZtoLMVEdceU0ihO4wILlcom3OqHs9WOd6VbgW5a19Thh2toxKidHz5\nrAaBMyZsQbFb6+vFshZwoCtOLZI/eIZfUUMFqMXlEPrKru1nSddNdai2+zi5rEnM\nHCot43+3XYuqkvWlOjoi9cP+C4epFYrxpykVbcrtbd7TK+wZNiK3xtDPnVzjdNWL\ngeAEl9xrrk0ss4nO/EreTQgS46gVU+tLC+b23m2dU7dcKZ7RDoiA9bdVc4a2IsaS\n2MvLL4NZ2nUh8hAEHiLtGMAV3C6xNbEyM07hEpDW6vk6tqk=\n-----END CERTIFICATE-----", "key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCf6sMQke4OUrPf\nlZXqKZC4uaQLMxJB2DgacBf4Q3kXcVNCNHtc2U3U5cMD8tr3/Jt5MKKun5jQrbXV\nFF4eVr4Iv9jgPBwQc2kBUC9QL/alsMhEuXMeqdGQcCK3F0CLJdV3zUlKUDU0kg+O\nExnbl1CHXrIbpD7zLy1i3s8p39v1pYFYf4WlrQxvfa/xo97gXY5dJv8RryryLzRc\nuhHYBvX5MHCGpbrY61JxpfZqBo8CmLuHl1tmbeXpdHdQB11LKiuL6HtKflNjc6rg\n5r8bXl1nZbM/KOZEE+muA1LVoaTyHzY/aGXz0bNy4QRUO+De9JFcTDgnXnNZVG5x\ncyyDBpc9AgMBAAECggEAatcEtehZPJaCeClPPF/Cwbe9YoIfe4BCk186lHI3z7K1\n5nB7zt+bwVY0AUpagv3wvXoB5lrYVOsJpa9y5iAb3GqYMc/XDCKfD/KLea5hwfcn\nBctEn0LjsPVKLDrLs2t2gBDWG2EU+udunwQh7XTdp2Nb6V3FdOGbGAg2LgrSwP1g\n0r4z14F70oWGYyTQ5N8UGuyryVrzQH525OYl38Yt7R6zJ/44FVi/2TvdfHM5ss39\nSXWi00Q30fzaBEf4AdHVwVCRKctwSbrIOyM53kiScFDmBGRblCWOxXbiFV+d3bjX\ngf2zxs7QYZrFOzOO7kLtHGua4itEB02497v+1oKDwQKBgQDOBvCVGRe2WpItOLnj\nSF8iz7Sm+jJGQz0D9FhWyGPvrN7IXGrsXavA1kKRz22dsU8xdKk0yciOB13Wb5y6\nyLsr/fPBjAhPb4h543VHFjpAQcxpsH51DE0b2oYOWMmz+rXGB5Jy8EkP7Q4njIsc\n2wLod1dps8OT8zFx1jX3Us6iUQKBgQDGtKkfsvWi3HkwjFTR+/Y0oMz7bSruE5Z8\ng0VOHPkSr4XiYgLpQxjbNjq8fwsa/jTt1B57+By4xLpZYD0BTFuf5po+igSZhH8s\nQS5XnUnbM7d6Xr/da7ZkhSmUbEaMeHONSIVpYNgtRo4bB9Mh0l1HWdoevw/w5Ryt\nL/OQiPhfLQKBgQCh1iG1fPh7bbnVe/HI71iL58xoPbCwMLEFIjMiOFcINirqCG6V\nLR91Ytj34JCihl1G4/TmWnsH1hGIGDRtJLCiZeHL70u32kzCMkI1jOhFAWqoutMa\n7obDkmwraONIVW/kFp6bWtSJhhTQTD4adI9cPCKWDXdcCHSWj0Xk+U8HgQKBgBng\nt1HYhaLzIZlP/U/nh3XtJyTrX7bnuCZ5FhKJNWrYjxAfgY+NXHRYCKg5x2F5j70V\nbe7pLhxmCnrPTMKZhik56AaTBOxVVBaYWoewhUjV4GRAaK5Wc8d9jB+3RizPFwVk\nV3OU2DJ1SNZ+W2HBOsKrEfwFF/dgby6i2w6MuAP1AoGBAIxvxUygeT/6P0fHN22P\nzAHFI4v2925wYdb7H//D8DIADyBwv18N6YH8uH7L+USZN7e4p2k8MGGyvTXeC6aX\nIeVtU6fH57Ddn59VPbF20m8RCSkmBvSdcbyBmqlZSBE+fKwCliKl6u/GH0BNAWKz\nr8yiEiskqRmy7P7MY9hDmEbG\n-----END PRIVATE KEY-----", "snis": [ "yourdomain.com" ] } ] } ``` ### How to configure global rule ```yaml global_rules: - id: 1 plugins: response-rewrite: body: "hello\n" #END ``` ```json { "global_rules": [ { "id": 1, "plugins": { "response-rewrite": { "body": "hello\n" } } } ] } ``` ### How to configure consumer ```yaml consumers: - username: jwt plugins: jwt-auth: key: user-key secret: my-secret-key #END ``` ```json { "consumers": [ { "username": "jwt", "plugins": { "jwt-auth": { "key": "user-key", "secret": "my-secret-key" } } } ] } ``` ### How to configure plugin metadata ```yaml upstreams: - id: 1 nodes: "127.0.0.1:1980": 1 type: roundrobin routes: - uri: /hello upstream_id: 1 plugins: http-logger: batch_max_size: 1 uri: http://127.0.0.1:1980/log plugin_metadata: - id: http-logger # note the id is the plugin name log_format: host: "$host" remote_addr: "$remote_addr" #END ``` ```json { "upstreams": [ { "id": 1, "nodes": { "127.0.0.1:1980": 1 }, "type": "roundrobin" } ], "routes": [ { "uri": "/hello", "upstream_id": 1, "plugins": { "http-logger": { "batch_max_size": 1, "uri": "http://127.0.0.1:1980/log" } } } ], "plugin_metadata": [ { "id": "http-logger", "log_format": { "host": "$host", "remote_addr": "$remote_addr" } } ] } ``` ### How to configure stream route ```yaml stream_routes: - server_addr: 127.0.0.1 server_port: 1985 id: 1 upstream_id: 1 plugins: mqtt-proxy: protocol_name: "MQTT" protocol_level: 4 upstreams: - nodes: "127.0.0.1:1995": 1 type: roundrobin id: 1 #END ``` ```json { "stream_routes": [ { "server_addr": "127.0.0.1", "server_port": 1985, "id": 1, "upstream_id": 1, "plugins": { "mqtt-proxy": { "protocol_name": "MQTT", "protocol_level": 4 } } } ], "upstreams": [ { "nodes": { "127.0.0.1:1995": 1 }, "type": "roundrobin", "id": 1 } ] } ``` ### How to configure protos ```yaml protos: - id: helloworld desc: hello world content: > syntax = "proto3"; package helloworld; service Greeter { rpc SayHello (HelloRequest) returns (HelloReply) {} } message HelloRequest { string name = 1; } message HelloReply { string message = 1; } #END ``` ```json { "protos": [ { "id": "helloworld", "desc": "hello world", "content": "syntax = \"proto3\";\npackage helloworld;\n\nservice Greeter {\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\nmessage HelloRequest {\n string name = 1;\n}\nmessage HelloReply {\n string message = 1;\n}\n" } ] } ```