Skip to content

Commit 212cf5b

Browse files
mjangADubhlaoich
andauthored
feat: Customer-friendly NGINX One Console home page (#628)
* feat: Customer-friendly NGINX One Console home page --------- Co-authored-by: Alan Dooley <a.dooley@f5.com>
1 parent 0be9711 commit 212cf5b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+367
-447
lines changed

content/includes/nginx-one/add-file/existing-ssl-bundle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs:
33
---
44

5-
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
5+
With this option, you can incorporate [Managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
66
In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then:
77

88
1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/connect-instances/add-instance.md
5+
- content/nginx-one/getting-started.md
6+
---
7+
8+
You can add an instance to NGINX One Console in the following ways:
9+
10+
- Directly, under **Instances**
11+
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**
12+
13+
In either case, NGINX One Console gives you a choice for data plane keys:
14+
15+
- Create a new key
16+
- Use an existing key
17+
18+
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
19+
20+
Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
21+
22+
```bash
23+
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
24+
```
25+
26+
Once the process is complete, you can configure that instance in your NGINX One Console.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/metrics/enable-metrics.md
5+
- content/nginx-one/getting-started.md
6+
---
7+
8+
Navigating the dashboard:
9+
10+
- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.
11+
- **Refine metric timeframe**: Metrics show the last hour's data by default. To view data from a different period, select the time interval you want from the drop-down menu.
12+
13+
<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;">
14+
{{< img src="nginx-one/images/nginx-one-dashboard.png">}}
15+
</span>
16+
17+
{{<bootstrap-table "table table-striped table-bordered">}}
18+
**NGINX One dashboard metrics**
19+
| Metric | Description | Details |
20+
|---|---|---|
21+
| <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. |
22+
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
23+
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
24+
| <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. | |
25+
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
26+
| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. |
27+
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
28+
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
29+
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
30+
| <i class="fas fa-exclamation-triangle"></i> **Unsuccessful response codes** | Look for instances with a high number of HTTP server errors and investigate their error codes. | |
31+
| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |
32+
33+
{{</bootstrap-table>}}
34+
35+
36+
37+
38+
39+

content/nginx-one/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: ''
33
docs: DOCS-1392
4-
title: About
4+
title: Manage your NGINX fleet
55
toc: true
66
weight: 10
77
type:

content/nginx-one/api/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: API
2+
title: Automate with the NGINX One API
33
description:
4-
weight: 1000
4+
weight: 700
55
url: /nginx-one/api
6-
---
6+
---

content/nginx-one/changelog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ You can:
8383
- Remove a deployed certificate from a Config Sync Group
8484

8585
For more information, including warnings about risks, see our documentation on how you can:
86-
- [Add a file]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md" >}})
87-
- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
86+
- [Add a file]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
87+
- [Manage certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}})
8888

8989
### Revert a configuration
9090

@@ -108,15 +108,15 @@ From the NGINX One Console you can now:
108108
- Ensure that your certificates are current and correct.
109109
- Manage your certificates from a central location. This can help you simplify operations and remotely update, rotate, and deploy those certificates.
110110

111-
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}}).
111+
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
112112

113113
## August 22, 2024
114114

115115
### Config Sync Groups
116116

117117
Config Sync Groups are now available in the F5 NGINX One Console. This feature allows you to manage and synchronize NGINX configurations across multiple instances as a single entity, ensuring consistency and simplifying the management of your NGINX environment.
118118

119-
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md" >}}).
119+
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}).
120120

121121
## August 8, 2024
122122

@@ -136,7 +136,7 @@ Select the link for each CVE to see the details, including the CVE's publish dat
136136

137137
### Edit NGINX configurations
138138

139-
You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}}).
139+
You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/nginx-configs/view-edit-nginx-configurations.md" >}}).
140140

141141
## May 28, 2024
142142

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description:
3+
title: Connect your instances
4+
weight: 200
5+
url: /nginx-one/connect-instances/
6+
---

content/nginx-one/how-to/nginx-configs/add-instance.md renamed to content/nginx-one/connect-instances/add-instance.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,16 @@ to set up a data plane key to connect your instances to NGINX One.
1616

1717
Before you add an instance to NGINX One Console, ensure:
1818

19-
- You have administrator access to NGINX One Console.
20-
- You have configured instances of NGINX that you want to manage through NGINX One Console.
21-
- You have or are ready to configure a data plane key.
22-
- You have or are ready to set up managed certificates.
19+
- You have [administrator access]({{< ref "/nginx-one/rbac/roles.md" >}}) to NGINX One Console.
20+
- You have [configured instances of NGINX]({{< ref "/nginx-one/getting-started.md#add-your-nginx-instances-to-nginx-one" >}}) that you want to manage through NGINX One Console.
21+
- You have or are ready to configure a [data plane key]({{< ref "/nginx-one/getting-started.md#generate-data-plane-key" >}}).
22+
- You have or are ready to set up [managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
2323

24-
{{< note >}}If this is the first time an instance is being added to a Config Sync Group, and you have not yet defined the configuration for that Config Sync Group, that instance provides the template for that group. For more information, see [Configuration management]({{< ref "nginx-one/how-to/config-sync-groups/manage-config-sync-groups#configuration-management" >}}).{{< /note >}}
24+
{{< note >}}If this is the first time an instance is being added to a Config Sync Group, and you have not yet defined the configuration for that Config Sync Group, that instance provides the template for that group. For more information, see [Configuration management]({{< ref "nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups#configuration-management" >}}).{{< /note >}}
2525

2626
## Add an instance
2727

28-
You can add an instance to NGINX One Console in the following ways:
29-
30-
- Directly, under **Instances**
31-
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**
32-
33-
In either case, NGINX One Console gives you a choice for data plane keys:
34-
35-
- Create a new key
36-
- Use an existing key
37-
38-
NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
39-
40-
Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
41-
42-
```bash
43-
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
44-
```
45-
46-
Once the process is complete, you can configure that instance in your NGINX One Console.
28+
{{< include "/nginx-one/how-to/add-instance.md" >}}
4729

4830
## Managed and Unmanaged Certificates
4931

@@ -71,5 +53,5 @@ Once you've completed the process, NGINX One reassigns this as a managed certifi
7153

7254
## Add an instance to a Config Sync Group
7355

74-
When you [Manage Config Sync Group membership]({{< ref "nginx-one/how-to/config-sync-groups/manage-config-sync-groups#manage-config-sync-group-membership" >}}), you can add an existing or new instance to the group of your choice.
56+
When you [Manage Config Sync Group membership]({{< ref "nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups#manage-config-sync-group-membership" >}}), you can add an existing or new instance to the group of your choice.
7557
That instance inherits the setup of that Config Sync Group.

content/nginx-one/how-to/containers/connect-nginx-plus-container-images-to-nginx-one.md renamed to content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: ''
33
docs: null
4-
title: Connect NGINX Plus container images to NGINX One
4+
title: Connect NGINX Plus container images
55
toc: true
66
weight: 400
77
type:
@@ -19,7 +19,7 @@ This guide explains how to set up an F5 NGINX Plus Docker container with NGINX A
1919
Before you start, make sure you have:
2020

2121
- A valid JSON Web Token (JWT) for your NGINX subscription.
22-
- [A data plane key from NGINX One]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}}).
22+
- [A data plane key from NGINX One]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}}).
2323
- Docker installed and running on your system.
2424

2525
#### Download your JWT license from MyF5

content/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md renamed to content/nginx-one/connect-instances/create-manage-data-plane-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: ''
33
docs: DOCS-1395
4-
title: Create and manage data plane keys
4+
title: Prepare - Create and manage data plane keys
55
toc: true
66
weight: 100
77
type:

0 commit comments

Comments
 (0)