Skip to content

Commit 3008d61

Browse files
Sollarfun20jontyms
andauthored
Move 2025 RDP Documetation Updates into Production (Full Revamp of the accessing windows guide) (#43)
* Images and starting new windows RDP Documentation * Finished Windows through Linux Connection Documentation, ready for test before cleaning * Removed old documention and fixed some spacing. * Completed MacOS documentation, ready for release. * Update Security Groups.md Fixing Spelling Mistake of "Securtiy" to "Security" --------- Co-authored-by: Jonathan Styles <[email protected]>
1 parent e8fe9b4 commit 3008d61

36 files changed

+109
-51
lines changed

docs/guides/How to access Windows Instances.md

Lines changed: 108 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,53 @@ There are 2 main ways to get access and control a Windows Instance on Openstack.
88
* Access to Infra via OpenVPN OR On the Cyberlab Secure Network
99

1010

11+
## Preparation: Recover your Windows Instance Password ##
12+
For some windows instance images, you will need to retrieve the password so you can set a new administrator password. If you already have an instance created and going with an SSH key, you can skip Step 1.
1113

12-
## Method 1: Using the Openstack Console (Must be used for initial Windows Setup) ##
14+
- Step 1: Create instance with an SSH key (use images from repo)
15+
1. On the left pane, choose `Compute` and then `Instances`.
16+
![Step2-1](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-1.png)
17+
2. Locate the instance you want to access the console of, and click on its name.
18+
![Step2-2](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-2.png)
19+
3. Select the `Console` tab under the instance name.
20+
![Step2-3.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-3.png)
21+
4. Send a ctrl+alt+delete to the server by pressing the `Send CtrlAltDelete` button in the upper right hand corner.
22+
![Step2-4.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-4.png)
23+
5. Log into the instance. If this is your first time, it may ask you to change the password. If it asks you for the pervious password, enter the password you retrieved earlier, then enter in the password you would like, make sure to note it down.
24+
![Step2-5.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-5.png)
1325

14-
Openstack has a built-in console viewer for Instances which allows you to get a true console view of the Instance allowing for easier debugging of the Instance. You will have to use this method to initially setup Windows Server.
1526

16-
### Steps: ###
17-
1. On the left plane, choose `Compute` and then `Instances`
18-
![Instance page](../img/win-guide/instancespage.png)
19-
2. Click on the Instance to view
20-
![Instance page](../img/win-guide/instancespage2.png)
21-
3. Click on the `Console` tab
22-
![Instance page](../img/win-guide/consoletab.png)
23-
4. You now have a console view of the Instance! From here you can add an Administrator password to Windows and use the Instance!
24-
![Instance page](../img/win-guide/consoleview.png)
2527

26-
## Method 2: Using Remote Desktop Connection ##
28+
## Method 1: Connect Using the Openstack Console (Must be used for initial Windows Setup) ##
29+
30+
Openstack has a built-in console viewer for Instances which allows you to get a true console view of the Instance allowing for easier debugging of the Instance. You will have to log in using this method to initially set up any new Windows Instance.
31+
32+
### Steps: ###
33+
1. On the left plane, choose `Compute` and then `Instances`.
34+
![Step1-1.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-1.png)
35+
2. Locate the instance you want to access the console of, and click on its name.
36+
![Step1-2.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-2.png)
37+
3. Select the `Console` tab under the instance name.
38+
![Step1-3.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-3.png)
39+
4. Send a ctrl+alt+delete to the server by pressing the `Send CtrlAltDelete` button in the upper right hand corner.
40+
![Step1-4.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-4.png)
41+
5. Log into the instance. If this is your first time, it may ask you to change the password. If it asks you for the pervious password, enter the password you retrieved earlier, then enter in the password you would like, make sure to note it down.
42+
![Step1-5.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-5.png)
43+
6. You may now access the instance through the openstack console normally as you would any other windows device.
44+
![Step1-6.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-6.png)
45+
46+
47+
## Method 2: Using Remote Desktop Connection (RDP)##
2748

2849
Remote Desktop Connection (Also known as RDP somtimes) is a program in Microsoft Windows that allows you to access another Windows computer over a network. Using this method has added benefits such as easy folder sharing, viewing the Instance in full-screen mode, clipboard sharing and more!
2950

3051
By default, Openstack blocks all inbound connections to Instances and therefore we need to make a security group to allow inbound RDP access
3152

3253
Important Note: You cannot directly use this method on the very first time you startup your Instance as Windows requires you to set an Administrator password upon Instance creation. Follow Method 1 to gain initial access to the machine and add a password.
3354

34-
### Step 1: Creating a security group ###
55+
### Part 1: Opening RDP Access for your Instance ###
56+
57+
#### Step 1: Creating a security group ###
3558
1. Connect to Infra via OpenVPN or `Cyberlab Secure`
3659
2. Go to `horizon.hackucf.cloud` and log into your account
3760
3. Click on `Network` on the left-hand pane and then `Security Groups`
@@ -46,7 +69,7 @@ Important Note: You cannot directly use this method on the very first time you s
4669

4770
This new group can be applied to any future Windows Instances to quickly allow RDP access
4871

49-
### Step 2: Adding the security group to your Instance ###
72+
#### Step 2: Adding the security group to your Instance ###
5073
1. On the left plane, choose `Compute` and then `Instances`
5174
![Instance page](../img/win-guide/instancespage.png)
5275

@@ -66,47 +89,82 @@ This new group can be applied to any future Windows Instances to quickly allow R
6689

6790
RDP will now be allowed through the Openstack firewall for the instance!
6891

69-
### Step 3: Connecting to the instance ###
70-
1. Open your remote desktop client
71-
* Windows Clients: Open Start Menu > type in "Remote Desktop Connection"
72-
* MacOS Clients: [Windows App](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12)
73-
* Linux Clients: [Remmina](https://remmina.org/)
74-
2. Enter the IP address of your Instance and press `Connect` (You can find this in Compute > Instances)
75-
76-
![Instance page](../img/win-guide/rdp.png)
7792

78-
3. Enter the credentials for the Instance and select OK
93+
### Part 3: Connecting to your the instance ###
94+
For the purposes of this guide, we will use the following applications for RDP.
95+
* Windows Clients: Open Start Menu > type in "Remote Desktop Connection"
96+
* MacOS Clients: [Windows App](https://apps.apple.com/us/app/windows-app/id1295203466?mt=12)
97+
* Linux Clients: [Remmina](https://remmina.org/)
7998

80-
![Instance page](../img/win-guide/rdp2.png)
8199

82-
4. You will be successfully connected to the Instance!
83100

84-
![Instance page](../img/win-guide/rdp_final.png)
85-
86-
87-
## Retrieving Windows Password #
88-
89-
To retrieve the Windows password for an instance in OpenStack Horizon, you need to follow these steps. This process assumes that you have created the instance with an SSH key, which is necessary for decrypting the password.
90-
91-
### Step 1: Creating an Instance with an SSH Key ##
92-
93-
1. On the left pane, choose `Compute` and then `Instances`.
94-
2. Click on `Launch Instance`.
95-
3. Fill in the necessary details for your instance, such as the instance name and flavor.
96-
4. Under the `Key Pair` section, select an existing key pair or create a new one. This key pair will be used to decrypt the Windows password. **Ensure the key is a RSA key.**
97-
![RSA_key](../img/win-guide/rsa_key.png)
101+
#### Connecting from Another Windows Device ####
102+
This is the most simple way to access a windows instance with RDP, as Windows comes with the needed software pre-installed.
103+
**Make sure you are connected to the HACK@UCF infrastructure via OpenVPN before attempting to connect**
98104

105+
1. On the left plane, choose `Compute` and then `Instances`
106+
![Step2-0.png](../img/win-guide-new/Windows-Windows-RDP-method/step2-0.png)
107+
2. Locate the name of the instance you want to access and note down it IP address.
108+
![Step2-1.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-1.png)
109+
3. Open the Windows Start Menu, type in "Remote Desktop Connection", and open the `Remote Desktop Connection` application
110+
![Step2-2.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-2.png)
111+
4. In the `Computer:` field, enter in the IP address of you noted in step 2, and press `Connect`.
112+
![Step2-3.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-3.png)
113+
5. When windows security prompts you to enter your credentials, select `Use a different account`.
114+
![Step2-4.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-4.png)
115+
6. In the `User name` field, enter "Administrator", and in the `Password` field, enter in the password you set when first logging in to your Windows instance, then select `OK`.
116+
![Step2-5.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-5.png)
117+
7. If you recieve a warning from windows stating that "The identity of the remote computer cannot be verified", check the `Don't ask me again for connections to this computer` option, and then select `Yes`.
118+
![Step2-6.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-6.png)
119+
8. You are now logged into your instsance, and you can navigate as you would any windows device.
120+
![Step2-7.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-7.png)
121+
122+
123+
124+
125+
#### Connecting to your Windows instance from a Linux Device ####
126+
For connecting to a windows instance with RDP for Linux, we will use the Remmina client.
127+
See https://remmina.org/how-to-install-remmina/ for more help with installing the Remmina client.
128+
129+
1. Open Remmina, either from your applications menu or the console.
130+
2. Press the `+` add new connection button in the top left corner.
131+
![Step4-2.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-2.png)
132+
3. In the `Name` field, enter in what you would like to name the connection to your windows instance.
133+
![Step4-3.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-3.png)
134+
4. Select the `Protocol` dropdown and select `RDP - Remote Desktop Protocol` as your protocol.
135+
![Step4-4.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-4.png)
136+
5. In the`Server` field, enter in your instance's IP address.
137+
![Step4-5.png](../img/win-guide-new/Linux-Windows-RDP-Method//Step4-5.png)
138+
6. In the `Username` and `Password` fields, enter in the username (likely "Administrator") and password you set for the instance earlier.
139+
![Step4-6.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-6.png)
140+
7. Select `Save and Connect`.
141+
![Step4-7.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-7.png)
142+
8. When prompted to accept the server's certificate, select `Yes`.
143+
![Step4-8.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-8.png)
144+
9. Verify the authentication credentials, then select `OK`.
145+
![Step4-9.png](../img/win-guide-new/Linux-Windows-RDP-Method/Stzep4-9.png)
146+
10. You should now be logged in to the windows instance and be able to navigate as you would any windows device.
147+
148+
149+
150+
#### Connecting to your Windows instance from a mac device ####
151+
For connecting to a Windows intance with RDP from MacOS, we will use the windows app.
152+
See [here](https://apps.apple.com/us/app/windows-app/id1295203466?mt=12) for more information.
153+
154+
1. Open the Windows App.
155+
2. Press the `+` botton in the top right color and then select `Add PC`.
156+
![Step5-1.png](../img/win-guide-new/Mac-Windows-RDP/Step5-1.png)
157+
3. In the `PC name` field enter the IP address of your instance and in the `Friendly name` enter what you would like to name the connection to the instance.
158+
![Step5-2.png](../img/win-guide-new/Mac-Windows-RDP/Step5-2.png)
159+
4. Select `Add` to save the connection.
160+
![Step5-3.png](../img/win-guide-new/Mac-Windows-RDP/Step5-3.png)
161+
5. Select the new connection with the friendly name you entered previously.
162+
![Step5-4.png](../img/win-guide-new/Mac-Windows-RDP/Step5-4.png)
163+
6. In the `Username` and `Password` field enter in the username (likely "Administrator") and password you set for the instance earlier, and then select `Continue`.
164+
![Step5-5.png](../img/win-guide-new/Mac-Windows-RDP/Step5-5.png)
165+
7. When prompted to accept the server's certificate, select `Continue`.
166+
![Step5-6.png](../img/win-guide-new/Mac-Windows-RDP/Step5-6.png)
167+
8. You should now be logged in to the windows instance and be able to navigate as you would any windows device.
99168

100-
### Step 2: Retrieving the Windows Password ##
101169

102-
1. On the left pane, choose `Compute` and then `Instances`.
103-
![Instance page](../img/win-guide/instancespage.png)
104-
2. Click on the instance for which you want to retrieve the password.
105-
![Instance page](../img/win-guide/instancespage2.png)
106-
3. Click on the `Actions` dropdown menu on the right and select `Retrieve Password`.
107-
![dropdown password](../img/win-guide/dropdown_password.png)
108-
4. In the `Retrieve Password` dialog, click on `Choose File` and upload the private key file associated with the SSH key pair used during instance creation.
109-
![retrieve password](../img/win-guide/retrieve_password.png)
110-
5. Click on `Decrypt Password`. The decrypted password will be displayed.
111170

112-
You can now use this password to log in to your Windows instance via the OpenStack console or Remote Desktop Connection.

docs/guides/Security Groups.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Securtiy Groups Guide
1+
# Security Groups Guide
22

33
This guide provides a step by step walkthrough of how to get started utilizing security groups in OpenStacks
44

13.5 KB
Loading
33.2 KB
Loading
44.2 KB
Loading
44.1 KB
Loading
44.7 KB
Loading
45.4 KB
Loading
31.6 KB
Loading
33.2 KB
Loading

0 commit comments

Comments
 (0)