Merge pull request #18 from insanefire10/win_guide

Windows Instances Guide
HackUCF · Oct 9, 2024 · ab8e41c · ab8e41c
2 parents 4c9d396 + b72a4e9
commit ab8e41c
Show file tree

Hide file tree

Showing 16 changed files with 85 additions and 0 deletions.
diff --git a/docs/guides/How to access Windows Instances.md b/docs/guides/How to access Windows Instances.md
@@ -0,0 +1,84 @@
+# How to access Windows Instances on Openstack #
+
+There are 2 main ways to get access and control a Windows Instance on Openstack. This tutorial will cover both methods.
+
+## Prerequesites ## 
+
+* A newly created Windows Server Instance on Openstack
+* Access to Infra via OpenVPN OR On the Cyberlab Secure Network
+
+
+
+# Method 1: Using the Openstack Console (Must be used for initial Windows Setup)
+
+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.
+
+## Steps:
+1. On the left plane, choose `Compute` and then `Instances`
+![Instance page](../img/win-guide/instancespage.png)
+2. Click on the Instance to view
+![Instance page](../img/win-guide/instancespage2.png) 
+3. Click on the `Console` tab
+![Instance page](../img/win-guide/consoletab.png) 
+4. You now have a console view of the Instance! From here you can add an Administrator password to Windows and use the Instance!
+![Instance page](../img/win-guide/consoleview.png) 
+
+# Method 2: Using Remote Desktop Connection
+
+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!
+
+By default, Openstack blocks all inbound connections to Instances and therefore we need to make a security group to allow inbound RDP access
+
+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.
+
+## Step 1: Creating a security group
+1. Connect to Infra via OpenVPN or `Cyberlab Secure`
+2. Go to `horizon.hackucf.cloud` and log into your account
+3. Click on `Network` on the left-hand pane and then `Security Groups` 
+![Instance page](../img/win-guide/network_secgroup.png)
+4. On the right-hand side, click on `Create Security Group` and give it a name and description, then press `Create Security Group`
+![Instance page](../img/win-guide/creategroup.png)
+![Instance page](../img/win-guide/creategroup2.png)
+5. On the Manage Security Group Rules screen, click `Add rule`
+![Instance page](../img/win-guide/addrule.png)
+6. Choose the `RDP` Rule in the Rule dropdown, leave all other options as default and click `Add`
+![Instance page](../img/win-guide/addrule2.png)
+
+This new group can be applied to any future Windows Instances to quickly allow RDP access
+
+## Step 2: Adding the security group to your Instance
+1. On the left plane, choose `Compute` and then `Instances`
+![Instance page](../img/win-guide/instancespage.png)
+
+
+2. Click on the Instance to add the security group to
+![Instance page](../img/win-guide/instancespage2.png)
+
+
+3. Click the dropdown arrow on the right and select `Edit Security Groups`
+![Instance page](../img/win-guide/editsecgroup.png)
+
+
+4. Select the appropriate security group and select `Save`
+
+![Instance page](../img/win-guide/choosesecgroup.png)
+
+
+RDP will now be allowed through the Openstack firewall for the instance!
+
+## Step 3: Connecting to the instance
+1. Open your remote desktop client
+    * Windows Clients: Open Start Menu > type in "Remote Desktop Connection"
+    * MacOS Clients: [Windows App](https://apps.apple.com/us/app/microsoft-remote-desktop/id1295203466?mt=12)
+    * Linux Clients: [Remmina](https://remmina.org/)
+2. Enter the IP address of your Instance and press `Connect` (You can find this in Compute > Instances)
+
+![Instance page](../img/win-guide/rdp.png)
+
+3. Enter the credentials for the Instance and select OK
+
+![Instance page](../img/win-guide/rdp2.png)
+
+4. You will be successfully connected to the Instance!
+
+![Instance page](../img/win-guide/rdp_final.png)
diff --git a/docs/img/win-guide/addrule.png b/docs/img/win-guide/addrule.png
diff --git a/docs/img/win-guide/addrule2.png b/docs/img/win-guide/addrule2.png
diff --git a/docs/img/win-guide/choosesecgroup.png b/docs/img/win-guide/choosesecgroup.png
diff --git a/docs/img/win-guide/consoletab.png b/docs/img/win-guide/consoletab.png
diff --git a/docs/img/win-guide/consoleview.png b/docs/img/win-guide/consoleview.png
diff --git a/docs/img/win-guide/creategroup.png b/docs/img/win-guide/creategroup.png
diff --git a/docs/img/win-guide/creategroup2.png b/docs/img/win-guide/creategroup2.png
diff --git a/docs/img/win-guide/editsecgroup.png b/docs/img/win-guide/editsecgroup.png
diff --git a/docs/img/win-guide/instancespage.png b/docs/img/win-guide/instancespage.png
diff --git a/docs/img/win-guide/instancespage2.png b/docs/img/win-guide/instancespage2.png
diff --git a/docs/img/win-guide/network_secgroup.png b/docs/img/win-guide/network_secgroup.png
diff --git a/docs/img/win-guide/rdp.png b/docs/img/win-guide/rdp.png
diff --git a/docs/img/win-guide/rdp2.png b/docs/img/win-guide/rdp2.png
diff --git a/docs/img/win-guide/rdp_final.png b/docs/img/win-guide/rdp_final.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -47,6 +47,7 @@ nav:
       - "Security Groups Guide": "guides/Security Groups.md"
       - "How to Launch an Instance": "guides/How to Launch an Instance.md"
       - "Migration Guide": "guides/Migrate Instance.md"
+      - "Windows Instances": "guides/How to access Windows Instances.md"
       - "Troubleshooting": "guides/Troubleshooting.md"
 #extra_css:
 #  - stylesheets/extra.css