Skip to content

Commit b7dcd95

Browse files
JTorreGJTorreG
authored
docs: Agent v3 docs to includes (#418)
* docs: move agent content to includes and n1 * fix: move agent section * fix: relref to ref
1 parent ce1b12d commit b7dcd95

Some content is hidden

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

57 files changed

+1688
-1114
lines changed

‎content/agent/about.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ The F5 NGINX Agent is a lightweight companion daemon designed to work with NGINX
1414

1515
- Enable Access to Key NGINX One Use Cases
1616
- Seamlessly integrates with essential NGINX One functionality, simplifying access to its core use cases and enhancing operational workflows.
17-
- [Connect to NGINX One Console]({{< relref "/agent/install-upgrade/install/#connect-an-instance-to-nginx-one-console" >}})
17+
- [Connect to NGINX One Console]({{< ref "/agent/install-upgrade/install-from-oss-repo.md#connect-an-instance-to-nginx-one-console" >}})
1818

1919
- Real-Time Observability into NGINX One Data Plane Instances
2020
- Provides live monitoring and actionable insights into the performance, status, and health of NGINX One Data Plane instances, improving decision-making and operational efficiency.
2121

22-
- [OpenTelemetry](https://opentelemetry.io/) support comes with F5 NGINX Agent, and the ability to [export the metrics data]({{< relref "/agent/otel/configure-otel-metrics.md" >}}) for use in other applications.
22+
- [OpenTelemetry](https://opentelemetry.io/) support comes with F5 NGINX Agent, and the ability to [export the metrics data]({{< ref "/agent/otel/configure-otel-metrics.md" >}}) for use in other applications.
2323

2424

2525

‎content/agent/changelog.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ toc: true
66

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

9-
See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< relref "./technical-specifications.md" >}}).
9+
See the list of supported Operating Systems and architectures in the [Technical Specifications]({{< ref "./tech-specs.md" >}}).
1010

1111
---
1212
## Release [v3.0.0](https//github.com/nginx/agent/releases/tag/v3.0.0)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Ubuntu is the recommended operating system for development, as it comes with mos
1717

1818
To begin this task, you will require the following:
1919

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

@@ -29,7 +29,7 @@ git clone [email protected]:nginx/agent.git
2929

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

32-
Follow the steps in the [Installation]({{< relref "/agent/install-upgrade/install.md" >}}) topic to install NGINX Agent.
32+
Follow the steps in the [Installation]({{< ref "/agent/install-upgrade/" >}}) topic to install NGINX Agent.
3333

3434
## Install prerequisite packages
3535
Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.

‎content/agent/contribute/start-mock-interface.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The mock interface is useful when developing NGINX Agent, as it allows you to vi
1313

1414
To begin this task, you will require the following:
1515

16-
- A [working NGINX Agent instance]({{< relref "/agent/install-upgrade/install.md" >}}).
16+
- A [working NGINX Agent instance]({{< ref "/agent/install-upgrade/" >}}).
1717
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
1818
- A [go-swagger](https://goswagger.io/go-swagger/install/) installation.
1919

@@ -39,7 +39,7 @@ INFO[0000] grpc listening at 54789 # grpc control plane port which NGINX Agent w
3939

4040
The mock control plane can use either gRPC or REST protocols to communicate with NGINX Agent.
4141

42-
To enable them, view the [Enable gRPC and REST interfaces]({{< relref "/agent/how-to/enable-interfaces.md" >}}) topic.
42+
To enable them, view the [Enable gRPC and REST interfaces]({{< ref "/agent/how-to/enable-interfaces.md" >}}) topic.
4343

4444
## Launch Swagger UI
4545

‎content/agent/how-to/enable-interfaces.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ api:
7070

7171
To apply the new configuration, NGINX Agent must be started or restarted.
7272

73-
You may want to view the [Start mock control plane interface]({{< relref "/agent/contribute/start-mock-interface.md" >}}) topic to test NGINX Agent, or view the [Configuration overview]({{< relref "/agent/how-to/configuration-overview.md" >}}) for more options.
73+
You may want to view the [Start mock control plane interface]({{< ref "/agent/contribute/start-mock-interface.md" >}}) topic to test NGINX Agent, or view the [Configuration overview]({{< ref "/agent/how-to/configuration-overview.md" >}}) for more options.

‎content/agent/install-upgrade/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Install and upgrade"
2+
title: "Install and update"
33
weight: 400
44
url: /nginx-agent/install-upgrade/
55
---

‎content/agent/install-upgrade/install-from-github.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Install from GitHub package files
3+
toc: true
4+
weight: 300
5+
docs: DOCS-000
6+
---
7+
8+
{{< note>}}
9+
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
10+
to manage your NGINX instances, NGINX Agent is installed automatically when you
11+
add an NGINX instance to NGINX One Console.
12+
13+
For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< ref "/nginx-one/how-to/nginx-configs/add-instance" >}})
14+
{{< /note >}}
15+
16+
Follow the steps in this guide to install NGINX Agent in your NGINX instance using
17+
GitHub package files.
18+
19+
## Before you begin
20+
21+
{{< include "/agent/installation/prerequisites.md" >}}
22+
23+
## GitHub package files
24+
25+
To install NGINX Agent on your system using GitHub package files, go to the
26+
[GitHub releases page](https://github.com/nginx/agent/releases) and download the
27+
latest package supported by your operating system distribution and CPU architecture.
28+
29+
Use your system's package manager to install the package. Some examples:
30+
31+
- Debian, Ubuntu, and other distributions using the `dpkg` package manager.
32+
33+
```shell
34+
sudo dpkg -i nginx-agent-<agent-version>.deb
35+
```
36+
37+
- RHEL, CentOS RHEL, Amazon Linux, Oracle Linux, and other distributions using
38+
the `yum` package manager
39+
40+
```shell
41+
sudo yum localinstall nginx-agent-<agent-version>.rpm
42+
```
43+
44+
- RHEL and other distributions using the `rpm` package manager
45+
46+
```shell
47+
sudo rpm -i nginx-agent-<agent-version>.rpm
48+
```
49+
50+
- Alpine Linux
51+
52+
```shell
53+
sudo apk add nginx-agent-<agent-version>.apk
54+
```
55+
56+
- FreeBSD
57+
58+
```shell
59+
sudo pkg add nginx-agent-<agent-version>.pkg
60+
```
61+
62+
### Manually connect NGINX Agent to NGINX One Console
63+
64+
{{< include "agent/installation/manually-connect-to-console" >}}
65+
66+
## Start, stop, and enable NGINX Agent
67+
68+
{{< include "/agent/installation/start-stop-agent.md" >}}
69+
70+
## Verify that NGINX Agent is running
71+
72+
{{< include "/agent/installation/verify-agent.md" >}}

‎content/agent/install-upgrade/install-from-oss-repo.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Install from Open Source repo
3+
toc: true
4+
weight: 100
5+
docs: DOCS-000
6+
---
7+
8+
{{< note>}}
9+
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
10+
to manage your NGINX instances, NGINX Agent is installed automatically when you
11+
add an NGINX instance to NGINX One Console.
12+
13+
For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< ref "/nginx-one/how-to/nginx-configs/add-instance" >}})
14+
{{< /note >}}
15+
16+
## Overview
17+
18+
Follow the steps in this guide to install NGINX Agent in your NGINX instance using
19+
the NGINX Open Source repository.
20+
21+
## Before you begin
22+
23+
{{< include "/agent/installation/prerequisites.md" >}}
24+
25+
## Manual installation using the NGINX Open Source repository
26+
27+
Before you install NGINX Agent for the first time on your system, you need to set
28+
up the `nginx-agent` packages repository. Afterward, you can install and update
29+
NGINX Agent from the repository.
30+
31+
<details>
32+
<summary>{{< fa "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
33+
34+
### Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux
35+
36+
{{< include "/agent/installation/oss/oss-rhel.md" >}}
37+
38+
</details>
39+
40+
<details>
41+
<summary>{{< fa "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
42+
43+
### Install NGINX Agent on Ubuntu
44+
45+
{{< include "/agent/installation/oss/oss-ubuntu.md" >}}
46+
47+
</details>
48+
49+
<details>
50+
<summary>{{< fa "brands fa-debian" >}} Install NGINX Agent on Debian</summary>
51+
52+
### Install NGINX Agent on Debian
53+
54+
{{< include "/agent/installation/oss/oss-debian.md" >}}
55+
56+
</details>
57+
58+
<details>
59+
<summary>{{< fa "brands fa-suse" >}} Install NGINX Agent on SLES</summary>
60+
61+
### Install NGINX Agent on SLES
62+
63+
{{< include "/agent/installation/oss/oss-sles.md" >}}
64+
65+
</details>
66+
67+
<details>
68+
<summary>{{< fa "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>
69+
70+
### Install NGINX Agent on Alpine Linux
71+
72+
{{< include "/agent/installation/oss/oss-alpine.md" >}}
73+
74+
</details>
75+
76+
<details>
77+
<summary>{{< fa "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>
78+
79+
### Install NGINX Agent on Amazon Linux
80+
81+
{{< include "/agent/installation/oss/oss-amazon-linux.md" >}}
82+
83+
</details>
84+
<details>
85+
<summary>{{< fa "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>
86+
87+
### Install NGINX Agent on FreeBSD
88+
89+
{{< include "/agent/installation/oss/oss-freebsd.md" >}}
90+
91+
</details>
92+
93+
### Manually connect NGINX Agent to NGINX One Console
94+
95+
{{< include "agent/installation/manually-connect-to-console" >}}
96+
97+
## Start, stop, and enable NGINX Agent
98+
99+
{{< include "/agent/installation/start-stop-agent.md" >}}
100+
101+
## Verify that NGINX Agent is running
102+
103+
{{< include "/agent/installation/verify-agent.md" >}}

‎content/agent/install-upgrade/install-from-plus-repo.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Install from NGINX Plus repo
3+
toc: true
4+
weight: 200
5+
docs: DOCS-000
6+
---
7+
8+
{{< note>}}
9+
If you are using [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}})
10+
to manage your NGINX instances, NGINX Agent is installed automatically when you
11+
add an NGINX instance to NGINX One Console.
12+
13+
For a quick guide on how to connect your instance to NGINX One Console see: [Connect to NGINX One Console]({{< ref "/nginx-one/how-to/nginx-configs/add-instance" >}})
14+
{{< /note >}}
15+
16+
## Overview
17+
18+
Follow the steps in this guide to install NGINX Agent in your NGINX instance using
19+
the NGINX Plus repository.
20+
21+
## Before you begin
22+
23+
{{< include "/agent/installation/prerequisites.md" >}}
24+
25+
## Manual installation using the NGINX Plus repository
26+
27+
Before you install NGINX Agent for the first time on your system, you need to
28+
set up the `nginx-agent` packages repository. Afterward, you can install and update
29+
NGINX Agent from the repository.
30+
31+
32+
<details>
33+
<summary>{{< fa "brands fa-centos" >}} Install NGINX Agent on RHEL, CentOS, Rocky Linux, AlmaLinux, and Oracle Linux</summary>
34+
35+
### 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>
36+
37+
{{< include "/agent/installation/plus/plus-rhel.md" >}}
38+
39+
</details>
40+
41+
<details>
42+
<summary>{{< fa "brands fa-ubuntu" >}} Install NGINX Agent on Ubuntu</summary>
43+
44+
### Install NGINX Agent on Ubuntu<a name="install-nginx-agent-on-ubuntu-plus"></a>
45+
46+
{{< include "/agent/installation/plus/plus-ubuntu.md" >}}
47+
48+
</details>
49+
50+
<details>
51+
<summary>{{< fa "brands fa-debian" >}} Install NGINX Agent on Debian</summary>
52+
53+
### Install NGINX Agent on Debian<a name="install-nginx-agent-on-debian-plus"></a>
54+
55+
{{< include "/agent/installation/plus/plus-debian.md" >}}
56+
57+
</details>
58+
59+
<details>
60+
<summary>{{< fa "brands fa-suse" >}} Install NGINX Agent on SLES</summary>
61+
62+
### Install NGINX Agent on SLES<a name="install-nginx-agent-on-sles-plus"></a>
63+
64+
{{< include "/agent/installation/plus/plus-sles.md" >}}
65+
66+
</details>
67+
68+
<details>
69+
<summary>{{< fa "solid fa-mountain-sun" >}} Install NGINX Agent on Alpine Linux</summary>
70+
71+
### Install NGINX Agent on Alpine Linux<a name="install-nginx-agent-on-alpine-linux-plus"></a>
72+
73+
{{< include "/agent/installation/plus/plus-alpine.md" >}}
74+
75+
</details>
76+
<details>
77+
<summary>{{< fa "brands fa-aws" >}} Install NGINX Agent on Amazon Linux</summary>
78+
79+
### Install NGINX Agent on Amazon Linux<a name="install-nginx-agent-on-amazon-linux-plus"></a>
80+
81+
{{< include "/agent/installation/plus/plus-amazon-linux.md" >}}
82+
83+
</details>
84+
85+
<details>
86+
<summary>{{< fa "brands fa-freebsd" >}} Install NGINX Agent on FreeBSD</summary>
87+
88+
### Install NGINX Agent on FreeBSD<a name="install-nginx-agent-on-freebsd-plus"></a>
89+
90+
{{< include "/agent/installation/plus/plus-freebsd.md" >}}
91+
92+
</details>
93+
94+
### Manually connect NGINX Agent to NGINX One Console
95+
96+
{{< include "agent/installation/manually-connect-to-console" >}}
97+
98+
## Start, stop, and enable NGINX Agent
99+
100+
{{< include "/agent/installation/start-stop-agent.md" >}}
101+
102+
## Verify that NGINX Agent is running
103+
104+
{{< include "/agent/installation/verify-agent.md" >}}

0 commit comments

Comments
 (0)