Automated Setup - Windows Usernames and GH SSH key pw (#74)

* refactor: playbook 2 ssh password fix

* chore: minor semantic changes for readability

* feature: windows - explicitily add SSH username to ssh conf

* setup guides generated

* chore: Windows - simplify ssh conf username verify

* revert: ansible playbook 2 ssh keys

* chore: playbook 1 - minor semantics, playbook 2 - ssh pw note added

* setup guides generated

* chore: playbook 2 instructions semantic updates

* setup guides generated

---------

Co-authored-by: github-actions <github-actions@github.com>

Author: lorcanrae

LINUX.md

@@ -51,8 +51,6 @@ There will be copying and pasting of terminal commands in this Setup Guide. Ther
 
 Let's start :rocket:
 
----
-
 # Part 1: Local Setup
 
 
@@ -586,7 +584,7 @@ Terraform is telling you what it will create:
 - A compute engine instance
 - A static external IP address
 
-**❗ If you have any errors, read the error and debug. If you need some help, raise a ticket with a teacher. ❗**
+**❗ If you have any errors, read the error and debug. If you are unsure, raise a ticket with a teacher. ❗**
 
 If everything was successful, create your VM with:
 
@@ -658,13 +656,13 @@ Notice the connection in the very bottom-left corner of your VS Code window. It
 If you want to view your SSH configuration:
 1. Start by clicking the symbol in the bottom-left corner of VS Code
 2. Click on **Connect to Host...**
-3. Click on **Configure SSH Hosts...***
+3. Click on **Configure SSH Hosts...**
 4. Select the configuration file. Usually the file at the top of the list.
 5. View your configuration file! You may need to edit this configuration if you change computers, or want to work on more than one computer during the bootcamp.
 
 </details>
 
-Congratulations, the setup of you local laptop is complete 🎉 We just need to fine tune your Virtual Machine 🪛
+Congratulations, the setup of you local computer is complete 🎉 We just need to fine tune your Virtual Machine 🪛
 
 ---
 
@@ -793,7 +791,7 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part1.yml
 
 And the playbook should start running!
 
-❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required.
+❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required (a cool concept called _Idempotency_ that you'll learn about later 😉).
 
 ### What is the playbook installing?
 
@@ -810,7 +808,7 @@ While this playbook is running, lets go through what is being installed and conf
 
 The playbook is also running checks to see if things are installed or not. This is so you can safely re-run the playbook without any problems.
 
-💡 Curious about how Ansible playbooks are defined, take a look at the playbook being run at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml)
+💡 Curious about how Ansible playbooks are defined, take a look at the playbooks' source code at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml). You might not understand exactly what is happening, but should be able to identify the different tasks.
 
 
 ## GitHub CLI
@@ -883,7 +881,7 @@ Open a ticket with a TA and do one of the following:
 - Compare your existing dotfiles with the current Le Wagon [dotfiles 🔗](https://github.com/lewagon/dotfiles), particularly the `.zshrc` and `settings.json` - if there is no meaningful difference, continue with the setup.
 - If you are OK with losing your existing dotfiles - delete your existing dotfiles repository on GitHub and continue with the setup
 - If you do not want to lose your existing dotfiles, we recommend working with branches:
-    - On your **laptop**, or wherever you have a **local** copy of **your** copy of dotfiles
+    - On your **laptop**, or wherever you have a **local** copy of **your existing version of dotfiles**
     - Create a branch of your existing dotfiles setup, and push to GitHub - `origin <branchname>`
     - On `local main` (or a new named branch), pull from `upstream main`, resolve any conflicts, commit, and push. It is important that you accept incoming changes to the `.zshrc` and `settings.json` files
     - Continue with the setup
@@ -968,7 +966,11 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part2.yml
 
 And the playbook should start running! If you're asked if you want VS Code to behave more like Sublime Text, click accept.
 
-❗ If any errors occur, raise a ticket with a teacher. You can safely run the playbook again.
+❗ **If you created a password for your GitHub SSH key**
+- You may be asked to type in your password during the playbook run
+- The task: **Clone data-engineering-challenges from your GitHub to VM** will fail. This is OK and expected with how SSH keys work and how the playbooks are modifying your configuration. To resolve, in your terminal run: `exec zsh`, and then re-run the playbook.
+
+❗ If any other errors occur, or your are unsure, raise a ticket with a teacher. You can safely run the playbook again and again. Generally, if the playbook runs from start to finish with no errors, everything should be good!
 
 ### What is the playbook installing?
 

WINDOWS.md

@@ -51,8 +51,6 @@ There will be copying and pasting of terminal commands in this Setup Guide. Ther
 
 Let's start :rocket:
 
----
-
 # Part 1: Local Setup
 
 
@@ -485,7 +483,7 @@ We'll need to change some values in this file. Here's were you can find the requ
 - **region:** take a look at the GCP Region and Zone documentation at this [link here](https://cloud.google.com/compute/docs/regions-zones#available). We generally recommend you choose a geographically nearby region.
 - **zone:** Zone is a subset of region. it is almost always the same as **region** appended with `-a`, `-b`, or `-c`. The zone you select within a region should not have a functional impact.
 - **instance_name:** we recommend naming your VM: `lw-de-vm-<YOUR_GITHUB_USERNAME>`. Replacing `<YOUR_GITHUB_USERNAME>` with your GitHub username.
-- **instance_user:** in Command Prompt, run `echo %username%`, and enter the value
+- **instance_user:** in Command Prompt, run `echo %username%`, and enter the value - try and remember your username, you will need it later on
 
 After completing this file, it might look similar to:
 
@@ -525,7 +523,7 @@ Terraform is telling you what it will create:
 - A compute engine instance
 - A static external IP address
 
-**❗ If you have any errors, read the error and debug. If you need some help, raise a ticket with a teacher. ❗**
+**❗ If you have any errors, read the error and debug. If you are unsure, raise a ticket with a teacher. ❗**
 
 If everything was successful, create your VM with:
 
@@ -564,6 +562,56 @@ For example, try running:
 # $ ssh lw-de-vm-<GITHUB_USERNAME>.<GCP_ZONE>.<GCP_PROJECT_ID>
 ```
 
+### Confirm Your SSH Settings
+
+Let's take a look at the SSH configuration that was just created and verify it. In VS Code:
+
+1. Open the **command palette** with `ctrl + shift + P` and type in: _remote ssh config_
+2. Select the option: **Remote-SSH: Open SSH Configuration File...**
+3. In the next menu, select: the file that looks like: **C:\Users\YOUR_USERNAME\.ssh\config**
+4. And a file should open that looks similar too:
+
+```bash
+# Google Compute Engine Section
+#
+# The following has been auto-generated by "gcloud compute config-ssh"
+# to make accessing your Google Compute Engine virtual machines easier.
+#
+# To remove this blob, run:
+#
+#   gcloud compute config-ssh --remove
+#
+# You can also manually remove this blob by deleting everything from
+# here until the comment that contains the string "End of Google Compute
+# Engine Section".
+#
+# You should not hand-edit this section, unless you are deleting it.
+#
+Host lw-de-vm-tswift.europe-west1-b.wagon-bootcamp
+    HostName 34.0.248.237
+    IdentityFile C:\Users\TaylorSwift\.ssh\google_compute_engine
+    UserKnownHostsFile=C:\Users\TaylorSwift\.ssh\google_compute_known_hosts
+    HostKeyAlias=compute.1637400398547578470
+    IdentitiesOnly=yes
+    CheckHostIP=no
+
+# End of Google Compute Engine Section
+```
+
+A bit happening here, most of it is documentation and context. Because of some quirks with Windows, we are in fact going to edit this file by hand. We want to add a new `User YOUR_USERNAME` key-value pair to the SSH connection configuration block. In the indented section after `CheckHostIP=no`, add a new `User` label with the value of your Windows username. For example: If the output of `echo %username%` in command prompt was `TaylorSwift`, my updated configuration would be:
+
+```bash
+Host lw-de-vm-tswift.europe-west1-b.wagon-bootcamp
+    HostName 34.0.248.237
+    IdentityFile C:\Users\TaylorSwift\.ssh\google_compute_engine
+    UserKnownHostsFile=C:\Users\TaylorSwift\.ssh\google_compute_known_hosts
+    HostKeyAlias=compute.1637400398547578470
+    IdentitiesOnly=yes
+    CheckHostIP=no
+    User TaylorSwift # <-- Add User label here
+```
+
+
 ### SSH File Permissions
 
 Windows has strict permissions for SSH files by default, we need to alter some permissions on the SSH configuration that was created by `gcloud` so VS Code can read the files and manage the SSH connection.
@@ -618,13 +666,13 @@ Notice the connection in the very bottom-left corner of your VS Code window. It
 If you want to view your SSH configuration:
 1. Start by clicking the symbol in the bottom-left corner of VS Code
 2. Click on **Connect to Host...**
-3. Click on **Configure SSH Hosts...***
+3. Click on **Configure SSH Hosts...**
 4. Select the configuration file. Usually the file at the top of the list.
 5. View your configuration file! You may need to edit this configuration if you change computers, or want to work on more than one computer during the bootcamp.
 
 </details>
 
-Congratulations, the setup of you local laptop is complete 🎉 We just need to fine tune your Virtual Machine 🪛
+Congratulations, the setup of you local computer is complete 🎉 We just need to fine tune your Virtual Machine 🪛
 
 ---
 
@@ -753,7 +801,7 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part1.yml
 
 And the playbook should start running!
 
-❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required.
+❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required (a cool concept called _Idempotency_ that you'll learn about later 😉).
 
 ### What is the playbook installing?
 
@@ -770,7 +818,7 @@ While this playbook is running, lets go through what is being installed and conf
 
 The playbook is also running checks to see if things are installed or not. This is so you can safely re-run the playbook without any problems.
 
-💡 Curious about how Ansible playbooks are defined, take a look at the playbook being run at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml)
+💡 Curious about how Ansible playbooks are defined, take a look at the playbooks' source code at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml). You might not understand exactly what is happening, but should be able to identify the different tasks.
 
 
 ## GitHub CLI
@@ -843,7 +891,7 @@ Open a ticket with a TA and do one of the following:
 - Compare your existing dotfiles with the current Le Wagon [dotfiles 🔗](https://github.com/lewagon/dotfiles), particularly the `.zshrc` and `settings.json` - if there is no meaningful difference, continue with the setup.
 - If you are OK with losing your existing dotfiles - delete your existing dotfiles repository on GitHub and continue with the setup
 - If you do not want to lose your existing dotfiles, we recommend working with branches:
-    - On your **laptop**, or wherever you have a **local** copy of **your** copy of dotfiles
+    - On your **laptop**, or wherever you have a **local** copy of **your existing version of dotfiles**
     - Create a branch of your existing dotfiles setup, and push to GitHub - `origin <branchname>`
     - On `local main` (or a new named branch), pull from `upstream main`, resolve any conflicts, commit, and push. It is important that you accept incoming changes to the `.zshrc` and `settings.json` files
     - Continue with the setup
@@ -928,7 +976,11 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part2.yml
 
 And the playbook should start running! If you're asked if you want VS Code to behave more like Sublime Text, click accept.
 
-❗ If any errors occur, raise a ticket with a teacher. You can safely run the playbook again.
+❗ **If you created a password for your GitHub SSH key**
+- You may be asked to type in your password during the playbook run
+- The task: **Clone data-engineering-challenges from your GitHub to VM** will fail. This is OK and expected with how SSH keys work and how the playbooks are modifying your configuration. To resolve, in your terminal run: `exec zsh`, and then re-run the playbook.
+
+❗ If any other errors occur, or your are unsure, raise a ticket with a teacher. You can safely run the playbook again and again. Generally, if the playbook runs from start to finish with no errors, everything should be good!
 
 ### What is the playbook installing?
 

_partials/dotfiles_simple.md

@@ -16,7 +16,7 @@ Open a ticket with a TA and do one of the following:
 - Compare your existing dotfiles with the current Le Wagon [dotfiles 🔗](https://github.com/lewagon/dotfiles), particularly the `.zshrc` and `settings.json` - if there is no meaningful difference, continue with the setup.
 - If you are OK with losing your existing dotfiles - delete your existing dotfiles repository on GitHub and continue with the setup
 - If you do not want to lose your existing dotfiles, we recommend working with branches:
-    - On your **laptop**, or wherever you have a **local** copy of **your** copy of dotfiles
+    - On your **laptop**, or wherever you have a **local** copy of **your existing version of dotfiles**
     - Create a branch of your existing dotfiles setup, and push to GitHub - `origin <branchname>`
     - On `local main` (or a new named branch), pull from `upstream main`, resolve any conflicts, commit, and push. It is important that you accept incoming changes to the `.zshrc` and `settings.json` files
     - Continue with the setup

_partials/intro.md

@@ -51,6 +51,4 @@ There will be copying and pasting of terminal commands in this Setup Guide. Ther
 
 Let's start :rocket:
 
----
-
 # Part 1: Local Setup

_partials/terraform_vm.md

@@ -126,7 +126,7 @@ $MAC_START
 - **instance_user:** in your terminal, run `whoami`, and enter the value
 $MAC_END
 $WINDOWS_START
-- **instance_user:** in Command Prompt, run `echo %username%`, and enter the value
+- **instance_user:** in Command Prompt, run `echo %username%`, and enter the value - try and remember your username, you will need it later on
 $WINDOWS_END
 $LINUX_START
 - **instance_user:** in your terminal, run `whoami`, and enter the value
@@ -178,7 +178,7 @@ Terraform is telling you what it will create:
 - A compute engine instance
 - A static external IP address
 
-**❗ If you have any errors, read the error and debug. If you need some help, raise a ticket with a teacher. ❗**
+**❗ If you have any errors, read the error and debug. If you are unsure, raise a ticket with a teacher. ❗**
 
 If everything was successful, create your VM with:
 

_partials/ubuntu_ansible_part1.md

@@ -46,7 +46,7 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part1.yml
 
 And the playbook should start running!
 
-❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required.
+❗ If an errors occur, raise a ticket with a teacher. The ansible playbooks are designed so that they can be run again, and again, and again and only make the changes that are required (a cool concept called _Idempotency_ that you'll learn about later 😉).
 
 ### What is the playbook installing?
 
@@ -63,4 +63,4 @@ While this playbook is running, lets go through what is being installed and conf
 
 The playbook is also running checks to see if things are installed or not. This is so you can safely re-run the playbook without any problems.
 
-💡 Curious about how Ansible playbooks are defined, take a look at the playbook being run at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml)
+💡 Curious about how Ansible playbooks are defined, take a look at the playbooks' source code at this [link here 🔗](https://github.com/lewagon/data-engineering-setup/blob/main-automation/automation/vm-ansible-setup/playbooks/setup_vm_part1.yml). You might not understand exactly what is happening, but should be able to identify the different tasks.

_partials/ubuntu_ansible_part2.md

@@ -20,7 +20,11 @@ cd ~/vm-ansible-setup && ansible-playbook playbooks/setup_vm_part2.yml
 
 And the playbook should start running! If you're asked if you want VS Code to behave more like Sublime Text, click accept.
 
-❗ If any errors occur, raise a ticket with a teacher. You can safely run the playbook again.
+❗ **If you created a password for your GitHub SSH key**
+- You may be asked to type in your password during the playbook run
+- The task: **Clone data-engineering-challenges from your GitHub to VM** will fail. This is OK and expected with how SSH keys work and how the playbooks are modifying your configuration. To resolve, in your terminal run: `exec zsh`, and then re-run the playbook.
+
+❗ If any other errors occur, or your are unsure, raise a ticket with a teacher. You can safely run the playbook again and again. Generally, if the playbook runs from start to finish with no errors, everything should be good!
 
 ### What is the playbook installing?