Skip to content

Commit e5982d4

Browse files
lamATnginxlamATnginx
committed
Merge branch 'main' into epic-472-port-nginx-one-labs
2 parents 82567cf + c8af3ad commit e5982d4

File tree

1,025 files changed

+1680
-1567
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,025 files changed

+1680
-1567
lines changed

‎content/agent/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Changelog"
33
weight: 1200
44
toc: true
5-
docs: "DOCS-1093"
5+
nd-docs: "DOCS-1093"
66
---
77

88
{{< 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 >}}

‎content/agent/configuration/configuration-overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Basic configuration
33
draft: false
44
weight: 100
55
toc: true
6-
docs: DOCS-1229
6+
nd-docs: DOCS-1229
77
type:
88
- how-to
99
---
@@ -50,7 +50,7 @@ server:
5050
# host of the control plane
5151
host: <FQDN>
5252
grpcPort: 443
53-
backoff: # note: default values are prepopulated
53+
backoff: # note: default values are prepopulated
5454
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
5555
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
5656
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
@@ -88,7 +88,7 @@ metrics:
8888
report_interval: 1m
8989
collection_interval: 15s
9090
mode: aggregated
91-
backoff: # note: default values are prepopulated
91+
backoff: # note: default values are prepopulated
9292
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
9393
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
9494
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
@@ -170,9 +170,9 @@ nginx-agent
170170

171171
### CLI Flags and Environment Variables
172172

173-
{{< warning >}}
173+
{{< warning >}}
174174

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

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

@@ -220,9 +220,9 @@ If you are upgrading from an older version, update your configuration accordingl
220220
<br>
221221

222222
{{<note>}}
223-
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.
223+
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.
224224

225-
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.
225+
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.
226226

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

‎content/agent/configuration/configure-nginx-agent-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 150
55
toc: true
66
type:
77
- how-to
8-
docs: DOCS-1678
8+
nd-docs: DOCS-1678
99
---
1010

1111
## Overview

‎content/agent/configuration/configure-nginx-agent-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Add NGINX users to nginx-agent Group
33
draft: false
44
weight: 300
55
toc: true
6-
docs: DOCS-933
6+
nd-docs: DOCS-933
77
type:
88
- how-to
99
---

‎content/agent/configuration/encrypt-communication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Encrypt communication
33
toc: true
44
weight: 200
5-
docs: DOCS-802
5+
nd-docs: DOCS-802
66
---
77

88
## Overview

‎content/agent/configuration/health-checks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 400
55
toc: true
66
type:
77
- how-to
8-
docs: DOCS-1677
8+
nd-docs: DOCS-1677
99
---
1010

1111
## Overview

‎content/agent/contribute/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Community and contribution
33
draft: false
44
weight: 100
55
toc: true
6-
docs: DOCS-1087
6+
nd-docs: DOCS-1087
77
type:
88
- how-to
99
---

‎content/agent/contribute/dev-environment-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Development environment setup
33
draft: false
44
weight: 200
55
toc: true
6-
docs: DOCS-1088
6+
nd-docs: DOCS-1088
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/container-environments/docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Build container images
33
draft: false
44
weight: 100
55
toc: true
6-
docs: DOCS-1410
6+
nd-docs: DOCS-1410
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/container-environments/docker-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Container support and troubleshooting
33
draft: false
44
toc: true
55
weight: 200
6-
docs: DOCS-909
6+
nd-docs: DOCS-909
77
type:
88
- task
99
---

‎content/agent/installation-upgrade/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Getting started
33
draft: false
44
weight: 100
55
toc: true
6-
docs: DOCS-1089
6+
nd-docs: DOCS-1089
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/installation-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Installation from GitHub release
33
draft: false
44
weight: 200
55
toc: true
6-
docs: DOCS-1090
6+
nd-docs: DOCS-1090
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/installation-oss.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Installation from NGINX repository
33
draft: false
44
weight: 300
55
toc: true
6-
docs: DOCS-1216
6+
nd-docs: DOCS-1216
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/installation-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Installation from NGINX Plus repository
33
draft: false
44
weight: 400
55
toc: true
6-
docs: DOCS-1217
6+
nd-docs: DOCS-1217
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/installation-unprivileged.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ weight: 450
44
toc: true
55
type: how-to
66
product: Agent
7+
nd-docs: DOCS-1781
78
---
89

910
## Overview

‎content/agent/installation-upgrade/uninstall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Uninstall NGINX Agent package
33
draft: false
44
weight: 700
55
toc: true
6-
docs: DOCS-1230
6+
nd-docs: DOCS-1230
77
type:
88
- how-to
99
---

‎content/agent/installation-upgrade/upgrade.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Upgrade NGINX Agent package
33
draft: false
44
weight: 600
55
toc: true
6-
docs: DOCS-1227
6+
nd-docs: DOCS-1227
77
type:
88
- how-to
99
---
@@ -39,48 +39,48 @@ To upgrade NGINX Agent, follow these steps:
3939
sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
4040
```
4141

42-
## Upgrade NGINX Agent to a Specific Version
42+
## Upgrade NGINX Agent to a Specific Version
4343

44-
To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
44+
To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
4545

46-
#### Steps to Upgrade:
46+
#### Steps to Upgrade:
4747

4848
1. Open an SSH connection to the server running NGINX Agent and log in.
4949

50-
1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade:
50+
1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade:
5151

5252
- `/etc/nginx-agent`
5353
- Any `config_dirs` directory specified in `/etc/nginx-agent/nginx-agent.conf`.
5454

55-
1. Perform the version-controlled upgrade.
55+
1. Perform the version-controlled upgrade.
5656

5757
- Debian, Ubuntu, Deb-Based
58-
58+
5959
```shell
6060
sudo apt-get update
6161
sudo apt-get install -y nginx-agent=<specific-version> -o Dpkg::Options::="--force-confold"
6262
```
63-
64-
Example (to upgrade to version 2.41.1~noble):
65-
63+
64+
Example (to upgrade to version 2.41.1~noble):
65+
6666
```shell
6767
sudo apt-get install -y nginx-agent=2.41.1~noble -o Dpkg::Options::="--force-confold"
6868
```
6969

70-
- CentOS, RHEL, RPM-Based
71-
70+
- CentOS, RHEL, RPM-Based
71+
7272
```shell
7373
sudo yum install -y nginx-agent-<specific-version>
7474
```
75-
76-
Example (to upgrade to version `2.41.1`):
77-
75+
76+
Example (to upgrade to version `2.41.1`):
77+
7878
```shell
7979
sudo yum install -y nginx-agent-2.41.1
8080
```
8181

82-
1. Verify the installed version:
83-
82+
1. Verify the installed version:
83+
8484
```shell
8585
sudo nginx-agent --version
8686
```

‎content/agent/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Overview
33
draft: false
44
weight: 100
55
toc: true
6-
docs: DOCS-1091
6+
nd-docs: DOCS-1091
77
type:
88
- how-to
99
---

‎content/agent/technical-specifications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Technical specifications
33
draft: false
44
weight: 200
55
toc: true
6-
docs: DOCS-1092
6+
nd-docs: DOCS-1092
77
type:
88
- how-to
99
---
@@ -12,12 +12,12 @@ type:
1212

1313
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
1414

15-
## NGINX Agent v3.0 Compatibility
15+
## NGINX Agent v3.0 Compatibility
1616
{{< bootstrap-table "table table-striped table-bordered" >}}
1717
| NGINX Product | Agent Version |
1818
|------------------------------|----------------|
1919
| **NGINX One Console** | 2.x |
20-
| **NGINX Gateway Fabric** | 3.x |
20+
| **NGINX Gateway Fabric** | 3.x |
2121
| **NGINX Plus** | 2.x, 3.x |
2222
| **NGINX Ingress Controller** | 2.x |
2323
| **NGINX Instance Manager** | 2.x |

‎content/amplify/additional-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Other NGINX Amplify Resources
33
weight: 899
44
toc: true
5-
docs: DOCS-977
5+
nd-docs: DOCS-977
66
---
77

88
If you are interested in learning more about F5 NGINX Amplify, visit the [NGINX Amplify Resources Page](https://amplify.nginx.com/docs/), where you will find links to:

‎content/amplify/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Changelog
33
description: These release notes list and describe the new features, enhancements, and resolved issues in F5 NGINX Amplify
44
weight: 900
55
toc: true
6-
docs: DOCS-1691
6+
nd-docs: DOCS-1691
77
---
88

99
## Sept 21, 2023

‎content/amplify/faq/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: General
33
description: General questions about F5 NGINX Amplify
44
weight: 10
55
toc: true
6-
docs: DOCS-956
6+
nd-docs: DOCS-956
77
---
88

99
### What Is F5 NGINX Amplify?

‎content/amplify/faq/metrics-and-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Amplify Metrics and Metadata
33
description: Questions about F5 NGINX Amplify's Metrics and Metadata
44
weight: 40
55
toc: true
6-
docs: DOCS-957
6+
nd-docs: DOCS-957
77
---
88

99
### What Data Does F5 NGINX Amplify Agent Gather?

‎content/amplify/faq/nginx-amplify-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Amplify Agent
33
description: Questions about F5 NGINX Amplify Agent
44
weight: 20
55
toc: true
6-
docs: DOCS-958
6+
nd-docs: DOCS-958
77
---
88

99
### What Operating Systems are Supported?

‎content/amplify/faq/user-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Amplify User Interface
33
description: Questions about F5 NGINX Amplify's User Interface
44
weight: 30
55
toc: true
6-
docs: DOCS-959
6+
nd-docs: DOCS-959
77
---
88

99
### What Browsers are Supported?

‎content/amplify/known-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Known Issues
33
weight: 1000
44
description: List of known issues in the latest release of F5 NGINX Amplify
55
toc: true
6-
docs: DOCS-1692
6+
nd-docs: DOCS-1692
77
---
88

99
{{<rn-styles>}}

‎content/amplify/metrics-metadata/metrics-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Metrics and Metadata Overview
33
description: Learn about the metrics and metadata F5 NGINX Amplify collects.
44
weight: 10
55
toc: true
6-
docs: DOCS-972
6+
nd-docs: DOCS-972
77
---
88

99
Most metrics are collected by F5 NGINX Amplify Agent without requiring the user to perform any additional setup. For troubleshooting, see [Troubleshooting Metrics Collection]({{< ref "/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md" >}}).

‎content/amplify/metrics-metadata/nginx-metrics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: NGINX Metrics
33
description: List of NGINX Metrics
44
weight: 30
55
toc: true
6-
docs: DOCS-973
6+
nd-docs: DOCS-973
77
---
88

99
## HTTP Connections and Requests
@@ -48,7 +48,7 @@ docs: DOCS-973
4848

4949
```
5050
Type: gauge, integer
51-
Description: Number of currently active requests (reading and writing).
51+
Description: Number of currently active requests (reading and writing).
5252
Number of requests reading headers or writing responses to clients.
5353
Source: stub_status (or NGINX Plus status API)
5454
```
@@ -127,7 +127,7 @@ docs: DOCS-973
127127

128128
```
129129
Type: counter, integer
130-
Description: Number of requests finalized with status code 499 which is
130+
Description: Number of requests finalized with status code 499 which is
131131
logged when the client closes the connection.
132132
Source: access.log
133133
```
@@ -213,7 +213,7 @@ docs: DOCS-973
213213

214214
```
215215
Type: gauge, integer
216-
Description: Hard limit on the number of file descriptors as seen
216+
Description: Hard limit on the number of file descriptors as seen
217217
by NGINX worker processes.
218218
```
219219

0 commit comments

Comments
 (0)