From b89bac90b152abf5f289b192ed9a9da00a8e25cb Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 12:36:39 +0000 Subject: [PATCH 01/14] Add a docs page to explain NGINX Agent features --- .../configure-nginx-agent-features.md | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 site/content/configuration/configure-nginx-agent-features.md diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md new file mode 100644 index 000000000..15779b5bd --- /dev/null +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -0,0 +1,62 @@ +# Configure NGINX Agent Features + +## Overview + +This guide explains how to enable or disable NGINX Agent features. + +## Before you begin + +Before you begin ensure: + +- NGINX Agent has been installed. +- Access to the NGINX Agent configuration file. + + +## Features + +The following table details the NGINX Agent features available. + +| Feature Name | Description | +| ------------- | ------------- | +| registration | Registering the NGINX Agent with the management plane.| +| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane.| +| metrics | Enable collecting of NGINX metrics.| +| metrics-throttle | Batch metrics before sending.| +| metrics-sender | Reports metrics over the gRPC connection.| +| dataplane-status | Report the health of the NGINX Instance.| +| process-watcher | Observe changes to the NGINX process.| +| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk.| +| activity-events | Send NGINX or NGINX Agent related events to the management plane.| +| agent-api | Enable the NGINX Agent REST API.| + + + + + + + + +### 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 +``` +3. **Add Features section:** Add the following yaml to the end of the file: + +``` +features: + - metrics + - metrics-throttle + - dataplane-status +``` + +4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes. + + + From 8d7ab5c7b5fab748f1e2858063eea7bc2aa7fc83 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 12:58:32 +0000 Subject: [PATCH 02/14] Formatting, Add title and other meta --- .../configure-nginx-agent-features.md | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 15779b5bd..8117256a8 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -1,8 +1,17 @@ -# Configure NGINX Agent Features +--- +title: "Configure NGINX Agent Features" +draft: false +weight: 300 +toc: true +tags: [ "docs" ] +docs: "DOCS-933" +categories: ["configuration"] +doctypes: ["task"] +--- ## Overview -This guide explains how to enable or disable NGINX Agent features. +This guide describes the NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file. ## Before you begin @@ -16,7 +25,7 @@ Before you begin ensure: The following table details the NGINX Agent features available. -| Feature Name | Description | +| **Feature Name** | **Description** | | ------------- | ------------- | | registration | Registering the NGINX Agent with the management plane.| | nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane.| @@ -30,12 +39,6 @@ The following table details the NGINX Agent features available. | agent-api | Enable the NGINX Agent REST API.| - - - - - - ### Use Cases #### Enable metrics only @@ -58,5 +61,5 @@ features: 4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes. - +At this stage, users will be able to view metrics data being sent, but will not have the capability to push NGINX configuration changes. From 6bdf4cfa0329f9d0860a1c2f1c146c63f370b21c Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 13:04:31 +0000 Subject: [PATCH 03/14] Remove redundant docs id --- site/content/configuration/configure-nginx-agent-features.md | 1 - 1 file changed, 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 8117256a8..6e8ebf59b 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -4,7 +4,6 @@ draft: false weight: 300 toc: true tags: [ "docs" ] -docs: "DOCS-933" categories: ["configuration"] doctypes: ["task"] --- From 8d866c8dd17014223e8bf60cfa5858e94eccc62a Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:49:23 +0000 Subject: [PATCH 04/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR review Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 6e8ebf59b..50460767d 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -14,7 +14,7 @@ This guide describes the NGINX Agent features, and how to enable and disable fea ## Before you begin -Before you begin ensure: +Before you start, make sure that you have: - NGINX Agent has been installed. - Access to the NGINX Agent configuration file. From 647a8d6417d35398d902d1a963d4de14045fcda8 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:49:47 +0000 Subject: [PATCH 05/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 50460767d..d8fe1e5a0 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -10,7 +10,7 @@ doctypes: ["task"] ## Overview -This guide describes the NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file. +This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file. ## Before you begin From ece4c9fdf03638e3a75ad6637f72bf39bcd20849 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:50:52 +0000 Subject: [PATCH 06/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index d8fe1e5a0..029dde0f0 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -16,7 +16,7 @@ This guide describes the F5 NGINX Agent features, and how to enable and disable Before you start, make sure that you have: -- NGINX Agent has been installed. +- NGINX Agent installed in your system. - Access to the NGINX Agent configuration file. From 237bdbe364e93f361df04b1eb833ce626f73ebd9 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:51:11 +0000 Subject: [PATCH 07/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 029dde0f0..1a7d9cea3 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -22,7 +22,7 @@ Before you start, make sure that you have: ## Features -The following table details the NGINX Agent features available. +The following table lists the NGINX Agent features. | **Feature Name** | **Description** | | ------------- | ------------- | From 2d8fa69a240bd5877209506494eb7155799ea530 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:51:34 +0000 Subject: [PATCH 08/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 1 + 1 file changed, 1 insertion(+) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 1a7d9cea3..4c3a181e8 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -24,6 +24,7 @@ Before you start, make sure that you have: The following table lists the NGINX Agent features. +{{}} | **Feature Name** | **Description** | | ------------- | ------------- | | registration | Registering the NGINX Agent with the management plane.| From ecb93230be78944f9ba3007dfb79a3f832bf1a78 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:52:03 +0000 Subject: [PATCH 09/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 4c3a181e8..f8cf6d3f6 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -37,7 +37,7 @@ The following table lists the NGINX Agent features. | file-watcher | Observe changes to the NGINX configuration or any changes to files on disk.| | activity-events | Send NGINX or NGINX Agent related events to the management plane.| | agent-api | Enable the NGINX Agent REST API.| - +{{}} ### Use Cases From 191bbd222cbb04b311918d613aed54839300b88f Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 13:53:11 +0000 Subject: [PATCH 10/14] Indent code blocks --- .../configuration/configure-nginx-agent-features.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index f8cf6d3f6..61841765b 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -44,19 +44,19 @@ The following table lists the NGINX Agent features. #### Enable metrics only 1. **Access the NGINX Instance:** SSH to the virtual machine/server where NGINX Agent is running. ``` -ssh user@your-nginx-instance + ssh user@your-nginx-instance ``` 2. **Edit NGINX Agent configuration:** ``` -sudo vim /etc/nginx-agent/nginx-agent.conf + sudo vim /etc/nginx-agent/nginx-agent.conf ``` 3. **Add Features section:** Add the following yaml to the end of the file: ``` -features: - - metrics - - metrics-throttle - - dataplane-status + features: + - metrics + - metrics-throttle + - dataplane-status ``` 4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes. From a682bcf1c65de5a332ada7fca6b729851a4a91a7 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney <133861979+nginx-seanmoloney@users.noreply.github.com> Date: Tue, 3 Dec 2024 13:54:11 +0000 Subject: [PATCH 11/14] Update site/content/configuration/configure-nginx-agent-features.md Suggestions from PR Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com> --- site/content/configuration/configure-nginx-agent-features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 61841765b..6743660a3 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -61,5 +61,5 @@ The following table lists the NGINX Agent features. 4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes. -At this stage, users will be able to view metrics data being sent, but will not have the capability to push NGINX configuration 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. From e8ea27ccbb3f4a53b749ca6f6cbed593a3184d54 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 14:13:42 +0000 Subject: [PATCH 12/14] - Add use case for publishing config, with metrics disabaled - Fix features code block format --- .../configure-nginx-agent-features.md | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 6743660a3..53321c902 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -54,12 +54,34 @@ The following table lists the NGINX Agent features. ``` features: - - metrics - - metrics-throttle - - dataplane-status + - 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. + From 10f8b6b4edded97df8f1d7e1184715c43f41d066 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Tue, 3 Dec 2024 14:15:51 +0000 Subject: [PATCH 13/14] Fix formatting --- .../configuration/configure-nginx-agent-features.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index 53321c902..c7deb9ae8 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -43,13 +43,17 @@ The following table lists the NGINX Agent features. #### 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 ``` + 3. **Add Features section:** Add the following yaml to the end of the file: ``` @@ -65,13 +69,17 @@ Once the steps have been completed, users will be able to view metrics data bein #### 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: ``` From 2bd8e67bbb70cfd9491afe9be459af91fd666ea1 Mon Sep 17 00:00:00 2001 From: nginx-seanmoloney Date: Wed, 4 Dec 2024 17:19:57 +0000 Subject: [PATCH 14/14] - Small change to title: How to configure NGINX Agent -> Basic configuration - Update weight to make new page appear second in the list - Added default/non-default --- .../configuration/configuration-overview.md | 2 +- .../configure-nginx-agent-features.md | 34 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/site/content/configuration/configuration-overview.md b/site/content/configuration/configuration-overview.md index b5bdd2ef0..e82e76246 100644 --- a/site/content/configuration/configuration-overview.md +++ b/site/content/configuration/configuration-overview.md @@ -1,5 +1,5 @@ --- -title: "How to configure NGINX Agent" +title: "Basic configuration" draft: false weight: 100 toc: true diff --git a/site/content/configuration/configure-nginx-agent-features.md b/site/content/configuration/configure-nginx-agent-features.md index c7deb9ae8..2a1cddcd1 100644 --- a/site/content/configuration/configure-nginx-agent-features.md +++ b/site/content/configuration/configure-nginx-agent-features.md @@ -1,7 +1,7 @@ --- -title: "Configure NGINX Agent Features" +title: "Features configuration" draft: false -weight: 300 +weight: 150 toc: true tags: [ "docs" ] categories: ["configuration"] @@ -25,23 +25,23 @@ Before you start, make sure that you have: The following table lists the NGINX Agent features. {{}} -| **Feature Name** | **Description** | -| ------------- | ------------- | -| registration | Registering the NGINX Agent with the management plane.| -| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane.| -| metrics | Enable collecting of NGINX metrics.| -| metrics-throttle | Batch metrics before sending.| -| metrics-sender | Reports metrics over the gRPC connection.| -| dataplane-status | Report the health of the NGINX Instance.| -| process-watcher | Observe changes to the NGINX process.| -| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk.| -| activity-events | Send NGINX or NGINX Agent related events to the management plane.| -| agent-api | Enable the NGINX Agent REST API.| +| **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 | {{}} -### Use Cases +## Use Cases -#### Enable metrics only +### Enable metrics only 1. **Access the NGINX Instance:** SSH to the virtual machine/server where NGINX Agent is running. ``` @@ -67,7 +67,7 @@ The following table lists the NGINX Agent features. 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. +### 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. ```