-
Notifications
You must be signed in to change notification settings - Fork 96
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
base: main
Are you sure you want to change the base?
Changes from all commits
9698077
2df7454
25f374f
411d3b8
1e1af12
56fa0e5
c44decd
5bd0015
d03aa23
5f50bea
a4b29ca
a9ecc38
67423e7
7d42168
f6faf61
d437960
a04b3e7
8c8580e
bd9ada1
c3046e1
7a90fb8
fa6260f
fac3953
f46af90
b461555
bfb0fec
4b312a1
16c7d06
e7b1ede
54faf01
5d33ebd
8a59ccc
2e00869
82567cf
e5982d4
9bc04c0
a6b54bf
a939950
a1b62b3
c6b5352
5083348
61b7954
c4daaa7
7b5786e
bd1fd9d
275abe7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,4 @@ server { | |
root /usr/share/nginx/html; | ||
} | ||
} | ||
``` | ||
``` |
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. |
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" | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,18 +24,18 @@ F5 NGINX One Console makes it easy to manage NGINX instances across locations an | |
{{<card title="Get started" titleUrl="/nginx-one/getting-started/" isFeatured="true" icon="unplug">}} | ||
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>}} | ||
{{<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-section>}} | ||
{{</card-layout>}} | ||
|
||
|
||
{{<card-layout>}} | ||
{{<card-section showAsCards="true" >}} | ||
{{<card title="Organize users with RBAC" titleUrl="/nginx-one/rbac/" >}} | ||
Assign responsibilities with role-based access control | ||
{{</card>}} | ||
|
@@ -45,6 +45,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>}} | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Workshops | ||
description: | ||
weight: 750 | ||
url: /nginx-one/workshops | ||
--- |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
--- | ||
title: "Lab 1: Get started with NGINX One Console" | ||
weight: 100 | ||
toc: true | ||
nd-content-type: tutorial | ||
nd-product: NGINX-ONE | ||
--- | ||
|
||
## Introduction | ||
|
||
This guide helps you log in to NGINX One Console and understand the basics of how it works. You’ll learn how to get started, find your way around the console, and manage your NGINX instances using data plane keys. | ||
|
||
## What you’ll learn | ||
|
||
By the end of this tutorial, you’ll know how to: | ||
|
||
- Open and use NGINX One Console | ||
- Understand what NGINX One Console does and how it works | ||
- Create, copy, and save a data plane key | ||
- Revoke or delete a data plane key (optional) | ||
|
||
## Before you begin | ||
|
||
Make sure you have: | ||
|
||
- An F5 Distributed Cloud (XC) account | ||
- NGINX One service enabled in your account | ||
Comment on lines
+26
to
+27
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. You might be able to use these includes: nginx-one/cloud-access.md 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. If enabling NGINX One is a separate step, I might need to update cloud-access-nginx.md |
||
- Basic knowledge of Linux and NGINX | ||
|
||
--- | ||
|
||
## Learn what NGINX One Console does | ||
|
||
NGINX One Console is a cloud-based service in the F5 Distributed Cloud platform. It helps you: | ||
|
||
- Manage all your NGINX instances from one place | ||
- Monitor performance and health metrics | ||
- Catch security risks like expired SSL certificates and known vulnerabilities | ||
- Keep track of software versions and get performance tips | ||
Comment on lines
+36
to
+39
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. I'd be tempted to add links, but that's a "stretch" goal IMO |
||
|
||
With NGINX One Console, you don’t need to switch between tools. You get a single dashboard with real-time data and alerts. | ||
|
||
--- | ||
|
||
## How NGINX One Console works | ||
|
||
NGINX One Console connects to each NGINX instance using a lightweight agent called **NGINX Agent**. | ||
|
||
NGINX Agent is responsible for securely registering and managing each instance through the console. | ||
|
||
There are a few ways to install NGINX Agent: | ||
|
||
- Use public Docker images of NGINX Open source that already include NGINX Agent | ||
- Use NGINX Plus containers with NGINX Agent preinstalled | ||
- Install manually using package managers like `apt` or `yum` | ||
- Use the one-line curl command that NGINX One provides during registration | ||
|
||
Comment on lines
+53
to
+57
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. I think I'd like some links to examples |
||
When you register a new instance in the console, you'll get a ready-to-use `curl` command that downloads and installs the NGINX Agent on your target system. | ||
|
||
For more information about NGINX Agent, see the [NGINX Agent documentation]({{< ref "/agent/about.md" >}}). | ||
|
||
--- | ||
|
||
## Open and use NGINX One Console | ||
|
||
1. Go to [https://console.ves.volterra.io/login/start](https://console.ves.volterra.io/login/start). | ||
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. When I go to this URL, I get the following screen. We're referring to In cloud-access.md, I'm using: "Navigate to https://INSERT_YOUR_TENANT_NAME.console.ves.volterra.io/ to access F5 Distributed Cloud." 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. Related -- we're about ready to release #731 (Once XC makes their June release, maybe on July 14) |
||
2. Sign in using your Distributed Cloud account. | ||
3. On the home page, find the **NGINX One** tile. | ||
4. Select the tile to open the console. | ||
5. Make sure the service status shows **Enabled**. | ||
6. Select **Visit Service** to go to the **Overview** dashboard. | ||
|
||
If NGINX One Console isn’t enabled, contact your XC administrator to request access. | ||
|
||
When no NGINX instances are connected, the dashboard will be empty. Once you add instances, it will show metrics like availability, version, and usage trends. | ||
|
||
--- | ||
|
||
## Create and save a data plane key | ||
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. Future issue: we may be able to set up more common content |
||
|
||
To register NGINX instances, you need a data plane key. | ||
|
||
1. In the console, go to **Manage > Data Plane Keys**. | ||
2. Select **Add Data Plane Key**. | ||
3. Enter a name for the key. | ||
4. Set an expiration date (or keep the default of one year). | ||
5. Select **Generate**. | ||
6. Copy the key when it appears—**you won’t be able to see it again**. | ||
7. Save it somewhere safe. | ||
|
||
You can use the same key to register many instances. If you lose the key, you’ll need to create a new one. | ||
|
||
--- | ||
|
||
## (Optional) Revoke a data plane key | ||
|
||
To disable a key: | ||
|
||
1. On the **Data Plane Keys** page, find the key you want to revoke. | ||
2. Select the key. | ||
3. Choose **Revoke**, then confirm. | ||
|
||
--- | ||
|
||
## (Optional) Delete a revoked key | ||
|
||
You can only delete a key after you revoke it. | ||
|
||
1. On the **Revoked Keys** tab, find the key you want to delete. | ||
2. Select the key. | ||
3. Choose **Delete Selected**, then confirm. | ||
|
||
--- | ||
|
||
## Next steps | ||
|
||
Now that you’ve explored NGINX One Console and created a key, you’re ready to connect your first NGINX instance. | ||
|
||
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 "/agent/about.md" >}}) |
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.