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
Confirm an F5 Distributed Cloud tenant has been provisioned for you. Log in to MyF5 and review your subscriptions. You should see within one of your subscriptions "Distributed Cloud". This could be in either an NGINX subscription or a Distributed Cloud. If the above does not appear in any of your subscriptions, reach out to either your F5 Account Team or Customer Success Manager.
8
+
9
+
With access, you or someone in your organization should have an email from [email protected] asking you to update your password when the tenant was created. The account name referenced in the E-Mail in bold is the tenant name.
10
+
11
+
Navigate to https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ to access F5 Distributed Cloud. If you have never logged in, select the **Forgot Password?** option in the log in screen. Alternatively, if someone within your organization has access, ask them to add you as a user within your tenant with a role providing permissions for NGINX One.
Ensure you have an instance of [NGINX Open Source or NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}}) installed and available. This guide will provide instructions for connecting an instance installed in a Linux environment (VM or bare metal hardware) where you have command line access.
8
+
Alternatively, we also have instructions for [Deploying NGINX and NGINX Plus with Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md" >}}) with NGINX and the NGINX Agent installed. That deployment can connect with environment variables.
Copy file name to clipboardExpand all lines: content/nginx-one/_index.md
+39-7Lines changed: 39 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,27 +13,59 @@ nd-product: NGINX One
13
13
[//]: #"These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
14
14
[//]: #"Use underscores for _italics_, and double asterisks for **bold**."
15
15
[//]: #"Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
16
-
The F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more.
16
+
F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more. NGINX One Console is part of NGINX One suite, which includes [additional components](#other-components).
17
17
18
18
## Featured content
19
19
[//]: #"You can add a maximum of three cards: any extra will not display."
20
20
[//]: #"One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
21
21
[//]: #"Some examples of content could be the latest release note, the most common install path, and a popular new feature."
Copy file name to clipboardExpand all lines: content/nginx-one/getting-started.md
+96-58Lines changed: 96 additions & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,65 @@ toc: true
4
4
weight: 100
5
5
type: how-to
6
6
product: NGINX One
7
-
nd-docs: DOCS-1393
8
7
---
9
8
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.
9
+
The F5 NGINX One Console makes it easy to manage NGINX instances across locations and environments. The console lets you monitor and control your NGINX fleet from one place—you can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more.
11
10
12
-
## Enable the NGINX One service {#enable-nginx-one}
11
+
This guide provides step-by-step instructions to activate and use F5 NGINX One Console. For a list of the latest changes, see our [changelog]({{< ref "/nginx-one/changelog.md" >}})
12
+
13
+
## Benefits and key features
14
+
15
+
NGINX One offers the following key benefits:
16
+
17
+
-**Centralized control**: Manage all your NGINX instances from a single console.
18
+
-**Enhanced monitoring and risk detection**: Automatically detect critical vulnerabilities (CVEs), verify SSL certificate statuses, and identify security issues in NGINX configurations.
19
+
-**Performance optimization**: Track your NGINX versions and receive recommendations for tuning your configurations for better performance.
20
+
-**Graphical Metrics Display**: Access a dashboard that shows key metrics for your NGINX instances, including instance availability, version distribution, system health, and utilization trends.
21
+
-**Real-time alerts**: Receive alerts about critical issues.
22
+
23
+
## Before you begin
24
+
25
+
**You need access to F5 Distributed Cloud**.
26
+
27
+
If you already have accessed F5 Distributed Cloud and have NGINX instances available, you can skip these sections and start to [Add your NGINX instances to NGINX One](#add-your-nginx-instances-to-nginx-one). Otherwise, take these steps to "onboard" yourself to NGINX One Console.
28
+
29
+
<details>
30
+
<summary>If you want to register for a trial</summary>
31
+
32
+
### Register for a trial subscription
33
+
34
+
<!-- Make sure to check with sales enablement -->
35
+
If you want to register for a trial, navigate to https://account.f5.com/myf5. If needed, select **Sign up** to get an account. Then follow these steps:
36
+
37
+
1. Navigate to https://account.f5.com/myf5 and log in.
38
+
1. Select trials
39
+
1. Find **F5 NGINX**. Sign up for the trial.
40
+
1. The trial may require approval.
41
+
42
+
</details>
43
+
44
+
<details>
45
+
<summary>Confirm access to the F5 Distributed Cloud</summary>
46
+
47
+
### Confirm access to the F5 Distributed Cloud
48
+
49
+
{{< include "/nginx-one/cloud-access.md" >}}
50
+
51
+
</details>
52
+
53
+
<details>
54
+
<summary>Confirm access to NGINX One Console</summary>
55
+
56
+
### Confirm access to NGINX One Console
57
+
58
+
{{< include "/nginx-one/cloud-access-nginx.md" >}}
59
+
60
+
</details>
61
+
62
+
<details>
63
+
<summary>Enable the NGINX One service</summary>
64
+
65
+
### Enable the NGINX One service {#enable-nginx-one}
13
66
14
67
To get started using NGINX One, enable the service on F5 Distributed Cloud.
15
68
@@ -18,11 +71,50 @@ To get started using NGINX One, enable the service on F5 Distributed Cloud.
18
71
1. Select **Enable Service**.
19
72
1. After the service has been enabled, select **Visit Service** to load NGINX One Console.
20
73
74
+
</details>
75
+
76
+
<details>
77
+
<summary>Install an instance of NGINX</summary>
78
+
79
+
### Install an instance of NGINX
80
+
81
+
{{< include "/nginx-one/install-nginx.md" >}}
82
+
83
+
</details>
84
+
85
+
<details>
86
+
<summary>Make sure you're running a supported Linux distribution</summary>
87
+
88
+
NGINX Agent sets up communication between your NGINX Instance and NGINX One Console. Make sure your Linux operating system is listed below. The installation script for NGINX Agent is compatible with these distributions and versions.
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.
117
+
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
118
27
119
The following instructions include minimal information, sufficient to "get started." See the following links for detailed instructions:
28
120
@@ -103,29 +195,6 @@ The `install` script writes an `nginx-agent.conf` file to the `/etc/nginx-agent/
103
195
104
196
<br>
105
197
106
-
<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.
The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Source Stub Status to report traffic and system metrics. The following sections show you how to enable those metrics.
@@ -153,37 +222,6 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor
153
222
154
223
{{< include "/use-cases/monitoring/n1c-dashboard-overview.md" >}}
155
224
156
-
Navigating the dashboard:
157
-
158
-
- **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.
159
-
- **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.
| <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. |
170
-
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
171
-
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
172
-
| <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. | |
173
-
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. ||
174
-
|<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. |
175
-
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
176
-
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
177
-
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
178
-
| <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. | |
179
-
| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |
0 commit comments