You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING_DOCS.md
+20-1Lines changed: 20 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ We have templates for the following types of documentation:
64
64
65
65
## How to format docs
66
66
67
-
### Basic markdown formatting
67
+
### Basic Markdown formatting
68
68
69
69
There are multiple ways to format text: for consistency and clarity, these are our conventions:
70
70
@@ -152,6 +152,25 @@ Here are some other shortcodes:
152
152
-`readfile`: Include the content of another file in the current file, which can be in an arbitrary location.
153
153
-`bootstrap-table`: formats a table using Bootstrap classes; accepts any bootstrap table classes as additional arguments, e.g. `{{< bootstrap-table "table-bordered table-hover" }}`
154
154
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
+
155
174
## Linting
156
175
157
176
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:
Role-based access control (RBAC) is a security system that governs access to resources within a software application. By assigning specific roles to users or groups, RBAC ensures that only authorized individuals have the ability to perform certain actions or access particular areas.
8
+
9
+
The value of RBAC lies in its ability to provide clear and structured control over what users can see and do. This makes it easier to maintain security, streamline user management, and ensure compliance with internal policies or regulations. By giving users only the permissions they need to fulfill their roles, RBAC reduces the risk of unauthorized access and fosters a more efficient and secure operating environment.
Copy file name to clipboardExpand all lines: content/nginx-one/getting-started.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -7,26 +7,26 @@ product: NGINX One
7
7
docs: DOCS-1393
8
8
---
9
9
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.
11
11
12
12
## Enable the NGINX One service {#enable-nginx-one}
13
13
14
14
To get started using NGINX One, enable the service on F5 Distributed Cloud.
15
15
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).
17
17
1. Select **NGINX One** from the list of services.
18
18
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.
20
20
21
21
---
22
22
23
23
## Add your NGINX instances to NGINX One
24
24
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.
26
26
27
27
### Add an instance
28
28
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:
30
30
31
31
-**For first-time users:** On the welcome screen, select **Add Instance**.
32
32
-**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
51
51
52
52
### Install NGINX Agent
53
53
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.
55
55
56
56
{{<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:
58
58
59
59
-`3.135.72.139`
60
60
-`3.133.232.50`
61
61
-`52.14.85.249`
62
62
{{</call-out>}}
63
63
64
-
To install the NGINX Agent on an NGINX instance:
64
+
To install NGINX Agent on an NGINX instance:
65
65
66
66
1.**Check if NGINX is running and start it if it's not:**
67
67
@@ -79,7 +79,7 @@ To install the NGINX Agent on an NGINX instance:
79
79
80
80
2. **Install NGINX Agent:**
81
81
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:
83
83
84
84
``` shell
85
85
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
{{<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>}}
109
109
110
110
<br>
111
111
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.
@@ -136,7 +136,7 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
136
136
137
137
## Enable NGINX metrics reporting
138
138
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).
140
140
141
141
### Enable NGINX Plus API
142
142
@@ -154,7 +154,7 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor
154
154
155
155
### Log in to NGINX One
156
156
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).
158
158
1. Select **NGINX One > Visit Service**.
159
159
160
160
### Overview of the NGINX One dashboard
@@ -172,7 +172,7 @@ Navigating the dashboard:
172
172
**NGINX One dashboard metrics**
173
173
| Metric | Description | Details |
174
174
|---|---|---|
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. |
176
176
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
177
177
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
178
178
| <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. | |
The NGINX One Console uses the **[F5 Distributed Cloud User Management](https://docs.cloud.f5.com/docs-v2/administration/how-tos/user-mgmt)** system for access controls and user permissions.
13
+
General information can be found on the User Management documentation for **[F5 Distributed Cloud](https://docs.cloud.f5.com/docs-v2/administration/how-tos/user-mgmt)**. This document provides guidance and reference material for utilizing those features to grant and restrict access within the NGINX One Console.
0 commit comments