Skip to content

Commit 12c33a6

Browse files
travisamartintravisamartin
committed
edits
1 parent e698ac8 commit 12c33a6

File tree

1 file changed

+74
-105
lines changed

1 file changed

+74
-105
lines changed

‎content/nginx-one/workshops/lab1.md‎

Lines changed: 74 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,153 +1,122 @@
11
---
2-
# We use sentence case and present imperative tone
3-
title: "Lab1: NGINX One Console Introduction & Access"
4-
# Weights are assigned in increments of 100: determines sorting order
5-
weight: i00
6-
# Creates a table of contents and sidebar, useful for large documents
7-
toc: false
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
2+
title: "Get started with NGINX One Console"
3+
weight: 100
4+
toc: true
95
nd-content-type: tutorial
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product: nginx-one
13-
docs:
6+
nd-product: NGINX-ONE
147
---
158

169
## Introduction
1710

18-
In this lab, you will be logging into NGINX One Console and exploring various components within it. This lab requires that you have access to F5 Distributed Cloud to work with the One Console. As part of this lab, you will explore the NGINX One Console product, as a quick Overview of what it is and how to access it.
11+
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.
1912

20-
<br/>
13+
## What you’ll learn
2114

22-
## Learning Objectives
15+
By the end of this tutorial, you’ll know how to:
2316

24-
By the end of the lab you will be able to:
17+
- Open and use NGINX One Console
18+
- Understand what NGINX One Console does and how it works
19+
- Create, copy, and save a data plane key
20+
- Revoke or delete a data plane key (optional)
2521

26-
- [Introduction](#introduction)
27-
- [Learning Objectives](#learning-objectives)
28-
- [Prerequisites](#prerequisites)
29-
- [NGINX One Console Introduction](#nginx-one-console-introduction)
30-
- [How it works](#how-it-works)
31-
- [Access and navigate NGINX One Console](#access-and-navigate-nginx-one-console)
32-
- [Create and manage data plane keys that would be used to manage NGINX instances](#create-and-manage-data-plane-keys-that-would-be-used-to-manage-nginx-instances)
33-
- [(Optional Exercise): Revoke a data plane key](#optional-exercise-revoke-a-data-plane-key)
34-
- [(Optional Exercise): Delete a data plane key](#optional-exercise-delete-a-data-plane-key)
35-
- [References:](#references)
36-
- [Authors](#authors)
22+
## Before you begin
3723

38-
## Prerequisites
24+
Make sure you have:
3925

40-
- You must have an F5 Distributed Cloud(XC) Account
41-
- You must have enabled NGINX One service on F5 Distributed Cloud(XC)
42-
- See `Lab0` for instructions on setting up your system for this Workshop
43-
- Familiarity with basic Linux concepts and commands
44-
- Familiarity with basic NGINX concepts and commands
26+
- An F5 Distributed Cloud (XC) account
27+
- NGINX One service enabled in your account
28+
- Completed setup in Lab0
29+
- Basic knowledge of Linux and NGINX
4530

46-
<br/>
47-
48-
### NGINX One Console Introduction
49-
50-
The F5 NGINX One Console is a service which is part of the F5 Distributed Cloud, gives all NGINX users access to a SaaS experience for managing NGINX instances. The console lets you monitor and control your NGINX fleet from one place. You can check configurations, track performance metrics, identify security vulnerabilities, manage SSL certificates, and more.
51-
52-
The NGINX One Console is valuable because it simplifies the complexities of modern application delivery by integrating multiple functionalities into a single platform. This reduces the need for disparate tools, lowers operational overhead and costs, and ensures robust security for your applications. You will be able to accelerate application delivery and time-to-value like never before with SaaS capabilities.
53-
54-
NGINX One Console offers the following key benefits:
55-
56-
- **Centralized control:** Manage all your NGINX instances from a single console.
57-
- **Enhanced monitoring and risk detection:** Automatically detect critical vulnerabilities (CVEs), verify SSL certificate statuses, and identify security issues in NGINX configurations.
58-
- **Performance optimization:** Track your NGINX versions and receive recommendations for tuning your configurations for better performance.
59-
- **Graphical Metrics Display:** Access a dashboard that shows key metrics for your NGINX instances, including instance availability, version distribution, system health, and utilization trends.
60-
- **Real-time alerts:** Receive alerts about critical issues.
61-
62-
### How it works
63-
64-
65-
The NGINX One Console requires `NGINX Agent`, an open source software module written by NGINX that connects and communicates with NGINX One Console. This NGINX Agent must be installed and running on every NGINX instance that you wish to manage with NGINX One Console. You will use the publicly available NGINX with Agent images from Docker Hub for your NGINX OSS containers. In addition, as part of your Docker Compose file, your NGINX Plus containers already have the required `NGINX Agent` installed for you. NGINX Agent can also be installed using regular Linux package managers like `apt` and `yum`. Refer to the References Section for links to the NGINX Agent installation guides.
66-
67-
### Access and navigate NGINX One Console
68-
69-
1. Login into the F5 Distributed Cloud console using your account credentials. The login page can be found at: https://console.ves.volterra.io/login/start
70-
71-
{{< img src="nginx-one/labs/lab-01/lab1_xc-login.png" alt="<Alternative text>">}}
72-
73-
1. Once logged in, the "home" screen shows you various tiles which represent F5 Distributed Cloud console features. In this lab, we'll focus on the `NGINX One` Console tile as highlighted in the below screenshot.
74-
75-
{{< img src="nginx-one/labs/lab-01/lab1_none-tile.png" alt="<Alternative text>">}}
76-
77-
1. Click on the `NGINX One` Console tile from the home screen. The NGINX One Console "welcome" screen will appear. Make sure the NGINX One Console status shows `green - Enabled` as highlighted in below screenshot. Click on `Visit Service`. If it is not enabled, you must request access from your F5 Distributed Cloud admin.
78-
79-
{{< img src="nginx-one/labs/lab-01/lab1_none-service.png" alt="<Alternative text>">}}
31+
---
8032

81-
2. By default, this will bring you to the NGINX One Console `Overview Dashboard` page. As no NGINX Instances are being managed by NGINX One Console you are seeing the blank dashboard as shown in below screenshot.
33+
## Learn what NGINX One Console does
8234

83-
{{< img src="nginx-one/labs/lab-01/lab1_none-empty-overview-dashboard.png" alt="<Alternative text>">}}
35+
NGINX One Console is a cloud-based service in the F5 Distributed Cloud platform. It helps you:
8436

85-
Once you add different NGINX Instance in the next section, this Dashboard would get populated by useful insights as depicted in below sample dashboard screenshot.
37+
- Manage all your NGINX instances from one place
38+
- Monitor performance and health metrics
39+
- Catch security risks like expired SSL certificates and known vulnerabilities
40+
- Keep track of software versions and get performance tips
8641

87-
{{< img src="nginx-one/labs/lab-01/lab1_none-overview-dashboard.png" alt="<Alternative text>">}}
42+
With NGINX One Console, you don’t need to switch between tools. You get a single dashboard with real-time data and alerts.
8843

89-
<br/>
44+
---
9045

91-
### Create and manage data plane keys that would be used to manage NGINX instances
46+
## How NGINX One Console works
9247

93-
1. Within the NGINX One Console, click on `Manage > Data Plane Keys`. This would show all the Data Plane keys that you currently have.
48+
NGINX One Console connects to each NGINX instance using a small agent called **NGINX Agent**.
9449

95-
![Dataplane key](../media/lab1/lab1_none-dataplane-key-overview.png)
50+
You can install NGINX Agent by:
9651

97-
1. Click on `Add Data Plane Key` to create a new Dataplane key. This should open an `Add Data Plane Key` window. Provide a name of your choice for the new key. By default, the expiration date is set for a year. You can modify the expiration data as per your preference or keep the defaults for this workshop. Click on `Generate` to create your new key.
52+
- Using public NGINX OSS Docker images with the agent already included
53+
- Using NGINX Plus containers (these already include the agent)
54+
- Installing from Linux package managers like `apt` or `yum`
9855

99-
![New Dataplane key](../media/lab1/lab1_none-dataplane-key-new.png)
56+
See the [NGINX Agent docs](https://docs.nginx.com/nginx-agent/overview/) for more details.
10057

101-
Once the key is generated, copy the value of this key to the clipboard using the `Copy` icon on the right side.
58+
---
10259

103-
> **NOTE:** This Dataplane Key is only shown here and NGINX One Console doesn't save this value. Save this value locally as you would be using it to register new NGINX Instances. You can Register as many NGINX Instances as you like with the same Dataplane Key. If you lose the value of the key then you need to generate a new one again.
60+
## Open and use NGINX One Console
10461

105-
![New Dataplane key save](../media/lab1/lab1_none-dataplane-key-save.png)
62+
1. Go to [https://console.ves.volterra.io/login/start](https://console.ves.volterra.io/login/start).
63+
2. Sign in using your Distributed Cloud account.
64+
3. On the home page, find the **NGINX One** tile.
65+
4. Select the tile to open the console.
66+
5. Make sure the service status shows **Enabled**.
67+
6. Select **Visit Service** to go to the **Overview** dashboard.
10668

107-
1. Once you have saved the key locally for future use, click the `Close` button to finish the Data plane key creation process.
69+
If NGINX Console isn’t enabled, contact your XC administrator to request access.
10870

109-
<br/>
71+
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.
11072

111-
### (Optional Exercise): Revoke a data plane key
73+
---
11274

113-
1. To revoke the data plane key, search the key that you would like to revoke within the Data Plane Keys Page and then click on the key. This should open a new overlay window on the right side as shown in below screenshot. Click on `Revoke` button. In the next confirmation window, again click on `Revoke` button to disable the data plane key.
75+
## Create and save a data plane key
11476

115-
![Revoke Dataplane Key](../media/lab1/lab1_none-dataplane-key-revoke1.png)
116-
![Confirm Revoke](../media/lab1/lab1_none-dataplane-key-revoke2.png)
77+
To register NGINX instances, you need a data plane key.
11778

118-
### (Optional Exercise): Delete a data plane key
79+
1. In the console, go to **Manage > Data Plane Keys**
80+
2. Select **Add Data Plane Key**
81+
3. Enter a name for the key
82+
4. Set an expiration date (or keep the default of one year)
83+
5. Select **Generate**
84+
6. Copy the key when it appears—**you won’t be able to see it again**
85+
7. Save it somewhere safe
11986

120-
1. Active keys cannot be directly deleted. The key must first be revoked and then can be deleted.
87+
You can use the same key to register many instances. If you lose the key, you’ll need to create a new one.
12188

122-
1. You can delete a revoked data plane key by opening the Data Plane Keys Page and then navigating to the `Revoked Keys` tab. This view should list all the revoked keys.
89+
---
12390

124-
![Revoke key list](../media/lab1/lab1_none-dataplane-key-revoke-list.png)
91+
## (Optional) Revoke a data plane key
12592

126-
To delete a particular revoked key, select the key and then click on `Delete Selected` button. In the next confirmation window, again click on `Delete` button to delete the data plane key.
93+
To disable a key:
12794

128-
![Delete key](../media/lab1/lab1_none-dataplane-key-delete1.png)
129-
![Delete key confirmation](../media/lab1/lab1_none-dataplane-key-delete2.png)
95+
1. In the **Data Plane Keys** page, find the key you want to revoke
96+
2. Select the key
97+
3. Choose **Revoke**, then confirm
13098

131-
<br/>
99+
---
132100

133-
This ends lab1.
101+
## (Optional) Delete a revoked key
134102

135-
<br/>
103+
You can only delete a key after you revoke it.
136104

137-
## References:
105+
1. In the **Revoked Keys** tab, find the key you want to delete
106+
2. Select the key
107+
3. Choose **Delete Selected**, then confirm
138108

139-
- [NGINX One Console](https://docs.nginx.com/nginx-one/)
140-
- [NGINX Agent](https://docs.nginx.com/nginx-agent/overview/)
109+
---
141110

142-
<br/>
111+
## Next steps
143112

144-
### Authors
113+
Now that you’ve explored NGINX One Console and created a key, you’re ready to connect your first NGINX instance.
145114

146-
- Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
147-
- Shouvik Dutta - Solutions Architect - Community and Alliances @ F5, Inc.
148-
- Adam Currier - Solutions Architect - Community and Alliances @ F5, Inc.
115+
[Go to Lab 2 →](../lab2/readme.md)
149116

150-
-------------
117+
---
151118

152-
Navigate to ([Lab2](../lab2/readme.md) | [LabGuide](../readme.md))
119+
## References
153120

121+
- [NGINX One Console documentation](https://docs.nginx.com/nginx-one/)
122+
- [NGINX Agent overview](https://docs.nginx.com/nginx-agent/overview/)

0 commit comments

Comments
 (0)