generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 103
Epic 472 port nginx one labs #681
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
travisamartin
wants to merge
52
commits into
main
Choose a base branch
from
epic-472-port-nginx-one-labs
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.
Open
Changes from all commits
Commits
Show all changes
52 commits
Select commit
Hold shift + click to select a range
9698077
Added lab 1
travisamartin 2df7454
added lab2
travisamartin 25f374f
added steps for lab 2
travisamartin 411d3b8
moved lab files out of content dir
travisamartin 1e1af12
added lab 3
travisamartin 56fa0e5
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin c44decd
edits to lab 3
travisamartin 5bd0015
Merge branch 'port-lab-3' of github.com:nginx/documentation into port…
travisamartin d03aa23
deleted unused file
travisamartin 5f50bea
edits to lab 3
travisamartin a4b29ca
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin a9ecc38
Merge branch 'epic-472-port-nginx-one-labs' into port-lab-3
travisamartin 67423e7
fixed link
travisamartin 7d42168
deleted 1-day and 30-day certs and keys
travisamartin f6faf61
Ported lab 4
travisamartin d437960
Merge branch 'epic-472-port-nginx-one-labs' into port-n1-lab-4-workshop
travisamartin a04b3e7
edits to note re combining NOSS and N+ in config sync groups
travisamartin 8c8580e
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin bd9ada1
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin c3046e1
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin 7a90fb8
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin fa6260f
Port lab 5 (#733)
travisamartin fac3953
edits per tech review
travisamartin f46af90
Merge branch 'epic-472-port-nginx-one-labs' of github.com:nginx/docum…
travisamartin b461555
Apply suggestions from code review
travisamartin bfb0fec
reordered N1 workshops in nav
travisamartin 4b312a1
edits
travisamartin 16c7d06
added verification step for enabling N+ API using CSG
travisamartin e7b1ede
added card for workshops to index page
travisamartin 54faf01
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin 5d33ebd
fixed workshops card link
travisamartin 8a59ccc
Merge branch 'main' into epic-472-port-nginx-one-labs
lamATnginx 2e00869
Update workshops card link
lamATnginx 82567cf
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin e5982d4
Merge branch 'main' into epic-472-port-nginx-one-labs
lamATnginx 9bc04c0
Fix url link in N1 landing + changed to workshop for featured card
lamATnginx a6b54bf
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin a939950
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin a1b62b3
edited N1 card text to include Console
travisamartin c6b5352
removed Apache license
travisamartin 5083348
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin 61b7954
added workshop card
travisamartin c4daaa7
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin 7b5786e
added wrench icon to workshop card
travisamartin bd1fd9d
Merge branch 'epic-472-port-nginx-one-labs' of github.com:nginx/docum…
travisamartin 275abe7
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin 00221ae
Merge remote-tracking branch 'origin/main' into epic-472-port-nginx-o…
travisamartin 257b1af
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
travisamartin 9f7dc44
Merge branch 'main' into epic-472-port-nginx-one-labs
travisamartin e2871ce
tightened up the text in lab 1
travisamartin 7f23814
edits to cloud-access-nginx and cloud-access includes
travisamartin b7cfc43
fixed number in cloud-access-nginx.md include
travisamartin 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
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 |
---|---|---|
|
@@ -34,4 +34,4 @@ server { | |
root /usr/share/nginx/html; | ||
} | ||
} | ||
``` | ||
``` |
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 |
---|---|---|
@@ -1,11 +1,12 @@ | ||
--- | ||
files: | ||
- content/nginx-one/secure-your-fleet/set-up-security-alerts.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. Go to `https://<TENANT_NAME>.console.ves.volterra.io/` to access F5 Distributed Cloud, and sign in. | ||
|
||
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 | ||
After you sign in, you should see the **NGINX One** tile. | ||
|
||
1. Select the **NGINX One** tile. | ||
1. If needed, select **Enable Service**. | ||
1. After the service is enabled, select **Visit Service** to open NGINX One Console. |
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
18 changes: 18 additions & 0 deletions
18
...t/includes/use-cases/monitoring/enable-nginx-plus-api-with-config-sync-group.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,18 @@ | ||
--- | ||
docs: | ||
files: | ||
- | ||
- | ||
--- | ||
|
||
1. In the NGINX One Console, select **Manage > Config Sync Groups**, then pick your config sync group's name. | ||
2. Select the **Configuration** tab, then select **Edit Configuration**. | ||
3. Select **Add File**. | ||
4. Select **New Configuration File**. | ||
5. In the **File name** box, enter `/etc/nginx/conf.d/dashboard.conf`, then select **Add**. | ||
6. Paste the following into the new file workspace: | ||
|
||
{{< include "config-snippets/enable-nplus-api-dashboard.md" >}} | ||
|
||
7. Select **Next**, review the diff, then select **Save and Publish**. | ||
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. |
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,27 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/nginx-one/workshops/lab4/config-sync-groups.md | ||
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-r34.md | ||
|
||
--- | ||
|
||
Set these environment variables: | ||
|
||
- **TOKEN**: your data plane key, for example: | ||
|
||
```shell | ||
export TOKEN="your-data-plane-key" | ||
``` | ||
|
||
- **JWT**: your NGINX Plus license JWT. Save it as `nginx-repo.jwt`, then run: | ||
|
||
```shell | ||
export JWT=$(cat path/to/nginx-repo.jwt) | ||
``` | ||
|
||
- **NAME**: a unique ID for your workshop (for example, `s.jobs`): | ||
|
||
```shell | ||
export NAME="s.jobs" | ||
``` |
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 |
---|---|---|
|
@@ -25,12 +25,6 @@ F5 NGINX One Console makes it easy to manage NGINX instances across locations an | |
{{<card title="Get started" titleUrl="/nginx-one/getting-started/" icon="unplug" isFullSize="true">}} | ||
Get up and running with NGINX One Console | ||
{{</card >}} | ||
{{</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>}} | ||
|
@@ -46,6 +40,16 @@ F5 NGINX One Console makes it easy to manage NGINX instances across locations an | |
{{</card-section>}} | ||
{{</card-layout>}} | ||
|
||
### Workshops | ||
|
||
{{<card-layout>}} | ||
{{<card-section showAsCards="true">}} | ||
{{<card title="NGINX One Console workshops" titleUrl="/nginx-one/workshops/" icon="wrench" >}} | ||
Learn how to register and manage NGINX instances in NGINX One Console. View CVE and configuration recommendations. Use Config Sync Groups to deploy JWT licenses and upgrade to the latest NGINX Plus. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a way to set this up with bullets?
|
||
{{</card>}} | ||
{{</card-section>}} | ||
{{</card-layout>}} | ||
|
||
### More information | ||
|
||
{{<card-layout>}} | ||
|
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: Workshops | ||
description: | ||
weight: 750 | ||
url: /nginx-one/workshops | ||
--- |
121 changes: 121 additions & 0 deletions
121
content/nginx-one/workshops/lab1/getting-started-with-nginx-one.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,121 @@ | ||
--- | ||
title: "Lab 1: Get started with NGINX One Console" | ||
weight: 100 | ||
toc: true | ||
nd-content-type: tutorial | ||
nd-product: NGINX-ONE | ||
--- | ||
|
||
## Introduction | ||
|
||
In this lab, you’ll log in to NGINX One Console, explore its main features, and create a data plane key to register NGINX instances. | ||
|
||
NGINX One Console is a cloud service in the F5 Distributed Cloud platform. It lets you: | ||
|
||
- Manage all NGINX instances in one place | ||
- Monitor performance and health metrics | ||
- Detect security risks like expired SSL certificates or known vulnerabilities | ||
- Track software versions | ||
- Get performance tips | ||
|
||
Instead of switching between tools, you get one dashboard with real-time data and alerts. | ||
|
||
--- | ||
|
||
## What you’ll learn | ||
|
||
By the end of this tutorial, you can: | ||
|
||
- Open and use NGINX One Console | ||
- Understand how NGINX One Console works | ||
- Create, copy, and store a data plane key | ||
- Revoke or delete a data plane key | ||
|
||
--- | ||
|
||
## Before you begin | ||
|
||
You need: | ||
|
||
- An F5 Distributed Cloud (XC) account | ||
- NGINX One service enabled | ||
- Basic Linux and NGINX knowledge | ||
|
||
{{< include "/nginx-one/cloud-access.md" >}} | ||
|
||
--- | ||
|
||
## How NGINX One Console works | ||
|
||
NGINX One Console connects to each NGINX instance through **NGINX Agent**, a lightweight process that enables secure communication between the instance and NGINX One Console. | ||
NGINX Agent applies configuration updates from NGINX One Console, collects performance and operating system metrics, and sends event notifications from the instance. | ||
|
||
You can install NGINX Agent in several ways: | ||
|
||
- Use public Docker images of NGINX Open Source with NGINX Agent preinstalled | ||
- Use public Docker images of NGINX Plus with NGINX Agent preinstalled | ||
- Install manually with `apt` or `yum` | ||
- Use the one-line `curl` command provided during registration | ||
|
||
When you register a new instance, NGINX One Console gives you a `curl` command that downloads and installs NGINX Agent on your target system. | ||
|
||
A data plane key is required to connect an instance to NGINX One Console. Once connected, you can monitor and manage the instance from the NGINX One Console dashboard. | ||
|
||
For more about NGINX Agent, see the [NGINX Agent overview]({{< ref "/nginx-one/agent/overview/about.md" >}}). | ||
|
||
--- | ||
|
||
## Open NGINX One Console | ||
|
||
{{< include "/nginx-one/cloud-access-nginx.md" >}} | ||
|
||
|
||
Until you add NGINX instances are connected, the NGINX One Console dashboard remains empty. After you add instances, the dashboard shows metrics like availability, version, and usage trends. | ||
|
||
--- | ||
|
||
## Create a data plane key | ||
|
||
1. In NGINX One Console, go to **Manage > Data Plane Keys**. | ||
2. Select **Add Data Plane Key**. | ||
3. Enter a name for the data plane key. | ||
4. Set an expiration date, or use the one-year default. | ||
5. Select **Generate**. | ||
6. Copy the data plane key — **you can’t view it again**. | ||
7. Store the data plane key in a safe place. | ||
|
||
You can use the same data plane key to register multiple instances. If you lose the data plane key, create a new one. | ||
|
||
--- | ||
|
||
## Revoke a data plane key | ||
|
||
1. In NGINX One Console, go to **Manage > Data Plane Keys**. | ||
2. Find the data plane key you want to revoke. | ||
3. Select the data plane key. | ||
4. Choose **Revoke**, and confirm. | ||
|
||
--- | ||
|
||
## Delete a revoked data plane key | ||
|
||
You can only delete a data plane key after you revoke it. | ||
|
||
1. In NGINX One Console, go to the **Revoked Keys** tab. | ||
2. Find the data plane key you want to delete. | ||
3. Select the data plane key. | ||
4. Choose **Delete Selected**, and confirm. | ||
|
||
--- | ||
|
||
## Next steps | ||
|
||
You’re ready to connect your first NGINX instance to NGINX One Console. | ||
Go to [Lab 2: Run workshop components with Docker]({{< ref "nginx-one/workshops/lab2/run-workshop-components-with-docker.md" >}}) | ||
|
||
--- | ||
|
||
## References | ||
|
||
- [Create and manage data plane keys]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md" >}}) | ||
- [NGINX Agent overview]({{< ref "/nginx-one/agent/overview/about.md" >}}) |
Oops, something went wrong.
Oops, something went wrong.
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.
Note to self: add file references here.