Skip to content

Commit

Permalink
Merge pull request #53 from aistairc/201906-reconstruct
Browse files Browse the repository at this point in the history
201906 reconstruct
  • Loading branch information
ogawa authored Jun 30, 2019
2 parents 12d8892 + 6b6e6db commit 1b20da7
Show file tree
Hide file tree
Showing 37 changed files with 344 additions and 316 deletions.
100 changes: 16 additions & 84 deletions en/docs/02.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,26 @@ For more detail, see the [ABCI Portal Guide](https://portal.abci.ai/docs/portal/

## 2.2. Connecting to Interactive Node {#connectiong-to-interactive-node}

To connect to the interactive node (*es*), the ABCI frontend, you first need to register your SSH public key on [ABCI User Portal](https://portal.abci.ai/user/). After that, you need to login to the access server (*as.abci.ai*) with SSH publickey authentication, so as to create an *SSH tunnel* between your computer and *es*.
To connect to the interactive node (*es*), the ABCI frontend, two-step SSH public key authentication is required.

### 2.2.1. Login using an SSH Client {#login-using-an-ssh-client}
1. Login to the access server (*as.abci.ai*) with SSH public key authentication, so as to create an *SSH tunnel* between your computer and *es*.
2. Login to the interative node (*es*) with SSH public key authentication via the SSH tunnel.

Your computer most likely has an SSH client installed by default. If your computer is a UNIX-like system such as Linux and macOS, or Windows 10 version 1803 (April 2018 Update) or later, it should have an SSH client. You can also check for an SSH client, just by typing ``ssh`` at the command line.
### Prerequisites

To connect to the interative node, you will need the following in advance:

* Registration of SSH public keys. Your first need to register your SSH public key on [ABCI User Portal](https://portal.abci.ai/user/). The instruction will be found at [Register Public Key](https://portal.abci.ai/docs/portal/en/02/#23-register-public-key).
* A SSH client. Your computer most likely has an SSH client installed by default. If your computer is a UNIX-like system such as Linux and macOS, or Windows 10 version 1803 (April 2018 Update) or later, it should have an SSH client. You can also check for an SSH client, just by typing ``ssh`` at the command line.

!!! note
If you would like to use PuTTY as an SSH client, Please read [PuTTY](tips/putty.md).

### Login using an SSH Client

In this section, we will describe two methods to login to the interactive node using a SSH client. The first one is creating an SSH tunnel on the access server first, and connecting the interative node via this tunnel next. The second one, much easier method, is connecting directly to the interactive node using ProxyJump implemented in OpenSSH 7.3 or later.

#### General method {#general-method}
#### General method

Login to the access server (*as.abci.ai*) with following command:

Expand Down Expand Up @@ -56,7 +67,7 @@ Enter passphrase for key '/path/identity_file': <- Enter passphrase
[username@es1 ~]$
```

#### ProxyJump {#proxyjump}
#### ProxyJump

If you have OpenSSH 7.3 or later, you can login with the following command:

Expand All @@ -83,85 +94,6 @@ Host abci
!!! warning
OpenSSH_for_Windows_7.7p1, bundled with Windows 10 version 1803 or later, does not allow you to use ProxyJump and ProxyCommand. They can be used in OpenSSH clients bundled with Windows Subsystem for Linux (WSL).

### 2.2.2. PuTTY {#putty}

This section describes how to use PuTTY for virtual terminal applications are available on Windows.
In order to login to the interactive node, the following procedure is necessary.

1. Set up an SSH tunnel configuration with PuTTY
2. Login to the access server to create an SSH tunnel
3. Login to the interactive node from another terminal via the SSH tunnel

#### 2.2.2.1. SSH tunnel with PuTTY {#ssh-tunnel-with-putty}

* Launch PuTTY, and set up an SSH tunnel configuration

click [Connection] - [SSH] - [Tunnels] and enter following information.

| item | value |
|:--|:--|
| sample image | <img src="/img/02_login_putty_02.png" width="480" title="putty:ssh tunnel setting" /> |
| local port | e.g., 11022 |
| remote host and port | *es.abci.local:22* or *es:22* (e.g., *es.abci.local:22*) |
| remote port | 22 |

* click [Add] to add the configuration

<div align="center">
<img src="/img/02_login_putty_03.png" width="480" title="putty:add ssh tunnel" />
</div>

#### 2.2.2.2. Login to access server with Putty {#login-to-access-server-with-putty}

* Specify a private key file<a name="putty:ssh-auth-as"></a>

Click [Connection] - [SSH] - [Auth], and specify a private key file.

| item | value |
|:--|:--|
| sample image | <img src="/img/02_login_putty_04.png" width="480" title="putty:auth info" /> |
| private key file for authentication | path of your private key file |

* Open a session to access server with PuTTY

Click [Session], enter following information

| item | value |
|:--|:--|
| sample image | <img src="/img/02_login_putty_05.png" width="480" title="putty:login info" > |
| hostname | *as.abci.ai* |

Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed.

<div align="center">
<img src="/img/02_login_putty_07.png" width="540" title="putty:login as success" >
</div>

!!! warning
Be aware! The SSH session will be disconnected if you press any key.

#### 2.2.2.3. Login to interactive node with Putty {#login-to-interactive-node-with-putty}

* Specify a private key file

Launch a new PuTTY screen, and enter your authentication information same as [access server](#putty:ssh-auth-as).

* Open session to interactive node with PuTTY

Click [Session], enter following information to login an interactive server.

| item | vlue |
|:--|:--|
| sample image | <img src="/img/02_login_putty_08.png" width="480" title="putty:login es" /> |
| host name | localhost |
| port | port number which use SSH tunnel (e.g., 11022) |

Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed.

<div align="center">
<img src="/img/02_login_putty_09.png" width="540" title="putty:login es success" >
</div>

## 2.3. File Transfer to Interactive Node {#file-transfer-to-interactive-node}

When you transfer files between your computer and the ABCI system, create an SSH tunnel and run the `scp` (`sftp`) command.
Expand Down
79 changes: 79 additions & 0 deletions en/docs/tips/putty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# PuTTY

This section describes how to use PuTTY, a virtual terminal application available on Windows, for connecting to ABCI Interactive Node. To use OpenSSH or other command-line based clients, you can find an instruction at [Connecting to Interative Node](../02.md#connecting-to-interactive-node).

In order to login to the interactive node, the following procedure is necessary.

1. Set up an SSH tunnel configuration with PuTTY
2. Login to the access server to create an SSH tunnel
3. Login to the interactive node from another terminal via the SSH tunnel

## SSH tunnel with PuTTY

* Launch PuTTY, and set up an SSH tunnel configuration

click [Connection] - [SSH] - [Tunnels] and enter following information.

| item | value |
|:--|:--|
| sample image | <img src="login_putty_02.png" width="480" title="putty:ssh tunnel setting" /> |
| local port | e.g., 11022 |
| remote host and port | *es.abci.local:22* or *es:22* (e.g., *es.abci.local:22*) |
| remote port | 22 |

* click [Add] to add the configuration

<div align="center">
<img src="login_putty_03.png" width="480" title="putty:add ssh tunnel" />
</div>

## Login to access server with PuTTY

* Specify a private key file<a name="putty:ssh-auth-as"></a>

Click [Connection] - [SSH] - [Auth], and specify a private key file.

| item | value |
|:--|:--|
| sample image | <img src="login_putty_04.png" width="480" title="putty:auth info" /> |
| private key file for authentication | path of your private key file |

* Open a session to access server with PuTTY

Click [Session], enter following information

| item | value |
|:--|:--|
| sample image | <img src="login_putty_05.png" width="480" title="putty:login info" > |
| hostname | *as.abci.ai* |

Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed.

<div align="center">
<img src="login_putty_07.png" width="540" title="putty:login as success" >
</div>

!!! warning
Be aware! The SSH session will be disconnected if you press any key.

## Login to interactive node with PuTTY

* Specify a private key file

Launch a new PuTTY screen, and enter your authentication information same as [access server](#putty:ssh-auth-as).

* Open session to interactive node with PuTTY

Click [Session], enter following information to login an interactive server.

| item | vlue |
|:--|:--|
| sample image | <img src="login_putty_08.png" width="480" title="putty:login es" /> |
| host name | localhost |
| port | port number which use SSH tunnel (e.g., 11022) |

Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed.

<div align="center">
<img src="login_putty_09.png" width="540" title="putty:login es success" >
</div>
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 1 addition & 0 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ nav:
- 'Remote Desktop': 'tips/remote-desktop.md'
- 'AWS CLI': 'tips/awscli.md'
- 'GCC 7.3.0': 'tips/gcc-7.3.0.md'
- 'PuTTY': 'tips/putty.md'
- 'NVIDIA GPU Cloud (NGC)': 'ngc.md'
- 'Known Issues': 'known-issues.md'
- 'System Updates': 'system-updates.md'
Expand Down
Loading

0 comments on commit 1b20da7

Please sign in to comment.