Skip to content

Commit a31b2eb

Browse files
committed
chore: Refactored icon usage to use new shortcode
1 parent 2782905 commit a31b2eb

File tree

16 files changed

+131
-49
lines changed

16 files changed

+131
-49
lines changed

_banners/agent-v3-release.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
22

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

4-
F5 NGINX One Console and NGINX Instance Manager (NIM) do not currently support Agent 3.x. If you are using NGINX One Console or NGINX Instance Manager in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
5+
F5 NGINX Instance Manager (NIM) does not currently support NGINX Agent 3.x. NGINX Instance Manager customers can upgrade to the latest NGINX Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
56

67
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
78

content/includes/agent/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Additionally, it collects system-level data, including CPU usage, memory consump
4040
deep observability into NGINX's behavior, enabling teams to troubleshoot issues effectively, optimize performance, and
4141
maintain high availability.
4242

43-
Collected metrics can be seamlessly exported to NGINX One Console or integrated with third-party data aggregators.
43+
By default, the OpenTelemetry Collector is configured to send metrics to NGINX One Console.

content/nginx-one/agent/containers/run-agent-container.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,10 @@ container image and create a configuration file.
2929

3030
### Pull the NGINX Agent container image
3131

32-
The NGINX Agent container image must be downloaded from a trusted source such as Docker Hub or a private container registry.
33-
3432
Run the following command to pull the official image:
3533

3634
```bash
37-
<!-- Registry HERE -->
38-
docker pull <Registry HERE>:latest
35+
docker pull private-registry.nginx.com/nginx-plus/agentv3:latest
3936
```
4037

4138
Ensure you are using the correct image version. Replace `latest` with the desired version tag if necessary.

content/nginx-one/agent/install-upgrade/install-from-oss-repo.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ up the `nginx-agent` packages repository. Afterward, you can install and update
3030
NGINX Agent from the repository.
3131

3232
<details>
33-
<summary>{{< icon "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
33+
<summary>{{< icon "brands centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
3434

3535
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
3636

@@ -39,7 +39,7 @@ NGINX Agent from the repository.
3939
</details>
4040

4141
<details>
42-
<summary>{{< icon "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
42+
<summary>{{< icon "brands ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
4343

4444
### Install NGINX Agent on Ubuntu
4545

@@ -48,7 +48,7 @@ NGINX Agent from the repository.
4848
</details>
4949

5050
<details>
51-
<summary>{{< icon "brands fa-debian" >}} Install NGINX Agent on Debian</summary>
51+
<summary>{{< icon "brands debian" >}} Install NGINX Agent on Debian</summary>
5252

5353
### Install NGINX Agent on Debian
5454

@@ -57,7 +57,7 @@ NGINX Agent from the repository.
5757
</details>
5858

5959
<details>
60-
<summary>{{< icon "brands fa-suse" >}} Install NGINX Agent on SLES</summary>
60+
<summary>{{< icon "brands suse" >}} Install NGINX Agent on SLES</summary>
6161

6262
### Install NGINX Agent on SLES
6363

@@ -66,7 +66,7 @@ NGINX Agent from the repository.
6666
</details>
6767

6868
<details>
69-
<summary>{{< icon "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>
69+
<summary>{{< icon "brands alpine" >}} Install NGINX Agent on Alpine Linux</summary>
7070

7171
### Install NGINX Agent on Alpine Linux
7272

@@ -75,15 +75,15 @@ NGINX Agent from the repository.
7575
</details>
7676

7777
<details>
78-
<summary>{{< icon "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>
78+
<summary>{{< icon "brands aws" >}} Install NGINX Agent on Amazon Linux</summary>
7979

8080
### Install NGINX Agent on Amazon Linux
8181

8282
{{< include "/agent/installation/oss/oss-amazon-linux.md" >}}
8383

8484
</details>
8585
<details>
86-
<summary>{{< icon "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>
86+
<summary>{{< icon "brands freebsd" >}} Install NGINX Agent on FreeBSD</summary>
8787

8888
### Install NGINX Agent on FreeBSD
8989

content/nginx-one/agent/install-upgrade/install-from-plus-repo.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NGINX Agent from the repository.
3131

3232

3333
<details>
34-
<summary>{{< icon "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
34+
<summary>{{< icon "brands centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
3535

3636
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux<a name="install-nginx-agent-on-rhel-centos-rocky-linux-almalinux-and-oracle-linux-plus"></a>
3737

@@ -40,7 +40,7 @@ NGINX Agent from the repository.
4040
</details>
4141

4242
<details>
43-
<summary>{{< icon "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
43+
<summary>{{< icon "brands ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
4444

4545
### Install NGINX Agent on Ubuntu<a name="install-nginx-agent-on-ubuntu-plus"></a>
4646

@@ -49,7 +49,7 @@ NGINX Agent from the repository.
4949
</details>
5050

5151
<details>
52-
<summary>{{< icon "brands fa-debian" >}} Install NGINX Agent on Debian</summary>
52+
<summary>{{< icon "brands debian" >}} Install NGINX Agent on Debian</summary>
5353

5454
### Install NGINX Agent on Debian<a name="install-nginx-agent-on-debian-plus"></a>
5555

@@ -58,7 +58,7 @@ NGINX Agent from the repository.
5858
</details>
5959

6060
<details>
61-
<summary>{{< icon "brands fa-suse" >}} Install NGINX Agent on SLES</summary>
61+
<summary>{{< icon "brands suse" >}} Install NGINX Agent on SLES</summary>
6262

6363
### Install NGINX Agent on SLES<a name="install-nginx-agent-on-sles-plus"></a>
6464

@@ -67,15 +67,15 @@ NGINX Agent from the repository.
6767
</details>
6868

6969
<details>
70-
<summary>{{< icon "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>
70+
<summary>{{< icon "brands alpine" >}} Install NGINX Agent on Alpine Linux</summary>
7171

7272
### Install NGINX Agent on Alpine Linux<a name="install-nginx-agent-on-alpine-linux-plus"></a>
7373

7474
{{< include "/agent/installation/plus/plus-alpine.md" >}}
7575

7676
</details>
7777
<details>
78-
<summary>{{< icon "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>
78+
<summary>{{< icon "brands aws" >}} Install NGINX Agent on Amazon Linux</summary>
7979

8080
### Install NGINX Agent on Amazon Linux<a name="install-nginx-agent-on-amazon-linux-plus"></a>
8181

@@ -84,7 +84,7 @@ NGINX Agent from the repository.
8484
</details>
8585

8686
<details>
87-
<summary>{{< icon "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>
87+
<summary>{{< icon "brands freebsd" >}} Install NGINX Agent on FreeBSD</summary>
8888

8989
### Install NGINX Agent on FreeBSD<a name="install-nginx-agent-on-freebsd-plus"></a>
9090

content/nginx-one/agent/install-upgrade/uninstall.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The user following performing the uninstall steps needs to have `root` privilege
1919
Complete the following steps on each host where you've installed NGINX Agent
2020

2121
<details>
22-
<summary>{{< icon "brands fa-centos" >}} Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
22+
<summary>{{< icon "brands centos" >}} Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
2323

2424
### Uninstall NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
2525

@@ -28,7 +28,7 @@ Complete the following steps on each host where you've installed NGINX Agent
2828
</details>
2929

3030
<details>
31-
<summary>{{< icon "brands fa-ubuntu" >}} Uninstall NGINX Agent on Ubuntu</summary>
31+
<summary>{{< icon "brands ubuntu" >}} Uninstall NGINX Agent on Ubuntu</summary>
3232

3333
### Uninstall NGINX Agent on Ubuntu
3434

@@ -37,7 +37,7 @@ Complete the following steps on each host where you've installed NGINX Agent
3737
</details>
3838

3939
<details>
40-
<summary>{{< icon "brands fa-debian" >}} Uninstall NGINX Agent on Debian</summary>
40+
<summary>{{< icon "brands debian" >}} Uninstall NGINX Agent on Debian</summary>
4141

4242
### Uninstall NGINX Agent on Debian
4343

@@ -46,7 +46,7 @@ Complete the following steps on each host where you've installed NGINX Agent
4646
</details>
4747

4848
<details>
49-
<summary>{{< icon "brands fa-suse" >}} Uninstall NGINX Agent on SLES</summary>
49+
<summary>{{< icon "brands suse" >}} Uninstall NGINX Agent on SLES</summary>
5050

5151
### Uninstall NGINX Agent on SLES
5252

@@ -55,7 +55,7 @@ Complete the following steps on each host where you've installed NGINX Agent
5555
</details>
5656

5757
<details>
58-
<summary>{{< icon "solid fa-mountain-sun" >}} Uninstall NGINX Agent on Alpine Linux</summary>
58+
<summary>{{< icon "brands alpine" >}} Uninstall NGINX Agent on Alpine Linux</summary>
5959

6060
### Uninstall NGINX Agent on Alpine Linux
6161

@@ -64,7 +64,7 @@ Complete the following steps on each host where you've installed NGINX Agent
6464
</details>
6565

6666
<details>
67-
<summary>{{< icon "brands fa-aws" >}} Uninstall NGINX Agent on Amazon Linux</summary>
67+
<summary>{{< icon "brands aws" >}} Uninstall NGINX Agent on Amazon Linux</summary>
6868

6969
### Uninstall NGINX Agent on Amazon Linux
7070

@@ -73,7 +73,7 @@ Complete the following steps on each host where you've installed NGINX Agent
7373
</details>
7474

7575
<details>
76-
<summary>{{< icon "brands fa-freebsd" >}} Uninstall NGINX Agent on FreeBSD</summary>
76+
<summary>{{< icon "brands freebsd" >}} Uninstall NGINX Agent on FreeBSD</summary>
7777

7878
### Uninstall NGINX Agent on FreeBSD
7979

content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ sudo docker login private-registry.nginx.com --username=YOUR_JWT_HERE --password
4242

4343
### Pull the NGINX Plus image
4444

45-
Pull the NGINX Plus image from the private registry. Replace `VERSION_TAG` with the desired version, such as `alpine`, `debian`, or `ubi`.
45+
Pull the NGINX Plus image from the private registry. Replace `<version-tag>` with the desired version, such as `alpine`, `debian`, or `ubi`.
4646

4747
```sh
48-
sudo docker pull private-registry.nginx.com/nginx-plus/agent:VERSION_TAG
48+
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
4949
```
5050

51-
You must specify a version tag. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
51+
You must specify a version tag that matches your distribution. The `latest` tag is not supported. Learn more in the [Deploying NGINX and NGINX Plus on Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}) guide.
5252

5353
<br>
5454

@@ -62,7 +62,7 @@ sudo docker pull private-registry.nginx.com/nginx-plus/agent:debian
6262

6363
### Start the NGINX Plus container
6464

65-
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `VERSION_TAG` with the version tag you pulled.
65+
Start the Docker container to connect it to NGINX One. Replace `YOUR_NGINX_ONE_DATA_PLANE_KEY_HERE` with your data plane key and `version-tag` with the version tag you pulled.
6666

6767
**For NGINX Plus R33 or later**:
6868

@@ -79,7 +79,7 @@ sudo docker run \
7979
--env=NGINX_AGENT_TLS_ENABLE=true \
8080
--restart=always \
8181
--runtime=runc \
82-
-d private-registry.nginx.com/nginx-plus/agent:<VERSION_TAG>
82+
-d private-registry.nginx.com/nginx-plus/agent:<version-tag>
8383
```
8484

8585
<br>

content/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,14 +162,9 @@ When adding a new NGINX instance that is not yet registered with NGINX One, you
162162
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
163163
- After selecting the OS, run the provided command to pull the Docker image.
164164

165-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
165+
**Note**: Subject to availability, you can modify the `agentv3:<version-tag>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agentv3:r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
166166

167167

168-
- From the **OS Type** list, choose the appropriate operating system for your Docker image.
169-
- After selecting the OS, run the provided command to pull the Docker image.
170-
171-
**Note**: Subject to availability, you can modify the `agent: <VERSION_TAG>` to match the specific NGINX Plus version, OS type, and OS version you need. For example, you might use `agent: r32-ubi-9`. For more details on version tags and how to pull an image, see [Deploying NGINX and NGINX Plus on Docker]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-docker.md#pull-the-image" >}}).
172-
173168
10. Run the provided command, which includes the data plane key, in your NGINX instance terminal to start the Docker container.
174169

175170
11. Select **Done** to complete the process.

content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,24 +156,36 @@ For NGINX Plus, run:
156156
docker pull private-registry.nginx.com/nginx-plus/base:<version-tag>
157157
```
158158

159-
For NGINX Plus with NGINX Agent, run:
159+
For NGINX Plus with NGINX Agent version 2, run:
160160

161161
```shell
162162
docker pull private-registry.nginx.com/nginx-plus/agent:<version-tag>
163163
```
164164

165+
For NGINX Plus with NGINX Agent version 3, run:
166+
167+
```shell
168+
docker pull private-registry.nginx.com/nginx-plus/agentv3:<version-tag>
169+
```
170+
165171
For NGINX Plus installed from `nginx` user (rootless installation), run:
166172

167173
```shell
168174
docker pull private-registry.nginx.com/nginx-plus/rootless-base:<version-tag>
169175
```
170176

171-
For NGINX Plus with NGINX Agent installed from `nginx` user (rootless installation), run:
177+
For NGINX Plus with NGINX Agent version 2 installed from `nginx` user (rootless installation), run:
172178

173179
```shell
174180
docker pull private-registry.nginx.com/nginx-plus/rootless-agent:<version-tag>
175181
```
176182

183+
For NGINX Plus with NGINX Agent version 3 installed from `nginx` user (rootless installation), run:
184+
185+
```shell
186+
docker pull private-registry.nginx.com/nginx-plus/rootless-agentv3:<version-tag>
187+
```
188+
177189
For NGINX modules, run:<!-- Is this enough info?-->
178190

179191
```shell

content/nic/configuration/policy-resource.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,14 @@ condition:
175175
|Field | Description | Type | Required |
176176
| ---| ---| ---| --- |
177177
|``jwt`` | defines a JWT condition to rate limit against. | [ratelimit.condition.jwt](#ratelimitconditionjwt) | No |
178-
|``default`` | sets the rate limit in this policy to be the default if no conditions are met. In a group of policies with the same JWT condition, only one policy can be the default. | ``bool`` | No |
178+
|``variables`` | defines a Variable condition to rate limit against. | [ratelimit.condition.variables](#ratelimitconditionvariables) | No |
179+
|``default`` | sets the rate limit in this policy to be the default if no conditions are met. In a group of policies with the same condition, only one policy can be the default. | ``bool`` | No |
179180
{{% /table %}}
181+
{{< note >}}
182+
183+
One condition of type `jwt` or `variables` is required. Each Policy supports only one condition.
184+
185+
{{< /note >}}
180186

181187
The rate limit policy with condition is designed to be used in combination with one or more rate limit policies. For example, multiple rate limit policies with [RateLimit.Condition.JWT](#ratelimitconditionjwt) can be used to apply different tiers of rate limit based on the value of a JWT claim. For a practical example of tiered rate limiting by the value of a JWT claim, see the example in our [GitHub repository](https://github.com/nginx/kubernetes-ingress/tree/v{{< nic-version >}}/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md).
182188

@@ -213,6 +219,27 @@ The rate limit policy will only apply to requests that contain a JWT with the sp
213219
|``match`` | the value of the claim to match against. | ``string`` | Yes |
214220
{{% /table %}}
215221

222+
### RateLimit.Condition.Variables
223+
224+
RateLimit.Condition.Variables defines a condition for a rate limit by NGINX variable. The following example defines a condition for a rate limit policy that only applies to requests with the request method with a value `GET`:
225+
226+
```yaml
227+
variables:
228+
- name: $request_method
229+
match: GET
230+
```
231+
232+
{{< note >}}
233+
Only one variable at a time is supported at present.
234+
{{< /note >}}
235+
236+
{{% table %}}
237+
|Field | Description | Type | Required |
238+
| ---| ---| ---| --- |
239+
|``name`` | the name of the NGINX variable to be rate limit by. | ``string`` | Yes |
240+
|``match`` | the value of the NGINX variable to match against. Values prefixed with the `~` character denote the following is a [regular expression](https://nginx.org/en/docs/http/ngx_http_map_module.html#map). | ``string`` | Yes |
241+
{{% /table %}}
242+
216243
### APIKey
217244

218245
The API Key auth policy configures NGINX to authorize client requests based on the presence of a valid API Key in a header or query param specified in the policy.

0 commit comments

Comments
 (0)