Skip to content

Commit 041646f

Browse files
authored
Apply suggestions from code review
@lucYang55 I have applied my suggestions to my PR as these are minor and well documented in our style guide.
1 parent 77d0aa3 commit 041646f

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

content/agent/configuration/configure-nginx-agent-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ doctypes: ["task"]
1313

1414
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`.
1515

16-
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 NGINX socket has the proper permissions.
16+
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.
1717

1818
A failure to update the `nginx-agent` group when the NGINX username changes may result in non-compliance errors for NGINX Plus.
1919

content/nms/nginx-agent/install-nginx-agent.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ This section lists the prerequisites for installing and configuring NGINX Agent.
2626
ps aux | grep nginx
2727
```
2828

29-
3. If a previous version of NGINX Agent was installed, you must stop the current NGINX Agent process before running NGINX Agent install script. To check if any NGINX Agent processes are running, run the following command:
29+
3. If a previous version of NGINX Agent was installed, you must stop the current NGINX Agent process before running the NGINX Agent install script. To check if any NGINX Agent processes are running, run the following command:
3030

3131
```bash
3232
ps aux | grep nginx-agent
3333
```
3434

35-
4. If a previous version of NGINX Agent was installed, make sure to uninstall `nginx-agent-selinux` before running NGINX Agent install script.
35+
4. If a previous version of NGINX Agent was installed, make sure to uninstall `nginx-agent-selinux` before running the NGINX Agent install script.
3636
To see if `nginx_agent_selinux` is installed, run the following command:
3737

3838
{{<tabs name="install_repo">}}
@@ -79,7 +79,7 @@ You can choose one of the following two methods to install NGINX Agent on your d
7979

8080
## Enable and Start NGINX Agent
8181

82-
Run the following command to enable and start NGINX Agent service:
82+
Run the following command to enable and start the NGINX Agent service:
8383

8484
```bash
8585
sudo systemctl enable nginx-agent --now
@@ -89,7 +89,7 @@ sudo systemctl enable nginx-agent --now
8989

9090
## Verifying NGINX Agent is Running and Registered
9191

92-
Run the following command on your data plane to verify that NGINX Agent process is running:
92+
Run the following command on your data plane to verify that the NGINX Agent process is running:
9393

9494
```bash
9595
ps aux | grep nginx-agent
@@ -128,10 +128,10 @@ In a web browser, go to the FQDN for your NGINX Management Suite host and log in
128128

129129
<br>
130130

131-
Once you've verified NGINX Agent instance is registered with NGINX Management Suite, no additional action is required for monitoring the instance.
131+
Once you've verified the NGINX Agent instance is registered with NGINX Management Suite, no additional action is required for monitoring the instance.
132132
133133
{{<note>}}
134-
If you need to remove the instance, ensure that NGINX Agent service is stopped first. Then you can remove the instance from the inventory.
134+
If you need to remove the instance, ensure that the NGINX Agent service is stopped first. Then you can remove the instance from the inventory.
135135
{{</note>}}
136136
137137
---
@@ -168,7 +168,7 @@ Examples of the configuration files are provided below:
168168
{{<note>}}
169169
In the following example `nginx-agent.conf` file, you can change the `server.host` and `server.grpcPort` to connect to the NGINX Management Suite.
170170
171-
If NGINX Agent was previously installed for data reporting purposes only, you may need to find and remove the following line from NGINX Agent configuration file:
171+
If NGINX Agent was previously installed for data reporting purposes only, you may need to find and remove the following line from the NGINX Agent configuration file:
172172
173173
```none
174174
features: registration,dataplane-status
@@ -323,7 +323,7 @@ If you are upgrading from an older version, update your configuration accordingl
323323
| `--nginx-exclude-logs` | `NGINX_AGENT_NGINX_EXCLUDE_LOGS` | Specifies paths of NGINX access logs to exclude from metrics collection. |
324324
| `--nginx-socket` | `NGINX_AGENT_NGINX_SOCKET` | Specifies the location of the NGINX Plus counting Unix socket. Default: *unix:/var/run/nginx-agent/nginx.sock* |
325325
| `--nginx-treat-warnings-as-errors` | `NGINX_AGENT_NGINX_TREAT_WARNINGS_AS_ERRORS` | Treats warnings as failures on configuration application. |
326-
| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of NGINX Agent internal queue. |
326+
| `--queue-size` | `NGINX_AGENT_QUEUE_SIZE` | Specifies the size of the NGINX Agent internal queue. |
327327
| `--server-command` | | Specifies the name of the command server sent in the TLS configuration. |
328328
| `--server-grpcport` | `NGINX_AGENT_SERVER_GRPCPORT` | Sets the desired GRPC port for NGINX Agent traffic. |
329329
| `--server-host` | `NGINX_AGENT_SERVER_HOST` | Specifies the IP address of the server host. |
@@ -412,7 +412,7 @@ The NGINX Agent package includes the following SELinux files:
412412
- `/usr/share/selinux/devel/include/contrib/nginx_agent.if`
413413
- `/usr/share/selinux/packages/nginx_agent.pp`
414414
415-
To load NGINX Agent policy, run the following commands:
415+
To load the NGINX Agent policy, run the following commands:
416416
417417
{{< include "installation/agent-selinux.md" >}}
418418

0 commit comments

Comments
 (0)