generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 120
docs: re-add agent config doc #1161
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
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
90 changes: 90 additions & 0 deletions
90
content/agent/configuration/configure-nginx-agent-features.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
--- | ||
title: Features configuration | ||
draft: false | ||
weight: 150 | ||
toc: true | ||
nd-docs: DOCS-000 | ||
nd-content-type: how-to | ||
--- | ||
|
||
## 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]({{< ref "/agent/installation-upgrade/" >}}) in your system. | ||
- Access to the NGINX Agent configuration file. | ||
|
||
|
||
JTorreG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
## Features | ||
|
||
The following table lists the NGINX Agent features: | ||
|
||
{{< table "features" >}} | ||
| 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 | | ||
{{< /table >}} | ||
|
||
## Use cases | ||
|
||
### Enable metrics only | ||
|
||
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running. | ||
|
||
`ssh user@your-nginx-instance` | ||
|
||
1. Open the NGINX Agent configuration file in a text editor. | ||
|
||
`sudo vim /etc/nginx-agent/nginx-agent.conf` | ||
|
||
1. Add the fetures section: Add the following to the end of the configuration file if it doesn't already exist. | ||
JTorreG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```nginx | ||
features: | ||
- metrics | ||
- metrics-throttle | ||
- dataplane-status | ||
``` | ||
|
||
1. Restart the NGINX Agent service to apply the changes. | ||
|
||
`sudo systemctl restart nginx-agent` | ||
|
||
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: Connect using SSH to the VM or server where NGINX Agent is running. | ||
|
||
`ssh user@your-nginx-instance` | ||
|
||
1. Open the NGINX Agent configuration file in a text editor. | ||
|
||
`sudo vim /etc/nginx-agent/nginx-agent.conf` | ||
|
||
1. Add the fetures section: Add the following to the end of the configuration file if it doesn't already exist. | ||
|
||
```nginx | ||
features: | ||
- nginx-config-async | ||
- dataplane-status | ||
- file-watcher | ||
|
||
1. Restart the NGINX Agent service to apply the changes. | ||
|
||
`sudo systemctl restart nginx-agent` | ||
|
||
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.