Skip to content

Commit ab42659

Browse files
authored
prerequisites (#13)
1 parent cb77334 commit ab42659

17 files changed

+147
-57
lines changed
139 KB
Loading
142 KB
Loading
198 KB
Loading

labs/lab0/media/F5signup.png

130 KB
Loading

labs/lab0/media/almostthere.png

370 KB
Loading

labs/lab0/media/courselist.png

136 KB
Loading

labs/lab0/media/domaincreds.png

18.7 KB
Loading
26.8 KB
Loading

labs/lab0/media/joinbutton.png

207 KB
Loading

labs/lab0/media/launchrdp.png

290 KB
Loading
161 KB
Loading

labs/lab0/media/udfloginnonf5.png

79.3 KB
Loading

labs/lab0/media/udfloginreset.png

127 KB
Loading

labs/lab0/media/useruser.png

138 KB
Loading

labs/lab0/media/waitforboot.png

200 KB
Loading

labs/lab0/prerequisites.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Preparing your Computer for the NGINX One Console Workshop
2+
3+
## Introduction
4+
5+
In order to complete the Lab exercises in this Workshop on your own computer and not use the F5 provided workshop environment, your computer should meet with the following license, hardware, software, and access requirements. If you are unable to meet these basic requirements, you will likely not be able to complete the Labs as written. It is highly recommended that you have the minimum requirements.
6+
7+
## Learning Objectives
8+
9+
By the end of this Prerequisite instructions, you will be ready to do the Workshop lab exercises in your own system.
10+
11+
## NGINX Plus License Requirements
12+
13+
1. You must have an NGINX Plus Commercial license/subscription for this Workshop.
14+
2. You must download the `nginx-repo.crt` and `nginx-repo.key` and `nginx-repo.jwt` files from your MyF5 account.
15+
3. If you do not have a current license, you can request a 30-Day Trial License for free, here: https://www.f5.com/trials/nginx-one . It takes several minutes for the F5 Licensing system to send you an email, with a `one-time download link` to the License files. `Save the nginx-repo.* files to your local storage`, you will need them before you start the Workshop.
16+
17+
## F5 Distributed Cloud Account
18+
19+
You will need an F5 Distributed Cloud account to complete the Nginx One Console lab exercises. If you do not have an Account, please contact your F5 Sales Representative for more information. Know more about F5 Distributed Cloud by navigating to the following link: https://www.f5.com/products/distributed-cloud-services/distributed-cloud-console.
20+
21+
You must also have enabled NGINX One service within F5 Distributed Cloud(XC) for this workshop.
22+
23+
## Hardware Requirments
24+
25+
1. 8GB available RAM
26+
2. 50GB available disk space
27+
3. Recommended - second monitor
28+
29+
## Software Requirements
30+
31+
1. Git
32+
1. Docker Engine
33+
1. Docker Compose
34+
1. Chrome or other modern browser
35+
1. Visual Studio Code, or other test/code editor
36+
1. Thunder Client VSCode extension or any other API platform that helps running API requests.
37+
38+
## Administrative Requirements
39+
40+
1. Network connection to the Internet
41+
1. Admin access to install software, Copy and Edit local files
42+
1. Admin access to control Network Firewalls and VPN settings
43+
1. Admin access to configure local DNS hosts file
44+
45+
## Install Docker Engine
46+
47+
- [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
48+
49+
## Install Docker Compose
50+
51+
- [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
52+
53+
## Optional - Install Visual Studio Code
54+
55+
- [https://code.visualstudio.com/download](https://code.visualstudio.com/download)
56+
57+
## Cloning the Workshop Repository locally
58+
59+
Once you have setup your system make sure to clone this repository locally in your system.
60+
61+
```bash
62+
git clone https://github.com/nginxinc/nginx-one-workshops.git
63+
64+
```
65+
66+
<br/>
67+
You are now prepared to start with the workshop labs.
68+
<br/>
69+
70+
## References:
71+
72+
- [NGINX Plus](https://docs.nginx.com/nginx/)
73+
- [NGINX Free 30-Day Trial](https://www.f5.com/trials/nginx-one)
74+
- [NGINX Admin Guide](https://docs.nginx.com/nginx/admin-guide/)
75+
- [NGINX Technical Specs](https://docs.nginx.com/nginx/technical-specs/)
76+
77+
<br/>
78+
79+
### Authors
80+
81+
- Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
82+
- Shouvik Dutta - Solutions Architect - Community and Alliances @ F5, Inc.
83+
- Adam Currier - Solutions Architect - Community and Alliances @ F5, Inc.
84+
85+
-------------
86+
87+
Navigate to ([Lab1](../lab1/readme.md) | [Main Menu](../readme.md))

labs/lab0/readme.md

+60-57
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,94 @@
1-
# Setup your Computer for NGINX Workshops
1+
# Workshop pre-work
22

3-
## `under construction`
3+
## Prep for your upcoming F5/NGINX Workshop
44

5-
## Introduction
5+
If you're here that probably means you are currently in, or registered for, an upcoming NGINXperts Workshop. By taking the time to run through this exercise you are helping us save time during the workshop and ensure that you meet the prerequisites to access the workshop. We appreciate you taking time to check your system and your access.
66

7-
In this Workshop, you will build a working Lab environment in Azure, and use Nginx for Azure to control traffic to these Azure Resources. The architecture you will build will look like this diagram:
7+
<br/>
88

9-
![N4A Workshop](media/n4a-workshop-diagram-r7.png)
10-
11-
In order to build this environment, your computer hardware, software, and applications must be properly installed and functional. This is the list of Prerequisite needed to successfully complete this Workshop as a Student.
9+
## Step 0: If this is your first time in an F5 Hosted Workshop
1210

13-
>It is `highly recommended` for Students attending this Workshop to be proficient with NGINX and Azure and have some experience with Kubernetes and Docker administration, networking tools, and Load Balancing concepts. An `Azure Subscription` and Admin level access to Azure Portal is required. Previous experience with Visual Studio Code and Redis Tools is also recommended.
11+
Look for an email from **`[email protected]`**. This will have instructions on how you can login into UDF (F5 workshop environment).
1412

15-
<br/>
13+
![Ultra Super Important Invite email](media/megasuperimportantemail.png)
1614

17-
## Prerequisites
15+
### If you cannot find your invite email ("UDF Course Registration:NGINXperts Lab ...") STOP
1816

19-
In this Lab0, the requirements for both the Student and the Azure environment will be described.
17+
- These commonly get caught by spam/junk filters. *Make sure to check your spam folder **and** your system's email Quarantine.*
2018

21-
> **IMPORTANT!** It is imperative that you have the appropriate computer, tools, and Azure Subscription privileges to successfully complete the Workshop.
19+
- If you still cannot find your invite email, you either have not been invited to a workshop or we have an incorrect email. Please get help from whoever sent you to this page.
2220

23-
</br>
21+
## Step 1: Get yourself to UDF
2422

25-
NGINXaaS for Azure | NGINX Plus | Kubernetes | Docker | Redis
26-
:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:
27-
![](media/nginx-azure-icon.png) | ![](media/nginx-plus-icon.png) | ![](media/kubernetes-icon.png) | ![](media/docker-icon.png) | ![](media/redis-icon.png)
23+
- Navigate to [https://udf.f5.com/](https://udf.f5.com/) and select `Invited Users`
24+
![Non F5](media/udfloginnonf5.png)
2825

29-
<br/>
26+
- If this is your first time using UDF, use the `Sign Up` link which would take your to F5 registration page.
27+
28+
**NOTE:** this will *not be the password to the Ubuntu Desktop or other VMs in the class!*
29+
![Sign up](media/F5signup.png)
3030

31-
## Student Azure Subscription Requirements
31+
- Once you have filled in your registration details, you should be receiving an `Account Activation` email as shown below
32+
![Account Activation Email](media/F5accountactivationemail.png)
3233

33-
**IMPORTANT:** Students taking this Workshop will require `Owner` level privileges to complete the Lab Exercises. In addition, Students will also require the following Subscription privileges. Consult with your IT Cloud Team to ensure you have the necessary privileges for the following items, *prior* to attempting the Workshop Exercises:
34+
- When you click on the `Activate Account` button within the activation email, you would be redirected to setup 2 factor authentication as shown below. Select your preferred authentication method.
35+
![2factor Authentication prompt](media/2factorAuthentication.png)
3436

35-
1. Multiple `Public Ip Addresses` used in this lab.
37+
- Once you have set up 2 factor authentication successfully, you will see a `green` checkmark on your preferred method. Click on `Finish`.
38+
![2factor Confirmation](media/2factorConfirmation.png)
3639

37-
- Public IP Address for the Nginx for Azure instance
38-
- Public IP Address for the UbuntuVM
39-
- Public IP Address for the Kubernetes Cluster API Server for the AKS instance(s)
40+
- If you already have an account but you can't remember your password, simply reset your password by clicking on `Forgot Password?` link.
41+
![Non F5](media/udfloginreset.png "happens to the best of us")
4042

41-
2. `Azure Key Vault` used in this lab, to create TLS certificates and keys.
43+
## Step 2: Start the course
4244

43-
3. `Entra ID` used in this lab, to create Applications and Settings for the OIDC/JWT integration with Nginx.
45+
- Once logged into UDF, click `Launch` (This will open a new tab.)
46+
![Non F5](media/courselist.png "click launch")
4447

45-
<br/>
48+
- And then click on `Join`
49+
![Non F5](media/joinbutton.png "'Yes I'm sure'")
4650

47-
### Student Hardware/Software/Azure Requirements
51+
- Click the `DEPLOYMENT` tab at the top
52+
![Non F5](media/almostthere.png "I'm up here")
4853

49-
Verify you have the proper computer requirements - hardware and software.
50-
- Hardware: Laptop, Admin rights, Internet connection
51-
- Software: Visual Studio, Terminal, Chrome, Docker, AKS and Azure CLI.
52-
- You will need the Azure Command Line Interface tool (version 2.61.0 or higher) installed on your client machine to manage your Azure services. See [Azure CLI Installation](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) for instructions.
53-
- You will also need the Azure CLI `NGINX` extension added. See [Azure CLI Extensions](https://learn.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview) for instructions.
54-
- Verify you have proper computer skills: Linux CLI, files, SSH/Terminal, Docker/Compose, Azure Portal, Load Balancing concepts, Linux tools, Azure CLI
55-
- Verify you have the proper access to Azure resources: Azure Subscription with Admin/Owner level access
54+
## Step 3: RDP to the Ubuntu Jumpbox
5655

57-
<br/>
56+
- username: `ubuntu`
57+
- password: `Nginx123`
5858

59-
### Required Skills
59+
THIS REQUIRES AN RDP CLIENT! If you have a Mac *and* haven't downloaded an RDP client before, here is the first-party version:
6060

61-
- Nginx for Azure NGINXperts Workshop has minimum REQUIRED Nginx Skills: Students must be familiar with Nginx operation, configurations, and concepts for HTTP traffic.
62-
- The NGINXperts Basics Workshop is HIGHLY recommended, students should have taken this workshop prior.
63-
- The NGINXperts Plus Ingress Controller workshop is also HIGHLY recommended, students should have taken this workshop prior.
64-
- Azure admin skills, previous training from Microsoft Learn is HIGHLY recommended.
65-
- Recommended: TLS, DNS, HTTP caching, Grafana, Redis
61+
[Microsoft's RDP client on the Apple Apps Store](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12)
6662

67-
<br/>
63+
- Now you just have to wait for the Ubuntu Desktop to finish booting. . .
6864

69-
[NGINXperts Basics Workshop](https://github.com/nginxinc/nginx-basics-workshops)
65+
![Non F5](media/waitforboot.png "loading. . .")
7066

71-
<br/>
67+
- Make sure to select a small enough resolution to see the whole screen.
7268

73-
**This completes Lab0.**
69+
![Non F5](media/launchrdp.png "almost there")
7470

75-
<br/>
71+
- Once you select the resolution, your browser will download an rdp file. Open this file to connect to Ubuntu Desktop.
7672

77-
## References:
73+
- Accept the self-signed cert, the Ubuntu Desktop username and password will be `ubuntu` and `Nginx123`.
74+
75+
(**NOTE:** This is *not* your UDF login username & password.)
7876

79-
- [NGINX As A Service for Azure](https://docs.nginx.com/nginxaas/azure/)
80-
- [NGINX Plus Product Page](https://docs.nginx.com/nginx/)
81-
- [NGINX Ingress Controller](https://docs.nginx.com//nginx-ingress-controller/)
82-
- [NGINX on Docker](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/)
83-
- [NGINX Directives Index](https://nginx.org/en/docs/dirindex.html)
84-
- [NGINX Variables Index](https://nginx.org/en/docs/varindex.html)
85-
- [NGINX Technical Specs](https://docs.nginx.com/nginx/technical-specs/)
86-
- [NGINX - Join Community Slack](https://community.nginx.org/joinslack)
77+
![Non F5](media/useruser.png)
8778

88-
<br/>
79+
-------------
80+
> **If you can't connect to the Ubuntu Desktop, *remember to shut off your VPN*, or join a non-proxied network (sometimes a guest network in the office will work)**
81+
-------------
82+
83+
**For machines running Windows and attached to a domain, Windows will helpfully attempt to use your domain creds to log in, and you'll see:**
84+
85+
![Non F5](media/domaincreds.png "everyone has credentials.com email accounts right?")
86+
87+
### Click "More choices" to enter both a username and a password
88+
89+
![Non F5](media/domaincredsannotated.png "green arrows")
90+
91+
That wraps the pre-requisites.
8992

9093
### Authors
9194

@@ -95,4 +98,4 @@ Verify you have the proper computer requirements - hardware and software.
9598

9699
-------------
97100

98-
Navigate to ([Lab1](../lab1/readme.md) | [LabGuide](../readme.md))
101+
Navigate to ([Lab1](../lab1/readme.md) | [Main Menu](../readme.md))

0 commit comments

Comments
 (0)