You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/nginx-one/workshops/lab1/getting-started-with-nginx-one.md
+58-59Lines changed: 58 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,119 +8,118 @@ nd-product: NGINX-ONE
8
8
9
9
## Introduction
10
10
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.
11
+
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.
12
12
13
-
## What you’ll learn
13
+
NGINX One Console is a cloud service in the F5 Distributed Cloud platform. It lets you:
14
14
15
-
By the end of this tutorial, you’ll know how to:
15
+
- Manage all NGINX instances in one place
16
+
- Monitor performance and health metrics
17
+
- Detect security risks like expired SSL certificates or known vulnerabilities
18
+
- Track software versions
19
+
- Get performance tips
16
20
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)
21
+
Instead of switching between tools, you get one dashboard with real-time data and alerts.
21
22
22
-
## Before you begin
23
+
---
23
24
24
-
Make sure you have:
25
+
## What you’ll learn
25
26
26
-
- An F5 Distributed Cloud (XC) account
27
-
- NGINX One service enabled in your account
28
-
- Basic knowledge of Linux and NGINX
27
+
By the end of this tutorial, you can:
29
28
30
-
---
29
+
- Open and use NGINX One Console
30
+
- Understand how NGINX One Console works
31
+
- Create, copy, and store a data plane key
32
+
- Revoke or delete a data plane key
31
33
32
-
## Learn what NGINX One Console does
34
+
---
33
35
34
-
NGINX One Console is a cloud-based service in the F5 Distributed Cloud platform. It helps you:
36
+
## Before you begin
35
37
36
-
- Manage all your NGINX instances from one place
37
-
- Monitor performance and health metrics
38
-
- Catch security risks like expired SSL certificates and known vulnerabilities
39
-
- Keep track of software versions and get performance tips
38
+
You need:
40
39
41
-
With NGINX One Console, you don’t need to switch between tools. You get a single dashboard with real-time data and alerts.
40
+
- An F5 Distributed Cloud (XC) account
41
+
- NGINX One service enabled
42
+
- Basic Linux and NGINX knowledge
42
43
43
44
---
44
45
45
46
## How NGINX One Console works
46
47
47
-
NGINX One Console connects to each NGINX instance using a lightweight agent called **NGINX Agent**.
48
+
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.
49
+
NGINX Agent applies configuration updates from NGINX One Console, collects performance and operating system metrics, and sends event notifications from the instance.
48
50
49
-
NGINX Agent is responsible for securely registering and managing each instance through the console.
51
+
You can install NGINX Agent in several ways:
50
52
51
-
There are a few ways to install NGINX Agent:
53
+
- Use public Docker images of NGINX Open Source with NGINX Agent preinstalled
54
+
- Use public Docker images of NGINX Plus with NGINX Agent preinstalled
55
+
- Install manually with `apt` or `yum`
56
+
- Use the one-line `curl` command provided during registration
52
57
53
-
- Use public Docker images of NGINX Open source that already include NGINX Agent
54
-
- Use NGINX Plus containers with NGINX Agent preinstalled
55
-
- Install manually using package managers like `apt` or `yum`
56
-
- Use the one-line curl command that NGINX One provides during registration
58
+
When you register a new instance, NGINX One Console gives you a `curl` command that downloads and installs NGINX Agent on your target system.
57
59
58
-
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.
60
+
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.
59
61
60
-
For more information about NGINX Agent, see the [NGINX Agent documentation]({{< ref "/agent/about.md" >}}).
62
+
For more about NGINX Agent, see the [NGINX Agent overview]({{< ref "/agent/overview/about.md" >}}).
61
63
62
64
---
63
65
64
-
## Open and use NGINX One Console
66
+
## Open NGINX One Console
65
67
66
68
1. Go to [https://console.ves.volterra.io/login/start](https://console.ves.volterra.io/login/start).
67
-
2. Sign in using your Distributed Cloud account.
69
+
2. Sign in with your F5 Distributed Cloud account.
68
70
3. On the home page, find the **NGINX One** tile.
69
-
4. Select the tile to open the console.
70
-
5.Make sure the service status shows**Enabled**.
71
-
6. Select **Visit Service** to go to the **Overview** dashboard.
71
+
4. Select the tile to open NGINX One Console.
72
+
5.Confirm the service status is**Enabled**.
73
+
6. Select **Visit Service** to open the **Overview** dashboard in NGINX One Console.
72
74
73
-
If NGINX One Console isn’t enabled, contact your XC administrator to request access.
75
+
If NGINX One Console isn’t enabled, ask your F5 Distributed Cloud administrator for access.
74
76
75
-
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.
77
+
When no NGINX instances are connected, the NGINX One Console dashboard stays empty. After you add instances, the dashboard shows metrics like availability, version, and usage trends.
76
78
77
79
---
78
80
79
-
## Create and save a data plane key
80
-
81
-
To register NGINX instances, you need a data plane key.
81
+
## Create a data plane key
82
82
83
-
1. In the console, go to **Manage > Data Plane Keys**.
83
+
1. In NGINX One Console, go to **Manage > Data Plane Keys**.
84
84
2. Select **Add Data Plane Key**.
85
-
3. Enter a name for the key.
86
-
4. Set an expiration date (or keep the default of oneyear).
85
+
3. Enter a name for the data plane key.
86
+
4. Set an expiration date, or use the one-year default.
87
87
5. Select **Generate**.
88
-
6. Copy the key when it appears—**you won’t be able to see it again**.
89
-
7.Save it somewhere safe.
88
+
6. Copy the data plane key — **you can’t view it again**.
89
+
7.Store the data plane key in a safe place.
90
90
91
-
You can use the same key to register many instances. If you lose the key, you’ll need to create a new one.
91
+
You can use the same data plane key to register multiple instances. If you lose the data plane key, create a new one.
92
92
93
93
---
94
94
95
-
## (Optional) Revoke a data plane key
95
+
## Revoke a data plane key
96
96
97
-
To disable a key:
98
-
99
-
1. On the **Data Plane Keys** page, find the key you want to revoke.
100
-
2. Select the key.
101
-
3. Choose **Revoke**, then confirm.
97
+
1. In NGINX One Console, go to **Manage > Data Plane Keys**.
98
+
2. Find the data plane key you want to revoke.
99
+
3. Select the data plane key.
100
+
4. Choose **Revoke**, and confirm.
102
101
103
102
---
104
103
105
-
## (Optional) Delete a revoked key
104
+
## Delete a revoked data plane key
106
105
107
-
You can only delete a key after you revoke it.
106
+
You can only delete a data plane key after you revoke it.
108
107
109
-
1. On the **Revoked Keys** tab, find the key you want to delete.
110
-
2. Select the key.
111
-
3. Choose **Delete Selected**, then confirm.
108
+
1. In NGINX One Console, go to the **Revoked Keys** tab.
109
+
2. Find the data plane key you want to delete.
110
+
3. Select the data plane key.
111
+
4. Choose **Delete Selected**, and confirm.
112
112
113
113
---
114
114
115
115
## Next steps
116
116
117
-
Now that you’ve explored NGINX One Console and created a key, you’re ready to connect your first NGINX instance.
118
-
117
+
You’re ready to connect your first NGINX instance to NGINX One Console.
119
118
Go to [Lab 2: Run workshop components with Docker]({{< ref "nginx-one/workshops/lab2/run-workshop-components-with-docker.md" >}})
120
119
121
120
---
122
121
123
122
## References
124
123
125
124
-[Create and manage data plane keys]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md" >}})
0 commit comments