Merge branch 'ngf-release-2.0' into ngf-feature-cp-dp-split

Author: ADubhlaoich

archetypes/concept.md

@@ -6,10 +6,10 @@ weight: i00
 # Creates a table of contents and sidebar, useful for large documents
 toc: false
 # Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
-type: concept
+nd-content-type: concept
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
-product:
+nd-product:
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -22,15 +22,11 @@ This guide provides an overview of <concept>, which is used <for/in> <action 1>,
 
 It is an example of a <other concept>, and is closely related to <third concept>.
 
----
-
 ## Background
 
 [//]: # "Explain what the concept is. If possible, relate it to another commonly known concept or software."
 [//]: # "This relates the new idea to the reader using their existing knowledge, helping their understanding of it and thus what its purpose is in context."
 
----
-
 ## Use cases
 
 [//]: # "Name the individual use case sections after the actual use case itself, e.g 'Route traffic between applications'"
@@ -56,7 +52,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
 
 ### Use case 2
 
----
 
 ## Conclusion
 
@@ -65,8 +60,6 @@ Starting from the <top/left> of the diagram, you can see that <thing> is connect
 [//]: # "Since each use case provides links to additional documents, you may not need to link to more,"
 [//]: # "or even include the final 'See also' section."
 
----
-
 ## See also
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as reference material or task instructions."

archetypes/default.md

@@ -6,10 +6,10 @@ weight: i00
 # Creates a table of contents and sidebar, useful for large documents
 toc: false
 # Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
-type: how-to
+nd-content-type: how-to
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
-product:
+nd-product:
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -20,8 +20,6 @@ product:
 
 This guide explains how to <X> with <Y>. In involves the use of <A>, <B> and <C>, demonstrating how <X> works with an example <Z>.
 
----
-
 ## Before you begin
 
 [//]: # "List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -34,8 +32,6 @@ To complete this guide, you will need the following prerequisites:
 
 [//]: # "Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
 
----
-
 ## Step 1
 
 [//]: # "Explain the initial step: this is usually creating or configuring a resource. Sub-steps may not be necessary, depending on complexity."
@@ -51,38 +47,29 @@ To complete this guide, you will need the following prerequisites:
 
 [//]: # "Sub-steps are ways of breaking steps into even smaller sections. Each step or sub-step should focus on one thing at a time: a user should be able to stop at the end of section and come back afterwards without leaving their software in a non-functional state."
 
----
-
 ### Sub-step 2
 
 [//]: # "A useful final sub-step for a given section is some kind of verification or testing, so the reader is confident the steps have been successful."
 
----
-
 ## Step 2
 
 [//]: # "Explain any additional steps required. If the how-to guide involves multiple components, each component can have its own step for delineation."
 
 ### Sub-step 1
 
----
 
 ### Sub-step 2
 
----
 
 ## Step 3
 
 [//]: # "The final step of a how-to guide is usually a final test, and summarizes all of the previous steps taken to accomplish the purpose of the guide."
 
 ### Sub-step 1
 
----
 
 ### Sub-step 2
 
----
-
-## See also
+## Next steps
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to the most common use cases after this specific instruction. For example. configuration usually follows installation."

archetypes/tutorial.md

@@ -6,10 +6,10 @@ weight: i00
 # Creates a table of contents and sidebar, useful for large documents
 toc: false
 # Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
-type: tutorial
+nd-content-type: tutorial
 # Intended for internal catalogue and search, case sensitive:
 # Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
-product:
+nd-product:
 ---
 
 [//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
@@ -29,8 +29,6 @@ By the end of the tutorial, you should have enough working knowledge of <thing>
 
 <thing> is a common use for <product>: it enables the ability to use <feature 1>, <feature 2> and <feature 3>, which are important when configuring <product> for <use case>.
 
----
-
 ## Before you begin
 
 [//]: # "List everything someone will need installed or configured before it's required. Link directly to installation guides where possible."
@@ -43,8 +41,6 @@ To complete this guide, you will need the following prerequisites:
 
 [//]: # "Note the style of link for requirement two: keep the markdown extension. Links are resolved from the root of the documentation folder, often /site."
 
----
-
 ## Step 1
 
 [//]: # "The text immediately following a heading in a tutorial should likely explain a concept to build a mental model of what the reader is about to do."
@@ -61,8 +57,6 @@ The first thing required for setting up <thing> is <step name>. This is the <ser
 
 Starting from the <top/left> of the diagram, you can see that <thing> is connected to <other thing>: this relationship is established when configuring <parameter> as part of <file name>.
 
----
-
 ### Sub-step 1
 
 [//]: # "The sub-steps of a tutorial should show the exact steps a reader should take to accomplish an action, and what to expect when doing so."
@@ -87,34 +81,25 @@ To verify the creation of <component>, you can also inspect information about it
 <the output of that command, possibly truncated and with changed IPs or domains>
 ```
 
----
-
 ### Sub-step 2
 
----
-
 ## Step 2
 
 [//]: # "Explain any additional steps required. If the tutorial involves multiple components, each component can have its own step for delineation."
 
----
-
 ### Sub-step 1
 
----
 
 ### Sub-step 2
 
----
 
 ## Conclusion
 
 [//]: # "Summarize everything that the reader will have learned and accomplished by the end of this tutorial."
 [//]: # "It should fulfill the promise made by the introductory paragraph at the top of the document."
 [//]: # "You may wish to link to another tutorial as the next logical step, but that could also be part of the 'See also' section."
 
----
 
-## See also
+## Next steps
 
-[//]: # "Link to related documents, such as concepts, reference material or similar use cases."
+[//]: # "Link to related documents, such as concepts, reference material or specific use cases."

content/includes/agent/installation/install-agent-api.md

@@ -1,74 +1,75 @@
-**Note**: To complete this step, make sure that `gpg` is installed on your system. You can install NGINX Agent using various command-line tools like `curl` or `wget`. If your NGINX Instance Manager host is not set up with valid TLS certificates, you can use the insecure flags provided by those tools. See the following examples:
+---
+docs: DOCS-1031
+files:
+  - content/nim/nginx-app-protect/setup-waf-config-management.md
+---
+
+{{<note>}}Make sure `gpg` is installed on your system before continuing. You can install NGINX Agent using command-line tools like `curl` or `wget`.{{</note>}}
+
+If your NGINX Instance Manager host doesn't use valid TLS certificates, you can use the insecure flags to bypass verification. Here are some example commands:
 
 {{<tabs name="install-agent-api">}}
 
 {{%tab name="curl"%}}
 
-- Secure:
+- **Secure:**
 
   ```bash
-  curl https://<NMS_FQDN>/install/nginx-agent | sudo sh
+  curl https://<NIM_FQDN>/install/nginx-agent | sudo sh
   ```
 
-- Insecure:
+- **Insecure:**
 
   ```bash
-  curl --insecure https://<NMS_FQDN>/install/nginx-agent | sudo sh
+  curl --insecure https://<NIM_FQDN>/install/nginx-agent | sudo sh
   ```
 
-  You can add your NGINX instance to an existing instance group or create one using `--instance-group` or `-g` flag when installing NGINX Agent.
-
-  The following example shows how to download and run the script with the optional `--instance-group` flag adding the NGINX instance to the instance group **my-instance-group**:
-
-  ```bash
-  curl https://<NMS_FQDN>/install/nginx-agent > install.sh; chmod u+x install.sh
-  sudo ./install.sh --instance-group my-instance-group
-  ```
+To add the instance to a specific instance group during installation, use the `--instance-group` (or `-g`) flag:
 
-  By default, the install script attempts to use a secure connection when downloading packages. If, however, the script cannot create a secure connection, it uses an insecure connection instead and logs the following warning message:
+```shell
+curl https://<NIM_FQDN>/install/nginx-agent -o install.sh
+chmod u+x install.sh
+sudo ./install.sh --instance-group <instance group>
+```
 
-  ``` text
-  Warning: An insecure connection will be used during this nginx-agent installation
-  ```
+By default, the install script uses a secure connection to download packages. If it can’t establish one, it falls back to an insecure connection and logs this message:
 
-  To require a secure connection, you can set the optional flag `skip-verify` to `false`.
+```text
+Warning: An insecure connection will be used during this nginx-agent installation
+```
 
-  The following example shows how to download and run the script with an enforced secure connection:
+To enforce a secure connection, set the `--skip-verify` flag to false:
 
-  ```bash
-  curl https://<NMS_FQDN>/install/nginx-agent > install.sh chmod u+x install.sh; chmod u+x install.sh
-  sudo sh ./install.sh --skip-verify false
-  ```
+```shell
+curl https://<NIM_FQDN>/install/nginx-agent -o install.sh
+chmod u+x install.sh
+sudo ./install.sh --skip-verify false
+```
 
 {{%/tab%}}
 
 {{%tab name="wget"%}}
 
+- **Secure:**
 
-- Secure:
-
-  ```bash
-  wget https://<NMS_FQDN>/install/nginx-agent -O - | sudo sh -s --skip-verify false
+  ```shell
+  wget https://<NIM_FQDN>/install/nginx-agent -O - | sudo sh -s --skip-verify false
   ```
 
-- Insecure:
+- **Insecure:**
 
-  ```bash
-  wget --no-check-certificate https://<NMS_FQDN>/install/nginx-agent -O - | sudo sh
+  ```shell
+  wget --no-check-certificate https://<NIM_FQDN>/install/nginx-agent -O - | sudo sh
   ```
 
-   When you install the NGINX Agent, you can use the  `--instance-group` or `-g` flag to add your NGINX instance to an existing instance group or to a new group that you specify.
-
-   The following example downloads and runs the NGINX Agent install script with the optional `--instance-group` flag, adding the NGINX instance to the instance group **my-instance-group**:
-
-   ```bash
-   wget https://gnms1.npi.f5net.com/install/nginx-agent -O install.sh ; chmod u+x install.sh
-   sudo ./install.sh --instance-group my-instance-group
-   ```
+To add your instance to a group during installation, use the `--instance-group` (or `-g`) flag:
 
+```shell
+wget https://<NIM_FQDN>/install/nginx-agent -O install.sh
+chmod u+x install.sh
+sudo ./install.sh --instance-group <instance group>
+```
 
 {{%/tab%}}
-{{</tabs>}}
 
-<!-- Do not remove. Keep this code at the bottom of the include -->
-<!-- DOCS-1031 -->
+{{</tabs>}}

content/includes/licensing-and-reporting/apply-jwt.md

@@ -1,11 +1,21 @@
 ---
 docs:
+file:
+  - content/solutions/about-subscription-licenses.md
+  - content/nap-waf/v5/admin-guide/install.md
 ---
 
 1. Copy the license file to `/etc/nginx/license.jwt` on Linux or `/usr/local/etc/nginx/license.jwt` on FreeBSD for each NGINX Plus instance.
+2. Reload NGINX:
 
-1. **SELinux**: If you're running a Linux distribution with SELinux enabled, set the file security context type with the following command:
-
-   ```bash
-   chcon -t httpd_config_t /etc/nginx/license.jwt
+   ```shell
+   systemctl reload nginx
    ```
+
+**If SELinux is enabled**: 
+
+Set the correct file context so NGINX can read the license:
+
+```shell
+chcon -t httpd_config_t /etc/nginx/license.jwt
+```

content/includes/licensing-and-reporting/configure-nginx-plus-report-to-nim.md

@@ -17,5 +17,5 @@ docs:
 3. Reload NGINX:
 
     ``` bash
-    nginx -s reload
+    systemctl reload nginx
     ```

content/includes/nap-waf/build-nginx-image-cmd.md

@@ -10,7 +10,7 @@ To build the image, execute the following command in the directory containing th
 
 
 ```shell
-sudo docker build --no-cache \
+sudo docker build --no-cache --platform linux/amd64 \
   --secret id=nginx-crt,src=nginx-repo.crt \
   --secret id=nginx-key,src=nginx-repo.key \
   -t nginx-app-protect-5 .

content/includes/nim/nap-waf/restart-nms-integrations.md

@@ -0,0 +1,11 @@
+---
+docs: DOCS-000
+files:
+  - content/nim/nginx-app-protect/setup-waf-config-management.md
+---
+
+Restart the `nms-integrations` service:
+
+```shell
+sudo systemctl restart nms-integrations
+```