Skip to content

Agent v3 IA changes #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged

Agent v3 IA changes #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/includes/agent/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/about.md
- content/nginx-one/agent/about.md
- content/nginx-one/agent/overview/about.md
---

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.
Expand All @@ -20,7 +20,7 @@ Real-time observability into NGINX One data plane instances:
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One data plane
instances, improving decision-making and operational efficiency.
- NGINX Agent supports [OpenTelemetry](https://opentelemetry.io/) and the ability to
[export the metrics data]({{< ref "/nginx-one/agent/configure-otel-metrics.md" >}}) for use in other applications.
[export the metrics data]({{< ref "/nginx-one/agent/metrics/configure-otel-metrics.md" >}}) for use in other applications.



Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/about.md
- content/nginx-one/agent/about.md
- content/nginx-one/agent/overview/about.md
---

The figure shows:
Expand Down
8 changes: 8 additions & 0 deletions content/includes/agent/installation/manually-connect-to-console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
docs:
files:
- content/nginx-one/agent/install-upgrade/install-from-github.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

If you have installed NGINX Agent manually, you will need to connect it to the
NGINX One Console to manage your NGINX instances.

Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-freebsd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. To setup the pkg repository create a file with name `/etc/pkg/nginx-agent.conf`
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-rhel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-sles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-freebsd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-rhel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-sles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/plus/plus-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

1. Create the `/etc/ssl/nginx` directory:
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/installation/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ files:
- content/agent/install-upgrade/install-from-github.md
- content/agent/install-upgrade/install-from-oss-repo.md
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

- You must use one of the [supported operating system and architectures]({{< ref "/nginx-one/agent/tech-specs.md#supported-distributions" >}})
- You must use one of the [supported operating system and architectures]({{< ref "/nginx-one/agent/overview/tech-specs.md#supported-distributions" >}})
- The user running the NGINX Agent installation must have the same privileges as
the main NGINX process. We recommend **not** running NGINX or NGINX Agent as the root user.
4 changes: 2 additions & 2 deletions content/includes/agent/installation/start-stop-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ files:
- content/agent/install-upgrade/install-from-github.md
- content/agent/install-upgrade/install-from-oss-repo.md
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

To start NGINX Agent on `systemd` systems, run the following command:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-alpine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-amazon-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-debian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-freebsd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-rhel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-sles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/uninstall/uninstall-ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/update-container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/update.md
- content/nginx-one/agent/update.md
- content/nginx-one/agent/install-upgrade/update.md
---

To migrate NGINX Agent containers, we provide a script to convert NGINX Agent v2 config files to NGINX Agent v3 config files: [NGINX Agent Config Upgrade Script](https://github.com/nginx/agent/blob/v3/scripts/packages/upgrade-agent-config.sh)
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/install-upgrade/update.md
- content/nginx-one/agent/update.md
- content/nginx-one/agent/install-upgrade/update.md
---


Expand Down
4 changes: 2 additions & 2 deletions content/includes/agent/installation/verify-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ files:
- content/agent/install-upgrade/install-from-github.md
- content/agent/install-upgrade/install-from-oss-repo.md
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-from-oss-repo.md
- content/nginx-one/agent/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
---

Once you have installed NGINX Agent, you can verify that it is running with the
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/tech-specs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
docs:
files:
- content/agent/tech-specs.md
- content/nginx-one/agent/tech-specs.md
- content/nginx-one/agent/overview/tech-specs.md
---

NGINX Agent is designed to operate efficiently on any system that meets the standard
Expand Down
12 changes: 12 additions & 0 deletions content/includes/agent/v3-available.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
docs:
files:
- content/nginx-one/agent/overview/about.md
- content/nginx-one/agent/changelog.md
---

{{<call-out "note" "F5 NGINX Agent v3.0 is available now">}}
NGINX Agent v3.0 is a major release that introduces new features and enhancements.

Visit our [Update]({{< ref "/nginx-one/agent/install-upgrade/update.md" >}}) guide to install the latest version in your environment.
{{</call-out>}}
8 changes: 5 additions & 3 deletions content/nginx-one/agent/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
title: "NGINX Agent Changelog"
weight: 700
title: "NGINX Agent changelog"
weight: 10000
toc: true
---

{{< note >}}You can find the full changelog, contributor list and assets for NGINX Agent in the [GitHub repository](https://github.com/nginx/agent/releases).{{< /note >}}

See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< ref "/nginx-one/agent/tech-specs.md" >}}).
See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< ref "/nginx-one/agent/overview/tech-specs.md" >}}).

---
## Release [v3.0.0](https//github.com/nginx/agent/releases/tag/v3.0.0)

{{< include "agent/v3-available.md" >}}

### 🌟 Highlights

### 🐛 Bug Fixes
Expand Down
5 changes: 5 additions & 0 deletions content/nginx-one/agent/community/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Community"
weight: 600
url: /nginx-one/agent/community/
---
0 content/nginx-one/agent/community.md → ...nt/nginx-one/agent/community/community.md
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions content/nginx-one/agent/configure-instance-reporting/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Configure instance reporting"
weight: 400
url: /nginx-one/agent/configure-instance-reporting/
---
0 ...ne/agent/how-to/configuration-overview.md → ...tance-reporting/configuration-overview.md
View file
Open in desktop
File renamed without changes.
0 ...one/agent/how-to/configure-agent-group.md → ...stance-reporting/configure-agent-group.md
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions content/nginx-one/agent/containers/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Containers"
weight: 300
url: /nginx-one/agent/containers/
---
2 changes: 1 addition & 1 deletion ...x-one/agent/how-to/run-agent-container.md → ...e/agent/containers/run-agent-container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Run the NGINX Agent in a container"
weight: 300
weight: 100
toc: true
type: how-to
product: Agent
Expand Down
5 changes: 0 additions & 5 deletions content/nginx-one/agent/how-to/_index.md
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions content/nginx-one/agent/install-upgrade/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Install and update"
weight: 400
url: /nginx-agent/install-upgrade/
weight: 200
url: /nginx-one/agent/install-upgrade/
---
5 changes: 5 additions & 0 deletions content/nginx-one/agent/metrics/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Metrics"
weight: 500
url: /nginx-one/agent/metrics/
---
0 ...nginx-one/agent/configure-otel-metrics.md → ...e/agent/metrics/configure-otel-metrics.md
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions content/nginx-one/agent/overview/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Overview"
weight: 100
url: /nginx-one/agent/install-upgrade/
---
Loading
Loading