Merge pull request #201 from nerc-project/ssh_using_host_config_file

SSH using host config file
nerc-project · May 21, 2024 · 3ddbc9e · 3ddbc9e
2 parents f1905f5 + 92abbbf
commit 3ddbc9e
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 4 deletions.
diff --git a/docs/openstack/create-and-connect-to-the-VM/ssh-to-the-VM.md b/docs/openstack/create-and-connect-to-the-VM/ssh-to-the-VM.md
@@ -51,10 +51,46 @@ sure you want to connect. Type `yes`.
 
 ![SSH To VM Successful](images/ssh_to_vm.png)
 
-!!! tip "Note"
+!!! tip "Important Note"
     If you haven't added your key to ssh-agent, you may need to specify the
     private key file, like this: `ssh -i ~/.ssh/cloud.key [email protected]`
 
+    To add your private key to the `ssh-agent` you can follow the following steps:
+
+    1. `eval "$(ssh-agent -s)"`
+
+        Output: `Agent pid 59566`
+
+    2. `ssh-add ~/.ssh/cloud.key`
+
+        If your private key is password protected, you'll be prompted to enter the
+        passphrase.
+
+    3. Verify that the key has been added by running `ssh-add -l`.
+
+## SSH to the VM using SSH Config
+
+**Alternatively,** You can also configure the setting for the remote instances in
+your SSH configuration file (typically found in `~/.ssh/config`). The SSH configuration
+file might include entry for your newly launched VM like this:
+
+    Host ExampleHostLabel
+        HostName 199.94.60.66
+        User ubuntu
+        IdentityFile ~/.ssh/cloud.key
+
+Here, the `Host` value can be any label you want. The `HostName` value is the
+**Floating IP** you have associated to your instance that you want to access, the
+`User` value specifies the default account username based on your base OS image
+used for the VM and `IdentityFile` specify the path to your **Private Key** on
+your local machine. With this configuration defined, you can connect to the account
+by simply using the Host value set as "ExampleHostLabel". You do not have to type
+the username, hostname, and private key each time.
+
+So, you can SSH into your host VM by running:
+
+    ssh ExampleHostLabel
+
 ---
 
 ## Setting a password

diff --git a/docs/openstack/create-and-connect-to-the-VM/using-vpn/openvpn/index.md b/docs/openstack/create-and-connect-to-the-VM/using-vpn/openvpn/index.md
@@ -36,7 +36,7 @@ The Security Groups attached to the OpenVPN server includes "**default**",
 
 Finally, you'll want to configure the setting for the remote instances in your
 SSH configuration file (typically found in `~/.ssh/config`). The SSH
-configuration file might include entry for your newly create OpenVPN server
+configuration file might include entry for your newly created OpenVPN server
 like this:
 
 ```sh

diff --git a/docs/openstack/create-and-connect-to-the-VM/using-vpn/sshuttle/index.md b/docs/openstack/create-and-connect-to-the-VM/using-vpn/sshuttle/index.md
@@ -18,7 +18,7 @@ Also, attach a Floating IP to this instance so you can ssh into it from outside.
 
 Finally, you'll want to configure the setting for the remote instances in your
 SSH configuration file (typically found in `~/.ssh/config`). The SSH
-configuration file might include entry for your newly create sshuttle server
+configuration file might include entry for your newly created sshuttle server
 like this:
 
 ```sh

diff --git a/docs/openstack/create-and-connect-to-the-VM/using-vpn/wireguard/index.md b/docs/openstack/create-and-connect-to-the-VM/using-vpn/wireguard/index.md
@@ -29,7 +29,7 @@ The Security Groups attached to the WireGuard server includes "**default**",
 
 Finally, you'll want to configure the setting for the remote instances in your
 SSH configuration file (typically found in `~/.ssh/config`). The SSH
-configuration file might include entry for your newly create WireGuard server
+configuration file might include entry for your newly created WireGuard server
 like this:
 
 ```ssh