Updated RDP Documention W/O Mac Documentation (for now)

README.md

@@ -20,7 +20,7 @@ Before contributing, make sure you have the following:
 
 ### 1. Fork the Repository
 
-- Go to the MkDocs website repository on GitHub.
+- Make a fork of this repo
 - Click the "Fork" button to create your own copy of the repository.
 
 ### 2. Clone the Repository

docs/guides/How to Launch an Instance.md

@@ -10,14 +10,14 @@ Launching an instance in OpenStack GUI is a straightforward process that allows
 ## Step 1: Navigate to the Instance Tab
 
 1. Go to the **Instance** tab in the Horizon dashboard.
-![Instance page](../img/Instance page.png)
+![Instance page](../img/How-to-Launch-an-Instance/Instance-Page.png)
 
 ## Step 2: Instance Details
 
 1. Click on the **Launch Instance** button.
 2. Provide a name for your instance.
 3. Optionally, add a description for your instance.
-![Launch Instance](../img/Launch Instance.png)
+![Launch Instance](../img/How-to-Launch-an-Instance/Launch-Instance.png)
 
 ## Step 3: Source
 

docs/guides/How to Unshelve an Instance.md

@@ -0,0 +1,34 @@
+# How To Unshelve Instances On Openstack #
+
+When you leave a machine shutdown for a long time in openstack, it will eventually be shelved. 
+Simply put, you need to unshelve the instance before you can turn it back on. This tutorial covers how to unshelve an instance so you can use it again.
+
+## Prerequisites ##
+
+* Access to openstack via OpenVPN or Cyberlab WiFi
+* One or more shelved instances (more on this later)
+
+### Why can't I turn on my instance? (if you don't care and just want to turn it on skip this text) ###
+
+If you leave your instance unattended for too long, it will eventually be shelved. Shelving an instance is like shutting it down even further than just turning it off. When you shut down an instance, Its associated resources like RAM and Disk Space are still assigned to the instance even if they are not in use. So if you leave a shut down instance on openstack it's essentially wasting space, which we don't like. To fix this issue, after a certain amount of time the instance will get **SHELVED**. This means that openstack will save the needed **details** to run the instance and then delete the instance so others can use its resources. Essentially, openstack saves what we need to rebuild the instance and deletes it so we can rebuild it later, this rebuilding is called **UNSHELVING**. Once rebuilt you can turn your machine back on and do as you wish.
+
+## TLDR of above paragraph ##
+
+You can't turn it on because it's temporarilly deleted but you can rebuild it to its former glory by unshelving it. Here's How!
+
+## Step 1: Is my instance shelved? ##
+
+If you've had it shutdown and untouched for a long time, most likely **yes**. Here's how you can tell.
+
+To turn on a shut down machine, select it, click the **"More Actions"** drop down, and click **"Start Instances"**.
+If the instance is shelved you'll get an error as shown below. You can also see if it is shelved under its **STATUS**.
+
+![step1](../img/Unshelve-instance/unshelving-step1.png)
+
+## Step 2: How to unshelve instance ##
+
+Once you confirm your instance is shelved, go back to the instance tab on openstack and: select the instance name, click the dropdown next to "Associate Floating IP", and click "**Unshelve Instance**"
+
+![step1](../img/Unshelve-instance/unshelving-step2.png)
+
+And you're done!

docs/guides/How to access Windows Instances.md

@@ -8,30 +8,53 @@ There are 2 main ways to get access and control a Windows Instance on Openstack.
 * Access to Infra via OpenVPN OR On the Cyberlab Secure Network
 
 
+## Preparation: Recover your Windows Instance Password ##
+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.  
 
-## Method 1: Using the Openstack Console (Must be used for initial Windows Setup) ##
+- Step 1: Create instance with an SSH key (use images from repo)
+    1. On the left pane, choose `Compute` and then `Instances`. 
+    ![Step2-1](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-1.png)
+    2. Locate the instance you want to access the console of, and click on its name.
+    ![Step2-2](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-2.png)
+    3. Select the `Console` tab under the instance name. 
+    ![Step2-3.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-3.png)
+    4. Send a ctrl+alt+delete to the server by pressing the `Send CtrlAltDelete` button in the upper right hand corner. 
+    ![Step2-4.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-4.png)
+    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.
+    ![Step2-5.png](../img/win-guide-new/Recover-Windows-Instance-Password/Step2-5.png)
 
-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 ##
+## Method 1: Connect 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 log in using this method to initially set up any new Windows Instance. 
+
+### Steps: ###
+1. On the left plane, choose `Compute` and then `Instances`.
+![Step1-1.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-1.png)
+2. Locate the instance you want to access the console of, and click on its name.
+![Step1-2.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-2.png)
+3. Select the `Console` tab under the instance name.
+![Step1-3.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-3.png)
+4.  Send a ctrl+alt+delete to the server by pressing the `Send CtrlAltDelete` button in the upper right hand corner.
+![Step1-4.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-4.png)
+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.
+![Step1-5.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-5.png)
+6. You may now access the instance through the openstack console normally as you would any other windows device.
+![Step1-6.png](../img/win-guide-new/Login-Via-Openstack-Console/Step1-6.png)
+
+
+## Method 2: Using Remote Desktop Connection (RDP)##
 
 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 ###
+### Part 1: Opening RDP Access for your Instance ###
+
+#### 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`
@@ -46,7 +69,7 @@ Important Note: You cannot directly use this method on the very first time you s
 
 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 ###
+#### 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)
 
@@ -66,6 +89,66 @@ This new group can be applied to any future Windows Instances to quickly allow R
 
 RDP will now be allowed through the Openstack firewall for the instance!
 
+
+### Part 3: Connecting to your the instance ###
+
+
+
+#### Connecting from Another Windows Device ####
+This is the most simple way to access a windows instance with RDP, as Windows comes with the needed software pre-installed. 
+**Make sure you are connected to the HACK@UCF infrastructure via OpenVPN before attempting to connect**
+
+1. On the left plane, choose `Compute` and then `Instances`
+![Step2-0.png](../img/win-guide-new/Windows-Windows-RDP-method/step2-0.png)
+2. Locate the name of the instance you want to access and note down it IP address.
+![Step2-1.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-1.png)
+3. Open the Windows Start Menu, type in "Remote Desktop Connection", and open the `Remote Desktop Connection` application
+![Step2-2.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-2.png)
+4. In the `Computer:` field, enter in the IP address of you noted in step 2, and press `Connect`.
+![Step2-3.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-3.png)
+5. When windows security prompts you to enter your credentials, select `Use a different account`.
+![Step2-4.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-4.png)
+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`.
+![Step2-5.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-5.png)
+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`.
+![Step2-6.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-6.png)
+8. You are now logged into your instsance, and you can navigate as you would any windows device.
+![Step2-7.png](../img/win-guide-new/Windows-Windows-RDP-method/Step2-7.png)
+
+
+
+
+#### Connecting to your Windows instance from a Linux Device ####
+For connecting to a windows instance with RDP for Linux, we will use the Remmina client.
+See https://remmina.org/how-to-install-remmina/ for more help with installing the Remmina client.
+
+1. Open Remmina, either from your applications menu or the console. 
+2. Press the `+` add new connection button in the top left corner.
+![Step4-2.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-2.png)
+3. In the `Name` field, enter in what you would like to name the connection to your windows instance.
+![Step4-3.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-3.png)
+4. Select the `Protocol` dropdown and select `RDP - Remote Desktop Protocol` as your protocol.
+![Step4-4.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-4.png)
+5. In the`Server` field, enter in your instance's IP address.
+![Step4-5.png](../img/win-guide-new/Linux-Windows-RDP-Method//Step4-5.png)
+6. In the `Username` and `Password` fields, enter in the username (likely "Administrator") and password you set on the instance earlier.
+![Step4-6.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-6.png)
+7. Select `Save and Connect`.
+![Step4-7.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-7.png)
+8. When prompted to accept the server's certificate, select `Yes`.
+![Step4-8.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-8.png)
+9. Verify the authentication credentials, then select `OK`.
+![Step4-9.png](../img/win-guide-new/Linux-Windows-RDP-Method/Step4-9.png)
+10. You should now be logged in to the windows instance and be able to navigate as you would any windows device.
+
+#### Connecting to your Windows instance from a mac device ####
+UUWork In Progress**
+
+
+
+
+
+
 ### Step 3: Connecting to the instance ###
 1. Open your remote desktop client
     * Windows Clients: Open Start Menu > type in "Remote Desktop Connection"
@@ -83,30 +166,3 @@ RDP will now be allowed through the Openstack firewall for the instance!
 
 ![Instance page](../img/win-guide/rdp_final.png)
 
-
-## Retrieving Windows Password #
-
-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.
-
-### Step 1: Creating an Instance with an SSH Key ##
-
-1. On the left pane, choose `Compute` and then `Instances`.
-2. Click on `Launch Instance`.
-3. Fill in the necessary details for your instance, such as the instance name and flavor.
-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.**
-![RSA_key](../img/win-guide/rsa_key.png)
-
-
-### Step 2: Retrieving the Windows Password ##
-
-1. On the left pane, choose `Compute` and then `Instances`.
-![Instance page](../img/win-guide/instancespage.png)
-2. Click on the instance for which you want to retrieve the password.
-![Instance page](../img/win-guide/instancespage2.png)
-3. Click on the `Actions` dropdown menu on the right and select `Retrieve Password`.
-![dropdown password](../img/win-guide/dropdown_password.png)
-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.
-![retrieve password](../img/win-guide/retrieve_password.png)
-5. Click on `Decrypt Password`. The decrypted password will be displayed.
-
-You can now use this password to log in to your Windows instance via the OpenStack console or Remote Desktop Connection.

docs/guides/OpenStack Setup Guide.md

@@ -41,7 +41,7 @@
 ## Step 4: Login With Keycloak
 0. Navigate to [https://horizon.hackucf.cloud](https://horizon.hackucf.cloud)
 1. Select login with Hack@UCF SSO
-![alt text](<../img/Login With SSO.png>)
+![alt text](<../img/OpenStack-Setup-Guide/Login-with-SSO.png>)
 2. (These other steps are just for the first time)
 3. Login with credentials emailed or dm by Hack@UCF bot
 4. Agree to TOS
@@ -55,7 +55,7 @@
 3. Name it something reasonable.
 4. Set "Key Type" to "SSH Key".
 5. Paste the contents of your id_rsa.pub file here, or use "Load Public Key from a file" to upload it.
-![alt text](<../img/Key pairs Page.png>)
+![alt text](<../img/OpenStack-Setup-Guide/Key-pairs-Page.png>)
 
 # Next Steps
 

docs/guides/Security Groups.md

@@ -28,10 +28,10 @@ Depending on your security and accessibility needs you'll need to tailor your se
 2. Click on Create Security Group
 ![alt text](../img/Security-Groups/Create-Security-Group.png)
 
-3. Name your new Secuirty Group something like "Allow SSH" or something similar to make it easier to remember in the future. You can also add a description for further clarification. When you're finished naming click Create Security Group.
+3. Name your new Security Group something like "Allow SSH" or something similar to make it easier to remember in the future. You can also add a description for further clarification. When you're finished naming click Create Security Group.
 ![alt text](../img/Security-Groups/Naming-Sec-Group.png)
 
-4. You'll then be taken to the rule management papge. Here you can add the specific rules you want for traffic on your instance. Here's a break down of the terms you'll see:
+4. You'll then be taken to the rule management page. Here you can add the specific rules you want for traffic on your instance. Here's a break down of the terms you'll see:
 ![alt text](../img/Security-Groups/Rules-Explained.png)
     - Egress: Outgoing network traffic from your vm
     - Ingress: Inbound network traffic to your vm