Skip to content

Commit f1a7806

Browse files
committed
Fix: Provide a description of the api_stats.sh script and its usage
1 parent bbc4f32 commit f1a7806

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

nginx-utils/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ kubectl -n <namespace> debug -it <nic-pod-name> --image=ghcr.io/nginx/nginx-util
1717
Please refer to the [nginx-utils packages page](https://github.com/nginx/nginx-supportpkg-for-k8s/pkgs/container/nginx-utils) for versions.
1818

1919
--------------
20-
#### Example usage of `api_stats.sh` found in the container:
20+
#### Example usage of `api_stats.sh` found in the container:
21+
The `api_stats.sh` script is designed to facilitate accessing the [/api](https://nginx.org/en/docs/http/ngx_http_api_module.html#api) endpoint to query various status information, configuring upstream server groups on-the-fly, and managing key-value pairs without the need of reconfiguring nginx.
22+
23+
<font color="red">NOTE</font>: The `api_stats.sh` script requires an `/api` endpoint that is listening on `loopback`, in a given `port`.
2124
```
2225
kubectl -n <namespace> debug -it <nic-pod-name> --image=ghcr.io/nginx/nginx-utils:latest --target=nginx-ingress
2326

0 commit comments

Comments
 (0)