diff --git a/content/agent/configuration/configure-nginx-agent-group.md b/content/agent/configuration/configure-nginx-agent-group.md index bb6260daf..d1152bfb2 100644 --- a/content/agent/configuration/configure-nginx-agent-group.md +++ b/content/agent/configuration/configure-nginx-agent-group.md @@ -13,7 +13,7 @@ doctypes: ["task"] During installation, NGINX Agent detects the NGINX user (typically `nginx`) for the master and worker processes and adds this user to a group called `nginx-agent`. -If you change the NGINX username after installing the NGINX Agent, you'll need to add the new username to the `nginx-agent` group so that the NGINX socket has the proper permissions. +If you change the NGINX username after installing NGINX Agent, you'll need to add the new username to the `nginx-agent` group so that the NGINX socket has the proper permissions. A failure to update the `nginx-agent` group when the NGINX username changes may result in non-compliance errors for NGINX Plus. diff --git a/content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md b/content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md index abcf7b89c..9ad9cafe6 100644 --- a/content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md +++ b/content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md @@ -62,7 +62,7 @@ If you need to deactivate a data plane key before its expiration date, follow th ## Delete a data plane key -Before you can delete a key, it must be expired or revoked. You can revoke a key either through the NGINX One console, as explained above, or by using the REST API. Once deleted, all information about the data plane key is permanently removed. +Before you can delete a key, it must be expired or revoked. You can revoke a key either through the NGINX One Console, as explained above, or by using the REST API. Once deleted, all information about the data plane key is permanently removed. 1. On the left menu, select **Data Plane Keys**. 2. Find the key you want to revoke in the list of expired or revoked keys. diff --git a/content/nms/nginx-agent/install-nginx-agent.md b/content/nms/nginx-agent/install-nginx-agent.md index b93746c5b..59105d952 100644 --- a/content/nms/nginx-agent/install-nginx-agent.md +++ b/content/nms/nginx-agent/install-nginx-agent.md @@ -17,7 +17,7 @@ This section lists the prerequisites for installing and configuring NGINX Agent. 1. [F5 NGINX Management Suite is installed on a server]({{< relref "/nim/deploy/_index.md" >}}). - {{}} When installing and configuring NGINX Management Suite, take note of the fully qualified domain name (FQDN) and gRPC port number. You'll need this information to properly configure the NGINX Agent to communicate with NGINX Management Suite. + {{}} When installing and configuring NGINX Management Suite, take note of the fully qualified domain name (FQDN) and gRPC port number. You'll need this information to properly configure NGINX Agent to communicate with NGINX Management Suite. {{}} 2. Make sure NGINX is running on your instance: @@ -58,7 +58,7 @@ To see if `nginx_agent_selinux` is installed, run the following command: ## Install NGINX Agent -You can choose one of the following two methods to install the NGINX Agent on your data plane host: +You can choose one of the following two methods to install NGINX Agent on your data plane host: - Install via the NGINX Management Suite API Gateway - Install from packages downloaded from [MyF5 Customer Portal](https://account.f5.com/myf5) or from your NGINX/F5 sales team. @@ -102,7 +102,7 @@ root 293850 109 1.1 1240056 23536 ? Ssl 22:00 0:07 /usr/local/bi vagrant 293866 0.0 0.0 8160 736 pts/0 S+ 22:00 0:00 grep --color=auto nginx-agent ``` -Once you've verified the NGINX Agent is running on your data plane, you should confirm it's registered with NGINX Management Suite. You can do this two ways: +Once you've verified NGINX Agent is running on your data plane, you should confirm it's registered with NGINX Management Suite. You can do this two ways: {{}} @@ -138,17 +138,17 @@ If you need to remove the instance, ensure that the NGINX Agent service is stopp ## Configuring the NGINX Agent -The following sections explain how to configure the NGINX Agent using configuration files, CLI flags, and environment variables. +The following sections explain how to configure NGINX Agent using configuration files, CLI flags, and environment variables. {{}} -- The NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities: +- NGINX Agent interprets configuration values set by configuration files, CLI flags, and environment variables in the following priorities: 1. CLI flags overwrite configuration files and environment variable values. 2. Environment variables overwrite configuration file values. 3. Config files are the lowest priority and config settings are superseded if either of the other options is used. -- The NGINX Agent is configured by default to connect to the NGINX Management Suite on port 443 based on the address used to download the install script. If this setting doesn't work, you can change the `server` fields in the `nginx-agent.conf` file. Instructions are provided in the following sections. +- NGINX Agent is configured by default to connect to the NGINX Management Suite on port 443 based on the address used to download the install script. If this setting doesn't work, you can change the `server` fields in the `nginx-agent.conf` file. Instructions are provided in the following sections. - Open any required firewall ports or SELinux/AppArmor rules for the ports and IPs you want to use. @@ -156,7 +156,7 @@ The following sections explain how to configure the NGINX Agent using configurat ### Configure with Config Files -The configuration files for the NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose. +The configuration files for NGINX Agent are `/etc/nginx-agent/nginx-agent.conf` and `/var/lib/nginx-agent/agent-dynamic.conf`. These files have comments at the top indicating their purpose. {{}}If you're running Instance Manager 2.10.1 or earlier or NGINX Agent 2.25.1 or earlier, the `agent-dynamic.conf` file is located in `/etc/nginx-agent/`.{{}} @@ -231,7 +231,7 @@ extensions: # Enable reporting NGINX App Protect details to the control plane. nginx_app_protect: - # Report interval for NGINX App Protect details - the frequency the NGINX Agent checks NGINX App Protect for changes. + # Report interval for NGINX App Protect details - the frequency NGINX Agent checks NGINX App Protect for changes. report_interval: 15s # Enable precompiled publication from the NGINX Management Suite (true) or perform compilation on the data plane host (false). precompiled_publication: true @@ -271,7 +271,7 @@ tags: ## CLI Flags & Environment Variables -This section details the CLI flags and corresponding environment variables used to configure the NGINX Agent. +This section details the CLI flags and corresponding environment variables used to configure NGINX Agent. ### Usage @@ -402,7 +402,7 @@ Additionally, you can use the agent installation script to add these fields: ## SELinux for NGINX Agent -This section explains how to install and configure the SELinux policy for the NGINX Agent. +This section explains how to install and configure the SELinux policy for NGINX Agent. ### Installing NGINX Agent SELinux Policy Module @@ -418,7 +418,7 @@ To load the NGINX Agent policy, run the following commands: ### Adding Ports for NGINX Agent SELinux Context -You can configure the NGINX Agent to work with SELinux. Make sure you add external ports to the firewall exception list. +You can configure NGINX Agent to work with SELinux. Make sure you add external ports to the firewall exception list. The following example shows how to allow external ports outside the HTTPD context. You may need to enable NGINX to connect to these ports. @@ -430,11 +430,11 @@ For additional information on using NGINX with SELinux, refer to the guide [Usin --- -## Secure the NGINX Agent with mTLS +## Secure NGINX Agent with mTLS -{{< important >}}By default, communication between the NGINX Agent and NGINX Management Suite is unsecured.{{< /important >}} +{{< important >}}By default, communication between NGINX Agent and NGINX Management Suite is unsecured.{{< /important >}} -For instructions on how configure mTLS to secure communication between the NGINX Agent and NGINX Management Suite, see [NGINX Agent TLS Settings](https://docs.nginx.com/nginx-agent/configuration/encrypt-communication/). +For instructions on how configure mTLS to secure communication between NGINX Agent and NGINX Management Suite, see [NGINX Agent TLS Settings](https://docs.nginx.com/nginx-agent/configuration/encrypt-communication/). ---