Merge pull request #65 from lewagon/lorcanrae/poc-main-corrections

Proof of Concept -> `main` corrections

Author: lorcanrae

LINUX.md

@@ -5,6 +5,7 @@ The `gcloud` Command Line Interface (CLI) is used to communicate with Google Clo
 ### Install gcloud
 
 $MAC_START
+
 Install with `brew`:
 
 ```bash
@@ -24,7 +25,9 @@ gcloud --version
 ```
 
 👉 [Install documentation 🔗](https://cloud.google.com/sdk/docs/install#mac)
+
 $MAC_END
+
 $WINDOWS_START
 
 To install, download the Google Cloud CLI installer from this [link here 🔗](https://cloud.google.com/sdk/docs/install#windows).
@@ -34,7 +37,7 @@ Once it's finished downloading, launch the installer and follow the prompts. You
 On the last screen of the installer there will be four check boxes. Makes sure that the boxes for `Start Google SDK Shell` and `Run gcloud init to configure the Google Cloud CLI` are selected then click **Finish**. This should open a new **Command Prompt** window and ask a series of questions like:
 - **Do you want to log in?** - type `y` and hit enter and following the prompts. It should open a web-browser to log in to your Google account.
 - **Pick cloud project to use** - Select your GCP Project ID that you want to connect with `gcloud`
-- **Select your region and zone** - You can safely enter `n`. It's not important to us at the moment.
+- **Select your region and zone** - You can safely enter `n`. It's not important at the moment.
 
 Once you've completed the `gcloud` setup, close **Command Prompt** and re-open it, then run:
 
@@ -44,7 +47,7 @@ gcloud config list
 
 You should get an output similar to:
 
-```
+```bash
 [accessibility]
 screen_reader = True/False # depends on install options
 [core]
@@ -56,8 +59,11 @@ Your active configurations: [default]
 ```
 
 Now `gcloud` is installed and authenticated 🚀
+
 $WINDOWS_END
+
 $LINUX_START
+
 Add the `APT` repository and install with:
 
 ```bash
@@ -74,4 +80,5 @@ To test your install, open a new terminal and run:
 gcloud --version
 ```
 👉 [Install documentation 🔗](https://cloud.google.com/sdk/docs/install#deb)
+
 $LINUX_END

WINDOWS.md

@@ -118,21 +118,28 @@ Once the verification goes through, you should receive an email stating that "Yo
 
 ## GCP APIs
 
-You will use different GCP services during the bootcamp which needs to be activated and configured.
+When you create a GCP Project, not every service is enabled by default. To enable a service (like using a VM or storing a Docker image in Artifact Registry) you have to enable the GCP API for that service.
 
 ### Default APIs
 
-Go to your project [APIs dashboard](https://console.cloud.google.com/apis/dashboard), you can see a bunch of APIs are already enabled:
+Go to your project [APIs dashboard 🔗](https://console.cloud.google.com/apis/dashboard), you can see a bunch of APIs are already enabled:
 
 <img alt='GCP APIs dashboard' src="images/gcp_apis_dashboard.png" width=200>
 
-### Enable Compute Engine (virtual machines) API
+### Enable additional APIs
 
-**👌 Note: Skip to the next section if you already have Compute Engine enabled**
+You'll need to enable some additional API's so that Terraform can create cloud resources on your behalf.
 
-- In the search bar, type _compute_ and click on the Compute Engine result
-    <img alt='APIs search' src="images/gcp_apis_search.png" width=500>
-- Click on `ENABLE`
+**Cloud Resource Manager**
 
-    <img alt='APIs enable' src="images/gcp_apis_enable.png" width=300>
-- Compute Engine is now enabled on your project
+On the [APIs dashboard 🔗](https://console.cloud.google.com/apis/dashboard) page, click on [Enable APIs and services 🔗](https://console.cloud.google.com/apis/library) and make sure your project is selected in the box in the top left.
+
+In the search box, search for: _cloud resource manager api_ and select the **Cloud Resource Manager API**. On the next page, click on **Enable**.
+
+**Service Usage**
+
+Navigate back to the [APIs and Services 🔗](https://console.cloud.google.com/apis/library) page and search for: _service usage api_ and select the top result: **Service Usage API**. On the next page, click on **Enable**. ❗ This API might already enabled - not a problem if it is!
+
+**Compute Engine**
+
+Navigate back to the [APIs and Services 🔗](https://console.cloud.google.com/apis/library) page and search for: _compute engine api_ and select: **Compute Engine API**. On the next page, click on **Enable**. ❗ This API might already enabled - not a problem if it is!

_partials/gcp_cli_setup.md

@@ -6,27 +6,29 @@ A part of the setup will be done on your **local machine** but most of the confi
 
 Please **read instructions carefully and execute all commands in the following order**. If you get stuck, don't hesitate to ask a teacher for help :raising_hand:
 
-This setup is largely automated with **Terraform** and **Ansible**. There are three main components to the setup! **Terraform** and **ansible** are _Infrastructure as Code_ tools.
+This setup is largely automated with [**Terraform** 🔗](https://developer.hashicorp.com/terraform) and [**Ansible** 🔗](https://docs.ansible.com/). **Terraform** and **ansible** are [_Infrastructure as Code_ 🔗](https://en.wikipedia.org/wiki/Infrastructure_as_code) tools.
 - **Terraform** excels at creating and destroying cloud resources, like virtual machines, IP addresses, databases and more!
-- **Ansible** is used to configure linux machines with specific settings and software. Perfect for fine-tuning the Virtual Machine you will be creating!
+- **Ansible** is used to configure linux machines with specific settings and software. Perfect for fine-tuning the Virtual Machine you will be creating with Terraform!
+
+There are three main components to the setup!
 
 ## Part 1: Setup your local computer
 
-In this section you'll setup your local computer and create some accounts. It will include things like:
-1. Install some communication tools: Zoom, Slack
+In this section you'll setup your local computer and create some accounts. It will include:
+1. Installing the primary communication tool you'll use on the bootcamp: **Slack**!
 2. Create some accounts: Github, Google Cloud Platform (GCP)
-3. Install Visual Studio Code (VS Code)
+3. Install **Visual Studio Code (VS Code)**
 4. Install and authentication the GCP command line tool: `gcloud`
-5. Install **terraform** on your local computer
-6. Create your virtual machine with **terraform** and connect to it with **VS Code**!
+5. Install **Terraform** on your local computer
+6. Create your virtual machine with **Terraform** and connect to it with **VS Code**!
 
 ## Part 2: Configure your Virtual Machine Part 1
 
 All parts of this section happen on your virtual machine.
 
 This section includes:
 1. Authenticate your virtual machine with `gcloud`
-2. Download and run an **ansible** playbook to partially configure your virtual machine
+2. Download and run an **Ansible** playbook to partially configure your virtual machine
 3. Login to the Github command line tool on your virtual machine
 4. Copy the Le Wagon recommended **dotfiles**. **Dotfiles** are settings that will enhance your terminal and developer experience!
 
@@ -35,11 +37,14 @@ This section includes:
 All parts of this section happen on your virtual machine.
 
 In this section you will:
-1. Download and run a second **ansible** playbook for some more fine tuning
+1. Download and run a second **Ansible** playbook for some more VM fine tuning
 2. Test your set up to make sure that everything has installed correctly
 3. Create isolated python environments for all your challenges
 
-
 Don't worry, we'll go into more detail in each of the individual sections.
 
 Let's start :rocket:
+
+---
+
+# Part 1: Local Setup

_partials/gcp_setup.md

@@ -3,27 +3,30 @@
 Terraform is a tool for infrastructure as code (IAC) to create (and destroy) resources to create in the cloud.
 
 $MAC_START
+
 You can use `brew` to install terraform. In your terminal, run:
 
 ```bash
 brew tap hashicorp/tap
 brew install hashicorp/tap/terraform
 ```
 $MAC_END
+
 $WINDOWS_START
+
 ### Download
 
 To install terraform, download the **zip archive** from the Terraform install page at this [link here 🔗](https://developer.hashicorp.com/terraform/install).
 
-❗ If you are using Windows 10 or 11, download the **AMD64** version (64 bit version).
+❗ If you are using Windows 10 or 11, download the **AMD64** version (64 bit version). ❗
 
 1. Using file explorer to go to the location you downloaded the **terraform zip archive**
 
 2. **Unzip** the archive and two files should appear: `terraform.exe` and `license.txt`.
 
 3. Copy `terraform.exe`
 
-4. Navigate to your home directory (`C:\Users\<YOUR_USERNAME>\`) and create a directory named `cli_apps`
+4. Navigate to your home directory (`C:\Users\<YOUR_USERNAME>\`) and create a directory named `terraform_cli`
 
 5. Paste `terraform.exe` in the `cli_apps` directory
 
@@ -32,19 +35,24 @@ To install terraform, download the **zip archive** from the Terraform install pa
 We need to manually add **Terraform** to the `PATH` environment variable. The `PATH` variable contains a list of directories that your computer looks in for programs that we run from the command prompt.
 
 To update your path:
-1. Open Windows Search and search for: **Environment Variables**
+1. Open Windows Search and search for: **Environment variables**
+
+2. Select and open **Edit environment variables for your account**
 
-2. Click **Environment Variables** or **Edit environment variables for your account**
+3. Under **User variables for <YOUR_USERNAME>** click on the variable named: `Path` to select it, then click on **Edit**
 
-3. Click **New** on to top right of this window
+3. In the new pop out window, click **New** on to top right
 
-4. Enter: `C:\Users\YOUR_USERNAME\cli_apps` - Make sure to replace `YOUR_USERNAME` with your computers user name.
+4. Enter: `C:\Users\YOUR_USERNAME\terraform_cli` - Make sure to replace `YOUR_USERNAME` with _your user name_. You can obtain your user name by running `echo %username%` in **Command Prompt**
 
 5. Click **Ok** to close the `Path` variable window, and click **Ok** again to close the Environment Variable window.
 
 6. Close **Command Prompt** and open it again
+
 $WINDOWS_END
+
 $LINUX_START
+
 Install some basic requirements:
 ```bash
 sudo apt-get update && sudo apt-get install -y gnupg software-properties-common
@@ -74,10 +82,26 @@ Now we can install terraform directly with **apt** 👇
 sudo apt update
 sudo apt-get install terraform
 ```
+
 $LINUX_END
 
 Verify the installation with:
 
 ```bash
 terraform --version
 ```
+
+The output should look similar to:
+
+```bash
+Terraform v1.14.3
+on <your_operating_system>_<your_cpu_architecture>
+
+# Windows example
+# Terraform v1.14.3
+# on windows_amd64
+
+# Linux example
+# Terraform v1.14.3
+# on linux_amd64
+```