generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 105
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
Merged
Merged
Changes from all commits
Commits
Show all changes
58 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 53cbf0e
edits to lab for reading level and style
travisamartin d7d3be1
added include for XC tenant requirement bullet
travisamartin c4f2295
added files metadata to xc-account.md include
travisamartin f8c0037
added files metadata to enable-nginx-plus-api-with-config-sync-group.…
travisamartin 14c1ebd
tweaked the workshops card text
travisamartin dfdb785
Merge branch 'main' into epic-472-port-nginx-one-labs
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,8 +4,15 @@ files: | |
- content/nginx-one/getting-started.md | ||
--- | ||
|
||
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. | ||
Confirm that an F5 Distributed Cloud tenant has been provisioned for you. | ||
|
||
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. | ||
1. Log in to [MyF5](https://my.f5.com/manage/s/) and review your subscriptions. | ||
2. Look for **Distributed Cloud** in one of your subscriptions. This could appear under an NGINX subscription or a Distributed Cloud subscription. | ||
|
||
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. | ||
If you don’t see **Distributed Cloud** in any subscription, contact your F5 account team or Customer Success Manager. | ||
|
||
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. | ||
|
||
Go to `https://<TENANT_NAME>.console.ves.volterra.io/` to access F5 Distributed Cloud. | ||
If you have never signed in, select **Forgot Password?** on the sign-in page. | ||
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. |
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,9 @@ | ||
--- | ||
files: | ||
- content/nginx-one/workshops/lab2/run-workshop-components-with-docker.md | ||
- content/nginx-one/workshops/lab3/explore-nginx-one-console-and-features.md | ||
- content/nginx-one/workshops/lab4/config-sync-groups.md | ||
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-latest-version.md | ||
--- | ||
|
||
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" >}}). |
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: | ||
- content/nginx-one/workshops/lab5/upgrade-nginx-plus-to-latest-version.md | ||
- content/nginx-one/nginx-configs/metrics/enable-metrics.md | ||
--- | ||
|
||
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
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: 710 | ||
url: /nginx-one/workshops | ||
--- |
122 changes: 122 additions & 0 deletions
122
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,122 @@ | ||
--- | ||
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 features, and create a data plane key to register NGINX instances. | ||
|
||
NGINX One Console is a cloud service in the F5 Distributed Cloud platform. You can use it to: | ||
|
||
- Manage all NGINX instances in one place | ||
- Monitor performance and health metrics | ||
- Detect security risks, such as 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 | ||
- Describe 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 provides secure communication between the instance and NGINX One Console. | ||
|
||
NGINX Agent applies configuration updates, collects performance and system metrics, and sends event notifications. | ||
|
||
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` | ||
- Run the one-line `curl` command provided during registration | ||
|
||
When you register a new instance, NGINX One Console gives you a `curl` command to download and install NGINX Agent on your 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 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 connect NGINX instances, the NGINX One Console dashboard is empty. After you add instances, the dashboard shows metrics such as 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 key. | ||
4. Set an expiration date, or keep the one-year default. | ||
5. Select **Generate**. | ||
6. Copy the key — **you can’t view it again**. | ||
7. Store the key in a safe place. | ||
|
||
You can use the same key to register multiple instances. If you lose it, create a new one. | ||
|
||
--- | ||
|
||
## Revoke a data plane key | ||
|
||
1. In NGINX One Console, go to **Manage > Data Plane Keys**. | ||
2. Find the key you want to revoke. | ||
3. Select the key. | ||
4. Choose **Revoke**, and confirm. | ||
|
||
--- | ||
|
||
## Delete a revoked data plane key | ||
|
||
You can delete a data plane key only after you revoke it. | ||
|
||
1. In NGINX One Console, go to the **Revoked Keys** tab. | ||
2. Find the key you want to delete. | ||
3. Select the 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.
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.
Uh oh!
There was an error while loading. Please reload this page.