Skip to content

Commit a780db4

Browse files
authored
Agent release 3.0 (#567)
- Adds the Agent 3.x documentation under the NGINX One docset - Updates the Agent 2.x documentation
1 parent 528efdd commit a780db4

File tree

99 files changed

+2425
-583
lines changed

Some content is hidden

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

99 files changed

+2425
-583
lines changed

content/agent/overview.md renamed to content/agent/about.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
2-
title: Overview
2+
title: About
33
draft: false
44
weight: 100
55
toc: true
66
nd-docs: DOCS-1091
7-
type:
8-
- how-to
7+
nd-content-type: how-to
98
---
109

1110
## Overview
1211

13-
NGINX Agent is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:
12+
NGINX Agent version 2 is a companion daemon for your NGINX Open Source or NGINX Plus instance. It enables:
1413

1514
- Remote management of NGINX configurations
1615
- Collection and reporting of real-time NGINX performance and operating system metrics
@@ -47,7 +46,6 @@ For NGINX Agent to work properly with an NGINX Plus instance, the API needs to b
4746
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:
4847

4948

50-
{{< raw-html>}}<div class="table-responsive">{{</raw-html>}}
5149
{{<bootstrap-table "table table-striped table-bordered">}}
5250
| Event | Description |
5351
| -------------------------------- | -------------------------------------------- |
@@ -64,6 +62,6 @@ NGINX Agent allows a gRPC connected control system to register a listener for a
6462
| CONFIG_ROLLBACK_SUCCESS_MESSAGE | Successfully rolled back NGINX configuration |
6563
| CONFIG_ROLLBACK_FAILURE_MESSAGE | Failed to roll back NGINX configuration |
6664
{{</bootstrap-table>}}
67-
{{< raw-html>}}</div>{{</raw-html>}}
65+
6866

6967

content/agent/changelog.md

Lines changed: 4 additions & 280 deletions
Large diffs are not rendered by default.

content/agent/community.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Community and contribution
3+
toc: true
4+
weight: 600
5+
nd-docs: DOCS-1884
6+
---
7+
8+
Discover the various ways you can participate in the F5 NGINX Agent project:
9+
10+
## Community
11+
12+
- Have questions or ideas to discuss? Join the conversation about NGINX Agent in the [NGINX Community Forum](https://community.nginx.org/).
13+
14+
## Contribute
15+
16+
Get involved with the project by contributing! Please see our [contributing guide](https://github.com/nginx/agent/blob/main/CONTRIBUTING.md) for details.
17+
18+
## License
19+
20+
[Apache License, Version 2.0](https://github.com/nginx/agent/blob/main/LICENSE)

content/agent/configuration/_index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2-
title: Configuration
3-
description: Learn how to configure NGINX Agent.
4-
weight: 400
2+
title: "Configuration"
3+
weight: "400"
54
url: /nginx-agent/configuration/
5+
cascade:
6+
logo: NGINX-product-icon.png
7+
layout: agent-v2-migration
68
---
9+
10+
Learn how to configure NGINX Agent.

content/agent/configuration/configuration-overview.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ draft: false
44
weight: 100
55
toc: true
66
nd-docs: DOCS-1229
7-
type:
8-
- how-to
7+
nd-content-type: how-to
98
---
109

1110
The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables.

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

Lines changed: 0 additions & 95 deletions
This file was deleted.

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Add NGINX users to nginx-agent Group
2+
title: "Add NGINX users to nginx-agent group"
33
draft: false
44
weight: 300
55
toc: true
66
nd-docs: DOCS-933
7-
type:
8-
- how-to
7+
nd-content-type: how-to
98
---
109

1110
## Overview

content/agent/configuration/health-checks.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: Health checks
33
draft: false
44
weight: 400
55
toc: true
6-
type:
7-
- how-to
6+
nd-content-type: how-to
87
nd-docs: DOCS-1677
98
---
109

content/agent/contribute/_index.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

content/agent/contribute/community.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,61 @@
11
---
2-
title: Development environment setup
3-
draft: false
4-
weight: 200
2+
title: "Development environment setup"
53
toc: true
64
nd-docs: DOCS-1088
7-
type:
8-
- how-to
5+
nd-content-type: how-to
96
---
107

118
## Overview
129

13-
Learn how to setup a Development Environment for NGINX Agent.
10+
This page describes how to configure a development environment for F5 NGINX Agent.
1411

15-
## Select an Operating System
12+
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.
1613

17-
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.
14+
Ubuntu is the recommended operating system for development, as it comes with most packages requires to build and run NGINX Agent.
1815

19-
## Install NGINX
16+
## Before you begin
2017

21-
Follow the steps in the [Installation]({{< ref "/agent/installation-upgrade/" >}}) section to download, install, and run NGINX and NGINX Agent.
18+
To begin this task, you will require the following:
2219

23-
## Clone the NGINX Agent Repository
20+
- A [working NGINX Agent instance]({{< ref "/nginx-one/agent/install-upgrade/" >}}).
21+
- A [Go installation](https://go.dev/dl/) of version 1.22.2 or newer.
22+
- A [Protocol Buffer Compiler](https://grpc.io/docs/protoc-installation/) installation.
2423

25-
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.
24+
You will also need a copy of the NGINX Agent repository, which you can clone using `git`:
2625

27-
## Installing Prerequisite Packages
26+
```shell
27+
git clone [email protected]:nginx/agent.git
28+
```
29+
30+
Read [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for more information
31+
32+
Follow the steps in the [Installation]({{< ref "/nginx-one/agent/install-upgrade/" >}}) topic to install NGINX Agent.
33+
34+
## Install prerequisite packages
2835
Depending on the operating system distribution, it may be necessary to install the following packages in order to build NGINX Agent.
2936

3037
Change to the NGINX Agent source directory:
31-
```bash
38+
```shell
3239
cd <path_to_development_directory>/agent
3340
```
3441

3542
Install Make:
36-
```bash
43+
```shell
3744
sudo apt install make
3845
```
3946

40-
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:
41-
```bash
42-
sudo apt install golang-go
43-
```
44-
45-
Install Protoc:
46-
```bash
47-
sudo apt install -y protobuf-compiler
48-
```
49-
5047
Install NGINX Agent tools and dependencies:
5148

5249
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:
53-
```bash
50+
```shell
5451
make install-tools deps
5552
```
5653

57-
## Building NGINX Agent from Source Code
54+
## Build NGINX Agent from source code
5855

5956
Run the following commands to build and run NGINX Agent:
6057

61-
```bash
58+
```shell
6259
make build
6360
sudo make run
6461
```

0 commit comments

Comments
 (0)