Skip to content

Agent release 3.0 #567

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.

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

Draft
wants to merge 67 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
ef2a885
docs: transfer v3 Docs to public repo
JTorreG Feb 10, 2025
ece7ce3
fix: fix broken links in v3 docs - theme bump
JTorreG Feb 12, 2025
3e37786
docs: re-add note
JTorreG Feb 12, 2025
8eab420
fix: add url meta
JTorreG Feb 12, 2025
e4732a0
docs: remove v2 metrics page
JTorreG Mar 3, 2025
e19abce
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG Mar 13, 2025
5fdc663
docs: update theme
JTorreG Mar 27, 2025
9535b7d
docs:Adding agent v3 docs (#326)
nginx-seanmoloney Mar 27, 2025
1e91a74
docs: review Agent v3 install doc (#327)
JTorreG Mar 31, 2025
d9609a5
docs: Change root wording agent (#339)
JTorreG Apr 1, 2025
13db0c6
docs: update agent v3 support doc (#357)
JTorreG Apr 3, 2025
e0003e0
docs: Change root wording agent (#339)
JTorreG Apr 1, 2025
e8c3f32
Add Agent V3 Diagram
CVanF5 Apr 1, 2025
d959cea
Add Agent V3 diagram description
CVanF5 Apr 3, 2025
60879a8
change wording based on feedback
CVanF5 Apr 4, 2025
8ec3646
Address PR feedback
CVanF5 Apr 7, 2025
fa9dc45
docs: about formatting (#375)
JTorreG Apr 8, 2025
a18ae36
docs: Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG Apr 9, 2025
e77cab5
docs: Agent v3 tech spec (#382)hhhhhhhhhhhhhhhhhhhhhhhh
JTorreG Apr 9, 2025
7b76e79
Update metrics docs, add run-container guide (#352)
nginx-seanmoloney Apr 14, 2025
ce1b12d
docs: rebase Merge remote-tracking branch 'origin' into agent-release…
JTorreG Apr 16, 2025
b7dcd95
docs: Agent v3 docs to includes (#418)
JTorreG Apr 22, 2025
abf09d4
Agent fix url (#437)
nginx-seanmoloney Apr 22, 2025
27b5058
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG Apr 28, 2025
90f2313
update hugo
JTorreG Apr 28, 2025
8c4573b
update v3 agent about (#452)
JTorreG Apr 28, 2025
85b6d64
Move Agent v3 Docs under NGINX One Console (#468)
JTorreG May 1, 2025
dda165a
Add environment variables table to Configuration Overview (#532)
nginx-seanmoloney May 7, 2025
879d759
fix: remove content from list sections for agent
JTorreG May 15, 2025
44cc125
Update agent install docs (#559)
john-david3 May 19, 2025
1b84944
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG May 20, 2025
e658701
Clean up files (#576)
nginx-seanmoloney May 21, 2025
7f05406
Update Agent v3 docs spelling errors (#577)
john-david3 May 21, 2025
01fbd57
Draft: new N1C doc homepage
mjang Apr 25, 2025
07c6406
Less
mjang Apr 25, 2025
a9a6c5f
More
mjang Apr 25, 2025
8e806e0
update
mjang Apr 25, 2025
152314a
new messages
mjang Apr 25, 2025
b4d6e87
Sync with presentation
mjang May 15, 2025
2f16929
Make more prod ready
mjang May 21, 2025
b561c0c
Make more prod ready
mjang May 21, 2025
a58e6a9
Agent v3 - update glossary (#579)
JTorreG May 22, 2025
c21614f
NGINX One and Agent v3 docs improvements based on feedback (#581)
JTorreG May 22, 2025
bddd77c
Rebase to 'internal/internal/nic-test-usecase-b'
JTorreG May 22, 2025
c94d883
fix: broken links after N1 docs changes
JTorreG May 23, 2025
8445dc0
Update content/includes/agent/about.md
JTorreG May 23, 2025
7c9efe8
Update content/includes/agent/about.md
JTorreG May 23, 2025
d57db93
Update content/includes/agent/architecture.md
JTorreG May 23, 2025
4f54f39
Update content/includes/agent/installation/oss/oss-debian.md
JTorreG May 23, 2025
079736d
Update content/includes/agent/installation/oss/oss-sles.md
JTorreG May 23, 2025
d6f0ff8
Update content/includes/agent/installation/oss/oss-ubuntu.md
JTorreG May 23, 2025
6c8ed3c
Update content/includes/agent/installation/plus/plus-sles.md
JTorreG May 23, 2025
9b0e746
Update content/nginx-one/agent/community.md
JTorreG May 23, 2025
772db24
Update content/nginx-one/agent/configure-otel-metrics.md
JTorreG May 23, 2025
fa381e8
Update content/nginx-one/agent/configure-otel-metrics.md
JTorreG May 23, 2025
275f631
fix conflicts
JTorreG May 23, 2025
bc32d6f
remove file that moved (fix conflicts)
JTorreG May 23, 2025
2d51add
recover file to fix conflicts with main
JTorreG May 23, 2025
6cd6faf
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG May 23, 2025
546524d
remove add-instance.md (moved)
JTorreG May 23, 2025
0a913de
Agent v3 IA changes (#601)
JTorreG May 28, 2025
196624f
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG May 30, 2025
71daf7b
fix conflicts
JTorreG May 30, 2025
0fd7cc4
remove double F
JTorreG May 30, 2025
37ca1e1
use new banner functionality for Agent announcement
JTorreG May 30, 2025
92bc01f
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG Jun 3, 2025
6916116
Merge remote-tracking branch 'origin' into agent-release-3.0
JTorreG Jun 3, 2025
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
7 changes: 7 additions & 0 deletions _banners/agent-v3-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{< banner "notice" "NGINX Agent v3.0 is now available" >}}

This documentation is for **NGINX Agent v2**. Visit the [Update NGINX Agent]({{< ref "/nginx-one/agent/install-upgrade/update.md" >}}) topic to learn how to upgrade your instances to the latest version.

For NGINX Agent v3 documentation, visit the [NGINX One Console docs]({{< ref "/nginx-one/agent/" >}}).

{{< /banner >}}
6 changes: 6 additions & 0 deletions content/agent/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,10 @@ description: NGINX Agent is a companion daemon for your NGINX Open Source or NGI
url: /nginx-agent/
cascade:
logo: NGINX-product-icon.png
banner:
enabled: true
type: deprecation
start-date: 2025-05-29
end-date: 2025-09-09
md: /_banners/agent-v3-release.md
---
12 changes: 5 additions & 7 deletions content/agent/overview.md → content/agent/about.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: Overview
title: About
draft: false
weight: 100
toc: true
docs: DOCS-1091
type:
- how-to
nd-docs: DOCS-1091
nd-content-type: how-to
---

## Overview

NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:
NGINX Agent v2 is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:

- Remote management of NGINX configurations
- Collection and reporting of real-time NGINX performance and operating system metrics
Expand Down Expand Up @@ -47,7 +46,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b
NGINX Agent allows a gRPC connected control system to register a listener for a specific event. The control mechanism is then invoked when NGINX Agent sends an associated system signal. The source of a notification can be either the NGINX instance or NGINX Agent itself. Here's a list of currently supported events:


{{< raw-html>}}<div class="table-responsive">{{</raw-html>}}
{{<bootstrap-table "table table-striped table-bordered">}}
| Event | Description |
| -------------------------------- | -------------------------------------------- |
Expand All @@ -64,6 +62,6 @@ NGINX Agent allows a gRPC connected control system to register a listener for a
| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration |
| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration |
{{</bootstrap-table>}}
{{< raw-html>}}</div>{{</raw-html>}}



5 changes: 2 additions & 3 deletions content/agent/changelog.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: "Changelog"
weight: 1200
weight: 700
toc: true
docs: "DOCS-1093"
---

{{< 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]({{< relref "./technical-specifications.md" >}}).
See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< ref "/agent/technical-specifications.md" >}}).

---
## Release [v2.40.0](https://github.com/nginx/agent/releases/tag/v2.40.0)
Expand Down
20 changes: 20 additions & 0 deletions content/agent/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Community and contribution"
toc: true
weight: 600
nd-docs: DOCS-000
---

Discover the various ways you can participate in the F5 NGINX Agent project:

## Community

- Have questions or ideas to discuss? Join the conversation about NGINX Agent in the [NGINX Community Forum](https://community.nginx.org/).

## Contribute

Get involved with the project by contributing! Please see our [contributing guide](https://github.com/nginx/agent/blob/main/CONTRIBUTING.md) for details.

## License

[Apache License, Version 2.0](https://github.com/nginx/agent/blob/main/LICENSE)
10 changes: 7 additions & 3 deletions content/agent/configuration/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Configuration
description: Learn how to configure NGINX Agent.
weight: 400
title: "Configuration"
weight: "400"
url: /nginx-agent/configuration/
cascade:
logo: NGINX-product-icon.png
layout: agent-v2-migration
---

Learn how to configure NGINX Agent.
19 changes: 10 additions & 9 deletions content/agent/configuration/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ title: Basic configuration
draft: false
weight: 100
toc: true
docs: DOCS-1229
type:
- how-to
nd-docs: DOCS-1229
nd-content-type: how-to


---

The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
Expand Down Expand Up @@ -50,7 +51,7 @@ server:
# host of the control plane
host: <FQDN>
grpcPort: 443
backoff: # note: default values are prepopulated
backoff: # note: default values are prepopulated
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
Expand Down Expand Up @@ -88,7 +89,7 @@ metrics:
report_interval: 1m
collection_interval: 15s
mode: aggregated
backoff: # note: default values are prepopulated
backoff: # note: default values are prepopulated
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
Expand Down Expand Up @@ -170,9 +171,9 @@ nginx-agent

### CLI Flags and Environment Variables

{{< warning >}}
{{< warning >}}

Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.
Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.

If you are upgrading from an older version, update your configuration accordingly.

Expand Down Expand Up @@ -220,9 +221,9 @@ If you are upgrading from an older version, update your configuration accordingl
<br>

{{<note>}}
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.

NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.

NGINX Agent follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:

Expand Down
94 changes: 0 additions & 94 deletions content/agent/configuration/configure-nginx-agent-features.md

This file was deleted.

7 changes: 3 additions & 4 deletions content/agent/configuration/configure-nginx-agent-group.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Add NGINX users to nginx-agent Group
title: "Add NGINX users to nginx-agent group"
draft: false
weight: 300
toc: true
docs: DOCS-933
type:
- how-to
nd-docs: DOCS-933
nd-content-type: how-to
---

## Overview
Expand Down
2 changes: 1 addition & 1 deletion content/agent/configuration/encrypt-communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Encrypt communication
toc: true
weight: 200
docs: DOCS-802
nd-docs: DOCS-802
---

## Overview
Expand Down
3 changes: 1 addition & 2 deletions content/agent/configuration/health-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ title: Health checks
draft: false
weight: 400
toc: true
type:
- how-to
nd-content-type: how-to
---

## Overview
Expand Down
6 changes: 0 additions & 6 deletions content/agent/contribute/_index.md

This file was deleted.

23 changes: 0 additions & 23 deletions content/agent/contribute/community.md

This file was deleted.

Loading
Loading