Skip to content

Commit 612a74e

Browse files
committed
Added lab1
1 parent 9f6eb21 commit 612a74e

17 files changed

+159
-0
lines changed
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: 300
5+
url: /nginx-one/workshops
6+
---
Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
---
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
9+
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:
14+
---
15+
16+
## Introduction
17+
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.
19+
20+
<br/>
21+
22+
## Learning Objectives
23+
24+
By the end of the lab you will be able to:
25+
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)
37+
38+
## Prerequisites
39+
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
45+
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>">}}
80+
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.
82+
83+
{{< img src="nginx-one/labs/lab-01/lab1_none-empty-overview-dashboard.png" alt="<Alternative text>">}}
84+
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.
86+
87+
{{< img src="nginx-one/labs/lab-01/lab1_none-overview-dashboard.png" alt="<Alternative text>">}}
88+
89+
<br/>
90+
91+
### Create and manage data plane keys that would be used to manage NGINX instances
92+
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.
94+
95+
![Dataplane key](../media/lab1/lab1_none-dataplane-key-overview.png)
96+
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.
98+
99+
![New Dataplane key](../media/lab1/lab1_none-dataplane-key-new.png)
100+
101+
Once the key is generated, copy the value of this key to the clipboard using the `Copy` icon on the right side.
102+
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.
104+
105+
![New Dataplane key save](../media/lab1/lab1_none-dataplane-key-save.png)
106+
107+
1. Once you have saved the key locally for future use, click the `Close` button to finish the Data plane key creation process.
108+
109+
<br/>
110+
111+
### (Optional Exercise): Revoke a data plane key
112+
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.
114+
115+
![Revoke Dataplane Key](../media/lab1/lab1_none-dataplane-key-revoke1.png)
116+
![Confirm Revoke](../media/lab1/lab1_none-dataplane-key-revoke2.png)
117+
118+
### (Optional Exercise): Delete a data plane key
119+
120+
1. Active keys cannot be directly deleted. The key must first be revoked and then can be deleted.
121+
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.
123+
124+
![Revoke key list](../media/lab1/lab1_none-dataplane-key-revoke-list.png)
125+
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.
127+
128+
![Delete key](../media/lab1/lab1_none-dataplane-key-delete1.png)
129+
![Delete key confirmation](../media/lab1/lab1_none-dataplane-key-delete2.png)
130+
131+
<br/>
132+
133+
This ends lab1.
134+
135+
<br/>
136+
137+
## References:
138+
139+
- [NGINX One Console](https://docs.nginx.com/nginx-one/)
140+
- [NGINX Agent](https://docs.nginx.com/nginx-agent/overview/)
141+
142+
<br/>
143+
144+
### Authors
145+
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.
149+
150+
-------------
151+
152+
Navigate to ([Lab2](../lab2/readme.md) | [LabGuide](../readme.md))
153+
75.6 KB
Loading
48.2 KB
Loading
137 KB
Loading
189 KB
Loading
83.5 KB
Loading
164 KB
Loading
66.7 KB
Loading
132 KB
Loading

0 commit comments

Comments
 (0)