Stand-alone mode

开启 Stand-alone 模式的 APISIX 节点，将不再使用默认的 etcd 作为配置中心。

这种方式比较适合两类用户：

  1. kubernetes(k8s)：声明式 API 场景，通过全量 yaml 配置来动态更新修改路由规则。
  2. 不同配置中心：配置中心的实现有很多，比如 Consul 等，使用全量 yaml 做中间转换桥梁。

APISIX 节点服务启动后会立刻加载 conf/apisix.yaml 文件中的路由规则到内存，并且每间隔一定时间（默认 1 秒钟），都会尝试检测文件内容是否有更新，如果有更新则重新加载规则。

注意：重新加载规则并更新时，均是内存热更新，不会有工作进程的替换过程，是个热更新过程。

由于目前 Admin API 都是基于 etcd 配置中心解决方案，当开启 Stand-alone 模式后， Admin API 将不再被允许使用。

通过设置 conf/config.yaml 中的 apisix.config_center 选项为 yaml ，并禁用 Admin API 即可启用 Stand-alone 模式。

参考下面示例：

  1. apisix:
  2.   enable_admin: false
  3.   config_center: yaml

如何配置规则

所有的路由规则均存放在 conf/apisix.yaml 这一个文件中，APISIX 会以每秒（默认）频率检查文件是否有变化，如果有变化，则会检查文件末尾是否能找到 #END 结尾，找到后则重新加载文件更新到内存。

下面就是个最小的示例：

  1. routes:
  2.   -
  3.     uri: /hello
  4.     upstream:
  5.         nodes:
  6.             "127.0.0.1:1980": 1
  7.         type: roundrobin
  8. #END

注意：如果 conf/apisix.yaml 末尾不能找到 #END，那么 APISIX 将不会加载这个文件规则到内存。

配置 Router

单个 Router：

  1. routes:
  2.   -
  3.     uri: /hello
  4.     upstream:
  5.         nodes:
  6.             "127.0.0.1:1980": 1
  7.         type: roundrobin
  8. #END

多个 Router：

  1. routes:
  2.   -
  3.     uri: /hello
  4.     upstream:
  5.         nodes:
  6.             "127.0.0.1:1980": 1
  7.         type: roundrobin
  8.   -
  9.     uri: /hello2
  10.     upstream:
  11.         nodes:
  12.             "127.0.0.1:1981": 1
  13.         type: roundrobin
  14. #END

配置 Router + Service

  1. routes:
  2.     -
  3.         uri: /hello
  4.         service_id: 1
  5. services:
  6.     -
  7.         id: 1
  8.         upstream:
  9.             nodes:
  10.                 "127.0.0.1:1980": 1
  11.             type: roundrobin
  12. #END

配置 Router + Upstream

  1. routes:
  2.     -
  3.         uri: /hello
  4.         upstream_id: 1
  5. upstreams:
  6.     -
  7.         id: 1
  8.         nodes:
  9.             "127.0.0.1:1980": 1
  10.         type: roundrobin
  11. #END

配置 Router + Service + Upstream

  1. routes:
  2.     -
  3.         uri: /hello
  4.         service_id: 1
  5. services:
  6.     -
  7.         id: 1
  8.         upstream_id: 2
  9. upstreams:
  10.     -
  11.         id: 2
  12.         nodes:
  13.             "127.0.0.1:1980": 1
  14.         type: roundrobin
  15. #END

配置 Plugins

  1. # 列出的插件会被热加载并覆盖掉启动时的配置
  2. plugins:
  3.   - name: ip-restriction
  4.   - name: jwt-auth
  5.   - name: mqtt-proxy
  6.     stream: true # stream 插件需要设置 stream 属性为 true
  7. #END

启用 SSL

  1. ssl:
  2.     -
  3.         cert: |
  4.             -----BEGIN CERTIFICATE-----
  5.             MIIDrzCCApegAwIBAgIJAI3Meu/gJVTLMA0GCSqGSIb3DQEBCwUAMG4xCzAJBgNV
  6.             BAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA8GA1UEBwwISGFuZ3pob3UxDTAL
  7.             BgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl
  8.             ci5sb2NhbDAeFw0yMDEwMjgwMzMzMDJaFw0yMTEwMjgwMzMzMDJaMG4xCzAJBgNV
  9.             BAYTAkNOMREwDwYDVQQIDAhaaGVqaWFuZzERMA8GA1UEBwwISGFuZ3pob3UxDTAL
  10.             BgNVBAoMBHRlc3QxDTALBgNVBAsMBHRlc3QxGzAZBgNVBAMMEmV0Y2QuY2x1c3Rl
  11.             ci5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ/qwxCR7g5S
  12.             s9+VleopkLi5pAszEkHYOBpwF/hDeRdxU0I0e1zZTdTlwwPy2vf8m3kwoq6fmNCt
  13.             tdUUXh5Wvgi/2OA8HBBzaQFQL1Av9qWwyES5cx6p0ZBwIrcXQIsl1XfNSUpQNTSS
  14.             D44TGduXUIdeshukPvMvLWLezynf2/WlgVh/haWtDG99r/Gj3uBdjl0m/xGvKvIv
  15.             NFy6EdgG9fkwcIalutjrUnGl9moGjwKYu4eXW2Zt5el0d1AHXUsqK4voe0p+U2Nz
  16.             quDmvxteXWdlsz8o5kQT6a4DUtWhpPIfNj9oZfPRs3LhBFQ74N70kVxMOCdec1lU
  17.             bnFzLIMGlz0CAwEAAaNQME4wHQYDVR0OBBYEFFHeljijrr+SPxlH5fjHRPcC7bv2
  18.             MB8GA1UdIwQYMBaAFFHeljijrr+SPxlH5fjHRPcC7bv2MAwGA1UdEwQFMAMBAf8w
  19.             DQYJKoZIhvcNAQELBQADggEBAG6NNTK7sl9nJxeewVuogCdMtkcdnx9onGtCOeiQ
  20.             qvh5Xwn9akZtoLMVEdceU0ihO4wILlcom3OqHs9WOd6VbgW5a19Thh2toxKidHz5
  21.             rAaBMyZsQbFb6+vFshZwoCtOLZI/eIZfUUMFqMXlEPrKru1nSddNdai2+zi5rEnM
  22.             HCot43+3XYuqkvWlOjoi9cP+C4epFYrxpykVbcrtbd7TK+wZNiK3xtDPnVzjdNWL
  23.             geAEl9xrrk0ss4nO/EreTQgS46gVU+tLC+b23m2dU7dcKZ7RDoiA9bdVc4a2IsaS
  24.             2MvLL4NZ2nUh8hAEHiLtGMAV3C6xNbEyM07hEpDW6vk6tqk=
  25.             -----END CERTIFICATE-----
  26.         key: |
  27.             -----BEGIN PRIVATE KEY-----
  28.             MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCf6sMQke4OUrPf
  29.             lZXqKZC4uaQLMxJB2DgacBf4Q3kXcVNCNHtc2U3U5cMD8tr3/Jt5MKKun5jQrbXV
  30.             FF4eVr4Iv9jgPBwQc2kBUC9QL/alsMhEuXMeqdGQcCK3F0CLJdV3zUlKUDU0kg+O
  31.             Exnbl1CHXrIbpD7zLy1i3s8p39v1pYFYf4WlrQxvfa/xo97gXY5dJv8RryryLzRc
  32.             uhHYBvX5MHCGpbrY61JxpfZqBo8CmLuHl1tmbeXpdHdQB11LKiuL6HtKflNjc6rg
  33.             5r8bXl1nZbM/KOZEE+muA1LVoaTyHzY/aGXz0bNy4QRUO+De9JFcTDgnXnNZVG5x
  34.             cyyDBpc9AgMBAAECggEAatcEtehZPJaCeClPPF/Cwbe9YoIfe4BCk186lHI3z7K1
  35.             5nB7zt+bwVY0AUpagv3wvXoB5lrYVOsJpa9y5iAb3GqYMc/XDCKfD/KLea5hwfcn
  36.             BctEn0LjsPVKLDrLs2t2gBDWG2EU+udunwQh7XTdp2Nb6V3FdOGbGAg2LgrSwP1g
  37.             0r4z14F70oWGYyTQ5N8UGuyryVrzQH525OYl38Yt7R6zJ/44FVi/2TvdfHM5ss39
  38.             SXWi00Q30fzaBEf4AdHVwVCRKctwSbrIOyM53kiScFDmBGRblCWOxXbiFV+d3bjX
  39.             gf2zxs7QYZrFOzOO7kLtHGua4itEB02497v+1oKDwQKBgQDOBvCVGRe2WpItOLnj
  40.             SF8iz7Sm+jJGQz0D9FhWyGPvrN7IXGrsXavA1kKRz22dsU8xdKk0yciOB13Wb5y6
  41.             yLsr/fPBjAhPb4h543VHFjpAQcxpsH51DE0b2oYOWMmz+rXGB5Jy8EkP7Q4njIsc
  42.             2wLod1dps8OT8zFx1jX3Us6iUQKBgQDGtKkfsvWi3HkwjFTR+/Y0oMz7bSruE5Z8
  43.             g0VOHPkSr4XiYgLpQxjbNjq8fwsa/jTt1B57+By4xLpZYD0BTFuf5po+igSZhH8s
  44.             QS5XnUnbM7d6Xr/da7ZkhSmUbEaMeHONSIVpYNgtRo4bB9Mh0l1HWdoevw/w5Ryt
  45.             L/OQiPhfLQKBgQCh1iG1fPh7bbnVe/HI71iL58xoPbCwMLEFIjMiOFcINirqCG6V
  46.             LR91Ytj34JCihl1G4/TmWnsH1hGIGDRtJLCiZeHL70u32kzCMkI1jOhFAWqoutMa
  47.             7obDkmwraONIVW/kFp6bWtSJhhTQTD4adI9cPCKWDXdcCHSWj0Xk+U8HgQKBgBng
  48.             t1HYhaLzIZlP/U/nh3XtJyTrX7bnuCZ5FhKJNWrYjxAfgY+NXHRYCKg5x2F5j70V
  49.             be7pLhxmCnrPTMKZhik56AaTBOxVVBaYWoewhUjV4GRAaK5Wc8d9jB+3RizPFwVk
  50.             V3OU2DJ1SNZ+W2HBOsKrEfwFF/dgby6i2w6MuAP1AoGBAIxvxUygeT/6P0fHN22P
  51.             zAHFI4v2925wYdb7H//D8DIADyBwv18N6YH8uH7L+USZN7e4p2k8MGGyvTXeC6aX
  52.             IeVtU6fH57Ddn59VPbF20m8RCSkmBvSdcbyBmqlZSBE+fKwCliKl6u/GH0BNAWKz
  53.             r8yiEiskqRmy7P7MY9hDmEbG
  54.             -----END PRIVATE KEY-----
  55.         snis:
  56.             - "yourdomain.com"
  57. #END

配置 global rule

  1. global_rules:
  2.     -
  3.         id: 1
  4.         plugins:
  5.             response-rewrite:
  6.                 body: "hello\n"

配置 consumer

  1. consumers:
  2.   - username: jwt
  3.     plugins:
  4.         jwt-auth:
  5.             key: user-key
  6.             secret: my-secret-key

配置 plugin metadata

  1. upstreams:
  2.   - id: 1
  3.     nodes:
  4.       "127.0.0.1:1980": 1
  5.     type: roundrobin
  6. routes:
  7.   -
  8.     uri: /hello
  9.     upstream_id: 1
  10.     plugins:
  11.         http-logger:
  12.             batch_max_size: 1
  13.             uri: http://127.0.0.1:1980/log
  14. plugin_metadata:
  15.   - id: http-logger # 注意 id 是插件名称
  16.     log_format:
  17.         host: "$host",
  18.         remote_addr: "$remote_addr"

配置 stream route

  1. stream_routes:
  2.   - server_addr: 127.0.0.1
  3.     server_port: 1985
  4.     id: 1
  5.     upstream_id: 1
  6.     plugins:
  7.       mqtt-proxy:
  8.         protocol_name: "MQTT"
  9.         protocol_level: 4
  10.         upstream:
  11.           ip: "127.0.0.1"
  12.           port: 1995
  13. upstreams:
  14.   - nodes:
  15.       "127.0.0.1:1995": 1
  16.     type: roundrobin
  17.     id: 1