-
Notifications
You must be signed in to change notification settings - Fork 100
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 21 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 |
---|---|---|
@@ -0,0 +1,176 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Workshops | ||
description: | ||
weight: 300 | ||
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**. | ||
|
||
The 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 OSS that already include the agent | ||
- Use NGINX Plus containers with the agent preinstalled | ||
- Install manually using package managers like `apt` or `yum` | ||
- Use the one-line curl command that NGINX One provides during registration | ||
|
||
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](https://docs.nginx.com/nginx-agent/overview/). | ||
|
||
--- | ||
|
||
## 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/overview.md" >}}) |
Uh oh!
There was an error while loading. Please reload this page.