Skip to content

Commit 2ca51c4

Browse files
Epic 472 port nginx one labs (#681)
Added NGINX One workshops.
1 parent b4af88d commit 2ca51c4

Some content is hidden

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

49 files changed

+3676
-18
lines changed

content/includes/config-snippets/enable-nplus-api-dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ server {
3434
root /usr/share/nginx/html;
3535
}
3636
}
37-
```
37+
```
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
files:
3-
- content/nginx-one/secure-your-fleet/set-up-security-alerts.md
43
- content/nginx-one/getting-started.md
54
---
65

7-
Once you've logged in with your password, you should be able to see and select the NGINX One tile.
6+
1. Go to `https://<TENANT_NAME>.console.ves.volterra.io/` to access F5 Distributed Cloud, and sign in.
87

9-
1. Select the **NGINX One** tile
10-
1. If needed, select **Enable Service**
11-
1. After the service has been enables, select **Visit Service** to load NGINX One Console
8+
After you sign in, you should see the **NGINX One** tile.
9+
10+
1. Select the **NGINX One** tile.
11+
1. If needed, select **Enable Service**.
12+
1. After the service is enabled, select **Visit Service** to open NGINX One Console.

content/includes/nginx-one/cloud-access.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@ files:
44
- content/nginx-one/getting-started.md
55
---
66

7-
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.
7+
Confirm that an F5 Distributed Cloud tenant has been provisioned for you.
88

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.
9+
1. Log in to [MyF5](https://my.f5.com/manage/s/) and review your subscriptions.
10+
2. Look for **Distributed Cloud** in one of your subscriptions. This could appear under an NGINX subscription or a Distributed Cloud subscription.
1011

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.
12+
If you don’t see **Distributed Cloud** in any subscription, contact your F5 account team or Customer Success Manager.
13+
14+
When your tenant is created, you or someone in your organization should receive an email from **[email protected]** asking you to set your password. The account name in bold in the email is your tenant name.
15+
16+
Go to `https://<TENANT_NAME>.console.ves.volterra.io/` to access F5 Distributed Cloud.
17+
If you have never signed in, select **Forgot Password?** on the sign-in page.
18+
Alternatively, ask someone in your organization with access to add you as a user in your tenant with a role that includes permissions for NGINX One Console.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
files:
3+
- content/nginx-one/workshops/lab2/run-workshop-components-with-docker.md
4+
- content/nginx-one/workshops/lab3/explore-nginx-one-console-and-features.md
5+
- content/nginx-one/workshops/lab4/config-sync-groups.md
6+
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-latest-version.md
7+
---
8+
9+
All labs require an **F5 Distributed Cloud (XC) account** with NGINX One enabled. If you don’t have an account or need to verify access, follow the steps in [Lab 1: Before you begin]({{< ref "nginx-one/workshops/lab1/getting-started-with-nginx-one.md#before-you-begin" >}}).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-latest-version.md
5+
- content/nginx-one/nginx-configs/metrics/enable-metrics.md
6+
---
7+
8+
1. In the NGINX One Console, select **Manage > Config Sync Groups**, then pick your config sync group's name.
9+
2. Select the **Configuration** tab, then select **Edit Configuration**.
10+
3. Select **Add File**.
11+
4. Select **New Configuration File**.
12+
5. In the **File name** box, enter `/etc/nginx/conf.d/dashboard.conf`, then select **Add**.
13+
6. Paste the following into the new file workspace:
14+
15+
{{< include "config-snippets/enable-nplus-api-dashboard.md" >}}
16+
17+
7. Select **Next**, review the diff, then select **Save and Publish**.
18+
8. Open your browser to `http://<instance-ip>:9000/dashboard.html` (replace `<instance-ip>` with the IP or hostname of one of your group members). You should see the NGINX Plus dashboard.

content/includes/use-cases/monitoring/enable-nginx-plus-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ To collect comprehensive metrics for NGINX Plus, including bytes streamed, infor
1515
- To restrict write methods (`POST`, `PATCH`, `DELETE`), uncomment and configure the `limit_except GET` block and set up [HTTP basic authentication](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html).
1616
{{</ call-out >}}
1717

18-
For more details, see the [NGINX Plus API module](https://nginx.org/en/docs/http/ngx_http_api_module.html) documentation and [Configuring the NGINX Plus API]({{< ref "/nginx/admin-guide/monitoring/live-activity-monitoring.md#configuring-the-api" >}}).
18+
For more details, see the [NGINX Plus API module](https://nginx.org/en/docs/http/ngx_http_api_module.html) documentation and [Configuring the NGINX Plus API]({{< ref "/nginx/admin-guide/monitoring/live-activity-monitoring.md#configuring-the-api" >}}).
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/workshops/lab4/config-sync-groups.md
5+
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-r34.md
6+
7+
---
8+
9+
Set these environment variables:
10+
11+
- **TOKEN**: your data plane key, for example:
12+
13+
```shell
14+
export TOKEN="your-data-plane-key"
15+
```
16+
17+
- **JWT**: your NGINX Plus license JWT. Save it as `nginx-repo.jwt`, then run:
18+
19+
```shell
20+
export JWT=$(cat path/to/nginx-repo.jwt)
21+
```
22+
23+
- **NAME**: a unique ID for your workshop (for example, `s.jobs`):
24+
25+
```shell
26+
export NAME="s.jobs"
27+
```

content/nginx-one/_index.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,6 @@ F5 NGINX One Console makes it easy to manage NGINX instances across locations an
2525
{{<card title="Get started" titleUrl="/nginx-one/getting-started/" icon="unplug" isFullSize="true">}}
2626
Get up and running with NGINX One Console
2727
{{</card >}}
28-
{{</card-section>}}
29-
{{</card-layout>}}
30-
31-
32-
{{<card-layout>}}
33-
{{<card-section showAsCards="true" >}}
3428
{{<card title="Connect more NGINX instances" titleUrl="/nginx-one/connect-instances/" >}}
3529
Work with data plane keys, containers, and proxy servers
3630
{{</card>}}
@@ -46,6 +40,16 @@ F5 NGINX One Console makes it easy to manage NGINX instances across locations an
4640
{{</card-section>}}
4741
{{</card-layout>}}
4842

43+
### Workshops
44+
45+
{{<card-layout>}}
46+
{{<card-section showAsCards="true">}}
47+
{{<card title="NGINX One Console workshops" titleUrl="/nginx-one/workshops/" icon="wrench" >}}
48+
Guided labs to help you secure, monitor, and scale your NGINX fleet with NGINX One Console.
49+
{{</card>}}
50+
{{</card-section>}}
51+
{{</card-layout>}}
52+
4953
### More information
5054

5155
{{<card-layout>}}

content/nginx-one/nginx-configs/metrics/enable-metrics.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ nd-product: NGINX-One
1414

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

17-
### Enable NGINX Plus API
17+
## Enable NGINX Plus API and dashboard
1818

1919
{{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}}
2020

21-
### Enable NGINX Open Source Stub Status API
21+
## Enable NGINX Plus API and dashboard with Config Sync Groups
22+
23+
To enable the NGINX Plus API and dashboard with [Config Sync Groups]({{< ref "nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}), add a file named `/etc/nginx/conf.d/dashboard.conf` to your shared group config. Any instance you add to that group automatically uses those settings.
24+
25+
{{< include "use-cases/monitoring/enable-nginx-plus-api-with-config-sync-group.md" >}}
26+
27+
## Enable NGINX Open Source Stub Status API
2228

2329
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}

content/nginx-one/workshops/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Workshops
3+
description:
4+
weight: 710
5+
url: /nginx-one/workshops
6+
---

0 commit comments

Comments
 (0)