Skip to content

Commit 9628ae5

Browse files
JTorreGADubhlaoich
andauthored
docs: Agent/add missing doc (#1207)
* docs: add config agent features --------- Co-authored-by: Alan Dooley <[email protected]>
1 parent 2358d56 commit 9628ae5

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Review and configure features
3+
weight: 350
4+
toc: true
5+
nd-docs: DOCS-000
6+
nd-content-type: how-to
7+
---
8+
9+
## Overview
10+
11+
This guide describes the F5 NGINX Agent features, and how to enable and disable them using the NGINX Agent configuration file, CLI flags, environment variables, and gRPC updates.
12+
13+
## Before you begin
14+
15+
Before you start, make sure that you have:
16+
17+
- [NGINX Agent installed]({{< ref "/nginx-one/agent/install-upgrade/" >}}) in your system.
18+
- Access to the NGINX Agent configuration file, CLI, or container environment.
19+
20+
## Features
21+
22+
The following table lists the NGINX Agent features:
23+
24+
{{< table "features" >}}
25+
| Feature Name | Description | Default |
26+
| ------------------- | --------------------------------------------------------------------------- | ------- |
27+
| configuration | Full read/write management of configurations, controlled by DataPlaneConfig ConfigMode. | On |
28+
| certificates | Inclusion of public keys and other certificates in the configurations toggled by DataPlaneConfig CertMode | Off |
29+
| connection | Sends an initial connection message reporting instance information on presence of Command ServerConfig Host and Port | On |
30+
| file-watcher | Monitoring of file changes in the allowed directories list and references from product configs. | On |
31+
| agent-api | REST API for NGINX Agent. | Off |
32+
| metrics | Full metrics reporting. | On |
33+
| > metrics-host | Host-level metrics (cpu, disk, load, fs, memory, network, paging). | On |
34+
| > metrics-container | Container-level metrics from cgroup information. | On |
35+
| > metrics-instance | OSS and Plus metrics depending on NGINX instance. | On |
36+
| logs | Collection and reporting of NGINX error logs. | Off |
37+
| > logs-nap | F5 WAF for NGINX logs. | Off |
38+
{{< /table >}}
39+
40+
## Configuration sources
41+
42+
You can enable or disable features using several configuration sources:
43+
44+
### CLI parameters
45+
46+
Enable features at launch:
47+
48+
```shell
49+
./nginx-agent --features=connection,configuration,metrics,file-watcher,agent-api
50+
```
51+
52+
### Environment variables
53+
54+
Use environment variables for containerized deployments:
55+
56+
```shell
57+
export NGINX_AGENT_FEATURES="connection,configuration,metrics,file-watcher,agent-api"
58+
```
59+
60+
### Configuration file
61+
62+
Define features in the `nginx-agent.conf` file:
63+
64+
```yaml
65+
features:
66+
- connection
67+
- configuration
68+
- metrics
69+
- file-watcher
70+
- agent-api
71+
```
72+
73+
## Use cases
74+
75+
### Enable metrics only
76+
77+
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running.
78+
79+
`ssh user@your-nginx-instance`
80+
81+
1. Open the NGINX Agent configuration file in a text editor.
82+
83+
`sudo vim /etc/nginx-agent/nginx-agent.conf`
84+
85+
1. Add the features section: Add the following to the end of the configuration file if it doesn't already exist.
86+
87+
```yaml
88+
features:
89+
- metrics
90+
- metrics-host
91+
- metrics-container
92+
- metrics-instance
93+
```
94+
95+
1. Restart the NGINX Agent service to apply the changes.
96+
97+
`sudo systemctl restart nginx-agent`
98+
99+
Once the steps have been completed, users will be able to view metrics data being sent but will not have the capability to push NGINX configuration changes.
100+

0 commit comments

Comments
 (0)