diff --git a/site/content/_index.md b/site/content/_index.md index ff64d487d3..ac81454ba1 100644 --- a/site/content/_index.md +++ b/site/content/_index.md @@ -1,5 +1,5 @@ --- -title: "Welcome to the NGINX Agent Documentation" +title: "Welcome to the NGINX Agent documentation" description: "NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance." linkTitle: "NGINX Agent" menu: docs diff --git a/site/content/configuration/configuration-overview.md b/site/content/configuration/configuration-overview.md index caafd40991..619685e9a6 100644 --- a/site/content/configuration/configuration-overview.md +++ b/site/content/configuration/configuration-overview.md @@ -1,5 +1,5 @@ --- -title: "Configuration Overview" +title: "Configuration overview" draft: false weight: 100 toc: true @@ -44,9 +44,9 @@ In the following example `nginx-agent.conf` file, you can change the `server.hos # # Configuration file for NGINX Agent. # -# This file tracks agent configuration values that are meant to be statically set. There +# 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. +# which can be found in /etc/nginx-agent/agent-dynamic.conf. # specify the server grpc port to connect to server: @@ -130,7 +130,7 @@ Default location in FreeBSD environments: `/var/db/nginx-agent/agent-dynamic.con # The agent configuration value that the agent install script can modify are as follows: # - instance_group -instance_group: devenv-group +instance_group: devenv-group tags: - devenv - test @@ -254,7 +254,7 @@ This section displays the configurable options for NGINX Agent that can be set w ### NGINX Agent Log Rotation -By default, NGINX Agent rotates logs daily using logrotate with the following configuration: +By default, NGINX Agent rotates logs daily using logrotate with the following configuration:
NGINX Agent Logrotate Configuration @@ -275,7 +275,7 @@ By default, NGINX Agent rotates logs daily using logrotate with the following co # 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 + missingok # do not rotate the log if it is empty notifempty } diff --git a/site/content/configuration/configure-nginx-agent-group.md b/site/content/configuration/configure-nginx-agent-group.md index 43cd80bde1..bb6260daf4 100644 --- a/site/content/configuration/configure-nginx-agent-group.md +++ b/site/content/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/configuration/encrypt-communication.md b/site/content/configuration/encrypt-communication.md index 26d0b015f0..11166eb639 100644 --- a/site/content/configuration/encrypt-communication.md +++ b/site/content/configuration/encrypt-communication.md @@ -1,5 +1,5 @@ --- -title: Encrypt Communication +title: Encrypt communication tags: - docs toc: true diff --git a/site/content/contribute/community.md b/site/content/contribute/community.md index 16763795dd..2566b4741c 100644 --- a/site/content/contribute/community.md +++ b/site/content/contribute/community.md @@ -1,5 +1,5 @@ --- -title: "Community and Contribution" +title: "Community and contribution" draft: false weight: 100 toc: true diff --git a/site/content/contribute/dev-environment-setup.md b/site/content/contribute/dev-environment-setup.md index 3209289da1..8a448036f1 100644 --- a/site/content/contribute/dev-environment-setup.md +++ b/site/content/contribute/dev-environment-setup.md @@ -1,5 +1,5 @@ --- -title: "Development Environment Setup" +title: "Development environment setup" draft: false weight: 200 toc: true diff --git a/site/content/installation-upgrade/_index.md b/site/content/installation-upgrade/_index.md index 211fc3e9b6..4c3d498997 100644 --- a/site/content/installation-upgrade/_index.md +++ b/site/content/installation-upgrade/_index.md @@ -1,5 +1,5 @@ --- -title: "Installation and Upgrade" +title: "Installation and upgrade" description: "Learn how to install, upgrade, and uninstall NGINX Agent." menu: docs weight: 300 diff --git a/site/content/installation-upgrade/container-environments/_index.md b/site/content/installation-upgrade/container-environments/_index.md index e2de9f52c2..ca964e34b0 100644 --- a/site/content/installation-upgrade/container-environments/_index.md +++ b/site/content/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/installation-upgrade/container-environments/docker-images.md b/site/content/installation-upgrade/container-environments/docker-images.md index cb164f60a6..659d8509d2 100644 --- a/site/content/installation-upgrade/container-environments/docker-images.md +++ b/site/content/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 diff --git a/site/content/installation-upgrade/container-environments/docker-support.md b/site/content/installation-upgrade/container-environments/docker-support.md index 7123d9ee12..f4701b3047 100644 --- a/site/content/installation-upgrade/container-environments/docker-support.md +++ b/site/content/installation-upgrade/container-environments/docker-support.md @@ -1,5 +1,5 @@ --- -title: Container Support and Troubleshooting +title: Container support and troubleshooting categories: - installation draft: false @@ -24,8 +24,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 diff --git a/site/content/installation-upgrade/getting-started.md b/site/content/installation-upgrade/getting-started.md index 22d2c6b8c1..102d2c4ca2 100644 --- a/site/content/installation-upgrade/getting-started.md +++ b/site/content/installation-upgrade/getting-started.md @@ -1,5 +1,5 @@ --- -title: "Getting Started" +title: "Getting started" draft: false weight: 100 toc: true @@ -23,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.21.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.21.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 @@ -39,14 +39,14 @@ INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent w ## 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. +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. +Create the `agent-dynamic.conf` file, which is required for NGINX Agent to run. In Linux environments: ```shell @@ -106,7 +106,7 @@ make launch-swagger-ui 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`. +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 @@ -124,24 +124,24 @@ Open another terminal window and start NGINX Agent. Issue the following command sudo make run # Command Output snippet -WARN[0000] Log level is info -INFO[0000] setting displayName to XXX +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] 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] Events initializing INFO[0001] OneTimeRegistration completed ``` @@ -170,9 +170,9 @@ To enable NGINX Agent to start on boot, run the following command: sudo systemctl enable nginx-agent ``` -## Logs +## 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`. +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. diff --git a/site/content/installation-upgrade/installation-github.md b/site/content/installation-upgrade/installation-github.md index ba507c7594..d53a07006e 100644 --- a/site/content/installation-upgrade/installation-github.md +++ b/site/content/installation-upgrade/installation-github.md @@ -1,5 +1,5 @@ --- -title: "Installation From GitHub Release" +title: "Installation from GitHub release" draft: false weight: 200 toc: true @@ -30,7 +30,7 @@ Use your system's package manager to install the package. Some examples: ``` - RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using the `yum` package manager - + ```shell sudo yum localinstall nginx-agent-.rpm ``` @@ -48,7 +48,7 @@ Use your system's package manager to install the package. Some examples: ``` - FreeBSD - + ```shell sudo pkg add nginx-agent-.pkg ``` diff --git a/site/content/installation-upgrade/installation-oss.md b/site/content/installation-upgrade/installation-oss.md index 9444700f6f..e730d6fbc4 100644 --- a/site/content/installation-upgrade/installation-oss.md +++ b/site/content/installation-upgrade/installation-oss.md @@ -1,5 +1,5 @@ --- -title: "Installation From NGINX Repository" +title: "Installation from NGINX repository" draft: false weight: 300 toc: true @@ -174,7 +174,7 @@ Before you install NGINX Agent for the first time on your system, you need to se ``` 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 @@ -249,7 +249,7 @@ Before you install NGINX Agent for the first time on your system, you need to se ``` The output should contain the following modulus: - + ``` Public-Key: (2048 bit) Modulus: diff --git a/site/content/installation-upgrade/installation-plus.md b/site/content/installation-upgrade/installation-plus.md index 0600eaeb1f..56343e8792 100644 --- a/site/content/installation-upgrade/installation-plus.md +++ b/site/content/installation-upgrade/installation-plus.md @@ -1,5 +1,5 @@ --- -title: "Installation From NGINX Plus Repository" +title: "Installation from NGINX Plus repository" draft: false weight: 400 toc: true diff --git a/site/content/installation-upgrade/uninstall.md b/site/content/installation-upgrade/uninstall.md index c5076775a6..58e75c4e14 100644 --- a/site/content/installation-upgrade/uninstall.md +++ b/site/content/installation-upgrade/uninstall.md @@ -1,5 +1,5 @@ --- -title: "Uninstall NGINX Agent Package" +title: "Uninstall NGINX Agent package" draft: false weight: 700 toc: true @@ -96,7 +96,7 @@ Complete the following steps on each host where you've installed NGINX Agent: ```bash sudo zypper remove nginx-agent - ``` + ``` ### Uninstalling NGINX Agent on Alpine Linux @@ -112,7 +112,7 @@ Complete the following steps on each host where you've installed NGINX agent: ```bash sudo apk del nginx-agent - ``` + ``` ### Uninstalling NGINX Agent on Amazon Linux @@ -128,10 +128,10 @@ Complete the following steps on each host where you've installed NGINX agent: ```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: @@ -144,4 +144,4 @@ Complete the following steps on each host where you've installed NGINX agent: ```bash sudo pkg delete nginx-agent - ``` + ``` diff --git a/site/content/installation-upgrade/upgrade.md b/site/content/installation-upgrade/upgrade.md index bf5bb90c49..f5e3409af7 100644 --- a/site/content/installation-upgrade/upgrade.md +++ b/site/content/installation-upgrade/upgrade.md @@ -1,5 +1,5 @@ --- -title: "Upgrade NGINX Agent Package" +title: "Upgrade NGINX Agent package" draft: false weight: 600 toc: true diff --git a/site/content/technical-specifications.md b/site/content/technical-specifications.md index 52864eaa48..4eaf680aea 100644 --- a/site/content/technical-specifications.md +++ b/site/content/technical-specifications.md @@ -1,7 +1,6 @@ --- -title: "Technical Specifications" +title: "Technical specifications" draft: false -description: "This document describes the requirements for NGINX Agent." weight: 200 toc: true tags: [ "docs" ] @@ -10,12 +9,16 @@ categories: ["development"] doctypes: ["task"] --- +## Overview + +This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging. + ## Supported Distributions NGINX Agent can run in most environments. We support the following distributions: {{< bootstrap-table "table table-striped table-bordered" >}} -| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2 | CentOS | Debian | +| | AlmaLinux | Alpine Linux | Amazon Linux | Amazon Linux 2 | CentOS | Debian | |-|-----------|--------------|--------------|----------------|--------|--------| |**Version**|8
9 | 3.16
3.17
3.18
3.19| 2023| LTS| 7.4+| 11
12| |**Architecture**| x86_84
aarch64| x86_64
aarch64 | x86_64
aarch64 | x86_64
aarch64 | x86_64
aarch64 | x86_64
aarch64 | @@ -29,7 +32,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,7 +41,7 @@ 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.