Skip to content

Commit 8a623fe

Browse files
JTorreGCVanF5
authored andcommitted
docs: Change root wording agent (#339)
* fix: root requirements for agent install * fix: bold not
1 parent 1e91a74 commit 8a623fe

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

content/agent/about.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,39 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
4242

4343
{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
4444

45+
```mermaid
46+
graph BT
47+
48+
%% Define colors for the subgraphs
49+
style ManagementPlane fill:#d0eac4,stroke:#228B22,stroke-width:2px,color:#000000
50+
style Compute fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
51+
style NGINX fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
52+
style NGINXConfig fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
53+
style Logs fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
54+
style Agent fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
55+
56+
subgraph ManagementPlane["Management Plane"]
57+
CommandControl["Command Server"]
58+
OTelManagementPlane["OTel Receiver"]
59+
end
60+
61+
subgraph Compute["NGINX Instance"]
62+
subgraph Agent["Agent Process"]
63+
OTelDataPlane["OTel Collector"]
64+
end
65+
66+
NGINX["NGINX Process"]
67+
NGINXConfig["NGINX Config Files"]
68+
Logs["NGINX Logs"]
69+
70+
Agent --> |Watch/Reload| NGINX
71+
Agent <--> |Reads/Writes| Logs
72+
Agent <--> |Reads/Writes| NGINXConfig
73+
OTelDataPlane --> |Collects| Metrics["Host Metrics"]
74+
OTelDataPlane --> |Reads| NGINXMetrics["NGINX Metrics"]
75+
end
76+
77+
Compute <--> |gRPC| ManagementPlane
78+
```
4579
---
4680

content/agent/install-upgrade/install.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ of methods:
1515
## Before you begin
1616

1717
- You must use one of the [supported operating system and architectures]({{< ref "/agent/technical-specifications.md#supported-distributions" >}})
18-
- You need to have `root` privileges
18+
- The user running the NGINX Agent installation must have the same privileges as
19+
the main NGINX process. We recommend **not** running NGINX or NGINX Agent as the root user.
1920

2021
## Install NGINX Agent using NGINX One Console<a name="connect-to-nginx-one-console"></a>
2122

0 commit comments

Comments
 (0)