Skip to content

Commit

Permalink
run helm-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jia Xu committed Aug 5, 2024
1 parent df7ede6 commit 5a77339
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions charts/apisix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,20 +91,20 @@ The command removes all the Kubernetes components associated with the chart and
| apisix.luaModuleHook.configMapRef.name | string | `""` | Name of the ConfigMap where the lua module codes store |
| apisix.luaModuleHook.hookPoint | string | `""` | the hook module which will be used to inject third party code into APISIX use the lua require style like: "module.say_hello" |
| apisix.luaModuleHook.luaPath | string | `""` | extend lua_package_path to load third party code |
| apisix.nginx.clientBodyTimeout | string | `"60s"` | Timeout for reading client request body, then 408 (Request Time-out) error is returned to the client. |
| apisix.nginx.clientHeaderTimeout | string | `"60s"` | Timeout for reading client request header, then 408 (Request Time-out) error is returned to the client. |
| apisix.nginx.configurationSnippet | object | `{"httpAdmin":"","httpEnd":"","httpSrv":"","httpStart":"","main":"","stream":""}` | Custom configuration snippet. |
| apisix.nginx.customLuaSharedDicts | list | `[]` | Add custom [lua_shared_dict](https://github.com/openresty/lua-nginx-module#toc88) settings, click [here](https://github.com/apache/apisix-helm-chart/blob/master/charts/apisix/values.yaml#L27-L30) to learn the format of a shared dict |
| apisix.nginx.enableCPUAffinity | bool | `true` | |
| apisix.nginx.envs | list | `[]` | |
| apisix.nginx.keepaliveTimeout | string | `60s` | Timeout during which a keep-alive client connection will stay open on the server side. |
| apisix.nginx.clientHeaderTimeout | string | `60s` | Timeout for reading client request header, then 408 (Request Time-out) error is returned to the client. |
| apisix.nginx.clientBodyTimeout | string | `60s` | Timeout for reading client request body, then 408 (Request Time-out) error is returned to the client. |
| apisix.nginx.sendTimeout | string | `10s` | Timeout for transmitting a response to the client, then the connection is closed. |
| apisix.nginx.keepaliveTimeout | string | `"60s"` | Timeout during which a keep-alive client connection will stay open on the server side. |
| apisix.nginx.logs.accessLog | string | `"/dev/stdout"` | Access log path |
| apisix.nginx.logs.accessLogFormat | string | `"$remote_addr - $remote_user [$time_local] $http_host \\\"$request\\\" $status $body_bytes_sent $request_time \\\"$http_referer\\\" \\\"$http_user_agent\\\" $upstream_addr $upstream_status $upstream_response_time \\\"$upstream_scheme://$upstream_host$upstream_uri\\\""` | Access log format |
| apisix.nginx.logs.accessLogFormatEscape | string | `"default"` | Allows setting json or default characters escaping in variables |
| apisix.nginx.logs.enableAccessLog | bool | `true` | Enable access log or not, default true |
| apisix.nginx.logs.errorLog | string | `"/dev/stderr"` | Error log path |
| apisix.nginx.logs.errorLogLevel | string | `"warn"` | Error log level |
| apisix.nginx.sendTimeout | string | `"10s"` | Timeout for transmitting a response to the client, then the connection is closed. |
| apisix.nginx.workerConnections | string | `"10620"` | |
| apisix.nginx.workerProcesses | string | `"auto"` | |
| apisix.nginx.workerRlimitNofile | string | `"20480"` | |
Expand Down

0 comments on commit 5a77339

Please sign in to comment.