Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a docs page to explain NGINX Agent features #941

Merged
merged 14 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/content/configuration/configuration-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "How to configure NGINX Agent"
title: "Basic configuration"
draft: false
weight: 100
toc: true
Expand Down
95 changes: 95 additions & 0 deletions site/content/configuration/configure-nginx-agent-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: "Features configuration"
draft: false
weight: 150
toc: true
tags: [ "docs" ]
categories: ["configuration"]
doctypes: ["task"]
---

## Overview

This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file.

## Before you begin

Before you start, make sure that you have:

- NGINX Agent installed in your system.
- Access to the NGINX Agent configuration file.


## Features

The following table lists the NGINX Agent features.

{{<bootstrap-table "table table-striped table-bordered">}}
| **Feature Name** | **Description** | **Default/Non-default** |
| ------------- | ------------- | ------------- |
| registration | Registering the NGINX Agent with the management plane.| Default |
| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane.| Default |
| metrics | Enable collecting of NGINX metrics.| Default |
| metrics-throttle | Batch metrics before sending.| Non-default |
| metrics-sender | Reports metrics over the gRPC connection.| Non-default |
| dataplane-status | Report the health of the NGINX Instance.| Default |
| process-watcher | Observe changes to the NGINX process.| Default |
| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk.| Default |
| activity-events | Send NGINX or NGINX Agent related events to the management plane.| Default |
| agent-api | Enable the NGINX Agent REST API.| Default |
{{</bootstrap-table>}}

## Use Cases

### Enable metrics only
1. **Access the NGINX Instance:** SSH to the virtual machine/server where NGINX Agent is running.

```
ssh user@your-nginx-instance
```

2. **Edit NGINX Agent configuration:**

```
sudo vim /etc/nginx-agent/nginx-agent.conf
```

nginx-seanmoloney marked this conversation as resolved.
Show resolved Hide resolved
3. **Add Features section:** Add the following yaml to the end of the file:

nginx-seanmoloney marked this conversation as resolved.
Show resolved Hide resolved
```
features:
- metrics
- metrics-throttle
- dataplane-status
```

4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.

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.

### Enable the publishing of NGINX configurations and disable the collection of metrics.
1. **Access the NGINX Instance:** SSH to the virtual machine/server where NGINX Agent is running.

```
ssh user@your-nginx-instance
```

2. **Edit NGINX Agent configuration:**

```
sudo vim /etc/nginx-agent/nginx-agent.conf
```

3. **Add Features section:** Add the following yaml to the end of the file:

```
features:
- nginx-config-async
- dataplane-status
- file-watcher
```

4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.

Once the steps have been completed, users will be able to publish NGINX configurations but metrics data will not be collected by the NGINX Agent.

Loading