Skip to content

Commit 8c4573b

Browse files
JTorreGJTorreG
authored
update v3 agent about (#452)
* update v3 agent about * update hugo * updage go.sum * convert about agent to includes * fix mermaid graphs
1 parent 90f2313 commit 8c4573b

File tree

4 files changed

+129
-40
lines changed

4 files changed

+129
-40
lines changed

‎content/agent/about.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,18 @@
11
---
2-
title: "Overview"
2+
title: "About"
33
weight: 100
44
toc: true
55
docs: DOCS-000
66
---
77
{{<call-out "note" "F5 NGINX Agent v3.0 is available now">}}
8-
<!-- (TODO: Link instructions ) -->
9-
{{</call-out>}}
10-
11-
The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX One, enabling remote management of the NGINX Instance(s). It also gathers performance metrics from NGINX and transmits them to the NGINX One Console for enhanced monitoring and control.
12-
13-
## Key Features
14-
15-
- Enable Access to Key NGINX One Use Cases
16-
- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows.
17-
- [Connect to NGINX One Console]({{< ref "/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})
18-
19-
- Real-Time Observability into NGINX One Data Plane Instances
20-
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency.
21-
22-
- [OpenTelemetry](https://opentelemetry.io/) support comes with F5 NGINX Agent, and the ability to [export the metrics data]({{< ref "/agent/otel/configure-otel-metrics.md" >}}) for use in other applications.
8+
NGINX Agent v3.0 is a major release that introduces new features and enhancements.
239

10+
Visit our [Update]({{< ref "/agent/install-upgrade/update.md" >}}) guide to install the latest version in your environment.
11+
{{</call-out>}}
2412

13+
{{< include "agent/about.md" >}}
2514

26-
### Configuration management
27-
28-
- The F5 NGINX Agent provides an interface that enables users to deploy configuration changes to NGINX from a centralized management plane.
29-
- Additionally, the F5 NGINX Agent verifies that the configuration changes are successfully applied to NGINX.
30-
31-
### Metrics Collection
32-
33-
- The F5 NGINX Agent comes pre-packaged with an embedded OpenTelemetry Collector .
34-
- This embedded collector gathers vital performance and health metrics for both NGINX and the underlying instance it operates on.
35-
- For example, it tracks key metrics such as active connections, requests per second, HTTP status codes, and response times. Additionally, it collects system-level data, including CPU usage, memory consumption, and disk I/O. These insights provide deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and maintain high availability.
36-
- Collected metrics can be seamlessly exported to the NGINX One Console or integrated with third-party data aggregators.
37-
38-
## How NGINX Agent works
15+
## Architecture
3916

4017
```mermaid
4118
graph BT
@@ -77,14 +54,4 @@ graph BT
7754
Compute <--> |gRPC| ManagementPlane
7855
```
7956

80-
The figure shows:
81-
82-
- An NGINX Instance running on bare metal, virtual machine or container
83-
- The NGINX One Cloud Console includes:
84-
- Command Server to manage NGINX configurations, push new/updated configuration files remotely, and perform integrity tests.
85-
- OpenTelemetry (OTel) Receiver that receives observability data from connected Agent instances.
86-
- An NGINX Agent process running on the NGINX instance. NGINX Agent is responsible for:
87-
- Watching, applying, validating, automatically roll back to last good configuration if issues are detected.
88-
- Embedding an OpenTelemetry Collector, collecting metrics from NGINX processes, host system performance data, then securely passing metric data to the NGINX One Cloud Console.
89-
- Collection and monitoring of host metrics (CPU usage, Memory utilization, Disk I/O) by the Agent OTel collector.
90-
- Collected data is made available on the NGINX One Cloud Console for monitoring, alerting, troubleshooting, and capacity planning purposes.
57+
{{< include "agent/architecture.md" >}}

‎content/includes/agent/about.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
docs:
3+
files:
4+
- content/agent/about.md
5+
- content/nginx-one/agent/about.md
6+
---
7+
8+
F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX One and enable remote management of NGINX instances. It also gathers performance metrics from NGINX and transmits them to the NGINX One Console for enhanced monitoring and control.
9+
10+
## Key features
11+
12+
Enable Access to key NGINX One use cases:
13+
14+
- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and
15+
enhancing operational workflows.
16+
- [Connects NGINX instances to NGINX One Console]({{< ref "/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})
17+
18+
Real-time observability into NGINX One data plane instances:
19+
20+
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One data plane
21+
instances, improving decision-making and operational efficiency.
22+
- NGINX Agent supports [OpenTelemetry](https://opentelemetry.io/), and the ability to
23+
[export the metrics data]({{< ref "/agent/otel/configure-otel-metrics.md" >}}) for use in other applications.
24+
25+
26+
27+
### Configuration management
28+
29+
- NGINX Agent provides an interface that enables users to deploy configuration changes to NGINX instances from a
30+
centralized management plane.
31+
- Additionally, NGINX Agent verifies that the configuration changes are successfully applied to NGINX instances.
32+
33+
### Metrics collection
34+
35+
NGINX Agent comes pre-packaged with an embedded OpenTelemetry Collector. This embedded collector gathers vital performance
36+
and health metrics for both NGINX and the underlying instance it operates on.
37+
38+
For example, it tracks key metrics such as active connections, requests per second, HTTP status codes, and response times.
39+
Additionally, it collects system-level data, including CPU usage, memory consumption, and disk I/O. These insights provide
40+
deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and
41+
maintain high availability.
42+
43+
Collected metrics can be seamlessly exported to NGINX One Console or integrated with third-party data aggregators.

‎content/includes/agent/architecture.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
docs:
3+
files:
4+
- content/agent/about.md
5+
- content/nginx-one/agent/about.md
6+
---
7+
8+
The figure shows:
9+
10+
- An NGINX instance running on bare metal, virtual machine or container
11+
- NGINX One Cloud Console includes:
12+
13+
- Command Server to manage NGINX configurations, push new/updated configuration files remotely, and perform integrity tests.
14+
- OpenTelemetry (OTel) Receiver that receives observability data from connected Agent instances.
15+
16+
- An NGINX Agent process running on the NGINX instance. NGINX Agent is responsible for:
17+
18+
- Watching, applying, validating, automatically roll back to last good configuration if issues are detected.
19+
- Embedding an OpenTelemetry Collector, collecting metrics from NGINX processes, host system performance data, then securely passing metric data to NGINX One Cloud Console.
20+
21+
- Collection and monitoring of host metrics (CPU usage, Memory utilization, Disk I/O) by the Agent OTel collector.
22+
- Collected data is made available on NGINX One Cloud Console for monitoring, alerting, troubleshooting, and capacity planning purposes.

‎content/nginx-one/agent/about.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "About"
3+
weight: 10
4+
toc: true
5+
---
6+
7+
{{<call-out "note" "F5 NGINX Agent v3.0 is available now">}}
8+
NGINX Agent v3.0 is a major release that introduces new features and enhancements.
9+
10+
Visit our [Update]({{< ref "/agent/install-upgrade/update.md" >}}) guide to install the latest version in your environment.
11+
{{</call-out>}}
12+
13+
{{< include "agent/about.md" >}}
14+
15+
## Architecture
16+
17+
```mermaid
18+
graph BT
19+
20+
%% Define colors for the subgraphs
21+
style ManagementPlane fill:#d0eac4,stroke:#228B22,stroke-width:2px,color:#000000
22+
style CommandControl fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
23+
style OTelManagementPlane fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
24+
style Compute fill:#cfe2f1,stroke:#1E90FF,stroke-width:2px,color:#000000
25+
style NGINX fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
26+
style NGINXConfig fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
27+
style ErrorLogs fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
28+
style Agent fill:#b5e0b6,stroke:#008000,stroke-width:2px,color:#000000
29+
30+
subgraph ManagementPlane["NGINX One"]
31+
CommandControl["Command Server"]
32+
OTelManagementPlane["OTel Receiver"]
33+
end
34+
35+
subgraph Compute["NGINX Instance"]
36+
subgraph Agent["Agent Process"]
37+
OTelDataPlane["OTel Collector"]
38+
end
39+
40+
subgraph NGINX["NGINX Process"]
41+
NGINXMetrics["Metrics"]
42+
end
43+
NGINXConfig["NGINX Configuration Files"]
44+
ErrorLogs["NGINX Error Logs"]
45+
46+
Metrics["Host Metrics"] --> |Collects| OTelDataPlane
47+
NGINXMetrics --> |Reads| OTelDataPlane["OTel Collector"]
48+
Agent --> |Watch/Reload| NGINX
49+
Agent --> |Reads| ErrorLogs
50+
OTelDataPlane --> |Reads| AccessLogs["NGINX Access Logs"]
51+
Agent <--> |Reads/Writes| NGINXConfig
52+
end
53+
54+
Compute <--> |gRPC| ManagementPlane
55+
```
56+
57+
{{< include "agent/architecture.md" >}}

0 commit comments

Comments
 (0)