Skip to content

feature: Secure your fleet #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 24 commits into from
Closed
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
2 changes: 1 addition & 1 deletion _banners/upgrade-r33.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{< banner "caution" "NGINX Plus R33 requires NGINX Instance Manager 2.18 or later" >}}
If your NGINX data plane instances are running NGINX Plus R33 or later, you must upgrade to NGINX Instance Manager 2.18 or later to support usage reporting. NGINX Plus R33 instances must report usage data to the F5 licensing endpoint or NGINX Instance Manager. Otherwise, they will stop processing traffic.
<br><br>
For more details about usage reporting and enforcement, see [About solution licenses](../../../../solutions/about-subscription-licenses)
For more details about usage reporting and enforcement, see [About solution licenses]({{< ref "/solutions/about-subscription-licenses.md" >}})
{{</ banner >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
docs:
---

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

1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.
Expand Down
29 changes: 29 additions & 0 deletions content/includes/nginx-one/how-to/add-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
docs:
<<<<<<< HEAD
files:
- content/nginx-one/connect-instances/add-instance.md
- content/nginx-one/getting-started.md
=======
>>>>>>> 4067237f (More)
---

You can add an instance to NGINX One Console in the following ways:

- Directly, under **Instances**
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**

In either case, NGINX One Console gives you a choice for data plane keys:

- Create a new key
- Use an existing key

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.

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.

```bash
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
```

Once the process is complete, you can configure that instance in your NGINX One Console.
39 changes: 39 additions & 0 deletions content/includes/use-cases/monitoring/n1c-dashboard-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
docs:
files:
- content/nginx-one/metrics/enable-metrics.md
- content/nginx-one/getting-started.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>}}






6 changes: 1 addition & 5 deletions content/nginx-one/about.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: ''
docs: DOCS-1392
title: About
title: Manage your NGINX fleet
toc: true
weight: 10
type:
Expand All @@ -19,7 +19,3 @@ NGINX One offers the following key benefits:
- **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.

## Legal notice: Licensing agreements for NGINX products

Using NGINX One is subject to our End User Service Agreement (EUSA). For [NGINX Plus]({{< ref "/nginx" >}}), usage is governed by the End User License Agreement (EULA). Open source projects, including [NGINX Agent](https://github.com/nginx/agent) and [NGINX OSS](https://github.com/nginx/nginx), are covered under their respective licenses. For more details on these licenses, follow the provided links.
18 changes: 15 additions & 3 deletions content/nginx-one/api/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
---
title: API
<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
title: Automate with the NGINX One API
=======
title: NGINX One API
>>>>>>> c7ce27ce (Draft: new N1C doc homepage)
=======
title: Automation with the NGINX One API
>>>>>>> 614bafed (more)
=======
title: Automate with the NGINX One API
>>>>>>> 4da8aa7e (based on Jason's feedback)
description:
weight: 1000
weight: 700
url: /nginx-one/api
---
---
6 changes: 6 additions & 0 deletions content/nginx-one/certificates/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description:
title: Monitor your certificates
weight: 400
url: /nginx-one/certificates
---
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ From the NGINX One Console you can:

You can manage the certificates for:

- [Unique instances]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md#new-ssl-certificate-or-ca-bundle" >}})
- For all instances that are members of a [Config Sync Group]({{< ref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups/#configuration-management" >}})
- [Unique instances]({{< ref "/nginx-one/nginx-configs/add-file.md#new-ssl-certificate-or-ca-bundle" >}})
- For all instances that are members of a [Config Sync Group]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups/#configuration-management" >}})


{{< tip >}}
Expand Down Expand Up @@ -178,7 +178,7 @@ If you register an instance to NGINX One Console, as described in [Add your NGIN
- Are used in their NGINX configuration
- Do _not_ match an existing managed SSL certificate/CA bundle

These certificates appear in the list of unmanaged certificates. NGINX One Console does not store unmanaged certs or keys, only metadata associated with certs for monitoring.
These certificates appear in the list of unmanaged certificates.

We recommend that you convert your unmanaged certificates. Converting to a managed certificate allows you to centrally manage, update, and deploy a certificate to your data plane from the NGINX One Console.

Expand All @@ -193,5 +193,5 @@ To convert these cerificates to managed, start with the Certificates menu, and s
## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Add a file in a configuration]({{< ref "/nginx-one/how-to/nginx-configs/add-file.md" >}})
- [Add an instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
- [Add a file in a configuration]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
22 changes: 17 additions & 5 deletions content/nginx-one/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,12 @@ 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/how-to/nginx-configs/add-file.md" >}})
- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
- [Add a file]({{< ref "/nginx-one/nginx-configs/add-file.md" >}})
<<<<<<< HEAD
- [Manage certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}})
=======
- [Manage certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}})
>>>>>>> c7ce27ce (Draft: new N1C doc homepage)

### Revert a configuration

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

For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}}).
<<<<<<< HEAD
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).
=======
For more information, see the full documentation on how you can [Manage Certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}}).
>>>>>>> c7ce27ce (Draft: new N1C doc homepage)

## August 22, 2024

### Config Sync Groups

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.

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" >}}).
<<<<<<< HEAD
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" >}}).
=======
For more information, see the full documentation on [Managing Config Sync Groups]({{< ref "/nginx-one/config-sync-groups/manage-config-sync-groups.md" >}}).
>>>>>>> c7ce27ce (Draft: new N1C doc homepage)

## August 8, 2024

Expand All @@ -136,7 +148,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/how-to/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/view-edit-nginx-configurations.md" >}}).

## May 28, 2024

Expand Down
6 changes: 6 additions & 0 deletions content/nginx-one/config-sync-groups/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description:
title: Change multiple instances with one push
weight: 400
url: /nginx-one/config-sync-groups
---
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ Enter the name of the desired configuration file, such as `abc.conf` and select
### Existing SSL Certificate or CA Bundle

{{< include "nginx-one/add-file/existing-ssl-bundle.md" >}}
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).

## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Manage certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md" >}})
- [Add an NGINX instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
- [Manage certificates]({{< ref "/nginx-one/certificates/manage-certificates.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Config Sync Groups support configuration inheritance and persistance. If you've

On the other hand, if you remove all instances from a Config Sync Group, the original configuration persists. In other words, the group retains the configuration from that first instance (or the original configuration). Any new instance that you add later still inherits that configuration.

{{< tip >}}You can use _unmanaged_ certificates. NGINX One Console does not store unmanaged certs or keys, only metadata associated with the certs or keys for monitoring. Your actions can affect the [Config Sync Group status](#config-sync-group-status). For future instances on the data plane, if it:
{{< tip >}}You can use _unmanaged_ certificates. Your actions can affect the [Config Sync Group status](#config-sync-group-status). For future instances on the data plane, if it:

- Has unmanaged certificates in the same file paths as defined by the NGINX configuration as the Config Sync Group, that instance will be [**In Sync**](#config-sync-group-status).
- Will be [**Out of Sync**](#config-sync-group-status) if the instance:
Expand Down Expand Up @@ -100,12 +100,6 @@ Now that you created a Config Sync Group, you can add instances to that group. A

Any instance that joins the group afterwards inherits that configuration.

{{< note >}} If you see the following [Config Sync Group Status](#config-sync-group-status) message: **Out of Sync**:

- Review the instance details in NGINX One Console to identify any publication problems.
- After you change the configuration of the Config Sync Group, [Publish it](#publish-the-config-sync-group-configuration].
In that case, review and resolve discrepancies between the Instance and the rest of the Config Sync Group. {{< /note >}}

### Add an existing instance to a Config Sync Group {#add-an-existing-instance-to-a-config-sync-group}

You can add existing NGINX instances that are already registered with NGINX One to a Config Sync Group.
Expand Down Expand Up @@ -264,4 +258,4 @@ Monitor the **Config Sync Status** column. It can help you ensure that your conf
## See also

- [Create and manage data plane keys]({{< ref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}})
- [View and edit NGINX configurations]({{< ref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}})
- [Add an NGINX instance]({{< ref "/nginx-one/nginx-configs/add-instance.md" >}})
6 changes: 6 additions & 0 deletions content/nginx-one/connect-instances/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
description:
title: Connect your instances
weight: 200
url: /nginx-one/connect-instances/
---
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,16 @@ to set up a data plane key to connect your instances to NGINX One.

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

- You have administrator access to NGINX One Console.
- You have configured instances of NGINX that you want to manage through NGINX One Console.
- You have or are ready to configure a data plane key.
- You have or are ready to set up managed certificates.
- You have [administrator access]({{< ref "/nginx-one/rbac/roles.md" >}}) to NGINX One Console.
- 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.
- You have or are ready to configure a [data plane key]({{< ref "/nginx-one/getting-started.md#generate-data-plane-key" >}}).
- You have or are ready to set up [managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md" >}}).

{{< 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 >}}
{{< 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 >}}

## Add an instance

You can add an instance to NGINX One Console in the following ways:

- Directly, under **Instances**
- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**

In either case, NGINX One Console gives you a choice for data plane keys:

- Create a new key
- Use an existing key

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.

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.

```bash
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
```

Once the process is complete, you can configure that instance in your NGINX One Console.
{{< include "/nginx-one/how-to/add-instance.md" >}}

## Managed and Unmanaged Certificates

Expand Down Expand Up @@ -71,5 +53,5 @@ 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/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.
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.
Loading