Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/includes/nginx-one/cloud-access-nginx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
files:
- content/nginx-one/secure-your-fleet/secure.md
- content/nginx-one/getting-started.md
---

Once you've logged in with your password, you should be able to see and select the NGINX One tile.

1. Select the **NGINX One** tile
1. If needed, select **Enable Service**
1. After the service has been enables, select **Visit Service** to load NGINX One Console
11 changes: 11 additions & 0 deletions content/includes/nginx-one/cloud-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
files:
- content/nginx-one/secure-your-fleet/secure.md
- content/nginx-one/getting-started.md
---

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.

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.

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.
10 changes: 10 additions & 0 deletions content/includes/nginx-one/install-nginx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
files:
- content/nginx-one/secure-your-fleet/secure.md
- content/nginx-one/getting-started.md
---

If you need to set up an instance of NGINX, you can do so in one of the following ways:

- Install [NGINX Open Source or NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}}). You can use the linked guide to install NGINX in a Linux environment, in a VM or on bare-metal hardware.
- [Deploy NGINX and NGINX Plus with Docker]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-docker.md" >}}) with NGINX and the NGINX Agent installed.
41 changes: 33 additions & 8 deletions content/nginx-one/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,52 @@ nd-product: NGINX One
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
[//]: # "Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
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.
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, which includes [NGINX One components](#nginx-one-components).

## Featured content
[//]: # "You can add a maximum of three cards: any extra will not display."
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
{{<card-layout>}}
{{<card-section showAsCards="true" isFeaturedSection="true">}}
{{<card title="Get started" titleUrl="nginx-one/getting-started/" isFeatured="true" icon="unplug">}}
See benefits from the NGINX One Console
{{<card title="Get started" titleUrl="/nginx-one/getting-started/" isFeatured="true" icon="unplug">}}
Get up and running with NGINX One Console
{{</card >}}
{{<card title="Changelog" titleUrl="nginx-one/changelog/" icon="clock-alert">}}
{{</card-section>}}
{{</card-layout>}}


{{<card-layout>}}
{{<card-section showAsCards="true" >}}
{{<card title="Connect more NGINX instances" titleUrl="/nginx-one/connect-instances/" >}}
Work with data plane keys, containers, and proxy servers
{{</card>}}
{{<card title="Manage your NGINX instances" titleUrl="/nginx-one/nginx-configs/" >}}
Manage one instance or groups of instances. Monitor certificates. Set up metrics.
{{</card>}}
{{<card title="Organize users with RBAC" titleUrl="/nginx-one/rbac/" >}}
Assign responsibilities with role-based access control
{{</card>}}
{{<card title="Automate with the NGINX One API" titleUrl="/nginx-one/api/" >}}
Manage your NGINX fleet over REST
{{</card>}}
{{</card-section>}}
{{</card-layout>}}

### More information

{{<card-layout>}}
{{<card-section showAsCards="true" >}}
{{<card title="Glossary" titleUrl="/nginx-one/glossary/" >}}
See latest updates: New features, improvements, and bug fixes
{{</card>}}
{{<card title="Add an NGINX instance" titleUrl="nginx-one/connect-instances/add-instance/" icon="copy-plus">}}
Connect your instances to NGINX One
{{<card title="Changelog" titleUrl="/nginx-one/changelog/" icon="clock-alert">}}
See latest updates: New features, improvements, and bug fixes
{{</card>}}
{{</card-section>}}
{{</card-layout>}}

## Other Components
## NGINX One components
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."

{{< card-layout >}}
Expand Down Expand Up @@ -66,4 +91,4 @@ The F5 NGINX One Console makes it easy to manage NGINX instances across location
Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.
{{</ card >}}
{{</ card-section >}}
{{</card-layout>}}
{{</card-layout>}}
21 changes: 0 additions & 21 deletions content/nginx-one/about.md

This file was deleted.

4 changes: 2 additions & 2 deletions content/nginx-one/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ You can:
- Remove a deployed certificate from a Config Sync Group

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

### Revert a configuration
Expand Down Expand Up @@ -144,7 +144,7 @@ Select the link for each CVE to see the details, including the CVE's publish dat

### Edit NGINX configurations

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" >}}).
You can now make configuration changes to your NGINX instances. For more details, see [View and edit NGINX configurations]({{< ref "/nginx-one/nginx-configs/one-instance/view-edit-nginx-configurations.md" >}}).

## May 28, 2024

Expand Down
2 changes: 1 addition & 1 deletion content/nginx-one/connect-instances/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description:
title: Connect your instances
title: Connect more instances
weight: 200
url: /nginx-one/connect-instances/
---
4 changes: 2 additions & 2 deletions content/nginx-one/connect-instances/add-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: ''
title: Add an NGINX instance
toc: true
weight: 100
weight: 300
type:
- how-to
---
Expand Down Expand Up @@ -54,4 +54,4 @@ Once you've completed the process, NGINX One reassigns this as a managed certifi
## Add an instance to a Config Sync Group

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.
That instance inherits the setup of that Config Sync Group.
That instance inherits the setup of that Config Sync Group.
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,7 @@ Before you can delete a key, it must be expired or revoked. You can revoke a key
2. Find the key you want to revoke in the list of expired or revoked keys.
3. Next to the key name, select the check box. You can select multiple keys at the same time.
4. Select **Delete selected**.

## Use the API

You can use our [API to manage your data plane keys]({{< ref "/nginx-one/api/api-reference-guide/#tag/Data-Plane/Key" >}}) in all of these ways (and more).
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
description: ''
nd-docs: null
title: Minimize connections - Set up NGINX as a proxy
title: Prepare - Set up NGINX as a proxy
toc: true
weight: 300
weight: 200
type:
- how-to
---
Expand Down
153 changes: 89 additions & 64 deletions content/nginx-one/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,109 @@ toc: true
weight: 100
type: how-to
product: NGINX One
nd-docs: DOCS-1393
---

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.
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.

## Enable the NGINX One service {#enable-nginx-one}
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" >}})

To get started using NGINX One, enable the service on F5 Distributed Cloud.
## Benefits and key features

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

- **Centralized control**: Manage all your NGINX instances from a single console.
- **Enhanced monitoring and risk detection**: Automatically detect critical vulnerabilities (CVEs), verify SSL certificate statuses, and identify security issues in NGINX configurations.
- **Performance optimization**: Track your NGINX versions and receive recommendations for tuning your configurations for better performance.
- **Graphical Metrics Display**: Access a dashboard that shows key metrics for your NGINX instances, including instance availability, version distribution, system health, and utilization trends.
- **Real-time alerts**: Receive alerts about critical issues.

## Before you begin

**You need access to F5 Distributed Cloud**.

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.

<details>
<summary>If you want to register for a trial</summary>

### Register for a trial subscription

<!-- Make sure to check with sales enablement -->
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:

1. Navigate to https://account.f5.com/myf5 and log in.
1. Select trials
1. Find **F5 NGINX**. Sign up for the trial.
1. The trial may require approval.

</details>

<details>
<summary>Confirm access to the F5 Distributed Cloud</summary>

### Confirm access to the F5 Distributed Cloud

{{< include "/nginx-one/cloud-access.md" >}}

</details>

<details>
<summary>Confirm access to NGINX One Console</summary>

### Confirm access to NGINX One Console

{{< include "/nginx-one/cloud-access-nginx.md" >}}

</details>

<details>
<summary>Install an instance of NGINX</summary>

### Install an instance of NGINX

{{< include "/nginx-one/install-nginx.md" >}}

</details>

<details>
<summary>Make sure you're running a supported Linux distribution</summary>

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.

### NGINX Agent installation script: supported distributions

{{<bootstrap-table "table table-striped table-bordered">}}

| Distribution | Version | Architecture |
|------------------------------|----------------------|-----------------|
| AlmaLinux | 8, 9 | x86_64, aarch64 |
| Alpine Linux | 3.16 - 3.18 | x86_64, aarch64 |
| Amazon Linux | 2023 | x86_64, aarch64 |
| Amazon Linux 2 | LTS | x86_64, aarch64 |
| CentOS | 7.4+ | x86_64, aarch64 |
| Debian | 11, 12 | x86_64, aarch64 |
| Oracle Linux | 7.4+, 8.1+, 9 | x86_64 |
| Red Hat Enterprise Linux | 7.4+, 8.1+, 9 | x86_64, aarch64 |
| Rocky Linux | 8, 9 | x86_64, aarch64 |
| Ubuntu | 20.04 LTS, 22.04 LTS | x86_64, aarch64 |

{{</bootstrap-table>}}

</span>

</details>

---

## Add your NGINX instances to NGINX One

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.
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.

The following instructions include minimal information, sufficient to "get started." See the following links for detailed instructions:

- [Create and manage data plane keys]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
- [Prepare - Create and manage data plane keys]({{< ref "/nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
- [Add an NGINX instance]({{< ref "/nginx-one/connect-instances/add-instance.md" >}})
- [Connect NGINX Plus container images]({{< ref "/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md" >}})

### Generate a data plane key {#generate-data-plane-key}

Expand Down Expand Up @@ -103,29 +182,6 @@ The `install` script writes an `nginx-agent.conf` file to the `/etc/nginx-agent/

<br>

<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.

#### NGINX Agent installation script: supported distributions

{{<bootstrap-table "table table-striped table-bordered">}}

| Distribution | Version | Architecture |
|------------------------------|----------------------|-----------------|
| AlmaLinux | 8, 9 | x86_64, aarch64 |
| Alpine Linux | 3.16 - 3.18 | x86_64, aarch64 |
| Amazon Linux | 2023 | x86_64, aarch64 |
| Amazon Linux 2 | LTS | x86_64, aarch64 |
| CentOS | 7.4+ | x86_64, aarch64 |
| Debian | 11, 12 | x86_64, aarch64 |
| Oracle Linux | 7.4+, 8.1+, 9 | x86_64 |
| Red Hat Enterprise Linux | 7.4+, 8.1+, 9 | x86_64, aarch64 |
| Rocky Linux | 8, 9 | x86_64, aarch64 |
| Ubuntu | 20.04 LTS, 22.04 LTS | x86_64, aarch64 |

{{</bootstrap-table>}}

</span>

---

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.
Expand Down Expand Up @@ -153,37 +209,6 @@ After connecting your NGINX instances to NGINX One, you can monitor their perfor

{{< include "/use-cases/monitoring/n1c-dashboard-overview.md" >}}

Navigating the dashboard:

- **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.
- **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.

<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;">
{{< img src="nginx-one/images/nginx-one-dashboard.png">}}
</span>

{{<bootstrap-table "table table-striped table-bordered">}}
**NGINX One dashboard metrics**
| Metric | Description | Details |
|---|---|---|
| <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. |
| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
| <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. | |
| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
| <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. |
| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
| <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. | |
| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |

{{</bootstrap-table>}}








Expand Down
Loading