{{}}
{{}}
| Event | Description |
diff --git a/site/content/changelog.md b/site/content/changelog.md
index 8da814d0ea..07f23553fb 100644
--- a/site/content/changelog.md
+++ b/site/content/changelog.md
@@ -1,6 +1,6 @@
---
title: "Changelog"
-weight: 1200
+weight: 700
toc: true
---
diff --git a/site/content/configuration/_index.md b/site/content/configuration/_index.md
deleted file mode 100644
index 3d1fdf4e34..0000000000
--- a/site/content/configuration/_index.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: "Configuration"
-description: "Learn how to configure NGINX Agent."
-linkTitle: "Configuration"
-weight: "400"
-menu: docs
----
\ No newline at end of file
diff --git a/site/content/configuration/configuration-overview.md b/site/content/configuration/configuration-overview.md
deleted file mode 100644
index 66d09b3c71..0000000000
--- a/site/content/configuration/configuration-overview.md
+++ /dev/null
@@ -1,286 +0,0 @@
----
-title: "Configuration overview"
-draft: false
-weight: 100
-toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
-
-{{}}
-
-- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
-
- 1. CLI flags overwrite configuration files and environment variable values.
- 2. Environment variables overwrite configuration file values.
- 3. Config files are the lowest priority and config settings are superseded if either of the other options is used.
-
-- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
-
-{{}}
-
-### Configure with Config Files
-
-The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
-
-Examples of the configuration files are provided below:
-
-
- example nginx-agent.conf
-
-{{}}
-In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control/management plane.
-{{}}
-
-```nginx {hl_lines=[13]}
-#
-# /etc/nginx-agent/nginx-agent.conf
-#
-# Configuration file for NGINX Agent.
-#
-# This file tracks agent configuration values that are meant to be statically set. There
-# are additional NGINX Agent configuration values that are set via the API and agent install script
-# which can be found in /etc/nginx-agent/agent-dynamic.conf.
-
-# specify the server grpc port to connect to
-server:
- # host of the control plane
- host:
- grpcPort: 443
-# tls options
-tls:
- # enable tls in the nginx-agent setup for grpcs
- # default to enable to connect with secure connection but without client cert for mtls
- enable: true
- # controls whether the server certificate chain and host name are verified.
- # for production use, see instructions for configuring TLS
- skip_verify: false
-log:
- # set log level (panic, fatal, error, info, debug, trace; default "info")
- level: info
- # set log path. if empty, don't log to file.
- path: /var/log/nginx-agent/
-nginx:
- # path of NGINX logs to exclude
- exclude_logs: ""
- # Set to true when NGINX configuration should contain no warnings when performing a configuration apply (nginx -t is used to carry out this check)
- treat_warnings_as_errors: false # Default is false
-# data plane status message / 'heartbeat'
-dataplane:
- status:
- # poll interval for dataplane status - the frequency the agent will query the dataplane for changes
- poll_interval: 30s
- # report interval for dataplane status - the maximum duration to wait before syncing dataplane information if no updates have been observed
- report_interval: 24h
-metrics:
- # specify the size of a buffer to build before sending metrics
- bulk_size: 20
- # specify metrics poll interval
- report_interval: 1m
- collection_interval: 15s
- mode: aggregated
-
-# OSS NGINX default config path
-# path to aux file dirs can also be added
-config_dirs: "/etc/nginx:/usr/local/etc/nginx"
-
-# Internal queue size
-queue_size: 100
-
-extensions:
- - nginx-app-protect
-
-# Enable reporting NGINX App Protect details to the control plane.
-nginx_app_protect:
- # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes.
- report_interval: 15s
- # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false).
- precompiled_publication: true
-```
-
-
-
-
-
- example dynamic-agent.conf
-
-{{}}
-Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
-
-Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
-{{}}
-
-```yaml
-# Dynamic configuration file for NGINX Agent.
-#
-# The purpose of this file is to track agent configuration
-# values that can be dynamically changed via the API and the agent install script.
-# You may edit this file, but API calls that modify the tags on this system will
-# overwrite the tag values in this file.
-#
-# The agent configuration values that API calls can modify are as follows:
-# - tags
-#
-# The agent configuration value that the agent install script can modify are as follows:
-# - instance_group
-
-instance_group: devenv-group
-tags:
- - devenv
- - test
-```
-
-
-
-
-### NGINX Agent CLI Flags & Usage {#nginx-agent-cli-flags-usage}
-
-This section displays the configurable options for NGINX Agent that can be set with CLI flags. See the CLI flags and their uses in the figure below:
-
-
- NGINX Agent CLI flags & usage
-
-```text
-Usage:
- nginx-agent [flags]
- nginx-agent [command]
-
-Available Commands:
- completion Generate completion script.
- help Help about any command
-
-Flags:
- --api-cert string The cert used by the Agent API.
- --api-host string The host used by the Agent API. (default "127.0.0.1")
- --api-key string The key used by the Agent API.
- --api-port int The desired port to use for nginx-agent to expose for HTTP traffic.
- --config-dirs string Defines the paths that you want to grant nginx-agent read/write access to. This key is formatted as a string and follows Unix PATH format. (default "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms")
- --dataplane-report-interval duration The amount of time the agent will report on the dataplane. After this period of time it will send a snapshot of the dataplane information. (default 24h0m0s)
- --dataplane-status-poll-interval duration The frequency the agent will check the dataplane for changes. Used as a "heartbeat" to keep the gRPC connections alive. (default 30s)
- --display-name string The instance's 'name' value.
- --dynamic-config-path string Defines the path of the Agent dynamic config file. (default "/var/lib/nginx-agent/agent-dynamic.conf")
- --features strings A comma-separated list of features enabled for the agent. (default [registration,nginx-config-async,nginx-ssl-config,nginx-counting,metrics,dataplane-status,process-watcher,file-watcher,activity-events,agent-api])
- -h, --help help for nginx-agent
- --ignore-directives strings A comma-separated list of ignoring directives which contain sensitive info.
- --instance-group string The instance's 'group' value.
- --log-level string The desired verbosity level for logging messages from nginx-agent. Available options, in order of severity from highest to lowest, are: panic, fatal, error, info, debug, and trace. (default "info")
- --log-path string The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr.
- --metrics-bulk-size int The amount of metrics reports collected before sending the data back to the server. (default 20)
- --metrics-collection-interval duration Sets the interval, in seconds, at which metrics are collected. (default 15s)
- --metrics-mode string Sets the desired metrics collection mode: streaming or aggregation. (default "aggregated")
- --metrics-report-interval duration The polling period specified for a single set of metrics being collected. (default 1m0s)
- --nginx-config-reload-monitoring-period duration The duration NGINX Agent will monitor error logs after a NGINX reload (default 10s)
- --nginx-exclude-logs string One or more NGINX access log paths that you want to exclude from metrics collection. This key is formatted as a string and multiple values should be provided as a comma-separated list.
- --nginx-socket string The NGINX Plus counting unix socket location. (default "unix:/var/run/nginx-agent/nginx.sock")
- --nginx-treat-warnings-as-errors On nginx -t, treat warnings as failures on configuration application.
- --queue-size int The size of the NGINX Agent internal queue.
- --server-command string The name of the command server sent in the tls configuration.
- --server-grpcport int The desired GRPC port to use for nginx-agent traffic.
- --server-host string The IP address of the server host. IPv4 addresses and hostnames are supported.
- --server-metrics string The name of the metrics server sent in the tls configuration.
- --server-token string An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "e202f883-54c6-4702-be15-3ba6e507879a")
- --tags strings A comma-separated list of tags to add to the current instance or machine, to be used for inventory purposes.
- --tls-ca string The path to the CA certificate file to use for TLS.
- --tls-cert string The path to the certificate file to use for TLS.
- --tls-enable Enables TLS for secure communications.
- --tls-key string The path to the certificate key file to use for TLS.
- --tls-skip-verify Only intended for demonstration, sets InsecureSkipVerify for gRPC TLS credentials
- -v, --version version for nginx-agent
-
-Use "nginx-agent [command] --help" for more information about a command.
-```
-
-
-
-#### NGINX Agent Config Dirs Option
-
-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/management 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 follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
-
-- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
-
-#### NGINX Agent Dynamic Config Path Option
-
-Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
-
-Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
-
-Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
-
-### NGINX Agent Environment Variables
-
-This section displays the configurable options for NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below:
-
-
- NGINX Agent Environment Variables
-
-```text
-- NMS_INSTANCE_GROUP
-- NMS_DISPLAY_NAME
-- NMS_FEATURES
-- NMS_LOG_LEVEL
-- NMS_LOG_PATH
-- NMS_PATH
-- NMS_METRICS_COLLECTION_INTERVAL
-- NMS_METRICS_MODE
-- NMS_METRICS_BULK_SIZE
-- NMS_METRICS_REPORT_INTERVAL
-- NMS_NGINX_EXCLUDE_LOGS
-- NMS_NGINX_SOCKET
-- NMS_NGINX_TREAT_WARNINGS_AS_ERRORS
-- NMS_SERVER_GRPCPORT
-- NMS_SERVER_HOST
-- NMS_SERVER_TOKEN
-- NMS_SERVER_COMMAND
-- NMS_SERVER_METRICS
-- NMS_TAGS
-- NMS_TLS_CA
-- NMS_TLS_CERT
-- NMS_TLS_ENABLE
-- NMS_TLS_KEY
-- NMS_TLS_SKIP_VERIFY
-- NMS_CONFIG_DIRS
-- NMS_QUEUE_SIZE
-- NMS_DATAPLANE_REPORT_INTERVAL
-- NMS_DATAPLANE_STATUS_POLL_INTERVAL
-```
-
-
-### NGINX Agent Log Rotation
-
-By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
-
-
- NGINX Agent Logrotate Configuration
-
-``` yaml
-/var/log/nginx-agent/*.log
-{
- # log files are rotated every day
- daily
- # log files are rotated if they grow bigger than 5M
- size 5M
- # truncate the original log file after creating a copy
- copytruncate
- # remove rotated logs older than 10 days
- maxage 10
- # log files are rotated 10 times before being removed
- rotate 10
- # old log files are compressed
- compress
- # if the log file is missing it will go on to the next one without issuing an error message
- missingok
- # do not rotate the log if it is empty
- notifempty
-}
-```
-
-
-If you need to make changes to the default configuration you can update the file here `/etc/logrotate.d/nginx-agent`
-
-For more detail on logrotate configuration see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate)
diff --git a/site/content/contribute/_index.md b/site/content/contribute/_index.md
index dc79b629a7..9eebf54038 100644
--- a/site/content/contribute/_index.md
+++ b/site/content/contribute/_index.md
@@ -1,7 +1,6 @@
---
title: "Contribute"
-description: "Learn about the NGINX Agent community and contribute to the project."
-linkTitle: "Contribute"
-menu: docs
-weight: "500"
----
\ No newline at end of file
+weight: 600
+---
+
+Learn about the NGINX Agent community and how to contribute to the project.
\ No newline at end of file
diff --git a/site/content/contribute/community.md b/site/content/contribute/community.md
index 4eea3d22a5..3fbf8f1615 100644
--- a/site/content/contribute/community.md
+++ b/site/content/contribute/community.md
@@ -1,13 +1,12 @@
---
title: "Community and contribution"
-draft: false
-weight: 100
toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 100
+docs: DOCS-000
---
+This topic describes the various ways you can get involved with the F5 NGINX Agent project.
+
# Community
- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts.
diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md
index f756ef7fcd..d56c064cba 100644
--- a/site/content/contribute/dev-environment-setup.md
+++ b/site/content/contribute/dev-environment-setup.md
@@ -1,64 +1,61 @@
---
-title: "Development environment Setup"
-draft: false
-weight: 200
+title: "Development environment setup"
toc: true
-tags: [ "docs" ]
-categories: ["development"]
-doctypes: ["task"]
+weight: 200
+docs: DOCS-000
---
## Overview
-Learn how to setup a Development Environment for NGINX Agent.
+This page describes how to configure a development environment for F5 NGINX Agent.
+
+While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu.
+
+Ubuntu is the recommended operating system for development, as it comes with most packages requires to build and run NGINX Agent.
+
+## Before you begin
-## Select an Operating System
+To begin this task, you will require the following:
-While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. Ubuntu is packaged with most libraries required to build and run NGINX Agent, and is the recommended platform for NGINX Agent development.
+- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}).
+- 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.
-## Install NGINX
+You will also need a copy of the NGINX Agent repository, which you can clone using `git`:
-Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX and NGINX Agent.
+```shell
+git clone git@github.com:nginx/agent.git
+```
-## Clone the NGINX Agent Repository
+Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information
-Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help.
+Follow the steps in the [Installation]({{< relref "/install-upgrade/install.md" >}}) topic to install NGINX Agent.
-## Installing Prerequisite Packages
+## Install prerequisite packages
Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.
Change to the NGINX Agent source directory:
-```bash
+```shell
cd /agent
```
Install Make:
-```bash
+```shell
sudo apt install make
```
-NGINX Agent is written in Go. You may [download Go](https://go.dev/doc/install) and follow installation instructions on the same page or run:
-```bash
-sudo apt install golang-go
-```
-
-Install Protoc:
-```bash
-sudo apt install -y protobuf-compiler
-```
-
Install NGINX Agent tools and dependencies:
Before starting development on NGINX Agent, it is important to download and install the necessary tool and dependencies required by NGINX Agent. You can do this by running the following `make` command:
-```bash
+```shell
make install-tools deps
```
-## Building NGINX Agent from Source Code
+## Build NGINX Agent from source code
Run the following commands to build and run NGINX Agent:
-```bash
+```shell
make build
sudo make run
```
diff --git a/site/content/contribute/start-mock-interface.md b/site/content/contribute/start-mock-interface.md
new file mode 100644
index 0000000000..2c148de78e
--- /dev/null
+++ b/site/content/contribute/start-mock-interface.md
@@ -0,0 +1,90 @@
+---
+title: Start mock control plane interface
+toc: true
+weight: 300
+docs: DOCS-000
+---
+
+This document describes how to configure and run F5 NGINX Agent using a mock interface ("control plane") for NGINX Agent to report to.
+
+The mock interface is useful when developing NGINX Agent, as it allows you to view what metrics are being reported.
+
+## Before you begin
+
+To begin this task, you will require the following:
+
+- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}).
+- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
+- A [go-swagger](https://goswagger.io/go-swagger/install/) installation.
+
+You will also need a copy of the NGINX Agent repository, which you can clone using `git`:
+
+```shell
+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.
+
+## Start the gRPC mock control plane
+
+Start the mock control plane by running the following command from the `agent` source code root directory:
+
+```shell
+go run sdk/examples/server.go
+```
+```text
+INFO[0000] http listening at 54790 # mock control plane port
+INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to
+```
+
+The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent.
+
+To enable them, view the [Enable gRPC and REST interfaces]({{< relref "/how-to/enable-interfaces.md" >}}) topic.
+
+## Launch Swagger UI
+
+To launch the Swagger UI for the REST interface run the following command:
+
+```shell
+make launch-swagger-ui
+```
+
+## Start NGINX Agent
+
+Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory.
+
+```shell
+sudo make run
+```
+```text
+WARN[0000] Log level is info
+INFO[0000] setting displayName to XXX
+INFO[0000] NGINX Agent at with pid 12345, clientID=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX name=XXX
+INFO[0000] NginxBinary initializing
+INFO[0000] Commander initializing
+INFO[0000] Comms initializing
+INFO[0000] OneTimeRegistration initializing
+INFO[0000] Registering XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX
+INFO[0000] Metrics initializing
+INFO[0000] MetricsThrottle initializing
+INFO[0000] DataPlaneStatus initializing
+INFO[0000] MetricsThrottle waiting for report ready
+INFO[0000] Metrics waiting for handshake to be completed
+INFO[0000] ProcessWatcher initializing
+INFO[0000] Extensions initializing
+INFO[0000] FileWatcher initializing
+INFO[0000] FileWatchThrottle initializing
+INFO[0001] Events initializing
+INFO[0001] OneTimeRegistration completed
+```
+
+Open a web browser to view the mock control plane at [http://localhost:54790](http://localhost:54790). The following links will be shown in the web interface:
+
+- **registered** - shows registration information of the data plane
+- **nginxes** - lists the nginx instances on the data plane
+- **configs** - shows the protobuf payload for NGINX configuration sent to the management plane
+- **configs/chunked** - shows the split-up payloads sent to the management plane
+- **configs/raw** - shows the actual configuration as it would live on the data plane
+- **metrics** - shows a buffer of metrics sent to the management plane (similar to what will be sent back in the REST API)
+
+For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples).
\ No newline at end of file
diff --git a/site/content/how-to/_index.md b/site/content/how-to/_index.md
new file mode 100644
index 0000000000..3f01dc82b9
--- /dev/null
+++ b/site/content/how-to/_index.md
@@ -0,0 +1,6 @@
+---
+title: "How-to guides"
+weight: 500
+---
+
+Learn how to configure NGINX Agent
\ No newline at end of file
diff --git a/site/content/how-to/configuration-overview.md b/site/content/how-to/configuration-overview.md
new file mode 100644
index 0000000000..26c2a41b27
--- /dev/null
+++ b/site/content/how-to/configuration-overview.md
@@ -0,0 +1,290 @@
+---
+title: "Configuration overview"
+toc: true
+weight: 100
+docs: DOCS-1229
+---
+
+This page describes how to configure F5 NGINX Agent using configuration files, CLI (Command line interface) flags, and environment variables.
+
+{{}}
+
+- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
+
+ 1. CLI flags overwrite configuration files and environment variable values.
+ 2. Environment variables overwrite configuration file values.
+ 3. Config files are the lowest priority and config settings are superseded if either of the other options is used.
+
+- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
+
+{{}}
+
+## Configuration files
+
+The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
+
+Examples of the configuration files are provided below:
+
+
+ example nginx-agent.conf
+
+{{}}
+In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane.
+{{}}
+
+```nginx {hl_lines=[13]}
+#
+# /etc/nginx-agent/nginx-agent.conf
+#
+# Configuration file for NGINX Agent.
+#
+# This file tracks agent configuration values that are meant to be statically set. There
+# are additional NGINX Agent configuration values that are set via the API and agent install script
+# which can be found in /etc/nginx-agent/agent-dynamic.conf.
+
+# specify the server grpc port to connect to
+server:
+ # host of the control plane
+ host:
+ grpcPort: 443
+ backoff: # note: default values are prepopulated
+ initial_interval: 100ms # Add the appropriate duration value here, e.g., "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, e.g., 0.10
+ multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
+ max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+ max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+# tls options
+tls:
+ # enable tls in the nginx-agent setup for grpcs
+ # default to enable to connect with secure connection but without client cert for mtls
+ enable: true
+ # controls whether the server certificate chain and host name are verified.
+ # for production use, see instructions for configuring TLS
+ skip_verify: false
+log:
+ # set log level (panic, fatal, error, info, debug, trace; default "info")
+ level: info
+ # set log path. if empty, don't log to file.
+ path: /var/log/nginx-agent/
+nginx:
+ # path of NGINX logs to exclude
+ exclude_logs: ""
+ # Set to true when NGINX configuration should contain no warnings when performing a configuration apply (nginx -t is used to carry out this check)
+ treat_warnings_as_errors: false # Default is false
+# data plane status message / 'heartbeat'
+dataplane:
+ status:
+ # poll interval for dataplane status - the frequency the NGINX Agent will query the dataplane for changes
+ poll_interval: 30s
+ # report interval for dataplane status - the maximum duration to wait before syncing dataplane information if no updates have been observed
+ report_interval: 24h
+metrics:
+ # specify the size of a buffer to build before sending metrics
+ bulk_size: 20
+ # specify metrics poll interval
+ report_interval: 1m
+ collection_interval: 15s
+ mode: aggregated
+ backoff: # note: default values are prepopulated
+ initial_interval: 100ms # Add the appropriate duration value here, e.g., "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, e.g., 0.10
+ multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
+ max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+ max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+
+# OSS NGINX default config path
+# path to aux file dirs can also be added
+config_dirs: "/etc/nginx:/usr/local/etc/nginx"
+
+# Internal queue size
+queue_size: 100
+
+extensions:
+ - nginx-app-protect
+
+# Enable reporting NGINX App Protect details to the control plane.
+nginx_app_protect:
+ # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes.
+ report_interval: 15s
+ # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false).
+ precompiled_publication: true
+```
+
+
+
+
+
+ example dynamic-agent.conf
+
+{{}}
+Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
+
+Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
+{{}}
+
+```yaml
+# Dynamic configuration file for NGINX Agent.
+#
+# The purpose of this file is to track agent configuration
+# values that can be dynamically changed via the API and the agent install script.
+# You may edit this file, but API calls that modify the tags on this system will
+# overwrite the tag values in this file.
+#
+# The agent configuration values that API calls can modify are as follows:
+# tags:
+# - dev
+# - qa
+#
+# The agent configuration value that the agent install script can modify are as follows:
+# instance_group: my-instance-group
+
+instance_group: my-instance-group
+tags:
+ - dev
+ - qa
+```
+
+
+
+## CLI flags and environment variables
+
+This section details the CLI flags and corresponding environment variables used to configure the NGINX Agent.
+
+### CLI flags
+
+```sh
+nginx-agent [flags]
+```
+
+### Environment variables
+
+```sh
+export ENV_VARIABLE_NAME="value"
+nginx-agent
+```
+
+### Flag and environment arguments
+
+{{< warning >}}
+
+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.
+
+{{< /warning >}}
+
+{{}}
+| CLI flag | Environment variable | Description |
+|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------|
+| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. |
+| `--api-host` | `NGINX_AGENT_API_HOST` | Sets the host used by the Agent API. Default: *127.0.0.1* |
+| `--api-key` | `NGINX_AGENT_API_KEY` | Specifies the key used by the Agent API. |
+| `--api-port` | `NGINX_AGENT_API_PORT` | Sets the port for exposing nginx-agent to HTTP traffic. |
+| `--config-dirs` | `NGINX_AGENT_CONFIG_DIRS` | Defines directories NGINX Agent can read/write. Default: *"/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"* |
+| `--dataplane-report-interval` | `NGINX_AGENT_DATAPLANE_REPORT_INTERVAL` | Sets the interval for dataplane reporting. Default: *24h0m0s* |
+| `--dataplane-status-poll-interval` | `NGINX_AGENT_DATAPLANE_STATUS_POLL_INTERVAL` | Sets the interval for polling dataplane status. Default: *30s* |
+| `--display-name` | `NGINX_AGENT_DISPLAY_NAME` | Sets the instance's display name. |
+| `--dynamic-config-path` | `NGINX_AGENT_DYNAMIC_CONFIG_PATH` | Specifies the path of the Agent dynamic config file. Default: *"/var/lib/nginx-agent/agent-dynamic.conf"* |
+| `--features` | `NGINX_AGENT_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* |
+| `--ignore-directives` | | Specifies a comma-separated list of directives to ignore for sensitive info.|
+| `--instance-group` | `NGINX_AGENT_INSTANCE_GROUP` | Sets the instance's group value. |
+| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* |
+| `--log-path` | `NGINX_AGENT_LOG_PATH` | Specifies the path to output log messages. |
+| `--metrics-bulk-size` | `NGINX_AGENT_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* |
+| `--metrics-collection-interval` | `NGINX_AGENT_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* |
+| `--metrics-mode` | `NGINX_AGENT_METRICS_MODE` | Sets the metrics collection mode: streaming or aggregation. Default: *aggregated* |
+| `--metrics-report-interval` | `NGINX_AGENT_METRICS_REPORT_INTERVAL` | Sets the interval for reporting collected metrics. Default: *1m0s* |
+| `--nginx-config-reload-monitoring-period` | | Sets the duration to monitor error logs after an NGINX reload. Default: *10s* |
+| `--nginx-exclude-logs` | `NGINX_AGENT_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. |
+| `--nginx-socket` | `NGINX_AGENT_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* |
+| `--nginx-treat-warnings-as-errors` | `NGINX_AGENT_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. |
+| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. |
+| `--server-command` | | Specifies the name of the command server sent in the TLS configuration. |
+| `--server-grpcport` | `NGINX_AGENT_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. |
+| `--server-host` | `NGINX_AGENT_SERVER_HOST` | Specifies the IP address of the server host. |
+| `--server-metrics` | | Specifies the name of the metrics server sent in the TLS configuration. |
+| `--server-token` | `NGINX_AGENT_SERVER_TOKEN` | Sets the authentication token for accessing the commander and metrics services. Default: *e202f883-54c6-4702-be15-3ba6e507879a* |
+| `--tags` | `NGINX_AGENT_TAGS` | Specifies a comma-separated list of tags for the instance or machine. |
+| `--tls-ca` | `NGINX_AGENT_TLS_CA` | Specifies the path to the CA certificate file for TLS. |
+| `--tls-cert` | `NGINX_AGENT_TLS_CERT` | Specifies the path to the certificate file for TLS. |
+| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. |
+| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
+| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
+{{}}
+
+
+
+{{}}
+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 follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
+
+- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
+
+{{}}
+
+{{}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
+
+Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
+
+Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
+
+{{}}
+
+## Logs
+
+NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files.
+
+We recommend adding a separate partition for `/var/log/nginx-agent`.
+
+{{< important >}}
+Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.
+{{< /important >}}
+
+By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
+
+
+ NGINX Agent Logrotate Configuration
+
+``` yaml
+/var/log/nginx-agent/*.log
+{
+ # log files are rotated every day
+ daily
+ # log files are rotated if they grow bigger than 5M
+ size 5M
+ # truncate the original log file after creating a copy
+ copytruncate
+ # remove rotated logs older than 10 days
+ maxage 10
+ # log files are rotated 10 times before being removed
+ rotate 10
+ # old log files are compressed
+ compress
+ # if the log file is missing it will go on to the next one without issuing an error message
+ missingok
+ # do not rotate the log if it is empty
+ notifempty
+}
+```
+
+
+If you need to change the default configuration, update the file at `/etc/logrotate.d/nginx-agent`.
+
+For more details on logrotate configuration, see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate).
+
+
+## Extensions
+
+An extension is noncritical code to the main functionality of NGINX Agent. They generally cover functionality outside of managing NGINX configuration and reporting metrics.
+
+To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`.
+
+This example enables the advanced metrics extension:
+
+```yaml
+extensions:
+ - advanced-metrics
+```
\ No newline at end of file
diff --git a/site/content/configuration/configure-nginx-agent-group.md b/site/content/how-to/configure-agent-group.md
similarity index 84%
rename from site/content/configuration/configure-nginx-agent-group.md
rename to site/content/how-to/configure-agent-group.md
index 9aa87c9a0a..dbfd3c6dd7 100644
--- a/site/content/configuration/configure-nginx-agent-group.md
+++ b/site/content/how-to/configure-agent-group.md
@@ -1,13 +1,12 @@
---
-title: "Add NGINX Users to nginx-agent group"
-draft: false
-weight: 300
+title: "Add users to nginx-agent group"
toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 400
+docs: DOCS-000
---
+This page describes how the F5 NGINX Agent process interacts with the NGINX user on a system, and how to add users to the NGINX Agent group.
+
## Overview
During installation, NGINX Agent detects the NGINX user (typically `nginx`) for the master and worker processes and adds this user to a group called `nginx-agent`.
@@ -16,8 +15,9 @@ If you change the NGINX username after installing the NGINX Agent, you'll need t
A failure to update the `nginx-agent` group when the NGINX username changes may result in non-compliance errors for NGINX Plus.
+---
-## NGINX Socket
+## NGINX socket
NGINX Agent creates a socket in the default location `/var/run/nginx-agent/nginx.sock`. You can customize this location by editing the `nginx-agent.conf` file and setting the path similar to the following example:
@@ -29,57 +29,58 @@ nginx:
The socket server starts when the NGINX socket configuration is enabled; the socket configuration is enabled by default.
+---
-## Add NGINX Users to nginx-agent Group
+## Add NGINX Users to nginx-agent group
To manually add NGINX users to the `nginx-agent` group, take the following steps:
1. Verify the `nginx-agent` group exists:
- ```bash
+ ```shell
sudo getent group | grep nginx-agent
```
The output looks similar to the following example:
- ```bash
+ ```shell
nginx-agent:x:1001:root,nginx
```
If the group doesn't exist, create it by running the following command:
- ```bash
+ ```shell
sudo groupadd nginx-agent
```
2. Verify the ownership of `/var/run/nginx-agent` directory:
- ```bash
+ ```shell
ls -l /var/run/nginx-agent
```
The output looks similar to the following:
- ```bash
+ ```shell
total 0
srwxrwxr-x 1 root nginx-agent 0 Jun 13 10:51 nginx.sockvv
```
If the group ownership is not `nginx-agent`, change the ownership by running the following command:
- ```bash
+ ```shell
sudo chown :nginx-agent /var/run/nginx-agent
```
3. To add NGINX user(s) to the `nginx-agent` group, run the following command:
- ```bash
+ ```shell
sudo usermod -a -G nginx-agent
```
For example to add the `nginx` user, take the following step:
- ```bash
+ ```shell
sudo usermod -a -G nginx-agent nginx
```
diff --git a/site/content/configuration/connect-management-plane.md b/site/content/how-to/connect-management-plane.md
similarity index 91%
rename from site/content/configuration/connect-management-plane.md
rename to site/content/how-to/connect-management-plane.md
index c11c39c9a6..c0919d65eb 100644
--- a/site/content/configuration/connect-management-plane.md
+++ b/site/content/how-to/connect-management-plane.md
@@ -1,15 +1,13 @@
---
title: "Connect to management plane"
-weight: 400
toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 600
+docs: DOCS-000
---
## Overview
-To monitor and manage all your NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file.
+To monitor and manage all your F5 NGINX Agent instances from a central management plane server, you first need to connect your instances and the server. You can configure the connection by making the required changes to the NGINX Agent configuration file.
There are three types of connections you can establish between the NGINX Agent and the management plane server:
@@ -52,7 +50,7 @@ To establish a mTLS connection between the NGINX Agent and the management plane
```
2. Restart the NGINX Agent service:
- ```bash
+ ```shell
sudo systemctl restart nginx-agent
```
@@ -86,7 +84,7 @@ To establish a TLS connection between the NGINX Agent and the management plane s
2. Restart the NGINX Agent service:
- ```bash
+ ```shell
sudo systemctl restart nginx-agent
```
@@ -111,6 +109,6 @@ To establish an insecure connection between the NGINX Agent and the management p
2. Restart the NGINX Agent service:
- ```bash
+ ```shell
sudo systemctl restart nginx-agent
```
diff --git a/site/content/how-to/enable-interfaces.md b/site/content/how-to/enable-interfaces.md
new file mode 100644
index 0000000000..c73557165a
--- /dev/null
+++ b/site/content/how-to/enable-interfaces.md
@@ -0,0 +1,73 @@
+---
+title: "Enable gRPC and REST interfaces"
+toc: true
+weight: 200
+docs: DOCS-000
+---
+
+This document describes how to enable the gRPC and REST interfaces for F5 NGINX Agent.
+
+## Before you begin
+
+If it doesn't already exist, create the directory `/etc/nginx-agent/`and copy the `nginx-agent.conf` file into it from the project root directory.
+
+```shell
+sudo mkdir /etc/nginx-agent
+sudo cp /nginx-agent.conf /etc/nginx-agent/
+```
+
+Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run.
+
+In Linux environments:
+```shell
+sudo touch /var/lib/nginx-agent/agent-dynamic.conf
+```
+
+In FreeBSD environments:
+```shell
+sudo touch /var/db/nginx-agent/agent-dynamic.conf
+```
+
+---
+
+## Enable the gRPC interface
+
+Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`:
+
+```yaml
+server:
+ host: 127.0.0.1 # mock control plane host
+ grpcPort: 54789 # mock control plane gRPC port
+
+# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION
+tls:
+ enable: false
+ skip_verify: true
+```
+
+For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md).
+
+---
+
+## Enable the REST interface
+
+The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present:
+
+```yaml
+api:
+ # Set API address to allow remote management
+ host: 127.0.0.1
+ # Set this value to a secure port number to prevent information leaks
+ port: 8038
+ # REST TLS parameters
+ cert: ".crt"
+ key: ".key"
+```
+
+---
+
+## Start NGINX Agent
+
+To apply the new configuration, NGINX Agent must be started or restarted.
+
+You may want to view the [Start mock control plane interface]({{< relref "/contribute/start-mock-interface.md" >}}) topic to test NGINX Agent, or view the [Configuration overview]({{< relref "/how-to/configuration-overview.md" >}}) for more options.
\ No newline at end of file
diff --git a/site/content/configuration/encrypt-communication.md b/site/content/how-to/encrypt-communication.md
similarity index 95%
rename from site/content/configuration/encrypt-communication.md
rename to site/content/how-to/encrypt-communication.md
index 3ff8b8e3cc..00876ffc40 100644
--- a/site/content/configuration/encrypt-communication.md
+++ b/site/content/how-to/encrypt-communication.md
@@ -1,14 +1,13 @@
---
-title: Encrypt communication
-tags:
-- docs
+title: "Encrypt communication"
toc: true
-weight: 200
+weight: 500
+docs: DOCS-000
---
## Overview
-Follow the steps in this guide to encrypt communication between NGINX Agent and Instance Manager with TLS.
+Follow the steps in this guide to encrypt communication between F5 NGINX Agent and Instance Manager with TLS.
## Before You Begin
@@ -40,7 +39,7 @@ The `cert-sni-name` value should match the SubjectAltName of the server certific
To enable mTLS for the NGINX Agent from the command line, run the following command:
-```bash
+```shell
nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to-ca-cert" --tls-enable
```
@@ -48,7 +47,7 @@ nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to-
To enable mTLS for NGINX Agent using environment variables, run the following commands:
-```bash
+```shell
NMS_TLS_CA="my-env-ca"
NMS_TLS_KEY="my-env-key"
NMS_TLS_CERT="my-env-cert"
@@ -67,7 +66,7 @@ To enable server-side TLS you must have TLS enabled. See the following examples
You can edit the `/etc/nginx-agent/nginx-agent.conf` file to enable server-side TLS. Make the following changes:
-```bash
+```shell
tls:
enable: true
skip_verify: false
@@ -77,7 +76,7 @@ tls:
To enable server-side TLS from the command line, run the following command:
-```bash
+```shell
nginx-agent --tls-enable
```
@@ -85,7 +84,7 @@ nginx-agent --tls-enable
To enable server-side TLS using environment variables, run the following commands:
-```bash
+```shell
NMS_TLS_ENABLE=true
```
@@ -99,7 +98,7 @@ NMS_TLS_ENABLE=true
To enable server-side TLS with a self-signed certificate, you must have TLS enabled and set `skip_verify` to `true`, which disables hostname validation. Setting `skip_verify` can be done done only by updating the configuration file. See the following example:
-```bash
+```shell
tls:
enable: true
skip_verify: true
@@ -113,7 +112,7 @@ To enable insecure mode, you simply need to set `tls:enable` to `false`. Setting
You can edit the `/etc/nginx-agent/nginx-agent.conf` file to enable insecure mode. Make the following changes:
-```bash
+```shell
tls:
enable: false
```
@@ -122,6 +121,6 @@ tls:
To enable insecure mode using environment variables, run the following commands:
-```bash
+```shell
NMS_TLS_ENABLE=false
```
diff --git a/site/content/how-to/export-metrics.md b/site/content/how-to/export-metrics.md
new file mode 100644
index 0000000000..7bbd3a6871
--- /dev/null
+++ b/site/content/how-to/export-metrics.md
@@ -0,0 +1,45 @@
+---
+title: "Export metrics data"
+weight: 300
+docs: DOCS-000
+---
+
+This document describes how to export the metrics data from F5 NGINX Agent.
+
+[//]: # "These are Markdown comments to guide you through document structure."
+[//]: # "Remove them as you go, as well as unnecessary sections for this use case."
+
+## Overview
+
+[//]: # "Write a description which outlines precisely what this page of instructions will accomplish."
+[//]: # "This description, like all instructions, should be direct and imperative."
+[//]: # "Avoid ambiguous promises such as 'enables functionality': state precisely what it does."
+
+---
+
+## Before you begin
+
+[//]: # "List all of the prerequisites for completing this task."
+[//]: # "This might be the first page for a reader, so include a link to installation."
+
+To begin this task, you will require the following:
+
+- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}).
+-
+-
+
+---
+
+## Export metrics data
+
+
+
+---
+
+## See also
+
+[//]: # "Examples of additional topics users might want to read include:"
+[//]: # "Relevant reference information, configuration options and more complex use cases."
+
+- [OpenTelemetry metrics]({{< ref "/metrics.md" >}})
+-
diff --git a/site/content/install-upgrade/_index.md b/site/content/install-upgrade/_index.md
new file mode 100644
index 0000000000..db1eae8abf
--- /dev/null
+++ b/site/content/install-upgrade/_index.md
@@ -0,0 +1,6 @@
+---
+title: "Install and upgrade"
+weight: 400
+---
+
+Learn how to install, upgrade, and uninstall NGINX Agent.
\ No newline at end of file
diff --git a/site/content/install-upgrade/container-environments/_index.md b/site/content/install-upgrade/container-environments/_index.md
new file mode 100644
index 0000000000..bd7ec74ba0
--- /dev/null
+++ b/site/content/install-upgrade/container-environments/_index.md
@@ -0,0 +1,6 @@
+---
+title: "Container environments"
+weight: 400
+---
+
+Learn how to build and run NGINX Agent docker images.
\ No newline at end of file
diff --git a/site/content/installation-upgrade/container-environments/docker-images.md b/site/content/install-upgrade/container-environments/docker-images.md
similarity index 90%
rename from site/content/installation-upgrade/container-environments/docker-images.md
rename to site/content/install-upgrade/container-environments/docker-images.md
index 22f76645c3..28db5a6bd9 100644
--- a/site/content/installation-upgrade/container-environments/docker-images.md
+++ b/site/content/install-upgrade/container-environments/docker-images.md
@@ -1,22 +1,18 @@
---
title: "Build container images"
-draft: false
-weight: 100
toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 100
+docs: DOCS-000
---
## Overview
-NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus.
+F5 NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus.
If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance.
See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "technical-specifications.md" >}}) topic.
-
## Set up your environment
### Install a container engine
@@ -158,47 +154,36 @@ $ docker build -t nginx-agent . \
Here is an example of how to run the NGINX Agent container using Docker:
-```console
+```shell
docker run --name nginx-agent -d nginx-agent
```
-{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/configuration/configuration-overview" >}}).{{}}
+{{< note >}} To learn more about the configuration options, refer to the [Configuration overview]({{< relref "/how-to/configuration-overview" >}}) topic. {{}}
+
+---
### Enable the gRPC interface
-To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example:
+To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface.
-```yaml
-erver:
- host: 127.0.0.1 # mock control plane host
- grpcPort: 54789 # mock control plane gRPC port
+The configuration required is explained in the [Enable the gRPC interface]({{< relref "/how-to/enable-interfaces.md#enable-the-grpc-interface" >}})
-# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION
-tls:
- enable: false
- skip_verify: true
-```
+---
### Enable the REST interface
-If your control plane requires REST API, you can expose NGINX Agent's REST API by editing the NGINX Agent configuration file, *nginx-agent.conf*. For example:
-
-```yaml
-api:
- host: 0.0.0.0
- port: 8038
-```
+If your control plane requires a REST API, you can [Enable the REST interface]({{< relref "/how-to/enable-interfaces.md#enable-the-rest-interfacee" >}}) for NGINX Agent.
Once you have updated the *nginx-agent.conf* file, you can run the container with the updated **nginx-agent.conf** mounted and the port **8038** exposed with the following command:
-```console
+```shell
docker run --name nginx-agent -d \
--mount type=bind,source="$(pwd)"/nginx-agent.conf,target=/etc/nginx-agent/nginx-agent.conf,readonly \
-p 127.0.0.1:8038:8038/tcp \
nginx-agent
```
-
+---
## Build the NGINX Agent images for specific OS targets
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-support.md b/site/content/install-upgrade/container-environments/docker-support.md
similarity index 80%
rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-support.md
rename to site/content/install-upgrade/container-environments/docker-support.md
index 7123d9ee12..f6e41ad6fd 100644
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-support.md
+++ b/site/content/install-upgrade/container-environments/docker-support.md
@@ -1,18 +1,13 @@
---
-title: Container Support and Troubleshooting
-categories:
-- installation
-draft: false
-tags:
-- docs
+title: "Container support and troubleshooting"
toc: true
weight: 200
-docs: "DOCS-909"
+docs: DOCS-000
---
## Overview
-The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
+The F5 NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/install-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
@@ -24,8 +19,8 @@ To collect metrics about the Docker container that the NGINX Agent is running in
NGINX Agent supports both versions of cgroups.
-- https://www.kernel.org/doc/Documentation/cgroup-v1/
-- https://www.kernel.org/doc/Documentation/cgroup-v2.txt
+- https://www.kernel.org/doc/Documentation/cgroup-v1/
+- https://www.kernel.org/doc/Documentation/cgroup-v2.txt
## Metrics
@@ -59,7 +54,7 @@ If no memory limit is set when starting the Docker container, then the memory li
If a warning message similar to the following example is seen in the NGINX Agent logs, the swap memory limit for the Docker container is greater than the swap memory for the Docker host system:
-```bash
+```shell
Swap memory limit specified for the container, ... is greater than the host system swap memory ...
```
@@ -67,7 +62,7 @@ The `system.swap.total` metric for the container matches the total swap memory f
If a warning message similar to the following example is seen in the NGINX Agent logs, the Docker host system does not have cgroup swap limit capabilities enabled. To enable these capabilities, follow the steps below.
-```bash
+```shell
Unable to collect Swap metrics because the file ... was not found
```
@@ -75,7 +70,7 @@ Unable to collect Swap metrics because the file ... was not found
Run the following command to see if the cgroup swap limit capabilities are enabled:
-```bash
+```shell
$ docker info | grep swap
WARNING: No swap limit support
```
diff --git a/site/content/install-upgrade/install.md b/site/content/install-upgrade/install.md
new file mode 100644
index 0000000000..95f6514684
--- /dev/null
+++ b/site/content/install-upgrade/install.md
@@ -0,0 +1,784 @@
+---
+title: Install NGINX Agent
+toc: true
+weight: 100
+docs: DOCS-000
+---
+
+This document describes the three main ways to install F5 NGINX agent:
+
+- Using the NGINX Open Source repository
+- Using the NGINX Plus repository
+- Using the GitHub package files
+
+## Before you begin
+
+There are a few prerequisites shared between all installation methods:
+
+- A [supported operating system and architecture](../technical-specifications/#supported-distributions)
+- `root` privilege
+
+## NGINX Open Source repository
+
+Before you install NGINX Agent, you must install and run NGINX.
+
+If you don't have it installed already, read the [Installing NGINX Open Source
+](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/) topic.
+
+
+### Configure NGINX OSS Repository for installing NGINX Agent
+
+Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository.
+
+- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
+- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu)
+- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian)
+- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles)
+- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux)
+- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux)
+- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd)
+
+#### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo yum install yum-utils
+ ```
+
+1. To set up the yum repository, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
+
+ ```
+ [nginx-agent]
+ name=nginx agent repo
+ baseurl=http://packages.nginx.org/nginx-agent/centos/$releasever/$basearch/
+ gpgcheck=1
+ enabled=1
+ gpgkey=https://nginx.org/keys/nginx_signing.key
+ module_hotfixes=true
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo yum install nginx-agent
+ ```
+
+ When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+
+#### Install NGINX Agent on Ubuntu
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring
+ ```
+
+1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key:
+
+ ```shell
+ curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
+ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
+ ```
+
+1. Verify that the downloaded file contains the proper key:
+
+ ```shell
+ gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
+ ```
+
+ The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
+
+ ```
+ pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+ ```
+
+ {{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
+
+1. Add the nginx agent repository:
+
+ ```shell
+ echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
+ http://packages.nginx.org/nginx-agent/ubuntu/ `lsb_release -cs` agent" \
+ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
+ ```
+
+1. To install `nginx-agent`, run the following commands:
+
+ ```shell
+ sudo apt update
+ sudo apt install nginx-agent
+ ```
+
+#### Install NGINX Agent on Debian
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring
+ ```
+
+1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key:
+
+ ```shell
+ curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
+ | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
+ ```
+
+1. Verify that the downloaded file contains the proper key:
+
+ ```shell
+ gpg --dry-run --quiet --no-keyring \
+ --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
+ ```
+
+ The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
+
+ ```
+ pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+ ```
+
+ {{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
+
+1. Add the `nginx-agent` repository:
+
+ ```shell
+ echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
+ http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
+ ```
+
+1. To install `nginx-agent`, run the following commands:
+
+ ```shell
+ sudo apt update
+ sudo apt install nginx-agent
+ ```
+
+#### Install NGINX Agent on SLES
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo zypper install curl ca-certificates gpg2 gawk
+ ```
+
+1. To set up the zypper repository for `nginx-agent` packages, run the following command:
+
+ ```shell
+ sudo zypper addrepo --gpgcheck --refresh --check \
+ 'http://packages.nginx.org/nginx-agent/sles/$releasever_major' nginx-agent
+ ```
+
+1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key:
+
+ ```shell
+ curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key
+ ```
+
+1. Verify that the downloaded file contains the proper key:
+
+ ```shell
+ gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
+ ```
+
+1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
+
+ ```
+ pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
+ 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
+ uid nginx signing key
+ ```
+
+1. Finally, import the key to the rpm database:
+
+ ```shell
+ sudo rpmkeys --import /tmp/nginx_signing.key
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo zypper install nginx-agent
+ ```
+
+#### Install NGINX Agent on Alpine Linux
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apk add openssl curl ca-certificates
+ ```
+
+1. To set up the apk repository for `nginx-agent` packages, run the following command:
+
+ ```shell
+ printf "%s%s%s\n" \
+ "http://packages.nginx.org/nginx-agent/alpine/v" \
+ `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \
+ "/main" \
+ | sudo tee -a /etc/apk/repositories
+ ```
+
+1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key:
+
+ ```shell
+ curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub
+ ```
+
+1. Verify that downloaded file contains the proper key:
+
+ ```shell
+ openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout
+ ```
+
+ The output should contain the following modulus:
+
+ ```
+ Public-Key: (2048 bit)
+ Modulus:
+ 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58:
+ 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70:
+ 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1:
+ f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab:
+ 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f:
+ 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64:
+ 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d:
+ 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3:
+ 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c:
+ 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34:
+ 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f:
+ 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17:
+ 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99:
+ 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67:
+ c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e:
+ ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4:
+ 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f:
+ ab:6d
+ Exponent: 65537 (0x10001)
+ ```
+
+1. Finally, move the key to apk trusted keys storage:
+
+ ```shell
+ sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo apk add nginx-agent
+ ```
+
+#### Install NGINX Agent on Amazon Linux
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo yum install yum-utils procps
+ ```
+
+1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
+ ```
+ [nginx-agent]
+ name=nginx agent repo
+ baseurl=http://packages.nginx.org/nginx-agent/amzn2/$releasever/$basearch/
+ gpgcheck=1
+ enabled=1
+ gpgkey=https://nginx.org/keys/nginx_signing.key
+ module_hotfixes=true
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo yum install nginx-agent
+ ```
+
+1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+
+#### Install NGINX Agent on FreeBSD
+
+1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content:
+
+ ```
+ nginx-agent: {
+ URL: pkg+http://packages.nginx.org/nginx-agent/freebsd/${ABI}/latest
+ ENABLED: true
+ MIRROR_TYPE: SRV
+ }
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo pkg install nginx-agent
+ ```
+
+## NGINX Plus repository
+
+Before you install NGINX Agent, you must install and run NGINX Plus.
+
+If you don’t have it installed already, read the [Installing NGINX Plus
+](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/) topic.
+
+You will also need the following:
+
+- Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc.
+- An NGINX Plus subscription (Full or trial)
+- Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc.
+
+### Configure NGINX Plus Repository for installing NGINX Agent
+
+Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository.
+
+- [Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
+- [Install NGINX Agent on Ubuntu](#install-nginx-agent-on-ubuntu)
+- [Install NGINX Agent on Debian](#install-nginx-agent-on-debian)
+- [Install NGINX Agent on SLES](#install-nginx-agent-on-sles)
+- [Install NGINX Agent on Alpine Linux](#install-nginx-agent-on-alpine-linux)
+- [Install NGINX Agent on Amazon Linux](#install-nginx-agent-on-amazon-linux)
+- [Install NGINX Agent on FreeBSD](#install-nginx-agent-on-freebsd)
+
+#### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo yum install yum-utils procps
+ ```
+
+1. Set up the yum repository by creating the file `nginx-agent.repo` in `/etc/yum.repos.d`, for example using `vi`:
+
+ ```shell
+ sudo vi /etc/yum.repos.d/nginx-agent.repo
+ ```
+
+1. Add the following lines to `nginx-agent.repo`:
+
+ ```
+ [nginx-agent]
+ name=nginx agent repo
+ baseurl=https://pkgs.nginx.com/nginx-agent/centos/$releasever/$basearch/
+ sslclientcert=/etc/ssl/nginx/nginx-repo.crt
+ sslclientkey=/etc/ssl/nginx/nginx-repo.key
+ gpgcheck=0
+ enabled=1
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo yum install nginx-agent
+ ```
+
+ When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+
+#### Install NGINX Agent on Ubuntu
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 ubuntu-keyring
+ ```
+
+1. Download and add [NGINX signing key](https://cs.nginx.com/static/keys/nginx_signing.key):
+
+ ```shell
+ wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
+ ```
+
+1. Create `apt` configuration `/etc/apt/apt.conf.d/90pkgs-nginx`:
+
+ ```
+ Acquire::https::pkgs.nginx.com::Verify-Peer "true";
+ Acquire::https::pkgs.nginx.com::Verify-Host "true";
+ Acquire::https::pkgs.nginx.com::SslCert "/etc/ssl/nginx/nginx-repo.crt";
+ Acquire::https::pkgs.nginx.com::SslKey "/etc/ssl/nginx/nginx-repo.key";
+ ```
+
+1. Add the `nginx-agent` repository:
+
+ ```shell
+ echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] https://pkgs.nginx.com/nginx-agent/ubuntu/ `lsb_release -cs` agent" \
+ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
+ ```
+
+1. To install `nginx-agent`, run the following commands:
+
+ ```shell
+ sudo apt update
+ sudo apt install nginx-agent
+ ```
+
+#### Install NGINX Agent on Debian
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring
+ ```
+
+1. Add the `nginx-agent` repository:
+
+ ```shell
+ echo "deb https://pkgs.nginx.com/nginx-agent/debian/ `lsb_release -cs` agent" \
+ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
+ ```
+
+1. Create apt configuration `/etc/apt/apt.conf.d/90pkgs-nginx`:
+
+ ```
+ Acquire::https::pkgs.nginx.com::Verify-Peer "true";
+ Acquire::https::pkgs.nginx.com::Verify-Host "true";
+ Acquire::https::pkgs.nginx.com::SslCert "/etc/ssl/nginx/nginx-repo.crt";
+ Acquire::https::pkgs.nginx.com::SslKey "/etc/ssl/nginx/nginx-repo.key";
+ ```
+
+1. To install `nginx-agent`, run the following commands:
+
+ ```shell
+ sudo apt update
+ sudo apt install nginx-agent
+ ```
+
+#### Install NGINX Agent on SLES
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Create a file bundle of the certificate and key:
+
+ ```shell
+ cat /etc/ssl/nginx/nginx-repo.crt /etc/ssl/nginx/nginx-repo.key > /etc/ssl/nginx/nginx-repo-bundle.crt
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo zypper install curl ca-certificates gpg2 gawk
+ ```
+
+1. To set up the zypper repository for `nginx-agent` packages, run the following command:
+
+ ```shell
+ sudo zypper addrepo --refresh --check \
+ 'https://pkgs.nginx.com/nginx-agent/sles/$releasever_major?ssl_clientcert=/etc/ssl/nginx/nginx-repo-bundle.crt&ssl_verify=peer' nginx-agent
+ ```
+
+1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key:
+
+ ```shell
+ curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key
+ ```
+
+1. Verify that the downloaded file contains the proper key:
+
+ ```shell
+ gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
+ ```
+
+1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
+
+ ```
+ pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
+ 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
+ uid nginx signing key
+ ```
+
+1. Finally, import the key to the rpm database:
+
+ ```shell
+ sudo rpmkeys --import /tmp/nginx_signing.key
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo zypper install nginx-agent
+ ```
+
+#### Install NGINX Agent on Alpine Linux
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/apk/` directory:
+
+ ```shell
+ sudo cp nginx-repo.key /etc/apk/cert.key
+ sudo cp nginx-repo.crt /etc/apk/cert.pem
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo apk add openssl curl ca-certificates
+ ```
+
+1. To set up the apk repository for `nginx-agent` packages, run the following command:
+
+ ```shell
+ printf "%s%s%s\n" \
+ "https://pkgs.nginx.com/nginx-agent/alpine/v" \
+ `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \
+ "/main" \
+ | sudo tee -a /etc/apk/repositories
+ ```
+
+1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key:
+
+ ```shell
+ curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub
+ ```
+
+1. Verify that downloaded file contains the proper key:
+
+ ```shell
+ openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout
+ ```
+
+ The output should contain the following modulus:
+
+ ```
+ Public-Key: (2048 bit)
+ Modulus:
+ 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58:
+ 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70:
+ 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1:
+ f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab:
+ 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f:
+ 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64:
+ 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d:
+ 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3:
+ 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c:
+ 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34:
+ 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f:
+ 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17:
+ 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99:
+ 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67:
+ c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e:
+ ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4:
+ 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f:
+ ab:6d
+ Exponent: 65537 (0x10001)
+ ```
+
+1. Finally, move the key to apk trusted keys storage:
+
+ ```shell
+ sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo apk add nginx-agent
+ ```
+
+#### Install NGINX Agent on Amazon Linux
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the `nginx-repo.crt` and `nginx-repo.key` files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo yum install yum-utils procps ca-certificates
+ ```
+
+1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
+
+ ```
+ [nginx-agent]
+ name=nginx-agent repo
+ baseurl=https://pkgs.nginx.com/nginx-agent/amzn2/$releasever/$basearch
+ sslclientcert=/etc/ssl/nginx/nginx-repo.crt
+ sslclientkey=/etc/ssl/nginx/nginx-repo.key
+ gpgcheck=0
+ enabled=1
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo yum install nginx-agent
+ ```
+
+1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+
+#### Install NGINX Agent on FreeBSD
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisite `ca_root_nss` package:
+
+ ```shell
+ sudo pkg install ca_root_nss
+ ```
+
+1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content:
+
+ ```
+ nginx-agent: {
+ URL: pkg+https://pkgs.nginx.com/nginx-agent/freebsd/${ABI}/latest
+ ENABLED: yes
+ MIRROR_TYPE: SRV
+ }
+ ```
+
+1. Add the following lines to the `/usr/local/etc/pkg.conf` file:
+
+ ```
+ PKG_ENV: { SSL_NO_VERIFY_PEER: "1",
+ SSL_CLIENT_CERT_FILE: "/etc/ssl/nginx/nginx-repo.crt",
+ SSL_CLIENT_KEY_FILE: "/etc/ssl/nginx/nginx-repo.key" }
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo pkg install nginx-agent
+ ```
+
+## GitHub package files
+
+To install NGINX Agent on your system, go to the [GitHub releases page](https://github.com/nginx/agent/releases) and download the latest package supported by your operating system distribution and CPU architecture.
+
+Use your system's package manager to install the package. Some examples:
+
+- Debian, Ubuntu, and other distributions using the `dpkg` package manager.
+
+ ```shell
+ sudo dpkg -i nginx-agent-.deb
+ ```
+
+- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using the `yum` package manager
+
+ ```shell
+ sudo yum localinstall nginx-agent-.rpm
+ ```
+
+- RHEL and other distributions using the `rpm` package manager
+
+ ```shell
+ sudo rpm -i nginx-agent-.rpm
+ ```
+
+- Alpine Linux
+
+ ```shell
+ sudo apk add nginx-agent-.apk
+ ```
+
+- FreeBSD
+
+ ```shell
+ sudo pkg add nginx-agent-.pkg
+ ```
+
+## systemd environments
+
+To start NGINX Agent on `systemd` systems, run the following command:
+
+```shell
+sudo systemctl start nginx-agent
+```
+
+To enable NGINX Agent to start on boot, run the following command:
+
+```shell
+sudo systemctl enable nginx-agent
+```
+
+## Verify that NGINX Agent is running
+
+Once you have installed NGINX Agent, you can verify that it is running with the following command:
+
+```shell
+sudo nginx-agent -v
+```
+
+## Enable interfaces
+
+Once NGINX Agent is successfully running, you can enable the required interfaces, which is described in the [Enable gRPC and REST interfaces]({{< relref "/how-to/enable-interfaces.md" >}}) topic.
+
+You may also be interested in the [Start mock control plane interface]({{< relref "/contribute/start-mock-interface.md" >}}) topic for development work.
\ No newline at end of file
diff --git a/site/content/install-upgrade/migrate-v3.md b/site/content/install-upgrade/migrate-v3.md
new file mode 100644
index 0000000000..fe9a0533f3
--- /dev/null
+++ b/site/content/install-upgrade/migrate-v3.md
@@ -0,0 +1,44 @@
+---
+title: Migrate from NGINX Agent v2 to v3
+weight: 500
+docs: DOCS-000
+---
+
+This topic describes how to migrate from F5 NGINX Agent v2 to NGINX Agent v3.
+
+[//]: # "These are Markdown comments to guide you through document structure."
+[//]: # "Remove them as you go, as well as unnecessary sections for this use case."
+
+## Overview
+
+[//]: # "Write a description which outlines precisely what this page of instructions will accomplish."
+[//]: # "This description, like all instructions, should be direct and imperative."
+[//]: # "Avoid ambiguous promises such as 'enables functionality': state precisely what it does."
+
+---
+
+## Before you begin
+
+[//]: # "List all of the prerequisites for completing this task."
+[//]: # "This might be the first page for a reader, so include a link to installation."
+
+To begin this task, you will require the following:
+
+- A [working NGINX Agent instance]({{< ref "/install-upgrade/install.md" >}}).
+-
+-
+
+---
+
+## Migrate from NGINX Agent v2 to v3
+
+
+---
+
+## See also
+
+[//]: # "Examples of additional topics users might want to read include:"
+[//]: # "Relevant reference information, configuration options and more complex use cases."
+
+-
+-
diff --git a/site/content/install-upgrade/uninstall.md b/site/content/install-upgrade/uninstall.md
new file mode 100644
index 0000000000..7fe869d585
--- /dev/null
+++ b/site/content/install-upgrade/uninstall.md
@@ -0,0 +1,145 @@
+---
+title: "Uninstall NGINX Agent"
+toc: true
+weight: 300
+docs: DOCS-000
+---
+
+## Overview
+
+Learn how to uninstall F5 NGINX Agent from your system.
+
+## Before you begin
+
+### Prerequisites
+
+- NGINX Agent installed [NGINX Agent installed](../installation-oss)
+- The user following these steps will need `root` privilege
+
+## Uninstall NGINX Agent
+Complete the following steps on each host where you’ve installed NGINX Agent
+
+
+- [Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#uninstall-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
+- [Uninstall NGINX Agent on Ubuntu](#uninstall-nginx-agent-on-ubuntu)
+- [Uninstall NGINX Agent on Debian](#uninstall-nginx-agent-on-debian)
+- [Uninstall NGINX Agent on SLES](#uninstall-nginx-agent-on-sles)
+- [Uninstall NGINX Agent on Alpine Linux](#uninstall-nginx-agent-on-alpine-linux)
+- [Uninstall NGINX Agent on Amazon Linux](#uninstall-nginx-agent-on-amazon-linux)
+- [Uninstall NGINX Agent on FreeBSD](#uninstall-nginx-agent-on-freebsd)
+
+### Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
+
+Complete the following steps on each host where you've installed NGINX Agent:
+
+1. Stop NGINX Agent:
+
+ ```shell
+ sudo systemctl stop nginx-agent
+ ```
+
+1. To uninstall NGINX Agent, run the following command:
+
+ ```shell
+ sudo yum remove nginx-agent
+ ```
+
+### Uninstall NGINX Agent on Ubuntu
+
+Complete the following steps on each host where you've installed NGINX Agent:
+
+1. Stop NGINX Agent:
+
+ ```shell
+ sudo systemctl stop nginx-agent
+ ```
+
+1. To uninstall NGINX Agent, run the following command:
+
+ ```shell
+ sudo apt-get remove nginx-agent
+ ```
+
+ {{< note >}} The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. {{< /note >}}
+
+### Uninstall NGINX Agent on Debian
+
+Complete the following steps on each host where you've installed NGINX Agent:
+
+1. Stop NGINX Agent:
+
+ ```shell
+ sudo systemctl stop nginx-agent
+ ```
+
+1. To uninstall NGINX Agent, run the following command:
+
+ ```shell
+ sudo apt-get remove nginx-agent
+ ```
+
+ {{< note >}} The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `. {{< /note >}}
+
+### Uninstall NGINX Agent on SLES
+
+Complete the following steps on each host where you've installed NGINX Agent:
+
+1. Stop NGINX agent:
+
+ ```shell
+ sudo systemctl stop nginx-agent
+ ```
+
+1. To uninstall NGINX agent, run the following command:
+
+ ```shell
+ sudo zypper remove nginx-agent
+ ```
+
+### Uninstall NGINX Agent on Alpine Linux
+
+Complete the following steps on each host where you've installed NGINX agent:
+
+1. Stop NGINX agent:
+
+ ```shell
+ sudo rc-service nginx-agent stop
+ ```
+
+1. To uninstall NGINX agent, run the following command:
+
+ ```shell
+ sudo apk del nginx-agent
+ ```
+
+### Uninstall NGINX Agent on Amazon Linux
+
+Complete the following steps on each host where you've installed NGINX agent:
+
+1. Stop NGINX agent:
+
+ ```shell
+ sudo systemctl stop nginx-agent
+ ```
+
+1. To uninstall NGINX agent, run the following command:
+
+ ```shell
+ sudo yum remove nginx-agent
+ ```
+
+### Uninstall NGINX Agent on FreeBSD
+
+Complete the following steps on each host where you've installed NGINX agent:
+
+1. Stop NGINX agent:
+
+ ```shell
+ sudo service nginx-agent stop
+ ```
+
+1. To uninstall NGINX agent, run the following command:
+
+ ```shell
+ sudo pkg delete nginx-agent
+ ```
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/upgrade.md b/site/content/install-upgrade/upgrade.md
similarity index 91%
rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/upgrade.md
rename to site/content/install-upgrade/upgrade.md
index bf5bb90c49..55898a2bb7 100644
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/upgrade.md
+++ b/site/content/install-upgrade/upgrade.md
@@ -1,17 +1,13 @@
---
-title: "Upgrade NGINX Agent Package"
-draft: false
-weight: 600
+title: "Upgrade NGINX Agent"
toc: true
-tags: [ "docs" ]
-docs: "DOCS-1227"
-categories: ["configuration"]
-doctypes: ["task"]
+weight: 200
+docs: DOCS-000
---
## Overview
-Learn how to upgrade NGINX Agent.
+Learn how to upgrade F5 NGINX Agent.
## Upgrade NGINX Agent from version v2.31.0 or greater
@@ -42,8 +38,6 @@ To upgrade NGINX Agent, follow these steps:
sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
```
-
-
## Upgrade NGINX Agent from a version less than v2.31.0
To upgrade NGINX Agent, take the following steps:
diff --git a/site/content/metrics.md b/site/content/metrics.md
new file mode 100644
index 0000000000..179f413b96
--- /dev/null
+++ b/site/content/metrics.md
@@ -0,0 +1,5 @@
+---
+title: OpenTelemetry metrics
+weight: 300
+docs: DOCS-000
+---
\ No newline at end of file
diff --git a/site/content/overview.md b/site/content/overview.md
deleted file mode 100644
index 76e16c8e69..0000000000
--- a/site/content/overview.md
+++ /dev/null
@@ -1,69 +0,0 @@
----
-title: "Overview"
-draft: false
-weight: 100
-toc: true
-tags: [ "docs" ]
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-NGINX Agent 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
-- Notifications of NGINX events
-
-
-{{< img src="grafana-dashboard-example.png" caption="Grafana dashboard showing metrics reported by NGINX Agent" alt="Grafana dashboard showing metrics reported by NGINX Agent" width="99%">}}
-
-## How it Works
-
-NGINX Agent runs as a companion process on a system running NGINX. It provides gRPC and REST interfaces for configuration management and metrics collection from the NGINX process and operating system. NGINX Agent enables remote interaction with NGINX using common Linux tools and unlocks the ability to build sophisticated monitoring and control systems that can manage large collections of NGINX instances.
-
-{{< img src="agent-flow.png" caption="How Agent works" alt="How NGINX Agent works" width="99%">}}
-
-
-## Configuration Management
-
-NGINX Agent provides an API interface for submission of updated configuration files. Upon receipt of a new file, it checks the output of `nginx -V` to determine the location of existing configurations. It then validates the new configuration with `nginx -t` before applying it via a signal HUP to the NGINX master process.
-
-## Collecting Metrics
-
-NGINX Agent interfaces with NGINX process information and parses NGINX logs to calculate and report metrics. When interfacing with NGINX Plus, NGINX Agent pulls relevant information from the NGINX Plus API. Reported metrics may be aggregated by [Prometheus](https://prometheus.io/) and visualized with tools like [Grafana](https://grafana.com/).
-
-### NGINX Open Source
-
-When running alongside an open source instance of NGINX, NGINX Agent requires that NGINX Access and Error logs are turned on and contain all default variables.
-
-### NGINX Plus
-
-For NGINX Agent to work properly with an NGINX Plus instance, the API needs to be configured in that instance's nginx.conf. See [Instance Metrics Overview](https://docs.nginx.com/nginx-management-suite/nim/about/overview-metrics/) for more details. Once NGINX Plus is configured with the `/api/` endpoint, the Agent will automatically use it on startup.
-
-## Event Notifications
-
-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>}}
{{}}
-{{}}
-| Event | Description |
-| -------------------------------- | -------------------------------------------- |
-| AGENT_START_MESSAGE | Agent process started |
-| AGENT_STOP_MESSAGE | Agent process stopped |
-| NGINX_FOUND_MESSAGE | NGINX master process detected on system |
-| NGINX_STOP_MESSAGE | NGINX master process stopped |
-| NGINX_RELOAD_SUCCESS_MESSAGE | NGINX master process reloaded successfully |
-| NGINX_RELOAD_FAILED_MESSAGE | NGINX master process failed to reload |
-| NGINX_WORKER_START_MESSAGE | New NGINX worker process started |
-| NGINX_WORKER_STOP_MESSAGE | NGINX worker process stopped |
-| CONFIG_APPLY_SUCCESS_MESSAGE | Successfully applied new NGINX configuration |
-| CONFIG_APPLY_FAILURE_MESSAGE | Failed to apply new NGINX configuration |
-| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration |
-| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration |
-{{}}
-{{< raw-html>}}
{{}}
-
-
diff --git a/site/content/previous-versions/NGINX-agent-v2/changelog.md b/site/content/previous-versions/NGINX-agent-v2/changelog.md
deleted file mode 100644
index d4c587926b..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/changelog.md
+++ /dev/null
@@ -1,211 +0,0 @@
----
-title: "Changelog"
-weight: 1200
-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" >}}).
-
----
-## Release [v2.32.2](https//github.com/nginx/agent/releases/tag/v2.32.2)
-
-### 🌟 Highlights
-
-- This release fixes an issue where certain container runtimes were reporting as bare-metal hosts.
-
-### 🚀 Features
-
-This release introduces the following new features:
-
-- feat: improve docker docs by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#587](https://github.com/nginx/agent/pull/587)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- Fix install-tools by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#581](https://github.com/nginx/agent/pull/581)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- change log updated for last release by [@oliveromahony](https://github.com/oliveromahony) in [#583](https://github.com/nginx/agent/pull/583)
-- Restore agent container information from nms docs by [@jputrino](https://github.com/jputrino) in [#584](https://github.com/nginx/agent/pull/584)
-- fix: add additional container checks during instance registration by [@mattdesmarais](https://github.com/mattdesmarais) in [#592](https://github.com/nginx/agent/pull/592)
-
----
-## Release [v2.32.1](https//github.com/nginx/agent/releases/tag/v2.32.1)
-
-### 🚀 Features
-
-This release introduces the following new features:
-
-- feat: Agent Docs IA refactor by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#548](https://github.com/nginx/agent/pull/548)
-- feat: move NMS agent docs by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#553](https://github.com/nginx/agent/pull/553)
-- feat: import changelog from github by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#570](https://github.com/nginx/agent/pull/570)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- fix runners and bump go version by [@oliveromahony](https://github.com/oliveromahony) in [#550](https://github.com/nginx/agent/pull/550)
-- Fix artifact name by [@oliveromahony](https://github.com/oliveromahony) in [#558](https://github.com/nginx/agent/pull/558)
-- fix: add missing catalog entry by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#572](https://github.com/nginx/agent/pull/572)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- Runc bump by [@oliveromahony](https://github.com/oliveromahony) in [#565](https://github.com/nginx/agent/pull/565)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- bump vulnerable version of buildkit by [@oliveromahony](https://github.com/oliveromahony) in [#564](https://github.com/nginx/agent/pull/564)
-
----
-## Release [v2.32.0](https//github.com/nginx/agent/releases/tag/v2.32.0)
-
-### 🚀 Features
-
-This release introduces the following new features:
-
-- feat: added the new OS support for NGINX R31 by [@oliveromahony](https://github.com/oliveromahony) in [#538](https://github.com/nginx/agent/pull/538)
-
----
-## Release [v2.31.2](https//github.com/nginx/agent/releases/tag/v2.31.2)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- chore: rename hugo folder to site, fix product naming by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#527](https://github.com/nginx/agent/pull/527)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- Update upgrade documentation by [@dhurley](https://github.com/dhurley) in [#526](https://github.com/nginx/agent/pull/526)
-- Bump the versions of containerd and go-git dependencies by [@dhurley](https://github.com/dhurley) in [#533](https://github.com/nginx/agent/pull/533)
-- updated dependencies by [@oliveromahony](https://github.com/oliveromahony) in [#536](https://github.com/nginx/agent/pull/536)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- Bump crypto dependency from 0.14.0 to 0.17.0 by [@dhurley](https://github.com/dhurley) in [#532](https://github.com/nginx/agent/pull/532)
-
----
-## Release [v2.31.1](https//github.com/nginx/agent/releases/tag/v2.31.1)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- Fix permissions for log file and dynamic config directory by [@aphralG](https://github.com/aphralG) in [#517](https://github.com/nginx/agent/pull/517)
-- Fix server example in sdk to have timeout by [@aphralG](https://github.com/aphralG) in [#518](https://github.com/nginx/agent/pull/518)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- Update SELinux Readme by [@aphralG](https://github.com/aphralG) in [#522](https://github.com/nginx/agent/pull/522)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- Replace mockgen by [@oliveromahony](https://github.com/oliveromahony) in [#524](https://github.com/nginx/agent/pull/524)
-- Restrict config apply directory permissions by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#519](https://github.com/nginx/agent/pull/519)
-- Restrict NAP file/dir permissions by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#516](https://github.com/nginx/agent/pull/516)
-
----
-## Release [v2.31.0](https//github.com/nginx/agent/releases/tag/v2.31.0)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- Fix otelcontrib version by [@oliveromahony](https://github.com/oliveromahony) in [#504](https://github.com/nginx/agent/pull/504)
-- Fix user agent request header to have the correct agent version by [@dhurley](https://github.com/dhurley) in [#498](https://github.com/nginx/agent/pull/498)
-- Fix alpine plus dockerfile on alpine>=3.17 by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#511](https://github.com/nginx/agent/pull/511)
-- fix: avoid stopping nginx-agent service on package upgrade by [@defanator](https://github.com/defanator) in [#352](https://github.com/nginx/agent/pull/352)
-- Fix SELinux Policy by [@aphralG](https://github.com/aphralG) in [#520](https://github.com/nginx/agent/pull/520)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- Add CLI arg to set dynamic config path by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#490](https://github.com/nginx/agent/pull/490)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- crossplane version bump by [@oliveromahony](https://github.com/oliveromahony) in [#512](https://github.com/nginx/agent/pull/512)
-- Add commander retry lock by [@dhurley](https://github.com/dhurley) in [#502](https://github.com/nginx/agent/pull/502)
-- Bump otel dependency version and fix github workflow for dependabot PRs by [@dhurley](https://github.com/dhurley) in [#515](https://github.com/nginx/agent/pull/515)
-
----
-## Release [v2.30.3](https//github.com/nginx/agent/releases/tag/v2.30.3)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- Fix dependabot issues by [@oliveromahony](https://github.com/oliveromahony) in [#503](https://github.com/nginx/agent/pull/503)
-
----
-## Release [v2.30.1](https//github.com/nginx/agent/releases/tag/v2.30.1)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- fix: Tolerate additional fields in App Protect yaml files by [@edarzins](https://github.com/edarzins) in [#494](https://github.com/nginx/agent/pull/494)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- Update nginx-plus-go-client to stop 404 errors in NGINX access logs by [@dhurley](https://github.com/dhurley) in [#495](https://github.com/nginx/agent/pull/495)
-
----
-## Release [v2.30.0](https//github.com/nginx/agent/releases/tag/v2.30.0)
-
-### 🐛 Bug Fixes
-
-In this release we have resolved the following issues:
-
-- Fix version for forked repo by [@dhurley](https://github.com/dhurley) in [#468](https://github.com/nginx/agent/pull/468)
-- Fix integration tests by [@aphralG](https://github.com/aphralG) in [#478](https://github.com/nginx/agent/pull/478)
-- Fix config apply by [@oliveromahony](https://github.com/oliveromahony) in [#480](https://github.com/nginx/agent/pull/480)
-- deprecate system.mem.used.all metric by [@aphralG](https://github.com/aphralG) in [#485](https://github.com/nginx/agent/pull/485)
-
-### 📝 Documentation
-
-We have made the following updates to the documentation:
-
-- Update CLI flags documentation by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#476](https://github.com/nginx/agent/pull/476)
-- Update NGINX plugin to read NGINX config on startup by [@dhurley](https://github.com/dhurley) in [#489](https://github.com/nginx/agent/pull/489)
-
-### 🔨 Maintenance
-
-We have made the following maintenance-related minor changes:
-
-- Update file watcher to ignore .swx files by [@dhurley](https://github.com/dhurley) in [#466](https://github.com/nginx/agent/pull/466)
-- Check Simplemetrics is not empty by [@aphralG](https://github.com/aphralG) in [#474](https://github.com/nginx/agent/pull/474)
-- Add error log if duplicate NGINX IDs are found by [@dhurley](https://github.com/dhurley) in [#477](https://github.com/nginx/agent/pull/477)
-- Add tests for additional SSL directives and key algorithms. [#276](https://github.com/nginx/agent/issues/276) by [@arsenalzp](https://github.com/arsenalzp) in [#469](https://github.com/nginx/agent/pull/469)
-- call underlying os.Hostname instead of the entire hostInfo gopsutil call by [@oliveromahony](https://github.com/oliveromahony) in [#479](https://github.com/nginx/agent/pull/479)
-- Add grpc integration tests by [@dhurley](https://github.com/dhurley) in [#475](https://github.com/nginx/agent/pull/475)
-- remove error log causing failures by [@aphralG](https://github.com/aphralG) in [#488](https://github.com/nginx/agent/pull/488)
-- Use singleflight for caching environment.go calls by [@oliveromahony](https://github.com/oliveromahony) in [#481](https://github.com/nginx/agent/pull/481)
-- Reduce the number of times env.Processes gets called by [@dhurley](https://github.com/dhurley) in [#482](https://github.com/nginx/agent/pull/482)
-- add additional check to nginxProcesses by [@aphralG](https://github.com/aphralG) in [#483](https://github.com/nginx/agent/pull/483)
-- profile.cgo by [@oliveromahony](https://github.com/oliveromahony) in [#493](https://github.com/nginx/agent/pull/493)
-
diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/_index.md b/site/content/previous-versions/NGINX-agent-v2/configuration/_index.md
deleted file mode 100644
index 3d1fdf4e34..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/configuration/_index.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: "Configuration"
-description: "Learn how to configure NGINX Agent."
-linkTitle: "Configuration"
-weight: "400"
-menu: docs
----
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/configuration-overview.md b/site/content/previous-versions/NGINX-agent-v2/configuration/configuration-overview.md
deleted file mode 100644
index caafd40991..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/configuration/configuration-overview.md
+++ /dev/null
@@ -1,287 +0,0 @@
----
-title: "Configuration Overview"
-draft: false
-weight: 100
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1229"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
-
-{{}}
-
-- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
-
- 1. CLI flags overwrite configuration files and environment variable values.
- 2. Environment variables overwrite configuration file values.
- 3. Config files are the lowest priority and config settings are superseded if either of the other options is used.
-
-- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
-
-{{}}
-
-### Configure with Config Files
-
-The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
-
-Examples of the configuration files are provided below:
-
-
- example nginx-agent.conf
-
-{{}}
-In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control/management plane.
-{{}}
-
-```nginx {hl_lines=[13]}
-#
-# /etc/nginx-agent/nginx-agent.conf
-#
-# Configuration file for NGINX Agent.
-#
-# This file tracks agent configuration values that are meant to be statically set. There
-# are additional NGINX Agent configuration values that are set via the API and agent install script
-# which can be found in /etc/nginx-agent/agent-dynamic.conf.
-
-# specify the server grpc port to connect to
-server:
- # host of the control plane
- host:
- grpcPort: 443
-# tls options
-tls:
- # enable tls in the nginx-agent setup for grpcs
- # default to enable to connect with secure connection but without client cert for mtls
- enable: true
- # controls whether the server certificate chain and host name are verified.
- # for production use, see instructions for configuring TLS
- skip_verify: false
-log:
- # set log level (panic, fatal, error, info, debug, trace; default "info")
- level: info
- # set log path. if empty, don't log to file.
- path: /var/log/nginx-agent/
-nginx:
- # path of NGINX logs to exclude
- exclude_logs: ""
- # Set to true when NGINX configuration should contain no warnings when performing a configuration apply (nginx -t is used to carry out this check)
- treat_warnings_as_errors: false # Default is false
-# data plane status message / 'heartbeat'
-dataplane:
- status:
- # poll interval for dataplane status - the frequency the agent will query the dataplane for changes
- poll_interval: 30s
- # report interval for dataplane status - the maximum duration to wait before syncing dataplane information if no updates have been observed
- report_interval: 24h
-metrics:
- # specify the size of a buffer to build before sending metrics
- bulk_size: 20
- # specify metrics poll interval
- report_interval: 1m
- collection_interval: 15s
- mode: aggregated
-
-# OSS NGINX default config path
-# path to aux file dirs can also be added
-config_dirs: "/etc/nginx:/usr/local/etc/nginx"
-
-# Internal queue size
-queue_size: 100
-
-extensions:
- - nginx-app-protect
-
-# Enable reporting NGINX App Protect details to the control plane.
-nginx_app_protect:
- # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes.
- report_interval: 15s
- # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false).
- precompiled_publication: true
-```
-
-
-
-
-
- example dynamic-agent.conf
-
-{{}}
-Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
-
-Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
-{{}}
-
-```yaml
-# Dynamic configuration file for NGINX Agent.
-#
-# The purpose of this file is to track agent configuration
-# values that can be dynamically changed via the API and the agent install script.
-# You may edit this file, but API calls that modify the tags on this system will
-# overwrite the tag values in this file.
-#
-# The agent configuration values that API calls can modify are as follows:
-# - tags
-#
-# The agent configuration value that the agent install script can modify are as follows:
-# - instance_group
-
-instance_group: devenv-group
-tags:
- - devenv
- - test
-```
-
-
-
-
-### NGINX Agent CLI Flags & Usage {#nginx-agent-cli-flags-usage}
-
-This section displays the configurable options for NGINX Agent that can be set with CLI flags. See the CLI flags and their uses in the figure below:
-
-
- NGINX Agent CLI flags & usage
-
-```text
-Usage:
- nginx-agent [flags]
- nginx-agent [command]
-
-Available Commands:
- completion Generate completion script.
- help Help about any command
-
-Flags:
- --api-cert string The cert used by the Agent API.
- --api-host string The host used by the Agent API. (default "127.0.0.1")
- --api-key string The key used by the Agent API.
- --api-port int The desired port to use for nginx-agent to expose for HTTP traffic.
- --config-dirs string Defines the paths that you want to grant nginx-agent read/write access to. This key is formatted as a string and follows Unix PATH format. (default "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms")
- --dataplane-report-interval duration The amount of time the agent will report on the dataplane. After this period of time it will send a snapshot of the dataplane information. (default 24h0m0s)
- --dataplane-status-poll-interval duration The frequency the agent will check the dataplane for changes. Used as a "heartbeat" to keep the gRPC connections alive. (default 30s)
- --display-name string The instance's 'name' value.
- --dynamic-config-path string Defines the path of the Agent dynamic config file. (default "/var/lib/nginx-agent/agent-dynamic.conf")
- --features strings A comma-separated list of features enabled for the agent. (default [registration,nginx-config-async,nginx-ssl-config,nginx-counting,metrics,dataplane-status,process-watcher,file-watcher,activity-events,agent-api])
- -h, --help help for nginx-agent
- --ignore-directives strings A comma-separated list of ignoring directives which contain sensitive info.
- --instance-group string The instance's 'group' value.
- --log-level string The desired verbosity level for logging messages from nginx-agent. Available options, in order of severity from highest to lowest, are: panic, fatal, error, info, debug, and trace. (default "info")
- --log-path string The path to output log messages to. If the default path doesn't exist, log messages are output to stdout/stderr.
- --metrics-bulk-size int The amount of metrics reports collected before sending the data back to the server. (default 20)
- --metrics-collection-interval duration Sets the interval, in seconds, at which metrics are collected. (default 15s)
- --metrics-mode string Sets the desired metrics collection mode: streaming or aggregation. (default "aggregated")
- --metrics-report-interval duration The polling period specified for a single set of metrics being collected. (default 1m0s)
- --nginx-config-reload-monitoring-period duration The duration NGINX Agent will monitor error logs after a NGINX reload (default 10s)
- --nginx-exclude-logs string One or more NGINX access log paths that you want to exclude from metrics collection. This key is formatted as a string and multiple values should be provided as a comma-separated list.
- --nginx-socket string The NGINX Plus counting unix socket location. (default "unix:/var/run/nginx-agent/nginx.sock")
- --nginx-treat-warnings-as-errors On nginx -t, treat warnings as failures on configuration application.
- --queue-size int The size of the NGINX Agent internal queue.
- --server-command string The name of the command server sent in the tls configuration.
- --server-grpcport int The desired GRPC port to use for nginx-agent traffic.
- --server-host string The IP address of the server host. IPv4 addresses and hostnames are supported.
- --server-metrics string The name of the metrics server sent in the tls configuration.
- --server-token string An authentication token that grants nginx-agent access to the commander and metrics services. Auto-generated by default. (default "e202f883-54c6-4702-be15-3ba6e507879a")
- --tags strings A comma-separated list of tags to add to the current instance or machine, to be used for inventory purposes.
- --tls-ca string The path to the CA certificate file to use for TLS.
- --tls-cert string The path to the certificate file to use for TLS.
- --tls-enable Enables TLS for secure communications.
- --tls-key string The path to the certificate key file to use for TLS.
- --tls-skip-verify Only intended for demonstration, sets InsecureSkipVerify for gRPC TLS credentials
- -v, --version version for nginx-agent
-
-Use "nginx-agent [command] --help" for more information about a command.
-```
-
-
-
-#### NGINX Agent Config Dirs Option
-
-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/management 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 follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
-
-- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
-
-#### NGINX Agent Dynamic Config Path Option
-
-Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
-
-Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
-
-Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
-
-### NGINX Agent Environment Variables
-
-This section displays the configurable options for NGINX Agent that can be set with environment variables. A list of the configurable environment variables can be seen below:
-
-
- NGINX Agent Environment Variables
-
-```text
-- NMS_INSTANCE_GROUP
-- NMS_DISPLAY_NAME
-- NMS_FEATURES
-- NMS_LOG_LEVEL
-- NMS_LOG_PATH
-- NMS_PATH
-- NMS_METRICS_COLLECTION_INTERVAL
-- NMS_METRICS_MODE
-- NMS_METRICS_BULK_SIZE
-- NMS_METRICS_REPORT_INTERVAL
-- NMS_NGINX_EXCLUDE_LOGS
-- NMS_NGINX_SOCKET
-- NMS_NGINX_TREAT_WARNINGS_AS_ERRORS
-- NMS_SERVER_GRPCPORT
-- NMS_SERVER_HOST
-- NMS_SERVER_TOKEN
-- NMS_SERVER_COMMAND
-- NMS_SERVER_METRICS
-- NMS_TAGS
-- NMS_TLS_CA
-- NMS_TLS_CERT
-- NMS_TLS_ENABLE
-- NMS_TLS_KEY
-- NMS_TLS_SKIP_VERIFY
-- NMS_CONFIG_DIRS
-- NMS_QUEUE_SIZE
-- NMS_DATAPLANE_REPORT_INTERVAL
-- NMS_DATAPLANE_STATUS_POLL_INTERVAL
-```
-
-
-### NGINX Agent Log Rotation
-
-By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
-
-
- NGINX Agent Logrotate Configuration
-
-``` yaml
-/var/log/nginx-agent/*.log
-{
- # log files are rotated every day
- daily
- # log files are rotated if they grow bigger than 5M
- size 5M
- # truncate the original log file after creating a copy
- copytruncate
- # remove rotated logs older than 10 days
- maxage 10
- # log files are rotated 10 times before being removed
- rotate 10
- # old log files are compressed
- compress
- # if the log file is missing it will go on to the next one without issuing an error message
- missingok
- # do not rotate the log if it is empty
- notifempty
-}
-```
-
-
-If you need to make changes to the default configuration you can update the file here `/etc/logrotate.d/nginx-agent`
-
-For more detail on logrotate configuration see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate)
diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md b/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md
deleted file mode 100644
index dc79b629a7..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/contribute/_index.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: "Contribute"
-description: "Learn about the NGINX Agent community and contribute to the project."
-linkTitle: "Contribute"
-menu: docs
-weight: "500"
----
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/community.md b/site/content/previous-versions/NGINX-agent-v2/contribute/community.md
deleted file mode 100644
index 16763795dd..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/contribute/community.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-title: "Community and Contribution"
-draft: false
-weight: 100
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1087"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-# Community
-
-- Our [Slack channel #nginx-agent](https://nginxcommunity.slack.com/), is the go-to place to start asking questions and sharing your thoughts.
-
-- Our [GitHub issues page](https://github.com/nginx/agent/issues) offers space for a more technical discussion at your own pace.
-
-# 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)
diff --git a/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md b/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md
deleted file mode 100644
index e9e3e9db03..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/contribute/dev-environment-setup.md
+++ /dev/null
@@ -1,65 +0,0 @@
----
-title: "Development Environment Setup"
-draft: false
-weight: 200
-toc: true
-tags: [ "docs" ]
-
-categories: ["development"]
-doctypes: ["task"]
----
-
-## Overview
-
-Learn how to setup a Development Environment for NGINX Agent.
-
-## Select an Operating System
-
-While most Linux or FreeBSD operating systems can be used to contribute to the NGINX Agent project, the following steps have been designed for Ubuntu. Ubuntu is packaged with most libraries required to build and run NGINX Agent, and is the recommended platform for NGINX Agent development.
-
-## Install NGINX
-
-Follow the steps in the [Installation]({{< relref "/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX and NGINX Agent.
-
-## Clone the NGINX Agent Repository
-
-Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help.
-
-## Installing Prerequisite Packages
-Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.
-
-Change to the NGINX Agent source directory:
-```bash
-cd /agent
-```
-
-Install Make:
-```bash
-sudo apt install make
-```
-
-NGINX Agent is written in Go. You may [download Go](https://go.dev/doc/install) and follow installation instructions on the same page or run:
-```bash
-sudo apt install golang-go
-```
-
-Install Protoc:
-```bash
-sudo apt install -y protobuf-compiler
-```
-
-Install NGINX Agent tools and dependencies:
-
-Before starting development on NGINX Agent, it is important to download and install the necessary tool and dependencies required by NGINX Agent. You can do this by running the following `make` command:
-```bash
-make install-tools deps
-```
-
-## Building NGINX Agent from Source Code
-
-Run the following commands to build and run NGINX Agent:
-
-```bash
-make build
-sudo make run
-```
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/_index.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/_index.md
deleted file mode 100644
index 211fc3e9b6..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/_index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: "Installation and Upgrade"
-description: "Learn how to install, upgrade, and uninstall NGINX Agent."
-menu: docs
-weight: 300
----
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/_index.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/_index.md
deleted file mode 100644
index e2de9f52c2..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/_index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: "Container Environments"
-description: "Learn how to build and run NGINX Agent docker images."
-menu: docs
-weight: 800
----
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md
deleted file mode 100644
index e7f3e96d69..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/getting-started.md
+++ /dev/null
@@ -1,181 +0,0 @@
----
-title: "Getting Started"
-draft: false
-weight: 100
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1089"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-Follow these steps to configure and run NGINX Agent and a mock interface ("control plane") to which NGINX Agent will report.
-
-## Install NGINX
-
-Follow the steps in the [Installation]({{< relref "/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX.
-
-## Clone the NGINX Agent Repository
-
-Using your preferred method, clone the NGINX Agent repository into your development directory. See [Cloning a GitHub Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for additional help.
-
-## Install Go
-
-NGINX Agent and the Mock Control Plane are written in Go. Go 1.23.0 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/).
-
-## Start the gRPC Mock Control Plane
-
-Start the mock control plane by running the following command from the `agent` source code root directory:
-
-```shell
-go run sdk/examples/server.go
-
-# Command Output
-INFO[0000] http listening at 54790 # mock control plane port
-INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent will report to
-```
-
-## NGINX Agent Settings
-
-If it doesn't already exist, create the `/etc/nginx-agent/` directory and copy the `nginx-agent.conf` file into it from the project root directory.
-
-```shell
-sudo mkdir /etc/nginx-agent
-sudo cp /nginx-agent.conf /etc/nginx-agent/
-```
-
-Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run.
-
-In Linux environments:
-```shell
-sudo touch /var/lib/nginx-agent/agent-dynamic.conf
-```
-
-In FreeBSD environments:
-```shell
-sudo touch /var/db/nginx-agent/agent-dynamic.conf
-```
-
-### Enable the gRPC interface
-
-Add the the following settings to `/etc/nginx-agent/nginx-agent.conf`:
-
-```yaml
-server:
- host: 127.0.0.1 # mock control plane host
- grpcPort: 54789 # mock control plane gRPC port
-
-# gRPC TLS options - DISABLING TLS IS NOT RECOMMENDED FOR PRODUCTION
-tls:
- enable: false
- skip_verify: true
-```
-
-For more information, see [Agent Protocol Definitions and Documentation](https://github.com/nginx/agent/tree/main/docs/proto/README.md).
-
-### Enable the REST interface
-
-The NGINX Agent REST interface can be exposed by validating the following lines in the `/etc/nginx-agent/nginx-agent.conf` file are present:
-
-```yaml
-api:
- # Set API address to allow remote management
- host: 127.0.0.1
- # Set this value to a secure port number to prevent information leaks
- port: 8038
- # REST TLS parameters
- cert: ".crt"
- key: ".key"
-```
-
-The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent.
-
-## Launch Swagger UI
-
-Swagger UI requires goswagger be installed. See [instructions for installing goswagger](https://goswagger.io/install.html) for additional help.
-
-To launch the Swagger UI for the REST interface run the following command:
-
-```shell
-make launch-swagger-ui
-```
-
-## Extensions
-
-An extension is a piece of code, not critical to the main functionality that NGINX agent is responsible for. This generally falls outside the remit of managing NGINX Configuration and reporting NGINX metrics.
-
-To enable an extension, it must be added to the extensions list in the `/etc/nginx-agent/nginx-agent.conf`.
-Here is an example of enabling the advanced metrics extension:
-
-```yaml
-extensions:
- - advanced-metrics
-```
-
-## Start NGINX Agent
-
-If already running, restart NGINX Agent to apply the new configuration. Alternatively, if NGINX Agent is not running, you may run it from the source code root directory.
-
-Open another terminal window and start NGINX Agent. Issue the following command from the `agent` source code root directory.
-
-```shell
-sudo make run
-
-# Command Output snippet
-WARN[0000] Log level is info
-INFO[0000] setting displayName to XXX
-INFO[0000] NGINX Agent at with pid 12345, clientID=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX name=XXX
-INFO[0000] NginxBinary initializing
-INFO[0000] Commander initializing
-INFO[0000] Comms initializing
-INFO[0000] OneTimeRegistration initializing
-INFO[0000] Registering XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX
-INFO[0000] Metrics initializing
-INFO[0000] MetricsThrottle initializing
-INFO[0000] DataPlaneStatus initializing
-INFO[0000] MetricsThrottle waiting for report ready
-INFO[0000] Metrics waiting for handshake to be completed
-INFO[0000] ProcessWatcher initializing
-INFO[0000] Extensions initializing
-INFO[0000] FileWatcher initializing
-INFO[0000] FileWatchThrottle initializing
-INFO[0001] Events initializing
-INFO[0001] OneTimeRegistration completed
-```
-
-Open a web browser to view the mock control plane at [http://localhost:54790](http://localhost:54790). The following links will be shown in the web interface:
-
-- **registered** - shows registration information of the data plane
-- **nginxes** - lists the nginx instances on the data plane
-- **configs** - shows the protobuf payload for NGINX configuration sent to the management plane
-- **configs/chunked** - shows the split-up payloads sent to the management plane
-- **configs/raw** - shows the actual configuration as it would live on the data plane
-- **metrics** - shows a buffer of metrics sent to the management plane (similar to what will be sent back in the REST API)
-
-For more NGINX Agent use cases, refer to the [NGINX Agent SDK examples](https://github.com/nginx/agent/tree/main/sdk/examples).
-
-## Start and Enable Start on Boot
-
-To start NGINX Agent on `systemd` systems, run the following command:
-
-```shell
-sudo systemctl start nginx-agent
-```
-
-To enable NGINX Agent to start on boot, run the following command:
-
-```shell
-sudo systemctl enable nginx-agent
-```
-
-## Logs
-
-NGINX Agent uses formatted log files to collect metrics. Expanding log formats and instance counts will also increase the size of the NGINX Agent log files. We recommend adding a separate partition for `/var/log/nginx-agent`.
-
-{{< important >}}
-Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.
-
-For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
-{{< /important >}}
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md
deleted file mode 100644
index ba507c7594..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-github.md
+++ /dev/null
@@ -1,54 +0,0 @@
----
-title: "Installation From GitHub Release"
-draft: false
-weight: 200
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1090"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-Learn how to install NGINX Agent from a GitHub Release.
-
-## Install NGINX
-
-NGINX Agent interfaces directly with an NGINX server process installed on the same system. If you don't have it already, follow these steps to install [NGINX Open Source](https://www.nginx.com/resources/wiki/start/topics/tutorials/install/) or [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/). Once installed, ensure the NGINX instance is running.
-
-## Install NGINX Agent from Package Files
-
-To install NGINX Agent on your system, go to [GitHub Releases](https://github.com/nginx/agent/releases) and download the latest package supported by your OS distribution and CPU architecture.
-
-Use your system's package manager to install the package. Some examples:
-
-- Debian, Ubuntu, and other distributions using the `dpkg` package manager.
-
- ```shell
- sudo dpkg -i nginx-agent-.deb
- ```
-
-- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using the `yum` package manager
-
- ```shell
- sudo yum localinstall nginx-agent-.rpm
- ```
-
-- RHEL and other distributions using the `rpm` package manager
-
- ```shell
- sudo rpm -i nginx-agent-.rpm
- ```
-
-- Alpine Linux
-
- ```shell
- sudo apk add nginx-agent-.apk
- ```
-
-- FreeBSD
-
- ```shell
- sudo pkg add nginx-agent-.pkg
- ```
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-oss.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-oss.md
deleted file mode 100644
index 9444700f6f..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-oss.md
+++ /dev/null
@@ -1,350 +0,0 @@
----
-title: "Installation From NGINX Repository"
-draft: false
-weight: 300
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1216"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-Learn how to install NGINX Agent from the NGINX Open Source repository.
-
-## Prerequisites
-
-- NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/)
-- A [supported operating system and architecture](../technical-specifications/#supported-distributions)
-- `root` privilege
-
-## Configure NGINX OSS Repository for installing NGINX Agent
-
-Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository.
-
-- [Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#installing-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
-- [Installing NGINX Agent on Ubuntu](#installing-nginx-agent-on-ubuntu)
-- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian)
-- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles)
-- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux)
-- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux)
-- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd)
-
-### Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
-
-1. Install the prerequisites:
-
- ```shell
- sudo yum install yum-utils
- ```
-
-1. To set up the yum repository, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
-
- ```
- [nginx-agent]
- name=nginx agent repo
- baseurl=http://packages.nginx.org/nginx-agent/centos/$releasever/$basearch/
- gpgcheck=1
- enabled=1
- gpgkey=https://nginx.org/keys/nginx_signing.key
- module_hotfixes=true
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo yum install nginx-agent
- ```
-
- When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
-
-### Installing NGINX Agent on Ubuntu
-
-1. Install the prerequisites:
-
- ```shell
- sudo apt install curl gnupg2 ca-certificates lsb-release ubuntu-keyring
- ```
-
-1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key:
-
- ```shell
- curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
- | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
- ```
-
-1. Verify that the downloaded file contains the proper key:
-
- ```shell
- gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
- ```
-
- The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
-
- ```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
- uid nginx signing key
- ```
-
- {{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
-
-1. Add the nginx agent repository:
-
- ```shell
- echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
- http://packages.nginx.org/nginx-agent/ubuntu/ `lsb_release -cs` agent" \
- | sudo tee /etc/apt/sources.list.d/nginx-agent.list
- ```
-
-1. To install `nginx-agent`, run the following commands:
-
- ```shell
- sudo apt update
- sudo apt install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-
-### Installing NGINX Agent on Debian
-
-1. Install the prerequisites:
-
- ```shell
- sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring
- ```
-
-1. Import an official nginx signing key so apt could verify the packages authenticity. Fetch the key:
-
- ```shell
- curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor \
- | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
- ```
-
-1. Verify that the downloaded file contains the proper key:
-
- ```shell
- gpg --dry-run --quiet --no-keyring \
- --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
- ```
-
- The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
-
- ```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
- uid nginx signing key
- ```
-
- {{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
-
-1. Add the `nginx-agent` repository:
-
- ```shell
- echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
- http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
- ```
-
-1. To install `nginx-agent`, run the following commands:
-
- ```shell
- sudo apt update
- sudo apt install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-
-### Installing NGINX Agent on SLES
-
-1. Install the prerequisites:
-
- ```shell
- sudo zypper install curl ca-certificates gpg2 gawk
- ```
-
-1. To set up the zypper repository for `nginx-agent` packages, run the following command:
-
- ```shell
- sudo zypper addrepo --gpgcheck --refresh --check \
- 'http://packages.nginx.org/nginx-agent/sles/$releasever_major' nginx-agent
- ```
-
-1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key:
-
- ```shell
- curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key
- ```
-
-1. Verify that the downloaded file contains the proper key:
-
- ```shell
- gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
- ```
-
-1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
-
- ```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
- uid nginx signing key
- ```
-
-1. Finally, import the key to the rpm database:
-
- ```shell
- sudo rpmkeys --import /tmp/nginx_signing.key
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo zypper install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on Alpine Linux
-
-1. Install the prerequisites:
-
- ```shell
- sudo apk add openssl curl ca-certificates
- ```
-
-1. To set up the apk repository for `nginx-agent` packages, run the following command:
-
- ```shell
- printf "%s%s%s\n" \
- "http://packages.nginx.org/nginx-agent/alpine/v" \
- `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \
- "/main" \
- | sudo tee -a /etc/apk/repositories
- ```
-
-1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key:
-
- ```shell
- curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub
- ```
-
-1. Verify that downloaded file contains the proper key:
-
- ```shell
- openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout
- ```
-
- The output should contain the following modulus:
-
- ```
- Public-Key: (2048 bit)
- Modulus:
- 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58:
- 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70:
- 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1:
- f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab:
- 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f:
- 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64:
- 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d:
- 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3:
- 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c:
- 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34:
- 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f:
- 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17:
- 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99:
- 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67:
- c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e:
- ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4:
- 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f:
- ab:6d
- Exponent: 65537 (0x10001)
- ```
-
-1. Finally, move the key to apk trusted keys storage:
-
- ```shell
- sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo apk add nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on Amazon Linux
-
-1. Install the prerequisites:
-
- ```shell
- sudo yum install yum-utils procps
- ```
-
-1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
- ```
- [nginx-agent]
- name=nginx agent repo
- baseurl=http://packages.nginx.org/nginx-agent/amzn2/$releasever/$basearch/
- gpgcheck=1
- enabled=1
- gpgkey=https://nginx.org/keys/nginx_signing.key
- module_hotfixes=true
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo yum install nginx-agent
- ```
-
-1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on FreeBSD
-
-1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content:
-
- ```
- nginx-agent: {
- URL: pkg+http://packages.nginx.org/nginx-agent/freebsd/${ABI}/latest
- ENABLED: true
- MIRROR_TYPE: SRV
- }
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo pkg install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-plus.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-plus.md
deleted file mode 100644
index 0600eaeb1f..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/installation-plus.md
+++ /dev/null
@@ -1,454 +0,0 @@
----
-title: "Installation From NGINX Plus Repository"
-draft: false
-weight: 400
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1217"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-Learn how to install NGINX Agent from NGINX Plus repository
-
-## Prerequisites
-
-- An NGINX Plus subscription (purchased or trial)
-- NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/)
-- A [supported operating system and architecture](../technical-specifications/#supported-distributions)
-- `root` privilege
-- Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc.
-- Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc.
-
-## Configure NGINX Plus Repository for installing NGINX Agent
-
-Before you install NGINX Agent for the first time on your system, you need to set up the `nginx-agent` packages repository. Afterward, you can install and update NGINX Agent from the repository.
-
-- [Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#installing-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
-- [Installing NGINX Agent on Ubuntu](#installing-nginx-agent-on-ubuntu)
-- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian)
-- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles)
-- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux)
-- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux)
-- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd)
-
-### Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo yum install yum-utils procps
- ```
-
-1. Set up the yum repository by creating the file `nginx-agent.repo` in `/etc/yum.repos.d`, for example using `vi`:
-
- ```shell
- sudo vi /etc/yum.repos.d/nginx-agent.repo
- ```
-
-1. Add the following lines to `nginx-agent.repo`:
-
- ```
- [nginx-agent]
- name=nginx agent repo
- baseurl=https://pkgs.nginx.com/nginx-agent/centos/$releasever/$basearch/
- sslclientcert=/etc/ssl/nginx/nginx-repo.crt
- sslclientkey=/etc/ssl/nginx/nginx-repo.key
- gpgcheck=0
- enabled=1
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo yum install nginx-agent
- ```
-
- When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on Ubuntu
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 ubuntu-keyring
- ```
-
-1. Download and add [NGINX signing key](https://cs.nginx.com/static/keys/nginx_signing.key):
-
- ```shell
- wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
- ```
-
-1. Create `apt` configuration `/etc/apt/apt.conf.d/90pkgs-nginx`:
-
- ```
- Acquire::https::pkgs.nginx.com::Verify-Peer "true";
- Acquire::https::pkgs.nginx.com::Verify-Host "true";
- Acquire::https::pkgs.nginx.com::SslCert "/etc/ssl/nginx/nginx-repo.crt";
- Acquire::https::pkgs.nginx.com::SslKey "/etc/ssl/nginx/nginx-repo.key";
- ```
-
-1. Add the `nginx-agent` repository:
-
- ```shell
- echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] https://pkgs.nginx.com/nginx-agent/ubuntu/ `lsb_release -cs` agent" \
- | sudo tee /etc/apt/sources.list.d/nginx-agent.list
- ```
-
-1. To install `nginx-agent`, run the following commands:
-
- ```shell
- sudo apt update
- sudo apt install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-
-### Installing NGINX Agent on Debian
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo apt install curl gnupg2 ca-certificates lsb-release debian-archive-keyring
- ```
-
-1. Add the `nginx-agent` repository:
-
- ```shell
- echo "deb https://pkgs.nginx.com/nginx-agent/debian/ `lsb_release -cs` agent" \
- | sudo tee /etc/apt/sources.list.d/nginx-agent.list
- ```
-
-1. Create apt configuration `/etc/apt/apt.conf.d/90pkgs-nginx`:
-
- ```
- Acquire::https::pkgs.nginx.com::Verify-Peer "true";
- Acquire::https::pkgs.nginx.com::Verify-Host "true";
- Acquire::https::pkgs.nginx.com::SslCert "/etc/ssl/nginx/nginx-repo.crt";
- Acquire::https::pkgs.nginx.com::SslKey "/etc/ssl/nginx/nginx-repo.key";
- ```
-
-1. To install `nginx-agent`, run the following commands:
-
- ```shell
- sudo apt update
- sudo apt install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on SLES
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Create a file bundle of the certificate and key:
-
- ```shell
- cat /etc/ssl/nginx/nginx-repo.crt /etc/ssl/nginx/nginx-repo.key > /etc/ssl/nginx/nginx-repo-bundle.crt
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo zypper install curl ca-certificates gpg2 gawk
- ```
-
-1. To set up the zypper repository for `nginx-agent` packages, run the following command:
-
- ```shell
- sudo zypper addrepo --refresh --check \
- 'https://pkgs.nginx.com/nginx-agent/sles/$releasever_major?ssl_clientcert=/etc/ssl/nginx/nginx-repo-bundle.crt&ssl_verify=peer' nginx-agent
- ```
-
-1. Next, import an official NGINX signing key so `zypper`/`rpm` can verify the package's authenticity. Fetch the key:
-
- ```shell
- curl -o /tmp/nginx_signing.key https://nginx.org/keys/nginx_signing.key
- ```
-
-1. Verify that the downloaded file contains the proper key:
-
- ```shell
- gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
- ```
-
-1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
-
- ```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
- uid nginx signing key
- ```
-
-1. Finally, import the key to the rpm database:
-
- ```shell
- sudo rpmkeys --import /tmp/nginx_signing.key
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo zypper install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on Alpine Linux
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/apk/` directory:
-
- ```shell
- sudo cp nginx-repo.key /etc/apk/cert.key
- sudo cp nginx-repo.crt /etc/apk/cert.pem
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo apk add openssl curl ca-certificates
- ```
-
-1. To set up the apk repository for `nginx-agent` packages, run the following command:
-
- ```shell
- printf "%s%s%s\n" \
- "https://pkgs.nginx.com/nginx-agent/alpine/v" \
- `grep -o -E '^[0-9]+\.[0-9]+' /etc/alpine-release` \
- "/main" \
- | sudo tee -a /etc/apk/repositories
- ```
-
-1. Next, import an official NGINX signing key so apk can verify the package's authenticity. Fetch the key:
-
- ```shell
- curl -o /tmp/nginx_signing.rsa.pub https://nginx.org/keys/nginx_signing.rsa.pub
- ```
-
-1. Verify that downloaded file contains the proper key:
-
- ```shell
- openssl rsa -pubin -in /tmp/nginx_signing.rsa.pub -text -noout
- ```
-
- The output should contain the following modulus:
-
- ```
- Public-Key: (2048 bit)
- Modulus:
- 00:fe:14:f6:0a:1a:b8:86:19:fe:cd:ab:02:9f:58:
- 2f:37:70:15:74:d6:06:9b:81:55:90:99:96:cc:70:
- 5c:de:5b:e8:4c:b2:0c:47:5b:a8:a2:98:3d:11:b1:
- f6:7d:a0:46:df:24:23:c6:d0:24:52:67:ba:69:ab:
- 9a:4a:6a:66:2c:db:e1:09:f1:0d:b2:b0:e1:47:1f:
- 0a:46:ac:0d:82:f3:3c:8d:02:ce:08:43:19:d9:64:
- 86:c4:4e:07:12:c0:5b:43:ba:7d:17:8a:a3:f0:3d:
- 98:32:b9:75:66:f4:f0:1b:2d:94:5b:7c:1c:e6:f3:
- 04:7f:dd:25:b2:82:a6:41:04:b7:50:93:94:c4:7c:
- 34:7e:12:7c:bf:33:54:55:47:8c:42:94:40:8e:34:
- 5f:54:04:1d:9e:8c:57:48:d4:b0:f8:e4:03:db:3f:
- 68:6c:37:fa:62:14:1c:94:d6:de:f2:2b:68:29:17:
- 24:6d:f7:b5:b3:18:79:fd:31:5e:7f:4c:be:c0:99:
- 13:cc:e2:97:2b:dc:96:9c:9a:d0:a7:c5:77:82:67:
- c9:cb:a9:e7:68:4a:e1:c5:ba:1c:32:0e:79:40:6e:
- ef:08:d7:a3:b9:5d:1a:df:ce:1a:c7:44:91:4c:d4:
- 99:c8:88:69:b3:66:2e:b3:06:f1:f4:22:d7:f2:5f:
- ab:6d
- Exponent: 65537 (0x10001)
- ```
-
-1. Finally, move the key to apk trusted keys storage:
-
- ```shell
- sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo apk add nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on Amazon Linux
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the `nginx-repo.crt` and `nginx-repo.key` files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Install the prerequisites:
-
- ```shell
- sudo yum install yum-utils procps ca-certificates
- ```
-
-1. To set up the yum repository for Amazon Linux 2, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
-
- ```
- [nginx-agent]
- name=nginx-agent repo
- baseurl=https://pkgs.nginx.com/nginx-agent/amzn2/$releasever/$basearch
- sslclientcert=/etc/ssl/nginx/nginx-repo.crt
- sslclientkey=/etc/ssl/nginx/nginx-repo.key
- gpgcheck=0
- enabled=1
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo yum install nginx-agent
- ```
-
-1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
-
-### Installing NGINX Agent on FreeBSD
-
-1. Create the `/etc/ssl/nginx` directory:
-
- ```shell
- sudo mkdir -p /etc/ssl/nginx
- ```
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
-
-1. Copy the files to the `/etc/ssl/nginx/` directory:
-
- ```shell
- sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
- ```
-
-1. Install the prerequisite `ca_root_nss` package:
-
- ```shell
- sudo pkg install ca_root_nss
- ```
-
-1. To setup the pkg repository create the file named `/etc/pkg/nginx-agent.conf` with the following content:
-
- ```
- nginx-agent: {
- URL: pkg+https://pkgs.nginx.com/nginx-agent/freebsd/${ABI}/latest
- ENABLED: yes
- MIRROR_TYPE: SRV
- }
- ```
-
-1. Add the following lines to the `/usr/local/etc/pkg.conf` file:
-
- ```
- PKG_ENV: { SSL_NO_VERIFY_PEER: "1",
- SSL_CLIENT_CERT_FILE: "/etc/ssl/nginx/nginx-repo.crt",
- SSL_CLIENT_KEY_FILE: "/etc/ssl/nginx/nginx-repo.key" }
- ```
-
-1. To install `nginx-agent`, run the following command:
-
- ```shell
- sudo pkg install nginx-agent
- ```
-
-1. Verify the installation:
-
- ```shell
- sudo nginx-agent -v
- ```
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/uninstall.md b/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/uninstall.md
deleted file mode 100644
index c5076775a6..0000000000
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/uninstall.md
+++ /dev/null
@@ -1,147 +0,0 @@
----
-title: "Uninstall NGINX Agent Package"
-draft: false
-weight: 700
-toc: true
-tags: [ "docs" ]
-docs: "DOCS-1230"
-categories: ["configuration"]
-doctypes: ["task"]
----
-
-## Overview
-
-Learn how to uninstall NGINX Agent from your system.
-
-## Prerequisites
-
-- NGINX Agent installed [NGINX Agent installed](../installation-oss)
-- The user following these steps will need `root` privilege
-
-## Uninstalling NGINX Agent
-Complete the following steps on each host where you’ve installed NGINX Agent
-
-
-- [Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux](#uninstalling-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux)
-- [Uninstalling NGINX Agent on Ubuntu](#uninstalling-nginx-agent-on-ubuntu)
-- [Uninstalling NGINX Agent on Debian](#uninstalling-nginx-agent-on-debian)
-- [Uninstalling NGINX Agent on SLES](#uninstalling-nginx-agent-on-sles)
-- [Uninstalling NGINX Agent on Alpine Linux](#uninstalling-nginx-agent-on-alpine-linux)
-- [Uninstalling NGINX Agent on Amazon Linux](#uninstalling-nginx-agent-on-amazon-linux)
-- [Uninstalling NGINX Agent on FreeBSD](#uninstalling-nginx-agent-on-freebsd)
-
-### Uninstalling NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
-
-Complete the following steps on each host where you've installed NGINX Agent:
-
-1. Stop NGINX Agent:
-
- ```bash
- sudo systemctl stop nginx-agent
- ```
-
-2. To uninstall NGINX Agent, run the following command:
-
- ```bash
- sudo yum remove nginx-agent
- ```
-
-### Uninstalling NGINX Agent on Ubuntu
-
-Complete the following steps on each host where you've installed NGINX Agent:
-
-1. Stop NGINX Agent:
-
- ```bash
- sudo systemctl stop nginx-agent
- ```
-
-2. To uninstall NGINX Agent, run the following command:
-
- ```bash
- sudo apt-get remove nginx-agent
- ```
-
- > **Note:** The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `.
-
-### Uninstalling NGINX Agent on Debian
-
-Complete the following steps on each host where you've installed NGINX Agent:
-
-1. Stop NGINX Agent:
-
- ```bash
- sudo systemctl stop nginx-agent
- ```
-
-2. To uninstall NGINX Agent, run the following command:
-
- ```bash
- sudo apt-get remove nginx-agent
- ```
-
- > **Note:** The `apt-get remove ` command will remove the package from your system, while keeping the associated configuration files for possible future use. If you want to completely remove the package and all of its configuration files, you should use `apt-get purge `.
-
-### Uninstalling NGINX Agent on SLES
-
-Complete the following steps on each host where you've installed NGINX Agent:
-
-1. Stop NGINX agent:
-
- ```bash
- sudo systemctl stop nginx-agent
- ```
-
-2. To uninstall NGINX agent, run the following command:
-
- ```bash
- sudo zypper remove nginx-agent
- ```
-
-### Uninstalling NGINX Agent on Alpine Linux
-
-Complete the following steps on each host where you've installed NGINX agent:
-
-1. Stop NGINX agent:
-
- ```bash
- sudo rc-service nginx-agent stop
- ```
-
-2. To uninstall NGINX agent, run the following command:
-
- ```bash
- sudo apk del nginx-agent
- ```
-
-### Uninstalling NGINX Agent on Amazon Linux
-
-Complete the following steps on each host where you've installed NGINX agent:
-
-1. Stop NGINX agent:
-
- ```bash
- sudo systemctl stop nginx-agent
- ```
-
-2. To uninstall NGINX agent, run the following command:
-
- ```bash
- sudo yum remove nginx-agent
- ```
-
-### Uninstalling NGINX Agent on FreeBSD
-
-Complete the following steps on each host where you've installed NGINX agent:
-
-1. Stop NGINX agent:
-
- ```bash
- sudo service nginx-agent stop
- ```
-
-2. To uninstall NGINX agent, run the following command:
-
- ```bash
- sudo pkg delete nginx-agent
- ```
diff --git a/site/content/previous-versions/_index.md b/site/content/previous-versions/_index.md
deleted file mode 100644
index 8e47a7385c..0000000000
--- a/site/content/previous-versions/_index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: "Previous Versions"
-description: "Documentation for previous versions of NGINX Agent."
-linkTitle: "Previous Versions"
-weight: 10000
----
\ No newline at end of file
diff --git a/site/content/support.md b/site/content/support.md
new file mode 100644
index 0000000000..0c7fff1bfe
--- /dev/null
+++ b/site/content/support.md
@@ -0,0 +1,15 @@
+---
+title: Support
+weight: 800
+docs: DOCS-000
+---
+
+## Support policy
+F5 NGINX Agent adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
+
+## Contact F5 Support
+For questions and/or assistance with installing, troubleshooting, or using NGINX Agent, contact Support via the [MyF5 Customer Portal](https://account.f5.com/myf5).
+
+## Community support
+- If you experience issues with NGINX Agent, please [open an issue in GitHub](https://github.com/nginx/agent/issues/new).
+- If you have any suggestions or feature requests, please [open an idea in GitHub discussions](https://github.com/nginx/agent/discussions).
\ No newline at end of file
diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md
index 6f9a72b091..fac11fbdc0 100644
--- a/site/content/technical-specifications.md
+++ b/site/content/technical-specifications.md
@@ -1,18 +1,15 @@
---
title: "Technical specifications"
-draft: false
-weight: 200
toc: true
-tags: [ "docs" ]
-categories: ["development"]
-doctypes: ["task"]
+weight: 200
+docs: DOCS-000
---
## Overview
-This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
+This document provides technical specifications for F5 NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
-## Supported Distributions
+## Supported distributions
NGINX Agent can run in most environments. We support the following distributions:
@@ -31,7 +28,7 @@ NGINX Agent can run in most environments. We support the following distributions
{{< /bootstrap-table >}}
-## Supported Deployment Environments
+## Supported deployment environments
NGINX Agent can be deployed in the following environments:
@@ -40,12 +37,12 @@ NGINX Agent can be deployed in the following environments:
- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure
- Virtual Machine
-## Supported NGINX Versions
+## Supported NGINX versions
NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus.
-## Sizing Recommendations
+## Sizing recommendations
Minimum system sizing recommendations for NGINX Agent:
{{< bootstrap-table "table table-striped table-bordered" >}}
@@ -56,4 +53,8 @@ Minimum system sizing recommendations for NGINX Agent:
## Logging
-NGINX Agent utilizes log files and formats to collect metrics. Increasing the log formats and instance counts will result in increased log file sizes. To prevent system storage issues due to a growing log directory, it is recommended to add a separate partition for `/var/log/nginx-agent` and enable [log rotation](http://nginx.org/en/docs/control.html#logs).
\ No newline at end of file
+NGINX Agent utilizes log files and formats to collect metrics. Increasing the log formats and instance counts will result in increased log file sizes.
+
+To prevent system storage issues due to a growing log directory, it is recommended to add a separate partition for `/var/log/nginx-agent` and enable [log rotation](http://nginx.org/en/docs/control.html#logs).
+
+More information is available in the [Configuration overview]({{< ref "/how-to/configuration-overview.md#logs" >}})
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/_index.md b/site/content/v2/_index.md
similarity index 72%
rename from site/content/previous-versions/NGINX-agent-v2/_index.md
rename to site/content/v2/_index.md
index 979f7a4c74..f0138d948b 100644
--- a/site/content/previous-versions/NGINX-agent-v2/_index.md
+++ b/site/content/v2/_index.md
@@ -1,6 +1,7 @@
---
title: "NGINX Agent v2"
description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance."
-linkTitle: "NGINX Agent"
-menu: docs
+weight: 900
+cascade:
+ type: agent-v2-migration
---
\ No newline at end of file
diff --git a/site/content/v2/changelog.md b/site/content/v2/changelog.md
new file mode 100644
index 0000000000..981348f9e3
--- /dev/null
+++ b/site/content/v2/changelog.md
@@ -0,0 +1,282 @@
+---
+title: "Changelog"
+weight: 1200
+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" >}}).
+
+---
+## Release [v2.39.0](https://github.com/nginx/agent/releases/tag/v2.39.0)
+
+### 🌟 Highlights
+
+- Remove official docker images & move testing images to test folder by [@aphralG](https://github.com/aphralG) in [#838](https://github.com/nginx/agent/pull/838)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Race conditions fixes by [@oliveromahony](https://github.com/oliveromahony) in [#810](https://github.com/nginx/agent/pull/810)
+- fix r30 pipeline failures by [@oliveromahony](https://github.com/oliveromahony) in [#844](https://github.com/nginx/agent/pull/844)
+- Fixed make target pointing at wrong Dockerfile and renamed others to be consistent by [@oliveromahony](https://github.com/oliveromahony) in [#857](https://github.com/nginx/agent/pull/857)
+- Fix broken links causing deployment failures by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#863](https://github.com/nginx/agent/pull/863)
+- Fix NGINX OSS integration tests by [@dhurley](https://github.com/dhurley) in [#888](https://github.com/nginx/agent/pull/888)
+- Fix docs docker failing without git context by [@nginx-jack](https://github.com/nginx-jack) in [#892](https://github.com/nginx/agent/pull/892)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- Add automatic changelog generation in release workflow by [@spencerugbo](https://github.com/spencerugbo) in [#784](https://github.com/nginx/agent/pull/784)
+- Add CLA bot workflow by [@lucacome](https://github.com/lucacome) in [#828](https://github.com/nginx/agent/pull/828)
+- Refactor docker images by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#841](https://github.com/nginx/agent/pull/841)
+- Docs: Add hugo version check and theme update to Makefile by [@nginx-jack](https://github.com/nginx-jack) in [#869](https://github.com/nginx/agent/pull/869)
+- Change casing of docs makefile to Makefile by [@nginx-jack](https://github.com/nginx-jack) in [#884](https://github.com/nginx/agent/pull/884)
+- docs: enableGitInfo config and docs-action bump by [@nginx-jack](https://github.com/nginx-jack) in [#886](https://github.com/nginx/agent/pull/886)
+- Change go version to latest go 1.23.2 by [@oliveromahony](https://github.com/oliveromahony) in [#889](https://github.com/nginx/agent/pull/889)
+- Remove link to github dockerfiles by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#897](https://github.com/nginx/agent/pull/897)
+- Docs: Update link to 3rd party site by [@nginx-aoife](https://github.com/nginx-aoife) in [#898](https://github.com/nginx/agent/pull/898)
+- Update the changelog for v2.38 by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#901](https://github.com/nginx/agent/pull/901)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- Set log level to debug for inetegration tests by [@aphralG](https://github.com/aphralG) in [#826](https://github.com/nginx/agent/pull/826)
+- updated runc dependency highlighted in security scan scan by [@oliveromahony](https://github.com/oliveromahony) in [#842](https://github.com/nginx/agent/pull/842)
+- Update CODEOWNERS by [@oCHRISo](https://github.com/oCHRISo) in [#851](https://github.com/nginx/agent/pull/851)
+- Check version command output by [@aphralG](https://github.com/aphralG) in [#853](https://github.com/nginx/agent/pull/853)
+- Bump NGINX plus go client version from v1 to v2 by [@dhurley](https://github.com/dhurley) in [#879](https://github.com/nginx/agent/pull/879)
+- Allowlist Error Messages by [@aphralG](https://github.com/aphralG) in [#907](https://github.com/nginx/agent/pull/907)
+
+---
+## Release [v2.38.0](https://github.com/nginx/agent/releases/tag/v2.38.0)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Fix broken URLS in docs by [@nginx-aoife](https://github.com/nginx-aoife) in [#796](https://github.com/nginx/agent/pull/796)
+- fix name of deprecated flag by [@aphralG](https://github.com/aphralG) in [#811](https://github.com/nginx/agent/pull/811)
+- Fix make image targets by [@dhurley](https://github.com/dhurley) in [#812](https://github.com/nginx/agent/pull/812)
+- Fix debian oss image by [@dhurley](https://github.com/dhurley) in [#819](https://github.com/nginx/agent/pull/819)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- docs: update GPG keys by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#776](https://github.com/nginx/agent/pull/776)
+- Add new docker images to v2 pipeline for integration testing by [@oliveromahony](https://github.com/oliveromahony) in [#756](https://github.com/nginx/agent/pull/756)
+- Update website changelog for v2.37.0 by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#790](https://github.com/nginx/agent/pull/790)
+- Pass on custom error log path at the time of validating config by [@achawla2012](https://github.com/achawla2012) in [#774](https://github.com/nginx/agent/pull/774)
+- Remove blocking calls in metrics framework by [@oliveromahony](https://github.com/oliveromahony) in [#788](https://github.com/nginx/agent/pull/788)
+- Update broken URL in installation-plus.md by [@nginx-aoife](https://github.com/nginx-aoife) in [#808](https://github.com/nginx/agent/pull/808)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- add new plus docker images to v2 pipeline by [@aphralG](https://github.com/aphralG) in [#779](https://github.com/nginx/agent/pull/779)
+- Add MaxRecvMsgSize and MaxSendMsgSize to client and server options by [@oliveromahony](https://github.com/oliveromahony) in [#795](https://github.com/nginx/agent/pull/795)
+- added leak tests for agent v2 by [@oliveromahony](https://github.com/oliveromahony) in [#807](https://github.com/nginx/agent/pull/807)
+
+---
+## Release [v2.37.0](https://github.com/nginx/agent/releases/tag/v2.37.0)
+
+### 🚀 Features
+
+This release introduces the following new features:
+
+- feat: Update the changelog by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#753](https://github.com/nginx/agent/pull/753)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Prevent writing outside allowed directories list from a config payload with actions by [@oliveromahony](https://github.com/oliveromahony) in [#766](https://github.com/nginx/agent/pull/766)
+- The letter v is now always prepended to output of -v by [@olli-holmala](https://github.com/olli-holmala) in [#751](https://github.com/nginx/agent/pull/751)
+- Fix backoff to drop Metrics Reports from buffer after max_elapsed_time has been reached by [@oliveromahony](https://github.com/oliveromahony) in [#752](https://github.com/nginx/agent/pull/752)
+- Fix Post Install Script Issues by [@spencerugbo](https://github.com/spencerugbo) in [#739](https://github.com/nginx/agent/pull/739)
+- docs: fix github links in changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#770](https://github.com/nginx/agent/pull/770)
+- Fix post install script for when no nginx instance is installed by [@dhurley](https://github.com/dhurley) in [#773](https://github.com/nginx/agent/pull/773)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- Upgrade prometheus exporter version to latest by [@oliveromahony](https://github.com/oliveromahony) in [#749](https://github.com/nginx/agent/pull/749)
+- Add badges for Go version, release, license, contributions, and Slack… by [@oCHRISo](https://github.com/oCHRISo) in [#763](https://github.com/nginx/agent/pull/763)
+- Add instructions for Amazon Linux 2023 by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#759](https://github.com/nginx/agent/pull/759)
+- Add docs-build-push github workflow by [@nginx-jack](https://github.com/nginx-jack) in [#765](https://github.com/nginx/agent/pull/765)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- Increase timeout period for collecting metrics by [@oliveromahony](https://github.com/oliveromahony) in [#755](https://github.com/nginx/agent/pull/755)
+
+---
+## Release [v2.36.1](https://github.com/nginx/agent/releases/tag/v2.36.1)
+
+### 🌟 Highlights
+
+- Upgrade crossplane version to prevent Agent from rolling back in the case of valid NGINX configurations by [@oliveromahony](https://github.com/oliveromahony) in [#746](https://github.com/nginx/agent/pull/746)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- Added version regex to parse the logs to see if matches vsemvar format by [@oliveromahony](https://github.com/oliveromahony) in [#747](https://github.com/nginx/agent/pull/747)
+
+---
+## Release [v2.36.0](https://github.com/nginx/agent/releases/tag/v2.36.0)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Fix incorrect bold tag in heading by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#715](https://github.com/nginx/agent/pull/715)
+- URL fix for building docker image in README.md by [@y82](https://github.com/y82) in [#720](https://github.com/nginx/agent/pull/720)
+- Fix for version by [@oliveromahony](https://github.com/oliveromahony) in [#732](https://github.com/nginx/agent/pull/732)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- More flexible container images for the official images by [@oliveromahony](https://github.com/oliveromahony) in [#729](https://github.com/nginx/agent/pull/729)
+- Update configuration examples by [@nginx-seanmoloney](https://github.com/nginx-seanmoloney) in [#731](https://github.com/nginx/agent/pull/731)
+- updated github.com/rs/cors version by [@oliveromahony](https://github.com/oliveromahony) in [#735](https://github.com/nginx/agent/pull/735)
+- docs: update changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#736](https://github.com/nginx/agent/pull/736)
+- Upgrade crossplane by [@oliveromahony](https://github.com/oliveromahony) in [#737](https://github.com/nginx/agent/pull/737)
+
+---
+## Release [v2.35.1](https://github.com/nginx/agent/releases/tag/v2.35.1)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- fix: add deduplication for the same ssl cert metadata by [@mattdesmarais](https://github.com/mattdesmarais) [@oliveromahony](https://github.com/oliveromahony) in [#716](https://github.com/nginx/agent/pull/716)
+- Fix release workflow by [@dhurley](https://github.com/dhurley) in [#724](https://github.com/nginx/agent/pull/724)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- Update environment variables from NMS to NGINX_AGENT by [@spencerugbo](https://github.com/spencerugbo) in [#710](https://github.com/nginx/agent/pull/710)
+- Update the flag & environment table callouts by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#712](https://github.com/nginx/agent/pull/712)
+- updated golang version to 1.22 by [@oliveromahony](https://github.com/oliveromahony) in [#717](https://github.com/nginx/agent/pull/717)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- More detailed test for env variables migration by [@oliveromahony](https://github.com/oliveromahony) in [#709](https://github.com/nginx/agent/pull/709)
+
+---
+## Release [v2.35.0](https://github.com/nginx/agent/releases/tag/v2.35.0)
+
+### 🌟 Highlights
+
+- R32 operating system support parity by [@oliveromahony](https://github.com/oliveromahony) in [#708](https://github.com/nginx/agent/pull/708)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Change environment prefix from nms to nginx_agent by [@spencerugbo](https://github.com/spencerugbo) in [#706](https://github.com/nginx/agent/pull/706)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- Consolidated CLI flag and Env Var sections by [@travisamartin](https://github.com/travisamartin) in [#701](https://github.com/nginx/agent/pull/701)
+- Add Ubuntu Noble 24.04 LTS support by [@Dean-Coakley](https://github.com/Dean-Coakley) in [#682](https://github.com/nginx/agent/pull/682)
+
+---
+## Release [v2.34.1](https://github.com/nginx/agent/releases/tag/v2.34.1)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Fix metrics reporter retry logic by [@dhurley](https://github.com/dhurley) in [#700](https://github.com/nginx/agent/pull/700)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- Update changelog for release 2.34 by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#693](https://github.com/nginx/agent/pull/693)
+
+---
+## Release [v2.34.0](https://github.com/nginx/agent/releases/tag/v2.34.0)
+
+### 🌟 Highlights
+
+- Bump the version of net package in golang by [@oliveromahony](https://github.com/oliveromahony) in [#645](https://github.com/nginx/agent/pull/645)
+
+- Add health check endpoint by [@dhurley](https://github.com/dhurley) in [#665](https://github.com/nginx/agent/pull/665)
+
+- Add pending health status by [@dhurley](https://github.com/dhurley) in [#672](https://github.com/nginx/agent/pull/672)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- fix: fix titles case by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#674](https://github.com/nginx/agent/pull/674)
+- Fix oracle linux integration test by [@dhurley](https://github.com/dhurley) in [#676](https://github.com/nginx/agent/pull/676)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- chore: add 2.33.0 changelog by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#622](https://github.com/nginx/agent/pull/622)
+- Change environment variable list to table with CLI references by [@ADubhlaoich](https://github.com/ADubhlaoich) in [#689](https://github.com/nginx/agent/pull/689)
+- Add health checks documentation by [@dhurley](https://github.com/dhurley) in [#673](https://github.com/nginx/agent/pull/673)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- Keep looking for master process by [@spencerugbo](https://github.com/spencerugbo) in [#617](https://github.com/nginx/agent/pull/617)
+- Bump docker dependency to version v24.0.9 by [@dhurley](https://github.com/dhurley) in [#626](https://github.com/nginx/agent/pull/626)
+- Bump the version of github.com/opencontainers/runc dependency by [@dhurley](https://github.com/dhurley) in [#657](https://github.com/nginx/agent/pull/657)
+- Remove unnecessary freebsd logic for finding process executable by [@dhurley](https://github.com/dhurley) in [#668](https://github.com/nginx/agent/pull/668)
+- Add additional checks in chunking functionality by [@dhurley](https://github.com/dhurley) in [#671](https://github.com/nginx/agent/pull/671)
+
+---
+## Release [v2.33.0](https://github.com/nginx/agent/releases/tag/v2.33.0)
+
+### 🚀 Features
+
+This release introduces the following new features:
+
+- feat: Add Support for NAP 5 by [@edarzins](https://github.com/edarzins) in [#604](https://github.com/nginx/agent/pull/604)
+
+### 🐛 Bug Fixes
+
+In this release we have resolved the following issues:
+
+- Fix nfpm.yaml for apk packages by [@dhurley](https://github.com/dhurley) in [#597](https://github.com/nginx/agent/pull/597)
+- fix unit test by [@oliveromahony](https://github.com/oliveromahony) in [#607](https://github.com/nginx/agent/pull/607)
+- Fix user workflow performance tests by [@dhurley](https://github.com/dhurley) in [#612](https://github.com/nginx/agent/pull/612)
+- fix Advanced Metrics by [@aphralG](https://github.com/aphralG) in [#598](https://github.com/nginx/agent/pull/598)
+
+### 📝 Documentation
+
+We have made the following updates to the documentation:
+
+- chore: Add the 2.32.2 Changelog to the docs website by [@Jcahilltorre](https://github.com/Jcahilltorre) in [#601](https://github.com/nginx/agent/pull/601)
+
+### 🔨 Maintenance
+
+We have made the following maintenance-related minor changes:
+
+- Bump the version of protobuf by [@oliveromahony](https://github.com/oliveromahony) in [#602](https://github.com/nginx/agent/pull/602)
+- replace duplicate isContainer call by [@oliveromahony](https://github.com/oliveromahony) in [#596](https://github.com/nginx/agent/pull/596)
+- Add logging to NGINX API http requests by [@dhurley](https://github.com/dhurley) in [#605](https://github.com/nginx/agent/pull/605)
+
diff --git a/site/content/v2/configuration/_index.md b/site/content/v2/configuration/_index.md
new file mode 100644
index 0000000000..cd9db7e495
--- /dev/null
+++ b/site/content/v2/configuration/_index.md
@@ -0,0 +1,6 @@
+---
+title: "Configuration"
+weight: "400"
+---
+
+Learn how to configure NGINX Agent.
\ No newline at end of file
diff --git a/site/content/v2/configuration/configuration-overview.md b/site/content/v2/configuration/configuration-overview.md
new file mode 100644
index 0000000000..b5bdd2ef06
--- /dev/null
+++ b/site/content/v2/configuration/configuration-overview.md
@@ -0,0 +1,274 @@
+---
+title: "How to configure NGINX Agent"
+draft: false
+weight: 100
+toc: true
+tags: [ "docs" ]
+docs: "DOCS-1229"
+categories: ["configuration"]
+doctypes: ["task"]
+---
+
+The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.
+
+{{}}
+
+- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities:
+
+ 1. CLI flags overwrite configuration files and environment variable values.
+ 2. Environment variables overwrite configuration file values.
+ 3. Config files are the lowest priority and config settings are superseded if either of the other options is used.
+
+- You must open any required firewall ports or add SELinux/AppArmor rules for the ports and IPs you want to use.
+
+{{}}
+
+## Configure with Config Files
+
+The default locations of configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. The `agent-dynamic.conf` file default location is different for FreeBSD which is located `/var/db/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose.
+
+Examples of the configuration files are provided below:
+
+
+ example nginx-agent.conf
+
+{{}}
+In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the control plane.
+{{}}
+
+```nginx {hl_lines=[13]}
+#
+# /etc/nginx-agent/nginx-agent.conf
+#
+# Configuration file for NGINX Agent.
+#
+# This file tracks agent configuration values that are meant to be statically set. There
+# are additional NGINX Agent configuration values that are set via the API and agent install script
+# which can be found in /etc/nginx-agent/agent-dynamic.conf.
+
+# specify the server grpc port to connect to
+server:
+ # host of the control plane
+ host:
+ grpcPort: 443
+ backoff: # note: default values are prepopulated
+ initial_interval: 100ms # Add the appropriate duration value here, e.g., "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, e.g., 0.10
+ multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
+ max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+ max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+# tls options
+tls:
+ # enable tls in the nginx-agent setup for grpcs
+ # default to enable to connect with secure connection but without client cert for mtls
+ enable: true
+ # controls whether the server certificate chain and host name are verified.
+ # for production use, see instructions for configuring TLS
+ skip_verify: false
+log:
+ # set log level (panic, fatal, error, info, debug, trace; default "info")
+ level: info
+ # set log path. if empty, don't log to file.
+ path: /var/log/nginx-agent/
+nginx:
+ # path of NGINX logs to exclude
+ exclude_logs: ""
+ # Set to true when NGINX configuration should contain no warnings when performing a configuration apply (nginx -t is used to carry out this check)
+ treat_warnings_as_errors: false # Default is false
+# data plane status message / 'heartbeat'
+dataplane:
+ status:
+ # poll interval for dataplane status - the frequency the NGINX Agent will query the dataplane for changes
+ poll_interval: 30s
+ # report interval for dataplane status - the maximum duration to wait before syncing dataplane information if no updates have been observed
+ report_interval: 24h
+metrics:
+ # specify the size of a buffer to build before sending metrics
+ bulk_size: 20
+ # specify metrics poll interval
+ report_interval: 1m
+ collection_interval: 15s
+ mode: aggregated
+ backoff: # note: default values are prepopulated
+ initial_interval: 100ms # Add the appropriate duration value here, e.g., "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, e.g., 0.10
+ multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
+ max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+ max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
+
+# OSS NGINX default config path
+# path to aux file dirs can also be added
+config_dirs: "/etc/nginx:/usr/local/etc/nginx"
+
+# Internal queue size
+queue_size: 100
+
+extensions:
+ - nginx-app-protect
+
+# Enable reporting NGINX App Protect details to the control plane.
+nginx_app_protect:
+ # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes.
+ report_interval: 15s
+ # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false).
+ precompiled_publication: true
+```
+
+
+
+
+
+ example dynamic-agent.conf
+
+{{}}
+Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
+
+Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
+{{}}
+
+```yaml
+# Dynamic configuration file for NGINX Agent.
+#
+# The purpose of this file is to track agent configuration
+# values that can be dynamically changed via the API and the agent install script.
+# You may edit this file, but API calls that modify the tags on this system will
+# overwrite the tag values in this file.
+#
+# The agent configuration values that API calls can modify are as follows:
+# tags:
+# - dev
+# - qa
+#
+# The agent configuration value that the agent install script can modify are as follows:
+# instance_group: my-instance-group
+
+instance_group: my-instance-group
+tags:
+ - dev
+ - qa
+```
+
+
+
+## CLI Flags & Environment Variables
+
+This section details the CLI flags and corresponding environment variables used to configure the NGINX Agent.
+
+### Usage
+
+#### CLI Flags
+
+```sh
+nginx-agent [flags]
+```
+
+#### Environment Variables
+
+```sh
+export ENV_VARIABLE_NAME="value"
+nginx-agent
+```
+
+### CLI Flags and Environment Variables
+
+{{< warning >}}
+
+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.
+
+{{< /warning >}}
+
+{{}}
+| CLI flag | Environment variable | Description |
+|---------------------------------------------|--------------------------------------|-----------------------------------------------------------------------------|
+| `--api-cert` | `NGINX_AGENT_API_CERT` | Specifies the certificate used by the Agent API. |
+| `--api-host` | `NGINX_AGENT_API_HOST` | Sets the host used by the Agent API. Default: *127.0.0.1* |
+| `--api-key` | `NGINX_AGENT_API_KEY` | Specifies the key used by the Agent API. |
+| `--api-port` | `NGINX_AGENT_API_PORT` | Sets the port for exposing nginx-agent to HTTP traffic. |
+| `--config-dirs` | `NGINX_AGENT_CONFIG_DIRS` | Defines directories NGINX Agent can read/write. Default: *"/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"* |
+| `--dataplane-report-interval` | `NGINX_AGENT_DATAPLANE_REPORT_INTERVAL` | Sets the interval for dataplane reporting. Default: *24h0m0s* |
+| `--dataplane-status-poll-interval` | `NGINX_AGENT_DATAPLANE_STATUS_POLL_INTERVAL` | Sets the interval for polling dataplane status. Default: *30s* |
+| `--display-name` | `NGINX_AGENT_DISPLAY_NAME` | Sets the instance's display name. |
+| `--dynamic-config-path` | `NGINX_AGENT_DYNAMIC_CONFIG_PATH` | Specifies the path of the Agent dynamic config file. Default: *"/var/lib/nginx-agent/agent-dynamic.conf"* |
+| `--features` | `NGINX_AGENT_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* |
+| `--ignore-directives` | | Specifies a comma-separated list of directives to ignore for sensitive info.|
+| `--instance-group` | `NGINX_AGENT_INSTANCE_GROUP` | Sets the instance's group value. |
+| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* |
+| `--log-path` | `NGINX_AGENT_LOG_PATH` | Specifies the path to output log messages. |
+| `--metrics-bulk-size` | `NGINX_AGENT_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* |
+| `--metrics-collection-interval` | `NGINX_AGENT_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* |
+| `--metrics-mode` | `NGINX_AGENT_METRICS_MODE` | Sets the metrics collection mode: streaming or aggregation. Default: *aggregated* |
+| `--metrics-report-interval` | `NGINX_AGENT_METRICS_REPORT_INTERVAL` | Sets the interval for reporting collected metrics. Default: *1m0s* |
+| `--nginx-config-reload-monitoring-period` | | Sets the duration to monitor error logs after an NGINX reload. Default: *10s* |
+| `--nginx-exclude-logs` | `NGINX_AGENT_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. |
+| `--nginx-socket` | `NGINX_AGENT_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* |
+| `--nginx-treat-warnings-as-errors` | `NGINX_AGENT_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. |
+| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. |
+| `--server-command` | | Specifies the name of the command server sent in the TLS configuration. |
+| `--server-grpcport` | `NGINX_AGENT_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. |
+| `--server-host` | `NGINX_AGENT_SERVER_HOST` | Specifies the IP address of the server host. |
+| `--server-metrics` | | Specifies the name of the metrics server sent in the TLS configuration. |
+| `--server-token` | `NGINX_AGENT_SERVER_TOKEN` | Sets the authentication token for accessing the commander and metrics services. Default: *e202f883-54c6-4702-be15-3ba6e507879a* |
+| `--tags` | `NGINX_AGENT_TAGS` | Specifies a comma-separated list of tags for the instance or machine. |
+| `--tls-ca` | `NGINX_AGENT_TLS_CA` | Specifies the path to the CA certificate file for TLS. |
+| `--tls-cert` | `NGINX_AGENT_TLS_CERT` | Specifies the path to the certificate file for TLS. |
+| `--tls-enable` | `NGINX_AGENT_TLS_ENABLE` | Enables TLS for secure communications. |
+| `--tls-key` | `NGINX_AGENT_TLS_KEY` | Specifies the path to the certificate key file for TLS. |
+| `--tls-skip-verify` | `NGINX_AGENT_TLS_SKIP_VERIFY` | Insecurely skips verification for gRPC TLS credentials. |
+{{}}
+
+
+
+{{}}
+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 follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
+
+- [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate)
+
+{{}}
+
+{{}} Use the `--dynamic-config-path` command-line option to set the location of the dynamic config file. This setting also requires you to move your dynamic config to the new path, or create a new dynamic config file at the specified location.
+
+Default location in Linux environments: `/var/lib/nginx-agent/agent-dynamic.conf`
+
+Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.conf`
+
+{{}}
+
+## Log Rotation
+
+By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
+
+
+ NGINX Agent Logrotate Configuration
+
+``` yaml
+/var/log/nginx-agent/*.log
+{
+ # log files are rotated every day
+ daily
+ # log files are rotated if they grow bigger than 5M
+ size 5M
+ # truncate the original log file after creating a copy
+ copytruncate
+ # remove rotated logs older than 10 days
+ maxage 10
+ # log files are rotated 10 times before being removed
+ rotate 10
+ # old log files are compressed
+ compress
+ # if the log file is missing it will go on to the next one without issuing an error message
+ missingok
+ # do not rotate the log if it is empty
+ notifempty
+}
+```
+
+
+If you need to change the default configuration, update the file at `/etc/logrotate.d/nginx-agent`.
+
+For more details on logrotate configuration, see [Logrotate Configuration Options](https://linux.die.net/man/8/logrotate).
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/configure-nginx-agent-group.md b/site/content/v2/configuration/configure-nginx-agent-group.md
similarity index 98%
rename from site/content/previous-versions/NGINX-agent-v2/configuration/configure-nginx-agent-group.md
rename to site/content/v2/configuration/configure-nginx-agent-group.md
index 43cd80bde1..45c3e9094c 100644
--- a/site/content/previous-versions/NGINX-agent-v2/configuration/configure-nginx-agent-group.md
+++ b/site/content/v2/configuration/configure-nginx-agent-group.md
@@ -1,5 +1,5 @@
---
-title: "Add NGINX Users to nginx-agent Group"
+title: "Add NGINX users to nginx-agent group"
draft: false
weight: 300
toc: true
diff --git a/site/content/previous-versions/NGINX-agent-v2/configuration/encrypt-communication.md b/site/content/v2/configuration/encrypt-communication.md
similarity index 83%
rename from site/content/previous-versions/NGINX-agent-v2/configuration/encrypt-communication.md
rename to site/content/v2/configuration/encrypt-communication.md
index 26d0b015f0..7d9f1b5472 100644
--- a/site/content/previous-versions/NGINX-agent-v2/configuration/encrypt-communication.md
+++ b/site/content/v2/configuration/encrypt-communication.md
@@ -1,5 +1,5 @@
---
-title: Encrypt Communication
+title: Encrypt communication
tags:
- docs
toc: true
@@ -13,7 +13,7 @@ Follow the steps in this guide to encrypt communication between NGINX Agent and
## Before You Begin
-To enable mTLS, you must have TLS enabled and supply a key, cert, and a CA cert on both the client and server. TSee the [Secure Traffic with Certificates](https://docs.nginx.com/nginx-management-suite/admin-guides/configuration/secure-traffic/) topic for instructions on how to generate keys and set them in the specific values in the NGINX Agent configuration.
+To enable mTLS, you must have TLS enabled and supply a key, cert, and a CA cert on both the client and server. See the [Secure Traffic with Certificates](https://docs.nginx.com/nginx-instance-manager/system-configuration/secure-traffic/) topic for instructions on how to generate keys and set them in the specific values in the NGINX Agent configuration.
## Enabling mTLS
@@ -50,10 +50,10 @@ nginx-agent --tls-cert "path-to-cert" --tls-key "path-to-key" --tls-ca "path-to-
To enable mTLS for NGINX Agent using environment variables, run the following commands:
```bash
-NMS_TLS_CA="my-env-ca"
-NMS_TLS_KEY="my-env-key"
-NMS_TLS_CERT="my-env-cert"
-NMS_TLS_ENABLE=true
+NGINX_AGENT_TLS_CA="my-env-ca"
+NGINX_AGENT_TLS_KEY="my-env-key"
+NGINX_AGENT_TLS_CERT="my-env-cert"
+NGINX_AGENT_TLS_ENABLE=true
```
@@ -87,7 +87,7 @@ nginx-agent --tls-enable
To enable server-side TLS using environment variables, run the following commands:
```bash
-NMS_TLS_ENABLE=true
+NGINX_AGENT_TLS_ENABLE=true
```
@@ -110,7 +110,7 @@ tls:
To enable insecure mode, you simply need to set `tls:enable` to `false`. Setting this value to `false` can be done only by updating the configuration file or with environment variables. See the following examples:
-### Enabling Insecure Mode via Config Values**
+### Enabling Insecure Mode via Config Values
You can edit the `/etc/nginx-agent/nginx-agent.conf` file to enable insecure mode. Make the following changes:
@@ -119,10 +119,10 @@ tls:
enable: false
```
-### Enabling Insecure Mode with Environment Variables**
+### Enabling Insecure Mode with Environment Variables
To enable insecure mode using environment variables, run the following commands:
```bash
-NMS_TLS_ENABLE=false
+NGINX_AGENT_TLS_ENABLE=false
```
diff --git a/site/content/v2/configuration/health-checks.md b/site/content/v2/configuration/health-checks.md
new file mode 100644
index 0000000000..f045955fbd
--- /dev/null
+++ b/site/content/v2/configuration/health-checks.md
@@ -0,0 +1,62 @@
+---
+title: "Health checks"
+draft: false
+weight: 400
+toc: true
+tags: [ "docs" ]
+categories: ["configuration"]
+doctypes: ["task"]
+---
+
+## Overview
+
+The REST API includes a health endpoint to verify the status of NGINX Agent.
+
+## Configure the REST API
+
+To enable the REST API, add the following configuration to the NGINX Agent configuration file, `/etc/nginx-agent/nginx-agent.conf`:
+
+```nginx
+api:
+ host: 127.0.0.1
+ port: 8038
+```
+
+## Using health checks
+
+After you enable the REST API, calling the `/health` endpoint returns the following JSON response:
+
+```json
+{
+ "status": "OK",
+ "checks": [
+ {
+ "name": "registration",
+ "status": "OK"
+ },
+ {
+ "name": "commandConnection",
+ "status": "OK"
+ },
+ {
+ "name": "metricsConnection",
+ "status": "OK"
+ }
+ ]
+}
+```
+
+The top-level `status` field is the overall health status of NGINX Agent. The health status can return three different states:
+
+1. `PENDING`: NGINX Agent is still determining its health status.
+2. `OK`: NGINX Agent is in a healthy state.
+3. `ERROR`: NGINX Agent is in an unhealthy state.
+
+The health checkpoint performs three checks to determine the overall health of the NGINX Agent:
+
+1. `registration`: Checks if NGINX Agent has successfully registered with the management plane server.
+2. `commandConnection`: Checks if NGINX Agent is still able to receive and send commands.
+3. `metricsConnection`: Checks if NGINX Agent is still able to send metric reports.
+
+If any of the checks are in an `ERROR` status, then the overall status of NGINX Agent will change to `ERROR` as well.
+
diff --git a/site/content/installation-upgrade/_index.md b/site/content/v2/installation-upgrade/_index.md
similarity index 100%
rename from site/content/installation-upgrade/_index.md
rename to site/content/v2/installation-upgrade/_index.md
diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/v2/installation-upgrade/container-environments/_index.md
similarity index 75%
rename from site/content/installation-upgrade/container-environments/_index.md
rename to site/content/v2/installation-upgrade/container-environments/_index.md
index e2de9f52c2..ca964e34b0 100644
--- a/site/content/installation-upgrade/container-environments/_index.md
+++ b/site/content/v2/installation-upgrade/container-environments/_index.md
@@ -1,5 +1,5 @@
---
-title: "Container Environments"
+title: "Container environments"
description: "Learn how to build and run NGINX Agent docker images."
menu: docs
weight: 800
diff --git a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-images.md b/site/content/v2/installation-upgrade/container-environments/docker-images.md
similarity index 51%
rename from site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-images.md
rename to site/content/v2/installation-upgrade/container-environments/docker-images.md
index cb164f60a6..40b3a3b2f8 100644
--- a/site/content/previous-versions/NGINX-agent-v2/installation-upgrade/container-environments/docker-images.md
+++ b/site/content/v2/installation-upgrade/container-environments/docker-images.md
@@ -1,5 +1,5 @@
---
-title: "Build Container Images"
+title: "Build container images"
draft: false
weight: 100
toc: true
@@ -11,12 +11,17 @@ docs: "DOCS-1410"
## Overview
-NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. The NGINX Agent GitHub repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that you can use to build custom container images that bundle NGINX Agent with NGINX or NGINX Plus.
+NGINX Agent is a companion daemon for NGINX Open Source or NGINX Plus instances and must run in the same container to work. This document explains multiple ways in which NGINX Agent can be run alongside NGINX in a container.
If you want to use NGINX Agent with NGINX Plus, you need to purchase an NGINX Plus license. Contact your F5 Sales representative for assistance.
See the requirements and supported operating systems in the [NGINX Agent Technical Specifications]({{< relref "technical-specifications.md" >}}) topic.
+## Deploy Offical NGINX and NGINX Plus Containers
+
+Docker images are available in the [Deploying NGINX and NGINX Plus on Docker](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/) NGINX documentation.
+
+This guide provides instructions on how to build images with NGINX Agent and NGINX packaged together. It includes steps for downloading the necessary Docker images, configuring your Docker environment, and deploying NGINX and NGINX Plus containers.
## Set up your environment
@@ -72,16 +77,6 @@ git clone git@github.com:nginx/agent.git
{{% /tabs %}}
-### Download the agent binary {#agent-binary}
-
-Before you can build a container image with NGINX, you must build or download the **agent** binary.
-
-The **agent** binary packages are available from the [NGINX Agent Releases](https://github.com/nginx/agent/releases) page on GitHub.
-
-Download the binary package for the operating system that you will use in the container image.
-
-Note the location and name of the downloaded package. You will need to use this when running the **make** command to build the image (referred to as `[PATH-TO-PACKAGE]` in the example commands below).
-
### Download the NGINX Plus certificate and key {#myf5-download}
{{< fa "circle-info" "text-muted" >}} **This step is required if you are using NGINX Plus. If you are using NGINX open source, you can skip this section.**
@@ -105,72 +100,28 @@ In order to build a container image with NGINX Plus, you must provide the SSL ce
- Be sure to replace the example certificate and key filenames shown in the example command with your actual file names.
- The file names in the *build/certs* directory must match those shown in the example.
-## Build the official NGINX Agent image with Docker
-
-{{}}
-
-{{%tab name="NGINX Open Source"%}}
+## Run the NGINX Agent container
-Change to the directory where the Dockerfile is located:
+To run NGINX Agent container using Docker use the following command:
```shell
-$ cd scripts/docker/official/nginx-oss-with-nginx-agent/alpine/
+docker pull docker-registry.nginx.com/nginx/agent:mainline
```
-
-- To build an image that contains the latest NGINX Agent and the latest mainline version of NGINX run the following command:
-
- ```shell
- $ docker build -t nginx-agent . --no-cache -f ./Dockerfile.mainline
- ```
-
-- To build an image that contains the latest NGINX Agent and the latest stable version of NGINX run the following command:
-
- ```shell
- $ docker build -t nginx-agent . --no-cache -f ./Dockerfile.stable
- ```
-
-{{% /tab %}}
-
-{{%tab name="NGINX Plus"%}}
-
-1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5) and download your "nginx-repo.crt" and "nginx-repo.key" files. These files are also provided with the NGINX Plus trial package.
-
-1. Copy the files to the directory where the Dockerfile is located **scripts/docker/official/nginx-plus-with-nginx-agent/alpine/**.
-
-1. To build an image that contains the latest NGINX Agent and the latest version of NGINX Plus change to the directory where the Dockerfile is located:
-
```shell
-$ cd scripts/docker/official/nginx-plus-with-nginx-agent/alpine/
+docker tag docker-registry.nginx.com/nginx/agent:mainline nginx-agent
```
-
-1. Run the following command to build the image:
-
```shell
-$ docker build -t nginx-agent . \
- --no-cache -f ./Dockerfile \
- --secret id=nginx-crt,src=nginx-repo.crt \
- --secret id=nginx-key,src=nginx-repo.key
-```
-{{% /tab %}}
-{{% /tabs %}}
-
-
-## Run the NGINX Agent container
-
-Here is an example of how to run the NGINX Agent container using Docker:
-
-```console
docker run --name nginx-agent -d nginx-agent
```
-{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/configuration/configuration-overview" >}}).{{}}
+{{}}To learn more about the configuration options, refer to the NGINX Agent [Configuration Overview]({{< relref "/v2/configuration/configuration-overview" >}}).{{}}
### Enable the gRPC interface
To connect your NGINX Agent container to your NGINX One or NGINX Instance Manager instance, you must enable the gRPC interface. To do this, you must edit the NGINX Agent configuration file, *nginx-agent.conf*. For example:
```yaml
-erver:
+server:
host: 127.0.0.1 # mock control plane host
grpcPort: 54789 # mock control plane gRPC port
@@ -199,6 +150,20 @@ docker run --name nginx-agent -d \
nginx-agent
```
+To ensure that the REST Interface is correctly configured, you can use the `curl` command targeting the following endpoint from your terminal:
+
+```shell
+curl 0.0.0.0:8038/nginx/
+```
+
+If the REST Interface is configured correctly, then you should see a JSON object ouputted to the terminal containing metadata such as NGINX version, path to the NGINX conf, and runtime modules.
+
+**Sample Output:**
+
+```code
+[{"nginx_id":"b636d4376dea15405589692d3c5d3869ff3a9b26b0e7bb4bb1aa7e658ace1437","version":"1.27.1","conf_path":"/etc/nginx/nginx.conf","process_id":"7","process_path":"/usr/sbin/nginx","start_time":1725878806000,"built_from_source":false,"loadable_modules":null,"runtime_modules":["http_addition_module","http_auth_request_module","http_dav_module","http_flv_module","http_gunzip_module","http_gzip_static_module","http_mp4_module","http_random_index_module","http_realip_module","http_secure_link_module","http_slice_module","http_ssl_module","http_stub_status_module","http_sub_module","http_v2_module","http_v3_module","mail_ssl_module","stream_realip_module","stream_ssl_module","stream_ssl_preread_module"],"plus":{"enabled":false,"release":""},"ssl":{"ssl_type":0,"details":["OpenSSL","3.3.0","9 Apr 2024 (running with OpenSSL 3.3.1 4 Jun 2024)"]},"status_url":"","configure_args":["","prefix=/etc/nginx","sbin-path=/usr/sbin/nginx","modules-path=/usr/lib/nginx/modules","conf-path=/etc/nginx/nginx.conf","error-log-path=/var/log/nginx/error.log","http-log-path=/var/log/nginx/access.log","pid-path=/var/run/nginx.pid","lock-path=/var/run/nginx.lock","http-client-body-temp-path=/var/cache/nginx/client_temp","http-proxy-temp-path=/var/cache/nginx/proxy_temp","http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp","http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp","http-scgi-temp-path=/var/cache/nginx/scgi_temp","with-perl_modules_path=/usr/lib/perl5/vendor_perl","user=nginx","group=nginx","with-compat","with-file-aio","with-threads","with-http_addition_module","with-http_auth_request_module","with-http_dav_module","with-http_flv_module","with-http_gunzip_module","with-http_gzip_static_module","with-http_mp4_module","with-http_random_index_module","with-http_realip_module","with-http_secure_link_module","with-http_slice_module","with-http_ssl_module","with-http_stub_status_module","with-http_sub_module","with-http_v2_module","with-http_v3_module","with-mail","with-mail_ssl_module","with-stream","with-stream_realip_module","with-stream_ssl_module","with-stream_ssl_preread_module","with-cc-opt='-Os -fstack-clash-protection -Wformat -Werror=format-security -g'","with-ld-opt=-Wl,--as-needed,-O1,--sort-common"],"error_log_paths":null}]
+```
+
## Build the NGINX Agent images for specific OS targets
@@ -207,175 +172,49 @@ docker run --name nginx-agent -d \
The NGINX Agent GitHub repo has a set of Make commands that you can use to build a container image for an specific operating system and version:
-- `make official-oss-image` builds an image containing NGINX Agent and NGINX open source.
-- `make official-plus-image` builds an image containing NGINX Agent and NGINX Plus.
+- `make oss-image` builds an image containing NGINX Agent and NGINX open source.
+- `make image` builds an image containing NGINX Agent and NGINX Plus.
You can pass the following arguments when running the **make** command to build an NGINX Agent container image.
{{}}
| Argument | Definition |
| ---------------- | -------------------------|
-| PACKAGE_NAME | **Required.** The full path to the downloaded [agent binary package](#agent-binary). Must precede the **make** command. |
| OS_RELEASE | The Linux distribution to use as the base image. Can also be set in the repo Makefile.|
| OS_VERSION | The version of the Linux distribution to use as the base image. Can also be set in the repo Makefile.|
-{{}}
-
-Refer to the [Supported distributions](technical-specifications.md/#supported-distributions) table to find out which base images you can use.
-You can find the official images and versions for each distribution on [Docker Hub](https://hub.docker.com/search?image_filter=official&q=&type=image).
+| AGENT_VERSION | The versions of NGINX agent that you want installed on the image.|
-Keep the following information in mind when using the NGINX Agent [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) to build container images:
-
-- On some operating systems, you need root privileges (**sudo**) to run **make** commands.
-- If you choose to run the **docker build** or **podman build** command instead of using the **make** commands provided, you must do so from the nginx-agent repository's root directory.
+{{}}
### Build NGINX open source images
-Run the following **make** command to build the default image, which uses Alpine 3.19 as the base image.
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] make official-oss-image
-```
-
-### Example build commands by distribution
-
-{{}}
-
-{{%tab name="alma linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=almalinux make oss-image
-```
-
-{{% /tab %}}
-
-{{%tab name="alpine linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=alpine make oss-image
-```
-
-{{% /tab %}}
-
-{{%tab name="amazon linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=amazonlinux make oss-image
-```
-
-{{% /tab %}}
-
-{{%tab name="debian"%}}
+Run the following `make` command to build the default image, which uses Alpine as the base image:
```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=debian make oss-image
+IMAGE_BUILD_TARGET=install-agent-repo make oss-image
```
-{{% /tab %}}
-
-{{%tab name="oracle linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=oraclelinux make oss-image
-```
-
-{{% /tab %}}
-
-{{%tab name="rocky linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=rockylinux make oss-image
-```
-
-{{% /tab %}}
-
-{{%tab name="ubuntu"%}}
-
-The command below creates a base image using the most recent LTS version of Ubuntu as the base image:
+To build an image with Debian and an older version of NGINX Agent you can run the following command:
```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] make oss-image OS_RELEASE=ubuntu
+IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_RELEASE=debian OS_VERSION=bullseye-slim make oss-image
```
-{{% /tab %}}
-
-{{% /tabs %}}
-
### Build NGINX Plus images
{{}}You need a license to use NGINX Agent with NGINX Plus. You must complete the steps in the [Download the certificate and key files from MyF5](#myf5-download) section before proceeding.{{}}
-Run the following `make` command to build the default image, which uses Ubuntu 22.04 (Jammy) as the base image.
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] make official-plus-image
-```
-
-### Example NGINX Plus build commands by distribution
-
-{{}}
-
-{{%tab name="alpine linux"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=alpine make official-plus-image
-```
-
-{{% /tab %}}
-
-{{%tab name="amazon linux"%}}
+Run the following `make` command to build the default image, which uses Ubuntu 24.04 (Noble) as the base image.
```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=amazonlinux make official-plus-image
+IMAGE_BUILD_TARGET=install-agent-repo make image
```
-{{% /tab %}}
-
-{{%tab name="centos"%}}
+To build an image with Debian and an older version of NGINX Agent you can run the following command:
```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=centos OS_VERSION=7 make official-plus-image
+IMAGE_BUILD_TARGET=install-agent-repo NGINX_AGENT_VERSION=2.37.0~bullseye OS_RELEASE=debian OS_VERSION=bullseye-slim make image
```
-{{% /tab %}}
-
-{{%tab name="debian"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=debian OS_VERSION=bullseye-slim make official-plus-image
-```
-
-{{% /tab %}}
-{{%tab name="oracle linux"%}}
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=oraclelinux make official-plus-image
-```
-
-{{% /tab %}}
-
-{{%tab name="rhel"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=redhatenterprise make official-plus-image
-```
-
-{{% /tab %}}
-
-{{%tab name="suse"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=suse OS_VERSION=sle15 make official-plus-image
-```
-
-{{% /tab %}}
-
-{{%tab name="ubuntu"%}}
-
-```shell
-PACKAGE_NAME=[PATH-TO-PACKAGE] OS_RELEASE=ubuntu make official-plus-image
-```
-
-{{% /tab %}}
-
-{{% /tabs %}}
diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/v2/installation-upgrade/container-environments/docker-support.md
similarity index 91%
rename from site/content/installation-upgrade/container-environments/docker-support.md
rename to site/content/v2/installation-upgrade/container-environments/docker-support.md
index be0605ab55..b0bdd98a65 100644
--- a/site/content/installation-upgrade/container-environments/docker-support.md
+++ b/site/content/v2/installation-upgrade/container-environments/docker-support.md
@@ -7,11 +7,12 @@ tags:
- docs
toc: true
weight: 200
+docs: "DOCS-909"
---
## Overview
-The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
+The NGINX Agent repository includes [Dockerfiles](https://github.com/nginx/agent/tree/main/scripts/docker) that can be used to [build custom container images]({{< relref "/v2/installation-upgrade/container-environments/docker-images.md" >}}). Images are created with an NGINX Open Source or NGINX Plus instance and are available for various operating systems.
See the [Technical Specifications]({{< relref "/technical-specifications.md#container-support" >}}) for a list of supported operationg systems.
diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/v2/installation-upgrade/getting-started.md
similarity index 92%
rename from site/content/installation-upgrade/getting-started.md
rename to site/content/v2/installation-upgrade/getting-started.md
index e3be8c8095..578037f537 100644
--- a/site/content/installation-upgrade/getting-started.md
+++ b/site/content/v2/installation-upgrade/getting-started.md
@@ -4,6 +4,7 @@ draft: false
weight: 100
toc: true
tags: [ "docs" ]
+docs: "DOCS-1089"
categories: ["configuration"]
doctypes: ["task"]
---
@@ -14,7 +15,7 @@ Follow these steps to configure and run NGINX Agent and a mock interface ("contr
## Install NGINX
-Follow the steps in the [Installation]({{< relref "/installation-upgrade/installation-github.md" >}}) section to download, install, and run NGINX.
+Follow the steps in the [Installation](https://docs.nginx.com/nginx/admin-guide/installing-nginx/) section to download, install, and run NGINX.
## Clone the NGINX Agent Repository
@@ -22,7 +23,7 @@ Using your preferred method, clone the NGINX Agent repository into your developm
## Install Go
-NGINX Agent and the Mock Control Plane are written in Go. Go 1.23.0 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/).
+NGINX Agent and the Mock Control Plane are written in Go. Go 1.23 or higher is required to build and run either application from the source code directory. You can [download Go from the official website](https://go.dev/dl/).
## Start the gRPC Mock Control Plane
@@ -93,7 +94,7 @@ The mock control plane can use either gRPC or REST protocols to communicate with
## Launch Swagger UI
-Swagger UI requires goswagger be installed. See [instructions for installing goswagger](https://goswagger.io/install.html) for additional help.
+Swagger UI requires goswagger be installed. See [instructions for installing goswagger](https://goswagger.io/go-swagger/install/) for additional help.
To launch the Swagger UI for the REST interface run the following command:
@@ -176,5 +177,5 @@ NGINX Agent uses formatted log files to collect metrics. Expanding log formats a
{{< important >}}
Without log rotation or storage on a separate partition, log files could use up all the free drive space and cause your system to become unresponsive to certain services.
-For more information, see [NGINX Agent Log Rotation]({{< relref "configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
+For more information, see [NGINX Agent Log Rotation]({{< relref "/v2/configuration/configuration-overview.md#nginx-agent-log-rotation" >}}).
{{< /important >}}
diff --git a/site/content/installation-upgrade/installation-github.md b/site/content/v2/installation-upgrade/installation-github.md
similarity index 98%
rename from site/content/installation-upgrade/installation-github.md
rename to site/content/v2/installation-upgrade/installation-github.md
index 20c3568f2b..d53a07006e 100644
--- a/site/content/installation-upgrade/installation-github.md
+++ b/site/content/v2/installation-upgrade/installation-github.md
@@ -4,6 +4,7 @@ draft: false
weight: 200
toc: true
tags: [ "docs" ]
+docs: "DOCS-1090"
categories: ["configuration"]
doctypes: ["task"]
---
diff --git a/site/content/installation-upgrade/installation-oss.md b/site/content/v2/installation-upgrade/installation-oss.md
similarity index 69%
rename from site/content/installation-upgrade/installation-oss.md
rename to site/content/v2/installation-upgrade/installation-oss.md
index d3c42ef31f..5e82dd21b1 100644
--- a/site/content/installation-upgrade/installation-oss.md
+++ b/site/content/v2/installation-upgrade/installation-oss.md
@@ -4,6 +4,7 @@ draft: false
weight: 300
toc: true
tags: [ "docs" ]
+docs: "DOCS-1216"
categories: ["configuration"]
doctypes: ["task"]
---
@@ -15,7 +16,7 @@ Learn how to install NGINX Agent from the NGINX Open Source repository.
## Prerequisites
- NGINX installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/)
-- A [supported operating system and architecture](../technical-specifications/#supported-distributions)
+- A [supported operating system and architecture]({{< relref "/technical-specifications.md#supported-distributions" >}})
- `root` privilege
## Configure NGINX OSS Repository for installing NGINX Agent
@@ -27,7 +28,8 @@ Before you install NGINX Agent for the first time on your system, you need to se
- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian)
- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles)
- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux)
-- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux)
+- [Installing NGINX Agent on Amazon Linux 2](#installing-nginx-agent-on-amazon-linux-2)
+- [Installing NGINX Agent on Amazon Linux 2023](#installing-nginx-agent-on-amazon-linux-2023)
- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd)
### Installing NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
@@ -56,7 +58,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo yum install nginx-agent
```
- When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+ When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
### Installing NGINX Agent on Ubuntu
@@ -79,12 +81,20 @@ Before you install NGINX Agent for the first time on your system, you need to se
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
```
- The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
+ The output should contain the full fingerprints `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3` as follows:
```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
- uid nginx signing key
+ pub rsa4096 2024-05-29 [SC]
+ 8540A6F18833A80E9C1653A42FD21310B49F6B46
+ uid nginx signing key
+
+ pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+
+ pub rsa4096 2024-05-29 [SC]
+ 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3
+ uid nginx signing key
```
{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
@@ -133,12 +143,20 @@ Before you install NGINX Agent for the first time on your system, you need to se
--import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
```
- The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
+ The output should contain the full fingerprints `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3` as follows:
```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
- uid nginx signing key
+ pub rsa4096 2024-05-29 [SC]
+ 8540A6F18833A80E9C1653A42FD21310B49F6B46
+ uid nginx signing key
+
+ pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+
+ pub rsa4096 2024-05-29 [SC]
+ 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3
+ uid nginx signing key
```
{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
@@ -191,12 +209,20 @@ Before you install NGINX Agent for the first time on your system, you need to se
gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
```
-1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
+1. The output should contain the full fingerprints `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3` as follows:
```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
- uid nginx signing key
+ pub rsa4096 2024-05-29 [SC]
+ 8540A6F18833A80E9C1653A42FD21310B49F6B46
+ uid nginx signing key
+
+ pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+
+ pub rsa4096 2024-05-29 [SC]
+ 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3
+ uid nginx signing key
```
1. Finally, import the key to the rpm database:
@@ -291,7 +317,43 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo nginx-agent -v
```
-### Installing NGINX Agent on Amazon Linux
+### Installing NGINX Agent on Amazon Linux 2023
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo dnf install yum-utils procps-ng
+ ```
+
+1. To set up the dnf repository for Amazon Linux 2023, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
+ ```
+ [nginx-agent]
+ name=nginx agent repo
+ baseurl=https://packages.nginx.org/nginx-agent/amzn/2023/$basearch/
+ gpgcheck=1
+ enabled=1
+ gpgkey=https://nginx.org/keys/nginx_signing.key
+ module_hotfixes=true
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo dnf install nginx-agent
+ ```
+
+1. When prompted to accept the GPG key, verify that the fingerprint matches
+ `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`,
+ `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`,
+ `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`
+ and if so, accept it.
+
+1. Verify the installation:
+
+ ```shell
+ sudo nginx-agent -v
+ ```
+### Installing NGINX Agent on Amazon Linux 2
1. Install the prerequisites:
@@ -316,7 +378,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo yum install nginx-agent
```
-1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
1. Verify the installation:
diff --git a/site/content/installation-upgrade/installation-plus.md b/site/content/v2/installation-upgrade/installation-plus.md
similarity index 81%
rename from site/content/installation-upgrade/installation-plus.md
rename to site/content/v2/installation-upgrade/installation-plus.md
index 643d021697..ba42502106 100644
--- a/site/content/installation-upgrade/installation-plus.md
+++ b/site/content/v2/installation-upgrade/installation-plus.md
@@ -4,6 +4,7 @@ draft: false
weight: 400
toc: true
tags: [ "docs" ]
+docs: "DOCS-1217"
categories: ["configuration"]
doctypes: ["task"]
---
@@ -16,7 +17,7 @@ Learn how to install NGINX Agent from NGINX Plus repository
- An NGINX Plus subscription (purchased or trial)
- NGINX Plus installed. Once installed, ensure it is running. If you don't have it installed already, follow these steps to install [NGINX Plus](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/)
-- A [supported operating system and architecture](../technical-specifications/#supported-distributions)
+- A [supported operating system and architecture]({{< relref "/technical-specifications.md#supported-distributions" >}})
- `root` privilege
- Your credentials to the MyF5 Customer Portal, provided by email from F5, Inc.
- Your NGINX Plus certificate and public key (`nginx-repo.crt` and `nginx-repo.key` files), provided by email from F5, Inc.
@@ -30,6 +31,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
- [Installing NGINX Agent on Debian](#installing-nginx-agent-on-debian)
- [Installing NGINX Agent on SLES](#installing-nginx-agent-on-sles)
- [Installing NGINX Agent on Alpine Linux](#installing-nginx-agent-on-alpine-linux)
+- [Installing NGINX Agent on Amazon Linux 2023](#installing-nginx-agent-on-amazon-linux-2023)
- [Installing NGINX Agent on Amazon Linux](#installing-nginx-agent-on-amazon-linux)
- [Installing NGINX Agent on FreeBSD](#installing-nginx-agent-on-freebsd)
@@ -79,7 +81,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo yum install nginx-agent
```
- When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+ When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
1. Verify the installation:
@@ -243,12 +245,20 @@ Before you install NGINX Agent for the first time on your system, you need to se
gpg --with-fingerprint --dry-run --quiet --no-keyring --import --import-options import-show /tmp/nginx_signing.key
```
-1. The output should contain the full fingerprint `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62` as follows:
+1. The output should contain the full fingerprints `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3` as follows:
```
- pub rsa2048 2011-08-19 [SC] [expires: 2024-06-14]
- 573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62
- uid nginx signing key
+ pub rsa4096 2024-05-29 [SC]
+ 8540A6F18833A80E9C1653A42FD21310B49F6B46
+ uid nginx signing key
+
+ pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
+ 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
+ uid nginx signing key
+
+ pub rsa4096 2024-05-29 [SC]
+ 9E9BE90EACBCDE69FE9B204CBCDCD8A38D88A2B3
+ uid nginx signing key
```
1. Finally, import the key to the rpm database:
@@ -352,7 +362,55 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo nginx-agent -v
```
-### Installing NGINX Agent on Amazon Linux
+### Installing NGINX Agent on Amazon Linux 2023
+
+1. Create the `/etc/ssl/nginx` directory:
+
+ ```shell
+ sudo mkdir -p /etc/ssl/nginx
+ ```
+
+1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
+
+1. Copy the `nginx-repo.crt` and `nginx-repo.key` files to the `/etc/ssl/nginx/` directory:
+
+ ```shell
+ sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
+ ```
+
+1. Install the prerequisites:
+
+ ```shell
+ sudo dnf install yum-utils procps-ng ca-certificates
+ ```
+
+1. To set up the dnf repository for Amazon Linux 2023, create the file named `/etc/yum.repos.d/nginx-agent.repo` with the following contents:
+
+ ```
+ [nginx-agent]
+ name=nginx-agent repo
+ baseurl=https://packages.nginx.org/nginx-agent/amzn/2023/$basearch/
+ sslclientcert=/etc/ssl/nginx/nginx-repo.crt
+ sslclientkey=/etc/ssl/nginx/nginx-repo.key
+ gpgcheck=0
+ enabled=1
+ ```
+
+1. To install `nginx-agent`, run the following command:
+
+ ```shell
+ sudo dnf install nginx-agent
+ ```
+
+1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
+
+1. Verify the installation:
+
+ ```shell
+ sudo nginx-agent -v
+ ```
+
+### Installing NGINX Agent on Amazon Linux 2
1. Create the `/etc/ssl/nginx` directory:
@@ -379,7 +437,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
```
[nginx-agent]
name=nginx-agent repo
- baseurl=https://pkgs.nginx.com/nginx-agent/amzn2/$releasever/$basearch
+ baseurl=https://pkgs.nginx.com/nginx-agent/amzn/2023/$releasever/$basearch
sslclientcert=/etc/ssl/nginx/nginx-repo.crt
sslclientkey=/etc/ssl/nginx/nginx-repo.key
gpgcheck=0
@@ -392,7 +450,7 @@ Before you install NGINX Agent for the first time on your system, you need to se
sudo yum install nginx-agent
```
-1. When prompted to accept the GPG key, verify that the fingerprint matches `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, and if so, accept it.
+1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
1. Verify the installation:
diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/v2/installation-upgrade/uninstall.md
similarity index 91%
rename from site/content/installation-upgrade/uninstall.md
rename to site/content/v2/installation-upgrade/uninstall.md
index 0431f72bda..49184df826 100644
--- a/site/content/installation-upgrade/uninstall.md
+++ b/site/content/v2/installation-upgrade/uninstall.md
@@ -4,6 +4,7 @@ draft: false
weight: 700
toc: true
tags: [ "docs" ]
+docs: "DOCS-1230"
categories: ["configuration"]
doctypes: ["task"]
---
@@ -113,7 +114,7 @@ Complete the following steps on each host where you've installed NGINX agent:
sudo apk del nginx-agent
```
-### Uninstalling NGINX Agent on Amazon Linux
+### Uninstalling NGINX Agent on Amazon Linux 2
Complete the following steps on each host where you've installed NGINX agent:
@@ -129,6 +130,21 @@ Complete the following steps on each host where you've installed NGINX agent:
sudo yum remove nginx-agent
```
+### Uninstalling NGINX Agent on Amazon Linux 2023
+
+Complete the following steps on each host where you've installed NGINX agent:
+
+1. Stop NGINX agent:
+
+ ```bash
+ sudo systemctl stop nginx-agent
+ ```
+
+2. To uninstall NGINX agent, run the following command:
+
+ ```bash
+ sudo dnf remove nginx-agent
+ ```
### Uninstalling NGINX Agent on FreeBSD
Complete the following steps on each host where you've installed NGINX agent:
diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/v2/installation-upgrade/upgrade.md
similarity index 99%
rename from site/content/installation-upgrade/upgrade.md
rename to site/content/v2/installation-upgrade/upgrade.md
index 4e0f445398..f5e3409af7 100644
--- a/site/content/installation-upgrade/upgrade.md
+++ b/site/content/v2/installation-upgrade/upgrade.md
@@ -4,6 +4,7 @@ draft: false
weight: 600
toc: true
tags: [ "docs" ]
+docs: "DOCS-1227"
categories: ["configuration"]
doctypes: ["task"]
---
diff --git a/site/content/v2/metrics.md b/site/content/v2/metrics.md
new file mode 100644
index 0000000000..e90e55c931
--- /dev/null
+++ b/site/content/v2/metrics.md
@@ -0,0 +1,10 @@
+---
+title: Metrics
+catalog: true
+catalogType: v2metrics
+toc: true
+weight: 200
+docs: DOCS-000
+---
+
+{{< v2-metrics >}}
\ No newline at end of file
diff --git a/site/content/previous-versions/NGINX-agent-v2/technical-specifications.md b/site/content/v2/technical-specifications.md
similarity index 87%
rename from site/content/previous-versions/NGINX-agent-v2/technical-specifications.md
rename to site/content/v2/technical-specifications.md
index 52864eaa48..efa731527b 100644
--- a/site/content/previous-versions/NGINX-agent-v2/technical-specifications.md
+++ b/site/content/v2/technical-specifications.md
@@ -1,16 +1,13 @@
---
-title: "Technical Specifications"
-draft: false
-description: "This document describes the requirements for NGINX Agent."
-weight: 200
+title: "Technical specifications"
+weight: 100
toc: true
-tags: [ "docs" ]
docs: "DOCS-1092"
-categories: ["development"]
-doctypes: ["task"]
---
-## Supported Distributions
+This document describes the requirements for NGINX Agent v2.
+
+## Supported distributions
NGINX Agent can run in most environments. We support the following distributions:
@@ -29,7 +26,7 @@ NGINX Agent can run in most environments. We support the following distributions
{{< /bootstrap-table >}}
-## Supported Deployment Environments
+## Supported deployment environments
NGINX Agent can be deployed in the following environments:
@@ -38,12 +35,12 @@ NGINX Agent can be deployed in the following environments:
- Public Cloud: AWS, Google Cloud Platform, and Microsoft Azure
- Virtual Machine
-## Supported NGINX Versions
+## Supported NGINX versions
NGINX Agent works with all supported versions of NGINX Open Source and NGINX Plus.
-## Sizing Recommendations
+## Sizing recommendations
Minimum system sizing recommendations for NGINX Agent:
{{< bootstrap-table "table table-striped table-bordered" >}}
diff --git a/site/go.mod b/site/go.mod
index 1675cfcc8c..e6c32c9f66 100644
--- a/site/go.mod
+++ b/site/go.mod
@@ -2,4 +2,4 @@ module github.com/nginx/agent/site
go 1.18
-require github.com/nginxinc/nginx-hugo-theme v0.40.8 // indirect
+require github.com/nginxinc/nginx-hugo-theme v0.41.23 // indirect
diff --git a/site/go.sum b/site/go.sum
index bd8c870ccb..3e619b076d 100644
--- a/site/go.sum
+++ b/site/go.sum
@@ -10,3 +10,5 @@ github.com/nginxinc/nginx-hugo-theme v0.35.0 h1:7XB2GMy6qeJgKEJy9wOS3SYKYpfvLW3/
github.com/nginxinc/nginx-hugo-theme v0.35.0/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
github.com/nginxinc/nginx-hugo-theme v0.40.8 h1:VtoSAtf9k67tI2jzbLRo0oFBAMHZBUPRh/xV4MYullI=
github.com/nginxinc/nginx-hugo-theme v0.40.8/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
+github.com/nginxinc/nginx-hugo-theme v0.41.23 h1:ddIfLF7BFd78qyIn3z5aReeC4BO/m9FH81d5S+al/6s=
+github.com/nginxinc/nginx-hugo-theme v0.41.23/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
diff --git a/site/layouts/agent-v2-migration/list.html b/site/layouts/agent-v2-migration/list.html
new file mode 100644
index 0000000000..54b0b0f66b
--- /dev/null
+++ b/site/layouts/agent-v2-migration/list.html
@@ -0,0 +1,10 @@
+{{ define "main" }}
+
+{{ end }}
\ No newline at end of file
diff --git a/site/layouts/agent-v2-migration/single.html b/site/layouts/agent-v2-migration/single.html
new file mode 100644
index 0000000000..e918630803
--- /dev/null
+++ b/site/layouts/agent-v2-migration/single.html
@@ -0,0 +1,49 @@
+{{ define "main" }}
+
+
+
+ {{if (.Params.catalog) }}
+
+ {{ else if and (gt .WordCount 200 ) (.Params.toc) }}
+
+ {{ else }}
+
+ {{ end }}
+
+
+
+ NGINX Agent v3 is available!
+ This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances.
+
+
+
+
{{ .Title }}
+
+ {{ if eq .Page.Draft true }}{{ partial "draft-badge.html" . }}{{ end }}
+ {{ if .Description }}
{{ .Description | markdownify }}
{{ end}}
+
+ {{ if in .Params.doctypes "beta" }}{{ partial "beta-badge" . }}{{ end }}
+
+ {{ .Content }}
+ {{ partial "version-list" . }}
+
+ {{ partial "previous-next-links-in-section-with-title.html" . }}
+
+
+ {{ if and (gt .WordCount 200 ) (.Params.toc) }}
+ {{ if (add (len (findRE "
+ {{ partial "toc.html" . }}
+
+ {{ end }}
+ {{ end }}
+
+
+{{if .Params.script}}
+ {{ $script := (delimit (slice "scripts" .Params.script) "/")}}
+ {{ partial (string $script) .}}
+{{end }}
+
+{{ end }}
\ No newline at end of file
diff --git a/site/layouts/catalogs/single.html b/site/layouts/catalogs/single.html
new file mode 100644
index 0000000000..57b1d77790
--- /dev/null
+++ b/site/layouts/catalogs/single.html
@@ -0,0 +1,14 @@
+{{ define "main" }}
+
+ This documentation is for NGINX Agent v2. We suggest reading the Migrate from NGINX Agent v2 to v3 topic to learn the differences between the two versions, and learn how to upgrade your instances.
+
+
+ {{ if .Content }}
+
+ {{ .Content | markdownify }}
+
+ {{ end }}
+
+
+
+
+
+
+ {{ range .Pages.GroupBy "Section" }}
+
+ {{ range .Pages.ByWeight }}
+
+ {{ if .Description }}{{ .Description | markdownify }}{{ end }}
+
{{*/}}
+
+
+
+
+ {{ end }}
+
+
+ {{ end }}
+
+
+
+
+
\ No newline at end of file
diff --git a/site/layouts/shortcodes/v2-metrics.html b/site/layouts/shortcodes/v2-metrics.html
new file mode 100644
index 0000000000..dc14d9a35e
--- /dev/null
+++ b/site/layouts/shortcodes/v2-metrics.html
@@ -0,0 +1,56 @@
+
+ {{ range .Site.Data.v2metrics }}
+
+