Skip to content

Commit 2c3f87a

Browse files
authored
Merge branch 'main' into feature-rbac-n1c
2 parents 40ed264 + ae1f162 commit 2c3f87a

File tree

11 files changed

+56
-29
lines changed

11 files changed

+56
-29
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ content/nap-dos/* @nginx/dos-docs-approvers
2929
content/nap-waf/* @nginx/nap-docs-approvers
3030
data/nap-waf/* @nginx/nap-docs-approvers
3131

32+
# NGINXaaS for Azure
33+
content/nginxaas-azure/* @nginx/n4a-docs
34+
content/includes/nginxaas-azure/* @nginx/n4a-docs
35+
3236
# NGINX Gateway Fabric
3337
content/ngf/* @nginx/nginx-gateway-fabric
3438
content/includes/ngf/* @nginx/nginx-gateway-fabric

CONTRIBUTING_DOCS.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ We have templates for the following types of documentation:
6464

6565
## How to format docs
6666

67-
### Basic markdown formatting
67+
### Basic Markdown formatting
6868

6969
There are multiple ways to format text: for consistency and clarity, these are our conventions:
7070

@@ -152,6 +152,25 @@ Here are some other shortcodes:
152152
- `readfile`: Include the content of another file in the current file, which can be in an arbitrary location.
153153
- `bootstrap-table`: formats a table using Bootstrap classes; accepts any bootstrap table classes as additional arguments, e.g. `{{< bootstrap-table "table-bordered table-hover" }}`
154154

155+
### How to use Hugo includes
156+
157+
As mentioned above, [Hugo includes](https://gohugo.io/contribute/documentation/#include) are a custom shortcode that allows you to reference reusable content stored in the [`/content/includes` directory](https://github.com/nginx/documentation/tree/main/content/includes).
158+
159+
For example, if the [`controller/add-existing-instance.md`](https://github.com/nginx/documentation/blob/main/content/includes/controller/add-existing-instance.md) file contains instructions on adding an instance to the NGINX Controller, you can reuse it on multiple pages by adding:
160+
161+
```md
162+
{{< include "controller/add-existing-instance.md" >}}
163+
```
164+
165+
The `controller/add-existing-instance.md` file is included in the following pages on the NGINX Docs Site:
166+
167+
- [Add an NGINX App Protect Instance](https://github.com/nginx/documentation/blob/main/content/controller/infrastructure/instances/add-nap-instance.md?plain=1#L35)
168+
- [Manage Your NGINX Instances](https://github.com/nginx/documentation/blob/main/content/controller/infrastructure/instances/manage-instances.md?plain=1#L29)
169+
- [Trial NGINX Controller with NGINX Plus](https://github.com/nginx/documentation/blob/main/content/controller/admin-guides/install/try-nginx-controller.md?plain=1#L277)
170+
- [Trial NGINX Controller with App Security](https://github.com/nginx/documentation/blob/main/content/controller/admin-guides/install/try-nginx-controller-app-sec.md?plain=1#L290)
171+
172+
This ensures that content is defined once and referenced in multiple places without duplication.
173+
155174
## Linting
156175

157176
To run the markdownlint check, run the following command, which uses the .markdownlint.yaml file to specify rules. For `<content>`, specify the path to your Markdown files:

content/nginx-one/getting-started.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@ product: NGINX One
77
docs: DOCS-1393
88
---
99

10-
This guide provides step-by-step instructions on how to activate and start using the F5 NGINX One Console. NGINX One is a management console for monitoring and managing NGINX data plane instances.
10+
This guide provides step-by-step instructions on how to activate and start using F5 NGINX One Console. NGINX One is a management console for monitoring and managing NGINX data plane instances.
1111

1212
## Enable the NGINX One service {#enable-nginx-one}
1313

1414
To get started using NGINX One, enable the service on F5 Distributed Cloud.
1515

16-
1. Log in to the [F5 Distributed Console](https://www.f5.com/cloud/products/distributed-cloud-console).
16+
1. Log in to [F5 Distributed Console](https://www.f5.com/cloud/products/distributed-cloud-console).
1717
1. Select **NGINX One** from the list of services.
1818
1. Select **Enable Service**.
19-
1. After the service has been enabled, select **Visit Service** to load the NGINX One console.
19+
1. After the service has been enabled, select **Visit Service** to load NGINX One Console.
2020

2121
---
2222

2323
## Add your NGINX instances to NGINX One
2424

25-
Next, add your NGINX instances to NGINX One. You'll need to create a data plane key and then install the NGINX Agent on each instance you want to monitor.
25+
Next, add your NGINX instances to NGINX One. You'll need to create a data plane key and then install NGINX Agent on each instance you want to monitor.
2626

2727
### Add an instance
2828

29-
Depending on whether this is your first time using the NGINX One console or you've used it before, follow the appropriate steps to add an instance:
29+
Depending on whether this is your first time using NGINX One Console or you've used it before, follow the appropriate steps to add an instance:
3030

3131
- **For first-time users:** On the welcome screen, select **Add Instance**.
3232
- **For returning users:** If you've added instances previously and want to add more, select **Instances** on the left menu, then select **Add Instance**.
@@ -51,17 +51,17 @@ Data plane keys expire after one year. You can change this expiration date later
5151

5252
### Install NGINX Agent
5353

54-
After entering your data plane key, you'll see a `curl` command similar to the one below. Copy and run this command on each NGINX instance to install the NGINX Agent. Once installed, the NGINX Agent typically registers with NGINX One within a few seconds.
54+
After entering your data plane key, you'll see a `curl` command similar to the one below. Copy and run this command on each NGINX instance to install NGINX Agent. Once installed, NGINX Agent typically registers with NGINX One within a few seconds.
5555

5656
{{<call-out "important" "Connecting to NGINX One" >}}
57-
The NGINX Agent must be able to establish a connection to the NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
57+
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`). Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
5858

5959
- `3.135.72.139`
6060
- `3.133.232.50`
6161
- `52.14.85.249`
6262
{{</call-out>}}
6363

64-
To install the NGINX Agent on an NGINX instance:
64+
To install NGINX Agent on an NGINX instance:
6565

6666
1. **Check if NGINX is running and start it if it's not:**
6767

@@ -79,7 +79,7 @@ To install the NGINX Agent on an NGINX instance:
7979
8080
2. **Install NGINX Agent:**
8181
82-
Next, use the `curl` command provided to you to install the NGINX Agent:
82+
Next, use the `curl` command provided to you to install NGINX Agent:
8383
8484
``` shell
8585
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="YOUR_DATA_PLANE_KEY" sh -s -- -y
@@ -105,11 +105,11 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
105105
106106
<span style="display: inline-block; margin-top: 20px;" >
107107
108-
{{<call-out "note" "Note: NGINX Agent poll interval" >}} We recommend keeping `dataplane.status.poll_interval` between `30s` and `60s` in the NGINX Agent config (`/etc/nginx-agent/nginx-agent.conf`). If the interval is set above `60s`, the NGINX One Console may report incorrect instance statuses.{{</call-out>}}
108+
{{<call-out "note" "Note: NGINX Agent poll interval" >}} We recommend keeping `dataplane.status.poll_interval` between `30s` and `60s` in the NGINX Agent config (`/etc/nginx-agent/nginx-agent.conf`). If the interval is set above `60s`, NGINX One Console may report incorrect instance statuses.{{</call-out>}}
109109
110110
<br>
111111
112-
<i class="fa fa-check-circle" aria-hidden="true"></i> Make sure your Linux operating system is listed below. The installation script for the NGINX Agent is compatible with these distributions and versions.
112+
<i class="fa fa-check-circle" aria-hidden="true"></i> Make sure your Linux operating system is listed below. The installation script for NGINX Agent is compatible with these distributions and versions.
113113
114114
#### NGINX Agent installation script: supported distributions
115115
@@ -136,7 +136,7 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
136136
137137
## Enable NGINX metrics reporting
138138
139-
In order for the NGINX One console to show specific traffic and system metrics, you need to enable the appropriate API on your NGINX data plane instances. The sections below provide step-by-step instructions for both NGINX Plus and NGINX Open Source (OSS).
139+
In order for NGINX One Console to show specific traffic and system metrics, you need to enable the appropriate API on your NGINX data plane instances. The sections below provide step-by-step instructions for both NGINX Plus and NGINX Open Source (OSS).
140140
141141
### Enable NGINX Plus API
142142
@@ -154,7 +154,7 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor
154154
155155
### Log in to NGINX One
156156
157-
1. Log in to the [F5 Distributed Console](https://www.f5.com/cloud/products/distributed-cloud-console).
157+
1. Log in to [F5 Distributed Console](https://www.f5.com/cloud/products/distributed-cloud-console).
158158
1. Select **NGINX One > Visit Service**.
159159
160160
### Overview of the NGINX One dashboard
@@ -172,7 +172,7 @@ Navigating the dashboard:
172172
**NGINX One dashboard metrics**
173173
| Metric | Description | Details |
174174
|---|---|---|
175-
| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: The NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with the NGINX Agent. <br> - **Unavailable**: The connection between the NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. |
175+
| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with NGINX Agent. <br> - **Unavailable**: The connection between NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. |
176176
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
177177
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
178178
| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | |

content/nginx/deployment-guides/setting-up-nginx-demo-environment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Configure NGINX Open Source as a web server and F5 NGINX Plus as a
44
docs: DOCS-462
55
doctypes:
66
- task
7-
title: Setting Up an NGINX Demo Environment
7+
title: Setting up an NGINX demo environment
88
toc: true
99
weight: 100
1010
---
@@ -19,7 +19,7 @@ This guide assumes you have already provisioned a number of host systems (physic
1919
Some commands require `root` privilege. If appropriate for your environment, prefix commands with the `sudo` command.
2020

2121
<span id="nginx-oss"></span>
22-
## Configuring NGINX Open Source for Web Serving
22+
## Configuring NGINX Open Source for web serving
2323

2424
The steps in this section configure an NGINX Open Source instance as a web server to return a page like the following, which specifies the server name, address, and other information. The page is defined in the <span style="white-space: nowrap; font-weight:bold;">demo-index.html</span> configuration file you create in Step 4 below.
2525

@@ -188,7 +188,7 @@ If you are using these instructions to satisfy the prerequisites for one of our
188188
```
189189

190190
<span id="nginx-plus"></span>
191-
## Configuring NGINX Plus for Load Balancing
191+
## Configuring NGINX Plus for load balancing
192192

193193
The steps in this section configure an NGINX Plus instance to load balance requests across the group of NGINX Open Source web servers you configured in the [previous section](#nginx-oss).
194194

@@ -272,7 +272,7 @@ Repeat these instructions on each instance. Alternatively, you can configure one
272272

273273
Directive documentation: [include](http://nginx.org/en/docs/ngx_core_module.html#include)
274274

275-
### Revision History
275+
### Revision history
276276

277277
- Version 2 (April 2019) – Generalized instructions for use with deployment guides
278278
- Version 1 (April 2018) – Initial version

content/nginxaas-azure/changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Changelog"
33
weight: 900
44
toc: true
55
docs: "DOCS-870"
6+
url: /nginxaas/azure/changelog/
7+
68
---
79

810
Learn about the latest updates, new features, and resolved bugs in F5 NGINX as a Service for Azure.

content/nginxaas-azure/faq.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ weight: 800
44
categories: ["concepts"]
55
toc: true
66
docs: "DOCS-881"
7+
url: /nginxaas/azure/faq/
8+
79
---
810

911
Common questions about F5 NGINX as a Service for Azure (NGINXaaS).

content/nginxaas-azure/known-issues.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: "Known issues"
33
weight: 1000
44
toc: true
55
docs: "DOCS-871"
6+
url: /nginxaas/azure/known-issues/
7+
68
---
79

810
List of known issues in the latest release of F5 NGINX as a Service for Azure (NGINXaaS).

content/nim/nginx-app-protect/setup-waf-config-management.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ Complete the following prerequisites before proceeding with this guide.
3030

3131
### Limitations
3232

33-
{{<important>}}App Protect WAF Config management is currently not supported when [deploying Instance Manager on Kubernetes]({{<relref "/nim/deploy/kubernetes/deploy-using-helm.md" >}}).{{</important>}}
34-
3533
Instance Manager does not support the following NGINX App Protect features:
3634

3735
- [Policies with external references](https://docs.nginx.com/nginx-app-protect/configuration-guide/configuration/#external-references)
@@ -254,7 +252,7 @@ You will need to use your NGINX repo certificates to setup automatic retrieval o
254252
<summary>Example request</summary>
255253
256254
```shell
257-
curl -X POST 'https://{{NMS_FQDN}}//api/platform/v1/certs' \
255+
curl -X POST 'https://{{NMS_FQDN}}/api/platform/v1/certs' \
258256
--header "Authorization: Bearer <access token>" \
259257
--header "Content-Type: application/json" \
260258
@@ -374,7 +372,7 @@ You will need to use the [Instance Manager REST API]({{< relref "/nim/fundamenta
374372
<summary>Attack Signatures Example</summary>
375373
376374
```shell
377-
curl -X POST 'https://{{NMS_FQDN}}//api/platform/v1/security/attack-signatures' \
375+
curl -X POST 'https://{{NMS_FQDN}}/api/platform/v1/security/attack-signatures' \
378376
--header "Authorization: Bearer <access token>" \
379377
--form 'revisionTimestamp="2022.11.16"' \
380378
--form 'filename=@"/attack-signatures.tgz"'
@@ -386,7 +384,7 @@ curl -X POST 'https://{{NMS_FQDN}}//api/platform/v1/security/attack-signatures'
386384
<summary>Threat Campaigns Example</summary>
387385
388386
```shell
389-
curl -X POST 'https://{{NMS_FQDN}}//api/platform/v1/security/threat-campaigns' \
387+
curl -X POST 'https://{{NMS_FQDN}}/api/platform/v1/security/threat-campaigns' \
390388
--header "Authorization: Bearer <access token>" \
391389
--form 'revisionTimestamp="2022.11.15"' \
392390
--form 'filename=@"/threat-campaigns.tgz"'

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ module github.com/nginxinc/docs
22

33
go 1.19
44

5-
require github.com/nginxinc/nginx-hugo-theme v0.41.22 // indirect
5+
require github.com/nginxinc/nginx-hugo-theme v0.42.1 // indirect

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
github.com/nginxinc/nginx-hugo-theme v0.41.22 h1:Gb/OLbpumNqp8vOPkZzO2GmgPDRd1yr2tWHWUBHg8BA=
2-
github.com/nginxinc/nginx-hugo-theme v0.41.22/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=
1+
github.com/nginxinc/nginx-hugo-theme v0.42.1 h1:SYj7R7fKPYwtbQobTcJWy/ZWQxa5tlHCSJfU2dxYXxY=
2+
github.com/nginxinc/nginx-hugo-theme v0.42.1/go.mod h1:DPNgSS5QYxkjH/BfH4uPDiTfODqWJ50NKZdorguom8M=

0 commit comments

Comments
 (0)