Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 35 additions & 38 deletions LINUX.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,58 +93,49 @@ Have you signed up to GitHub? If not, [do it right away](https://github.com/join

We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate.

- Open your terminal

<details>
<summary markdown='span'>💡 Windows tip</summary>

We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation
</details>
<summary markdown='span'>Windows</summary>

- Create a SSH key
- We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation.
- Open Windows Terminal
- Run one of the following commands:
- If you're using _Windows PowerShell_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "[email protected]"
```
- If you're using the classic _Command Prompt_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "[email protected]"
```

<details>
<summary markdown='span'>Windows</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -C "[email protected]"
```
</details>

<details>
<summary markdown='span'>MacOS & Linux</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -C "[email protected]"
```
- Open your Terminal
- Run the following command:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
</details>


You should get the following message: `> Generating public/private algorithm key pair.`
- When you are prompted `> Enter a file in which to save the key`, press Enter
- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase.

ℹ️ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons.
You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase.

- You should be asked to `Enter same passphrase again`, do it.
ℹ️ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons.

**❗️ You must remember this passphrase.**

<details>
<summary markdown='span'> ❗️ /home/your_username/.ssh/id_ed25519 already exists.</summary>
If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github).
You should be asked to `Enter same passphrase again`, do it.

To create a separate SSH key to exclusively use for this bootcamp use the following:

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
**❗️ You must remember this passphrase.**

Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
</details>
Your new SSH Key will be named `de-bootcamp`.


## Google Cloud Platform setup
Expand Down Expand Up @@ -339,13 +330,19 @@ _Note: The following section requires you already have a [Google Cloud Platform]

<img alt="gcloud-console-add-manual-ssh-key" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-manual-ssh-key.png" width=500>
- In your terminal display your public SSH key:
- Windows: navigate to where you created your SSH key and open `id_ed25519.pub`
- Windows:
```bash
# If you use Windows Terminal
more $HOME\.ssh\de-bootcamp.pub
# OR if you use Command Prompt:
# more %HOMEPATH%\.ssh\de-bootcamp.pub
```

- Mac/Linux users can use:
```bash
cat ~/.ssh/id_ed25519.pub
# OR cat ~/.ssh/de-bootcamp.pub if you created a unique key
cat ~/.ssh/de-bootcamp.pub
```

- Copy your public SSH key and paste it:

<img alt="gcloud-console-add-ssh-key-pub" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-ssh-key-pub.png" width=500>
Expand Down Expand Up @@ -438,7 +435,7 @@ That's the only extension you should install on your _local_ machine, we will in
<img alt="vscode-connect-to-host" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-connect-to-host.png" width=500>

- Click on `Add a new host`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa [email protected]`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp [email protected]`

<img alt="vscode-ssh-connection-command" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-ssh-connection-command.png" width=500>

Expand Down
73 changes: 35 additions & 38 deletions WINDOWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,58 +93,49 @@ Have you signed up to GitHub? If not, [do it right away](https://github.com/join

We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate.

- Open your terminal

<details>
<summary markdown='span'>💡 Windows tip</summary>

We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation
</details>
<summary markdown='span'>Windows</summary>

- Create a SSH key
- We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation.
- Open Windows Terminal
- Run one of the following commands:
- If you're using _Windows PowerShell_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "[email protected]"
```
- If you're using the classic _Command Prompt_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "[email protected]"
```

<details>
<summary markdown='span'>Windows</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -C "[email protected]"
```
</details>

<details>
<summary markdown='span'>MacOS & Linux</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -C "[email protected]"
```
- Open your Terminal
- Run the following command:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
</details>


You should get the following message: `> Generating public/private algorithm key pair.`
- When you are prompted `> Enter a file in which to save the key`, press Enter
- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase.

ℹ️ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons.
You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase.

- You should be asked to `Enter same passphrase again`, do it.
ℹ️ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons.

**❗️ You must remember this passphrase.**

<details>
<summary markdown='span'> ❗️ /home/your_username/.ssh/id_ed25519 already exists.</summary>
If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github).
You should be asked to `Enter same passphrase again`, do it.

To create a separate SSH key to exclusively use for this bootcamp use the following:

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
**❗️ You must remember this passphrase.**

Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
</details>
Your new SSH Key will be named `de-bootcamp`.


## Google Cloud Platform setup
Expand Down Expand Up @@ -339,13 +330,19 @@ _Note: The following section requires you already have a [Google Cloud Platform]

<img alt="gcloud-console-add-manual-ssh-key" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-manual-ssh-key.png" width=500>
- In your terminal display your public SSH key:
- Windows: navigate to where you created your SSH key and open `id_ed25519.pub`
- Windows:
```bash
# If you use Windows Terminal
more $HOME\.ssh\de-bootcamp.pub
# OR if you use Command Prompt:
# more %HOMEPATH%\.ssh\de-bootcamp.pub
```

- Mac/Linux users can use:
```bash
cat ~/.ssh/id_ed25519.pub
# OR cat ~/.ssh/de-bootcamp.pub if you created a unique key
cat ~/.ssh/de-bootcamp.pub
```

- Copy your public SSH key and paste it:

<img alt="gcloud-console-add-ssh-key-pub" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-ssh-key-pub.png" width=500>
Expand Down Expand Up @@ -405,7 +402,7 @@ That's the only extension you should install on your _local_ machine, we will in
<img alt="vscode-connect-to-host" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-connect-to-host.png" width=500>

- Click on `Add a new host`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa [email protected]`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp [email protected]`

<img alt="vscode-ssh-connection-command" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-ssh-connection-command.png" width=500>

Expand Down
59 changes: 25 additions & 34 deletions _partials/ssh_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,46 @@

We want to safely communicate with your virtual machine using [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell). We need to generate a SSH key to authenticate.

- Open your terminal

<details>
<summary markdown='span'>💡 Windows tip</summary>

We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=fr-fr&gl=FR) from the Windows Store (installed on Windows 11 by default) to perform this operation
</details>
<summary markdown='span'>Windows</summary>

- Create a SSH key
- We highly recommend installing [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Windows Store (installed on Windows 11 by default) to perform this operation.
- Open Windows Terminal
- Run one of the following commands:
- If you're using _Windows PowerShell_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f $HOME\.ssh\de-bootcamp -C "[email protected]"
```
- If you're using the classic _Command Prompt_:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -f %HOMEPATH%\.ssh\de-bootcamp -C "[email protected]"
```

<details>
<summary markdown='span'>Windows</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen.exe -t ed25519 -C "[email protected]"
```
</details>

<details>
<summary markdown='span'>MacOS & Linux</summary>

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -C "[email protected]"
```
- Open your Terminal
- Run the following command:
```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
</details>


You should get the following message: `> Generating public/private algorithm key pair.`
- When you are prompted `> Enter a file in which to save the key`, press Enter
- You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press enter without typing anything when asked to enter a passphrase.

ℹ️ Don't worry if nothing prompt when you type, that is perfectly normal for security reasons.
You should be asked to `Enter a passphrase` - this is optional if you want additional security. To continue without a passphrase press _Enter_ without typing anything when asked to enter a passphrase.

- You should be asked to `Enter same passphrase again`, do it.
ℹ️ Don't worry if nothing is shown when you are typing, that is perfectly normal for security reasons.

**❗️ You must remember this passphrase.**

<details>
<summary markdown='span'> ❗️ /home/your_username/.ssh/id_ed25519 already exists.</summary>
If you receive this message, you may already have an SSH Key with the same name (if you are a Le Wagon Alumni or are using SSH Authentication with Github).
You should be asked to `Enter same passphrase again`, do it.

To create a separate SSH key to exclusively use for this bootcamp use the following:

```bash
# replace "[email protected]" with your GCP account email
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "[email protected]"
```
**❗️ You must remember this passphrase.**

Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
</details>
Your new SSH Key will be named `de-bootcamp`.
12 changes: 9 additions & 3 deletions _partials/virtual_machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,19 @@ _Note: The following section requires you already have a [Google Cloud Platform]

<img alt="gcloud-console-add-manual-ssh-key" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-manual-ssh-key.png" width=500>
- In your terminal display your public SSH key:
- Windows: navigate to where you created your SSH key and open `id_ed25519.pub`
- Windows:
```bash
# If you use Windows Terminal
more $HOME\.ssh\de-bootcamp.pub
# OR if you use Command Prompt:
# more %HOMEPATH%\.ssh\de-bootcamp.pub
```

- Mac/Linux users can use:
```bash
cat ~/.ssh/id_ed25519.pub
# OR cat ~/.ssh/de-bootcamp.pub if you created a unique key
cat ~/.ssh/de-bootcamp.pub
```

- Copy your public SSH key and paste it:

<img alt="gcloud-console-add-ssh-key-pub" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/gcloud-console-add-ssh-key-pub.png" width=500>
Expand Down
2 changes: 1 addition & 1 deletion _partials/vscode_remote_ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ That's the only extension you should install on your _local_ machine, we will in
<img alt="vscode-connect-to-host" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-connect-to-host.png" width=500>

- Click on `Add a new host`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/id_rsa` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/id_rsa [email protected]`
- Type `ssh -i <path/to/your/private/key> <username>@<ip address>`, for instance, my username is `somedude`, my private SSH key is located at `~/.ssh/de-bootcamp` on my local computer, my VM has a public IP of `34.77.50.76`: I'll type `ssh -i ~/.ssh/de-bootcamp [email protected]`

<img alt="vscode-ssh-connection-command" src="https://wagon-public-datasets.s3.amazonaws.com/data-engineering/setup/vscode-ssh-connection-command.png" width=500>

Expand Down
Loading