Packages scripts refactor (#316)

* Packages scripts refactor * Packages scripts refactor * Packages scripts refactor --------- Co-authored-by: Chris Adams <[email protected]>
nginx · May 22, 2023 · cf4cc7f · cf4cc7f
1 parent 8ea5b58
commit cf4cc7f
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 20 deletions.
diff --git a/nginx-agent.conf b/nginx-agent.conf
@@ -3,8 +3,8 @@
 #
 # Configuration file for NGINX Agent.
 #
-# This file is to track agent configuration values that are meant to be statically set. There  
-# are additional agent configuration values that are set via the API and agent install script
+# This file is to track NGINX Agent configuration values that are meant to be statically set. There  
+# are additional NGINX Agent configuration values that are set via the API and NGINX Agent install script
 # which can be found in /var/lib/nginx-agent/agent-dynamic.conf. 
 
 log:
@@ -20,7 +20,7 @@ nginx:
 
 dataplane:
   status:
-    # poll interval for data plane status - the frequency the agent will query the dataplane for changes
+    # poll interval for data plane status - the frequency the NGINX Agent will query the dataplane for changes
     poll_interval: 30s
     # report interval for data plane status - the maximum duration to wait before syncing dataplane information if no updates have being observed
     report_interval: 24h
@@ -37,5 +37,5 @@ metrics:
 config_dirs: "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"
 
 api:
-  # default port for Agent API, this is for the server configuration of the REST API
+  # default port for NGINX Agent API, this is for the server configuration of the REST API
   port: 8081
diff --git a/scripts/packages/manifest b/scripts/packages/manifest
@@ -2,7 +2,7 @@ name: nginx-agent
 version: "${VERSION}"
 origin: www/nginx-agent
 comment: "Monitors NGINX"
-desc: "Unified agent for various NGINX control plane services."
+desc: "NGINX Agent for various NGINX control plane services."
 maintainer: "NGINX Inc. <[email protected]>"
 www: https://nginx.com
 prefix: /
diff --git a/scripts/packages/postinstall.sh b/scripts/packages/postinstall.sh
@@ -183,8 +183,8 @@ add_default_config_file() {
 #
 # Configuration file for NGINX Agent.
 #
-# This file is to track agent configuration values that are meant to be statically set. There  
-# are additional agent configuration values that are set via the API and agent install script
+# This file is to track NGINX Agent configuration values that are meant to be statically set. There  
+# are additional NGINX Agent configuration values that are set via the API and NGINX Agent install script
 # which can be found in /var/lib/nginx-agent/agent-dynamic.conf. 
 
 # specify the server grpc port to connect to
@@ -224,7 +224,7 @@ nginx:
 
 dataplane:
   status:
-    # poll interval for data plane status - the frequency the agent will query the dataplane for changes
+    # poll interval for data plane status - the frequency the NGINX Agent will query the dataplane for changes
     poll_interval: 30s
     # report interval for data plane status - the maximum duration to wait before syncing dataplane information if no updates have being observed
     report_interval: 24h
@@ -241,7 +241,7 @@ metrics:
 config_dirs: "/etc/nginx:/usr/local/etc/nginx:/usr/share/nginx/modules:/etc/nms"
 
 api:
-  # default port for Agent API, this is for the server configuration of the REST API
+  # default port for NGINX Agent API, this is for the server configuration of the REST API
   port: 8081
 EOF
     printf "PostInstall: Updating file permissions for nginx-agent.conf to 0640\n"
@@ -303,4 +303,3 @@ summary() {
     upgrade_config_file
     summary
 }
-
diff --git a/scripts/packages/preinstall.sh b/scripts/packages/preinstall.sh
@@ -42,15 +42,15 @@ AGENT_DYNAMIC_CONFIG_COMMENT="#
 #
 # Dynamic configuration file for NGINX Agent.
 #
-# The purpose of this file is to track agent configuration
-# values that can be dynamically changed via the API and the agent install script.
+# The purpose of this file is to track NGINX Agent configuration
+# values that can be dynamically changed via the API and the NGINX Agent install script.
 # You may edit this file, but API calls that modify the tags on this system will
 # overwrite the tag values in this file.
 #
-# The agent configuration values that API calls can modify are as follows:
+# The NGINX Agent configuration values that API calls can modify are as follows:
 #    - tags
 #
-# The agent configuration value(s) that the agent install script can modify are as follows:
+# The NGINX Agent configuration value(s) that the NGINX Agent install script can modify are as follows:
 #    - instance_group
 
 "
@@ -67,8 +67,6 @@ err_exit() {
 
 title() {
     printf "\n --- NGINX Agent Package Installer --- \n\n"
-    printf " --- Will install the NGINX Agent in 5 seconds ---\n"
-    sleep 5
 }
 
 ensure_sudo() {
@@ -109,7 +107,7 @@ update_config_file() {
     printf "Updating %s ...\n" "${AGENT_DYNAMIC_CONFIG_FILE}"
 
     if [ ! -f "$AGENT_CONFIG_FILE" ]; then
-        printf "Agent config file %s does not exist. Could not be updated\n" "$AGENT_CONFIG_FILE"        
+        printf "NGINX Agent config file %s does not exist. Could not be updated\n" "$AGENT_CONFIG_FILE"        
         exit 0
     fi
 
@@ -160,4 +158,4 @@ update_config_file() {
     ensure_sudo
     load_config_values
     update_config_file
-}
+}
diff --git a/scripts/selinux/README.md b/scripts/selinux/README.md
@@ -44,8 +44,8 @@ sudo ./nginx_agent.sh --update
 
 ## Debugging
 * To check for policy violation look at the file `/var/log/audit/audit.log`
-* To check if agent is confined by selinux: `ps -efZ | grep nginx-agent`
+* To check if NGINX Agent is confined by selinux: `ps -efZ | grep nginx-agent`
 * For debugging nginx selinux issues refer to this nginx blog: https://www.nginx.com/blog/using-nginx-plus-with-selinux
 
 ## References
-* https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/using_selinux/writing-a-custom-selinux-policy_using-selinux
+* https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/using_selinux/writing-a-custom-selinux-policy_using-selinux