NGINX Agent docs. Consistency issues. #906
Description
Describe the bug
There are multiple docs that refer to running the agent in containers, but they vary between using environment variables and mounted config files. Ideally, we should pick one consistent approach per version, or clearly explain when and why to use one over the other.
- For example, this doc recommends using a config file (mounted via volume) for Agent v3.
- Meanwhile, this one shows environment variables, but only for Agent v2 — and those variables are different from v3.
This doc includes an example using environment variables for v2, but also briefly mentions v3, which may cause additional confusion.
Finally, this doc references pulling the agent from docker-registry.nginx.com, which is for the OSS version. That could mislead NGINX Plus customers, as the distinction isn’t very clear.
Also, in https://docs.nginx.com/nginx-agent/overview/
- This is no longer correct:
F5 NGINX One Console and NGINX Instance Manager (NIM) do not currently support Agent 3.x. If you are
using NGINX One Console or NGINX Instance Manager in your environment, upgrade to the latest Agent 2.x
version by following the Upgrade NGINX Agent guide.
Also... And probably a good idea to have flag to env variable map for V3 like the one for V2 https://docs.nginx.com/nginx-agent/configuration/configuration-overview/, this way the field/customer has a simple way of looking them up when building a config file (for baremetal/VM) or their k8s manifest
To reproduce
Steps to reproduce the behavior:
- Deploy this project using [...]
- View output/logs/configuration on [...]
- See error
Expected behavior
A clear and concise description of what you expected to happen.
Your environment
- Version/release of this project or specific commit
- Target deployment platform
Additional context
Add any other context about the problem here.
Sensitive Information
Remember to redact any sensitive information such as authentication credentials or license keys.