Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ content/nim/* @nginx/nim-docs-approvers
content/nginx/* @nginx/plus-docs-approvers

# NGINX One
content/nginx-one/* @nginx/one-docs-approvers
content/nginx-one-console/* @nginx/one-docs-approvers

6 changes: 3 additions & 3 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ product/nginx-plus:
- 'content/nginx/**'
- 'content/includes/nginx-plus/**'

product/nginx-one:
product/nginx-one-console:
- changed-files:
- any-glob-to-any-file:
- 'content/nginx-one/**'
- 'content/includes/nginx-one/**'
- 'content/nginx-one-console/**'
- 'content/includes/nginx-one-console/**'

product/nginxaas-azure:
- changed-files:
Expand Down
2 changes: 1 addition & 1 deletion _banners/agent-v3-release.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}

The documentation in this section is for **NGINX Agent version 2.x**. For NGINX Agent 3.x content visit the [NGINX One Console documentation]({{< ref "/nginx-one/agent/" >}})
The documentation in this section is for **NGINX Agent version 2.x**. For NGINX Agent 3.x content visit the [NGINX One Console documentation]({{< ref "/nginx-one-console/agent/" >}})

F5 NGINX Instance Manager (NIM) does not currently support NGINX Agent 3.x. NGINX Instance Manager customers can upgrade to the latest NGINX Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.

Expand Down
2 changes: 1 addition & 1 deletion _banners/eol-amplify.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ NGINX Amplify support ends on January 31, 2026. To continue monitoring your NGIN

1. [Contact the F5 NGINX Sales team](https://www.f5.com/products/get-f5/f5-nginx-products-and-packaging) to get an NGINX One subscription, if you don’t already have one.
2. [Uninstall the NGINX Amplify agent]({{< ref "/amplify/nginx-amplify-agent/install/uninstalling-amplify-agent.md" >}}).
3. [Follow the NGINX One Console getting started guide]({{< ref "/nginx-one/getting-started.md" >}}).
3. [Follow the NGINX One Console getting started guide]({{< ref "/nginx-one-console/getting-started.md" >}}).

[Professional Services](https://www.f5.com/services) are available to support your transition. Additional fees may apply.
{{</ banner >}}
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn how to deliver, manage, and protect your applications using F
Learn how to deliver, manage, and protect your applications using F5 NGINX products.

{{<card-section showAsCards="true" title="F5 NGINX One">}}
{{<card title="F5 NGINX One Console" titleUrl="/nginx-one/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}
{{<card title="F5 NGINX One Console" titleUrl="/nginx-one-console/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}
Monitor your infrastructure, address security vulnerabilities, and assess the health of your NGINX fleet, all from a single console.
{{</card >}}
{{<card title="F5 NGINX Plus" titleUrl="/nginx/" brandIcon="NGINX-Plus-product-icon.svg" isLanding="true">}}
Expand Down
4 changes: 2 additions & 2 deletions content/agent/contribute/dev-environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Ubuntu is the recommended operating system for development, as it comes with mos

To begin this task, you will require the following:

- A [working NGINX Agent instance]({{< ref "/nginx-one/agent/install-upgrade/" >}}).
- A [working NGINX Agent instance]({{< ref "/nginx-one-console/agent/install-upgrade/" >}}).
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
- A [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/) installation.

Expand All @@ -29,7 +29,7 @@ git clone git@github.com:nginx/agent.git

Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information

Follow the steps in the [Installation]({{< ref "/nginx-one/agent/install-upgrade/" >}}) topic to install NGINX Agent.
Follow the steps in the [Installation]({{< ref "/nginx-one-console/agent/install-upgrade/" >}}) topic to install NGINX Agent.

## Install prerequisite packages
Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.
Expand Down
2 changes: 1 addition & 1 deletion content/agent/contribute/start-mock-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The mock interface is useful when developing NGINX Agent, as it allows you to vi

To begin this task, you will require the following:

- A [working NGINX Agent instance]({{< ref "/nginx-one/agent/install-upgrade/" >}}).
- A [working NGINX Agent instance]({{< ref "/nginx-one-console/agent/install-upgrade/" >}}).
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
- A [go-swagger](https://goswagger.io/go-swagger/install/) installation.

Expand Down
8 changes: 4 additions & 4 deletions content/glossary/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ This glossary defines terms used in F5 NGINX.

| Term | Definition |
| ---- | ---------- |
| **Config Sync Group** / **Instance Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. Also known as an Instance Group in NGINX Instance Manager. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
| **Config Sync Group** / **Instance Group** | A group of NGINX systems (or instances) with identical configurations. They may also share the same certificates. However, the instances in a Config Sync Group could belong to different systems and even different clusters. Also known as an Instance Group in NGINX Instance Manager. For more information, see this explanation of [Important considerations]({{< ref "/nginx-one-console/nginx-configs/config-sync-groups/manage-config-sync-groups.md#important-considerations" >}}) |
| **Control Plane** | The control plane is the part of a network architecture that manages and controls the flow or data or traffic (the Data Plane). It is responsible for system-level tasks such as routing and traffic management. |
| **Data Plane** | The data plane is the part of a network architecture that carries user traffic. It handles tasks like forwarding data packets between devices and managing network communication. In the context of NGINX, the data plane is responsible for tasks such as load balancing, caching, and serving web content. |
| **Instance** | An instance is an individual system with NGINX installed. You can group the instances of your choice in a Config Sync Group. When you add an instance to NGINX One Console, you need to use a data plane key. |
| **Namespace** | In F5 Distributed Cloud, a namespace groups a tenant's configuration objects, similar to administrative domains. Every object in a namespace must have a unique name, and each namespace must be unique to its tenant. This setup ensures isolation, preventing cross-referencing of objects between namespaces. You'll see the namespace in the NGINX One Console URL as `/namespaces/<namespace name>/`. To switch an instance between namespaces, you have to deregister an instance from an old namespace, and register it on the new namespace. |
| **NGINX Agent** | A lightweight software component installed on NGINX instances to enable communication with the NGINX One console. NGINX Agent also enables communication with NGINX Instance Manager. |
| **Staged Configurations** | Also known as **Staged Configs**. Allows you to save "work in progress." You can create it from scratch, an Instance, another Staged Config, or a Config Sync Group. It does _not_ have to be a working configuration until you publish it to an instance or a Config Sync Group. You can even manage your **Staged Configurations** through our [API]({{< ref "/nginx-one/api/api-reference-guide/#tag/StagedConfigs" >}}). |
| **Staged Configurations** | Also known as **Staged Configs**. Allows you to save "work in progress." You can create it from scratch, an Instance, another Staged Config, or a Config Sync Group. It does _not_ have to be a working configuration until you publish it to an instance or a Config Sync Group. You can even manage your **Staged Configurations** through our [API]({{< ref "/nginx-one-console/api/api-reference-guide/#tag/StagedConfigs" >}}). |
| **Tenant** | A tenant in F5 Distributed Cloud is an entity that owns a specific set of configuration and infrastructure. It is fundamental for isolation, meaning a tenant cannot access objects or infrastructure of other tenants. Tenants can be either individual or enterprise, with the latter allowing multiple users with role-based access control (RBAC). |

{{< /table >}}
Expand Down Expand Up @@ -62,9 +62,9 @@ It assumes you are familiar with various layer 7 (L7) hypertext transfer protoco

## NGINX Alerts

To set up NGINX Alerts through the F5 Distributed Cloud, follow the procedure in [Set up security alerts]({{< ref "/nginx-one/secure-your-fleet/set-up-security-alerts/" >}}).
To set up NGINX Alerts through the F5 Distributed Cloud, follow the procedure in [Set up security alerts]({{< ref "/nginx-one-console/secure-your-fleet/set-up-security-alerts/" >}}).

{{< include "/nginx-one/alert-labels.md" >}}
{{< include "/nginx-one-console/alert-labels.md" >}}


## References
Expand Down
6 changes: 3 additions & 3 deletions content/includes/agent/about.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/about.md
- content/nginx-one/agent/overview/about.md
- content/nginx-one-console/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 @@ -12,14 +12,14 @@ Enable Access to key NGINX One use cases:

- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and
enhancing operational workflows.
- [Connects NGINX instances to NGINX One Console]({{< ref "/nginx-one/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})
- [Connects NGINX instances to NGINX One Console]({{< ref "/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})

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-console/agent/configure-otel-metrics.md" >}}) for use in other applications.



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

The figure shows:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
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
- content/nginx-one-console/agent/install-upgrade/install-from-github.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

If you have installed NGINX Agent manually, you will need to connect it to the
Expand Down
2 changes: 1 addition & 1 deletion content/includes/agent/installation/oss/oss-alpine.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
---

1. Install the prerequisites:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/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
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,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-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

- You must use one of the [supported operating system and architectures]({{< ref "/nginx-one/agent/overview/tech-specs.md#supported-distributions" >}})
- You must use one of the [supported operating system and architectures]({{< ref "/nginx-one-console/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
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,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-upgrade/install-from-oss-repo.md
- content/nginx-one/agent/install-upgrade/install-from-plus-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-oss-repo.md
- content/nginx-one-console/agent/install-upgrade/install-from-plus-repo.md
---

To start NGINX Agent on `systemd` systems, run the following command:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/uninstall.md
- content/nginx-one/agent/install-upgrade/uninstall.md
- content/nginx-one-console/agent/install-upgrade/uninstall.md
---

Complete the following steps on each host where you've installed NGINX Agent:
Expand Down
4 changes: 2 additions & 2 deletions content/includes/agent/installation/update-container.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
files:
- content/agent/install-upgrade/update.md
- content/nginx-one/agent/install-upgrade/update.md
- content/nginx-one-console/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 All @@ -14,7 +14,7 @@ wget https://raw.githubusercontent.com/nginx/agent/refs/heads/main/scripts/packa
```

If your NGINX Agent container was previously a member of a Config Sync Group, then your NGINX Agent config must be manually updated to add the Config Sync Group label.
See [Add Config Sync Group]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}) for more information.
See [Add Config Sync Group]({{< ref "/nginx-one-console/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}) for more information.

### Rolling back from NGINX Agent v3 to v2

Expand Down
Loading
Loading