generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 100
feature: Secure your fleet, NGINX One #731
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
Open
mjang
wants to merge
3
commits into
main
Choose a base branch
from
secure-your-fleet-r3
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+211
−5
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
content/includes/nginx-one/how-to/generate-data-plane-key.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nginx-one/secure-your-fleet/secure.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
A data plane key is a security token that ensures only trusted NGINX instances can register and communicate with NGINX One. | ||
|
||
To generate a data plane key: | ||
|
||
- **For a new key:** In the **Add Instance** pane, select **Generate Data Plane Key**. | ||
- **To reuse an existing key:** If you already have a data plane key and want to use it again, select **Use existing key**. Then, enter the key's value in the **Data Plane Key** box. | ||
|
||
{{<call-out "caution" "Data plane key guidelines" "fas fa-key" >}} | ||
Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely. | ||
|
||
Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#change-expiration-date" >}}). | ||
|
||
If you [Revoke a data plane key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) you disconnect all instances registered with that key. | ||
{{</call-out>}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nginx-one/secure-your-fleet/secure.md | ||
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
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. | ||
|
||
{{<call-out "important" "Connecting to NGINX One" >}} | ||
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: | ||
|
||
- `3.135.72.139` | ||
- `3.133.232.50` | ||
- `52.14.85.249` | ||
{{</call-out>}} | ||
|
||
To install NGINX Agent on an NGINX instance: | ||
|
||
1. **Check if NGINX is running and start it if it's not:** | ||
|
||
First, see if NGINX is running: | ||
|
||
```shell | ||
sudo systemctl status nginx | ||
``` | ||
|
||
If the status isn't `Active`, go ahead and start NGINX: | ||
|
||
```shell | ||
sudo systemctl start nginx | ||
``` | ||
|
||
2. **Install NGINX Agent:** | ||
|
||
Next, use the `curl` command provided to you to install NGINX Agent: | ||
|
||
``` shell | ||
curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="YOUR_DATA_PLANE_KEY" sh -s -- -y | ||
``` | ||
|
||
- Replace `YOUR_DATA_PLANE_KEY` with your actual data plane key. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Secure your fleet | ||
description: | ||
weight: 450 | ||
url: /nginx-one/secure-your-fleet | ||
--- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
--- | ||
title: "Set up security alerts" | ||
weight: 500 | ||
toc: true | ||
nd-content-type: how-to | ||
nd-product: NGINX One | ||
--- | ||
|
||
With this page, you'll learn how to set up alerts in F5 Distributed Cloud. Once configured, you'll see the CVEs and insecure configurations associated with your NGINX fleet. These instructions are intended for those responsible for keeping their NGINX infrastructure and application traffic secure. It assumes you know how to: | ||
|
||
- Install Linux programs or run Docker containers | ||
|
||
By the end of this tutorial, you'll be able to: | ||
|
||
- Access the NGINX One Console in F5 Distributed Cloud | ||
- Connect NGINX instances to the NGINX One Console | ||
- Review Security Risks associated with your NGINX fleet | ||
- Configure Alert Policies in F5 Distributed Cloud | ||
|
||
## Background | ||
|
||
NGINX One Console is a service to monitor and manage NGINX. It's a part of the F5 Distributed Cloud and is included with all NGINX and F5 Distributed Cloud subscriptions. While NGINX is built to be secure and stable, critical vulnerabilities can occasionally emerge – and misconfigurations may leave your applications or APIs exposed to attacks. | ||
|
||
## Before you begin | ||
|
||
If you already have accessed F5 Distributed Cloud and have NGINX instances available, you can skip these steps and start to connect instances to the NGINX One Console. | ||
|
||
### Confirm access to the F5 Distributed Cloud | ||
|
||
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 email in bold is the tenant name. | ||
|
||
Go 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. | ||
|
||
### Confirm access to NGINX One Console in the F5 Distributed Cloud | ||
|
||
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. Select **Visit Service** | ||
|
||
### Install an instance of NGINX | ||
|
||
Ensure you have an instance of [NGINX Open Source or NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/" >}}) installed and available. This guide provides instructions for connecting an instance installed in a Linux environment (VM or bare metal hardware) where you have command line access. | ||
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. | ||
|
||
## Connect at least one NGINX instance to the NGINX One Console | ||
|
||
If you already have connected instances to the NGINX One Console, you can start to [Configure an active alert policy]({{< ref "/nginx-one/secure-your-fleet/secure.md#configure-an-active-alert-policy" >}}). | ||
Otherwise, you need to generate a data plane key, add an instance, and install NGINX Agent. We assume this is the first time you are connecting an instance. | ||
|
||
### Add an instance | ||
|
||
{{< include "/nginx-one/how-to/add-instance.md" >}} | ||
|
||
### Generate a data plane key | ||
|
||
{{< include "/nginx-one/how-to/generate-data-plane-key.md" >}} | ||
|
||
### Install NGINX Agent | ||
|
||
{{< include "/nginx-one/how-to/install-nginx-agent.md" >}} | ||
|
||
You can also install NGINX Agent from our repositories and configure it manually. Alternatively you can use our official NGINX Docker images, pre-configured with NGINX Agent. | ||
|
||
## Configure an active alert policy | ||
|
||
The NGINX One Console monitors all connected NGINX instances for CVEs and insecure configurations. Using the F5 Distributed Cloud's Alert Policies, you can receive alerts for these risks in a manner of your choosing; for the purposes of this guide, we show you how to configure email alerts. | ||
|
||
The F5 Distributed Cloud generates alerts from all its services including NGINX One Console. You can configure rules to send those alerts to a receiver of your choice. These instructions walk you through how to configure an email notification when we see new CVEs or detect security issues with your NGINX instances. | ||
|
||
This page describes basic steps to set up an email alert. For authoritative documentation, see | ||
[Alerts - Email & SMS](https://docs.cloud.f5.com/docs-v2/shared-configuration/how-tos/alerting/alerts-email-sms). | ||
|
||
## Configure alerts to be sent to your email | ||
|
||
To configure security-related alerts, follow these steps: | ||
|
||
1. Go to the F5 Distributed Cloud Console at https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io. | ||
1. Select **Audit Logs & Alerts** | ||
1. Select **Alerts Management > Alert Receivers** | ||
1. Select **Add Alert Receiver** | ||
1. Enter the name of your choice. | ||
1. (Optional) Specify a label and description. | ||
1. Under **Receiver**, select **Email** and enter your email address. | ||
1. Select **Add Alert Receiver** | ||
Your alert receiver should now appear on the list of Alert Receivers. | ||
1. Select the **Actions** ellipsis (...) for your receiver. Select **Verify Email**. | ||
1. Select **Send email** to confirm. | ||
1. You should receive a verification code in the email provided. Copy that code. | ||
1. Under the **Actions** column, select **Enter verification code**. | ||
1. Paste the code and select **Verify receiver**. | ||
|
||
## Configure Alert Policy | ||
|
||
Next, configure the policy that identifies when you'll get an alert. | ||
|
||
1. Go to **Alerts Management > Alert Policies**. | ||
1. Select **Add Alert Policy**. | ||
1. Enter the name of your choice. | ||
1. (Optional) Specify a label and description. | ||
1. Under **Alert Reciever Configuration > Alert Receivers,** select the **Alert Receiver** you just created. | ||
1. Under **Policy Rules** select **Configure**. | ||
1. Select **Add Item**. | ||
1. Under **Select Alerts** select a filter. If you're interested in all NGINX alerts, select **Matching RegEx of Alertname**. In the text box that appears, enter **NGINX**. | ||
1. Set the **Action as Send** and select **Apply**. | ||
1. Select **Apply** again, and then select **Apply Alert Policy**. | ||
|
||
Now set a second alert related to Common Vulnerabilities and Exposures (CVEs). | ||
|
||
1. Select **Add Item** | ||
1. Under **Select Alerts** select a filter. If you're interested in all CVEs, select **Matching RegEx of Alertname**. In the text box that appears, enter **CVE**. | ||
1. Under **Select Alerts**, set the **Action** as **Send** and select **Apply** | ||
You should now see two alerts under **Policy Rules**. | ||
1. Select **Apply** to save thse policies. | ||
1. Select **Add Alert Policy**. | ||
|
||
You've now set up F5 Distributed Cloud to send you security-related alerts from NGINX One Console. | ||
|
||
## Summary | ||
|
||
In this tutorial, you learned how to: | ||
|
||
- Access the NGINX One Console | ||
- Connect an NGINX instance | ||
- Configure an Alert | ||
|
||
You will now receive an email any time the NGINX One Console recognizes one of your connected instances has a configuration that is insecure or an NGINX CVE impacts it. | ||
travisamartin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Next steps | ||
|
||
Now that you have NGINX instances connected to the NGINX One Console, consider reviewing our [use cases]({{< ref "/nginx-one/" >}}) to see how you can easily manage your NGINX instances, draft new configurations, and more. | ||
Additionally, you can review how to add additional Alert Receivers such as [SMS](https://docs.cloud.f5.com/docs-v2/shared-configuration/how-tos/alerting/alerts-email-sms), [Slack](https://docs.cloud.f5.com/docs-v2/shared-configuration/how-tos/alerting/alerts-slack), [PagerDuty](https://docs.cloud.f5.com/docs-v2/shared-configuration/how-tos/alerting/alerts-pagerduty), or with a [webhook](https://docs.cloud.f5.com/docs-v2/shared-configuration/how-tos/alerting/alerts-webhook). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we spell out CVE on first mention? Or is this a well-known domain acronym?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I have the "curse of knowledge" on this one. It's not spelled out in the UI. You're welcome to say "that's not good enough".