diff --git a/en/docs/02.md b/en/docs/02.md index 92446d601..f6baee179 100644 --- a/en/docs/02.md +++ b/en/docs/02.md @@ -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: @@ -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: @@ -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 | | - | 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 - -
- -
- -#### 2.2.2.2. Login to access server with Putty {#login-to-access-server-with-putty} - -* Specify a private key file - - Click [Connection] - [SSH] - [Auth], and specify a private key file. - - | item | value | - |:--|:--| - | sample image | | - | 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 | | - | hostname | *as.abci.ai* | - - Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed. - -
- -
- -!!! 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 | | - | 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. - -
- -
- ## 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. diff --git a/en/docs/tips/putty.md b/en/docs/tips/putty.md new file mode 100644 index 000000000..258a085e3 --- /dev/null +++ b/en/docs/tips/putty.md @@ -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 | | + | 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 + +
+ +
+ +## Login to access server with PuTTY + +* Specify a private key file + + Click [Connection] - [SSH] - [Auth], and specify a private key file. + + | item | value | + |:--|:--| + | sample image | | + | 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 | | + | hostname | *as.abci.ai* | + + Click [Open] and enter your ABCI account and passphrase. Successfully logged in, the following screen displayed. + +
+ +
+ +!!! 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 | | + | 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. + +
+ +
diff --git a/en/docs/img/02_login_putty_00.png b/en/docs/tips/putty/login_putty_00.png similarity index 100% rename from en/docs/img/02_login_putty_00.png rename to en/docs/tips/putty/login_putty_00.png diff --git a/en/docs/img/02_login_putty_01.png b/en/docs/tips/putty/login_putty_01.png similarity index 100% rename from en/docs/img/02_login_putty_01.png rename to en/docs/tips/putty/login_putty_01.png diff --git a/en/docs/img/02_login_putty_02.png b/en/docs/tips/putty/login_putty_02.png similarity index 100% rename from en/docs/img/02_login_putty_02.png rename to en/docs/tips/putty/login_putty_02.png diff --git a/en/docs/img/02_login_putty_03.png b/en/docs/tips/putty/login_putty_03.png similarity index 100% rename from en/docs/img/02_login_putty_03.png rename to en/docs/tips/putty/login_putty_03.png diff --git a/en/docs/img/02_login_putty_04.png b/en/docs/tips/putty/login_putty_04.png similarity index 100% rename from en/docs/img/02_login_putty_04.png rename to en/docs/tips/putty/login_putty_04.png diff --git a/en/docs/img/02_login_putty_05.png b/en/docs/tips/putty/login_putty_05.png similarity index 100% rename from en/docs/img/02_login_putty_05.png rename to en/docs/tips/putty/login_putty_05.png diff --git a/en/docs/img/02_login_putty_07.png b/en/docs/tips/putty/login_putty_07.png similarity index 100% rename from en/docs/img/02_login_putty_07.png rename to en/docs/tips/putty/login_putty_07.png diff --git a/en/docs/img/02_login_putty_08.png b/en/docs/tips/putty/login_putty_08.png similarity index 100% rename from en/docs/img/02_login_putty_08.png rename to en/docs/tips/putty/login_putty_08.png diff --git a/en/docs/img/02_login_putty_09.png b/en/docs/tips/putty/login_putty_09.png similarity index 100% rename from en/docs/img/02_login_putty_09.png rename to en/docs/tips/putty/login_putty_09.png diff --git a/en/mkdocs.yml b/en/mkdocs.yml index 6df96480c..fb7b7a698 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -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' diff --git a/ja/docs/02.md b/ja/docs/02.md index a178dec87..1155013f5 100644 --- a/ja/docs/02.md +++ b/ja/docs/02.md @@ -13,13 +13,24 @@ ABCIシステムを利用するには、「利用責任者」が[ABCI利用ポ ## 2.2. インタラクティブノードへの接続 {#connecting-to-interactive-node} -ABCIシステムのフロントエンドであるインタラクティブノード(代表ホスト名: *es*)に接続するには、事前に[ABCI利用ポータル](https://portal.abci.ai/user/)にてSSH公開鍵を登録する必要があります。その上で、SSH公開鍵認証を用いてアクセスサーバ(ホスト名: *as.abci.ai*)にログインして、ローカルPCとインタラクティブノードの間にSSHポートフォワーディングによるトンネリング（以下「SSHトンネル」という）を作成する必要があります。 +ABCIシステムのフロントエンドであるインタラクティブノード(ホスト名: *es*)に接続するには、二段階のSSH公開鍵認証による接続を行います。 + +1. SSH公開鍵認証を用いてアクセスサーバ(ホスト名: *as.abci.ai*)にログインして、ローカルPCとインタラクティブノードの間にSSHポートフォワーディングによるトンネリング（以下「SSHトンネル」という）を作成 +2. SSHトンネルを介して、SSH公開鍵認証を用いてインタラクティブノード(*es*)にログイン なお本章では、ABCIのサーバ名は *イタリック* で表記します。 -### 2.2.1. SSHクライアントによるログイン {#login-using-an-ssh-client} +### 前提 {#prerequisites} + +インタラクティブノードに接続するには、以下が必要になります。 + +* SSH公開鍵の登録。[ABCI利用ポータル](https://portal.abci.ai/user/)にてSSH公開鍵の登録を事前に行ってください。登録方法は、[SSH公開鍵の登録](https://portal.abci.ai/docs/portal/ja/02/#23)を参照。 +* SSHクライアント。Linux、macOSを含むUNIX系OS、Windows 10 version 1803 (April 2018 Update)以降など、ほとんどのPCには、デフォルトでSSHクライアントがインストールされています。インストールされているかどうかを確認するには、コマンドラインから``ssh``コマンドを実行してください。 -Linux、macOSを含むUNIX系OS、Windows 10 version 1803 (April 2018 Update)以降など、ほとんどのPCには、デフォルトでSSHクライアントがインストールされています。インストールされているかどうかを確認するには、コマンドラインから``ssh``コマンドを実行するだけで済みます。 +!!! note + SSHクライアントとして、Tera TermやPuTTYを利用する場合は、[Tera Termの利用](tips/tera-term.md)、[PuTTYの利用](tips/putty.md)を参照。 + +### SSHクライアントによるログイン {#login-using-an-ssh-client} 以下では、SSHクライアントを用いて、(1) アクセスサーバでSSHトンネルの作成後にインタラクティブノードにログインする方法と、(2) OpenSSH 7.3以降で実装されたProxyJumpを使ったより簡便なログイン方法、を説明します。 @@ -85,235 +96,6 @@ Host abci !!! warning Windows 10 バージョン1803以降で標準でバンドルされているOpenSSH_for_Windows_7.7p1では、ProxyJumpおよびProxyCommandが使えません。Windows Subsystem for Linux (WSL)にバンドルされているOpenSSHでは使えます。 -### 2.2.2. Tera Term {#tera-term} - -インタラクティブノードへのログインは、以下手順で実施します。 - -1. Tera Termを起動し、SSHトンネル情報を設定 -2. アクセスサーバ(*as.abci.ai*)にログインして、SSHトンネルを作成 -3. 別のTera Term画面を起動して、SSHトンネルを用いてインタラクティブノードにログイン - -!!! note - 事前に[ABCI利用ポータル](https://portal.abci.ai/user/)にて[SSH公開鍵の登録](https://portal.abci.ai/docs/portal/ja/02/#23)が必要です。 - -#### 2.2.2.1. SSHトンネル情報の設定 {#ssh-tunnel-with-teraterm} - -* Tera Term の起動 - - Tera Term起動直後に表示される新しい接続画面は[キャンセル]ボタンで閉じ、未接続のTera Termを画面を残します。 - -
-
-↓
- -
- -* SSHポート転送画面の表示 - - Tera Termの[設定]メニューを開き[SSH転送]を選択し、SSHポート転送画面を表示します。 - -
- -
- -* ポート転送の追加 - - [追加]ボタンをクリックし、SSHポート転送の設定画面を表示してください。 - -
- -
- -* SSHポート転送の設定 - - SSHポート転送の設定画面で以下の表の設定値を入力します。ローカルのポートはお使いのシステムで許容されているポート番号の中から任意の値を設定可能ですが、他設定は固定値です。設定が完了したら、[OK]ボタンをクリックして前の画面に戻ります。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ローカルのポート | システムで許されている任意のポート番号 (例: 10022) | - | リモート側ホスト | *es.abci.local* または *es* （固定値）| - | ポート | 22 （固定値）| - -* 設定が追加されていることを確認し、[OK]ボタンをクリックしてTera Term の画面に戻ります。 - -
- -
- -!!! warning - Tera Termの画面は閉じないでください。この画面を使って、次節でアクセスサーバへの接続を行います。 - -#### 2.2.2.2. アクセスサーバへの接続 {#login-to-access-server-with-teraterm} - -ここでは、アクセスサーバの接続手順を説明します。 - -* 接続情報の入力画面の表示 - - 前章で設定したTera Termの[ファイル]メニューを開き、[新しい接続]画面を表示します。 - -
- -
- -* アクセスサーバへの新規接続 - - 接続先にアクセスサーバ（*as.abci.ai*）を指定し、SSHで接続します。設定は以下のとおりです。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ホスト | *as.abci.ai* | - | TCPポート | 22 | - | サービス | ssh | - - 設定が完了したら、[OK]ボタンをクリックしてSSHの認証に移ります。 - -* 認証（アクセスサーバ） - - - SSHの認証情報を入力します。設定は以下のとおりです。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ユーザ名 | ABCIアカウント | - | パスフレーズ | 秘密鍵のパスフレーズ | - | 認証方法 | RSA/DSA/ECDSA鍵をつかうにチェック | - | 秘密鍵 | 登録した公開鍵の秘密鍵ファイルパス | - - 設定が完了したら、[OK]ボタンをクリックしてアクセスサーバにログインします。ログインに成功すると以下の画面が表示されます。ABCIにログイン中は、このログインセッションを維持する必要があります。 - -
- -
- -!!! warning - 画面上で何らかのキーを入力するとSSH接続が切断されてしますので注意してください。 - -#### 2.2.2.3. インタラクティブノードへの接続 {#login-to-interactive-node-with-teraterm} - -ここでは、インタラクティブノードへの接続手順を説明します。 - -* Tera Termの起動と接続設定 - - 新規にTera Termを起動し、インタラクティブノードに接続します。設定は以下のとおりです。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ホスト | localhost(固定） | - | TCPポート | [SSHトンネル情報の設定](#ssh-tunnel-with-teraterm)で設定したポート番号 (画面例: 10022) | - | サービス | ssh （固定）| - - 設定が完了したら、[OK]ボタンをクリックし、SSHの認証に移ります。 - -* 認証（インタラクティブノード） - - インタラクティブノードの認証は、アクセスサーバと同じです。[アクセスサーバの認証方法](#teraterm:ssh-auth-as)を参照し、SSHの認証情報を入力してください。 - - 設定が完了したら、[OK]ボタンをクリックしてインタラクティブノードにログインしてください。ログインに成功すると以下の画面が表示されます。 - -
- -
- -### 2.2.3. PuTTY {#putty} - -インタラクティブノードへのログインは、以下手順で実施します。 - -1. PuTTYを起動し、SSHトンネル情報を設定 -2. アクセスサーバ(*as.abci.ai*)にログインして、SSHトンネルを作成 -3. 別のPuTTY画面を起動して、SSHトンネルを用いてインタラクティブノードにログイン - -!!! note - 事前に[ABCI利用ポータル](https://portal.abci.ai/user/)にて[SSH公開鍵の登録](https://portal.abci.ai/docs/portal/ja/02/#23)が必要です。 - -#### 2.2.3.1. SSHトンネル情報の設定 {#ssh-tunnel-with-putty} - -* PuTTY の起動 - - PuTTYを起動すると以下のような画面が表示されます。 - -
- -
- -* SSHポート転送の設定 - - 左のCategoryから、 Connection -> SSH -> Tunnels とメニューを開き、Tunnlesをクリックします。表示されたSSHポート転送の設定項目に、以下表の設定値を入力します。ポート番号はお使いのシステムで許容されているポート番号の中から任意の値を設定可能ですが、他の設定は固定値です。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ローカルのポート | システムで許されている任意のポート番号 (画面例: 11022) | - | リモート側ホスト | *es.abci.local:22* または *es:22* (画面例: *es.abci.local:22*) | - | ポート | 22 (固定値) | - -* [Add]ボタンをクリックして設定を追加します。 - -
- -
- -#### 2.2.3.2. アクセスサーバへの接続 {#login-to-access-server-with-putty} - -ここでは、アクセスサーバの接続手順を説明します。 - -* 認証設定（アクセスサーバ） - - 左のCategoryから、 Connection -> SSH -> Authを選択します。設定は以下のとおりです。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | 秘密鍵ファイル | 認証に使用する秘密鍵ファイルのパス | - -* アクセスサーバへのログイン - 左のCategoryからSessionを選択し、アクセスサーバへのログイン情報を入力します。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ホスト名 | *as.abci.ai* | - - 入力が完了したら[Open]ボタンをクリックします。 - - ABCIアカウントおよびパスフレーズを入力し、アクセスサーバにログインします。ログインに成功すると以下の画面が表示されます。ABCIにログイン中は、このログインセッションを維持する必要があります。 - -
- -
- -!!! warning - 画面上で何らかのキーを入力するとSSH接続が切断されてしますので注意してください。 - -#### 2.2.3.3. インタラクティブノードへの接続 {#login-to-interactive-node-with-putty} - -ここでは、インタラクティブノードへの接続手順を説明します。 - -* 認証設定（インタラクティブノード） - - 新規にPuTTYを起動し、SSHの認証情報を設定します。インタラクティブノードの認証は、アクセスサーバと同じです。[アクセスサーバの認証方法](#putty:ssh-auth-as)を参照し、SSHの認証情報を入力してください。 - -* インタラクティブノードへのログイン - - 左のCategoryからSessionを選択し、インタラクティブノードへのログイン情報を入力します。 - - | 項目 | 画面と設定値 | - |:--|:--| - | 設定画面 | | - | ホスト名 | localhost | - | TCPポート | [SSHトンネル情報の設定](#ssh-tunnel-with-putty)で設定したポート番号 (画面例: 11022) | - - 入力が完了したら[Open]ボタンをクリックします。 - - ログインに成功すると、以下のような画面が表示されます。 - -
- -
- ## 2.3. インタラクティブノードへのファイル転送 {#file-transfer-to-interactive-node} ローカルPCとABCIシステム間でファイル転送をするには、`scp`(`sftp`)コマンドを利用します。この場合もSSHトンネルを介して行う必要があります。 diff --git a/ja/docs/tips/putty.md b/ja/docs/tips/putty.md new file mode 100644 index 000000000..569d54b40 --- /dev/null +++ b/ja/docs/tips/putty.md @@ -0,0 +1,98 @@ +# PuTTYの利用 + +ここでは、Windowsで利用可能なSSHクライアントである、PuTTYを用いたインタラクティブノードへのログイン手順を示します。OpenSSHクライアントなどコマンドラインベースのSSHクライアントを利用したログイン手順は、[インタラクティブノードへの接続](../02.md#connecting-to-interactive-node)を参照してください。 + +インタラクティブノードへのログインは、以下の手順で実施します。 + +1. PuTTYを起動し、SSHトンネル情報を設定 +2. アクセスサーバ(*as.abci.ai*)にログインして、SSHトンネルを作成 +3. 別のPuTTY画面を起動して、SSHトンネルを用いてインタラクティブノードにログイン + +!!! note + 事前に[ABCI利用ポータル](https://portal.abci.ai/user/)にて[SSH公開鍵の登録](https://portal.abci.ai/docs/portal/ja/02/#23)が必要です。 + +## SSHトンネル情報の設定 {#ssh-tunnel-with-putty} + +* PuTTY の起動 + + PuTTYを起動すると以下のような画面が表示されます。 + +
+ +
+ +* SSHポート転送の設定 + + 左のCategoryから、 Connection -> SSH -> Tunnels とメニューを開き、Tunnlesをクリックします。表示されたSSHポート転送の設定項目に、以下表の設定値を入力します。ポート番号はお使いのシステムで許容されているポート番号の中から任意の値を設定可能ですが、他の設定は固定値です。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ローカルのポート | システムで許されている任意のポート番号 (画面例: 11022) | + | リモート側ホスト | *es.abci.local:22* または *es:22* (画面例: *es.abci.local:22*) | + | ポート | 22 (固定値) | + +* [Add]ボタンをクリックして設定を追加します。 + +
+ +
+ +## アクセスサーバへの接続 {#login-to-access-server-with-putty} + +ここでは、アクセスサーバの接続手順を説明します。 + +* 認証設定（アクセスサーバ） + + 左のCategoryから、 Connection -> SSH -> Authを選択します。設定は以下のとおりです。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | 秘密鍵ファイル | 認証に使用する秘密鍵ファイルのパス | + +* アクセスサーバへのログイン + 左のCategoryからSessionを選択し、アクセスサーバへのログイン情報を入力します。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ホスト名 | *as.abci.ai* | + + 入力が完了したら[Open]ボタンをクリックします。 + + ABCIアカウントおよびパスフレーズを入力し、アクセスサーバにログインします。ログインに成功すると以下の画面が表示されます。ABCIにログイン中は、このログインセッションを維持する必要があります。 + +
+ +
+ +!!! warning + 画面上で何らかのキーを入力するとSSH接続が切断されてしますので注意してください。 + +## インタラクティブノードへの接続 {#login-to-interactive-node-with-putty} + +ここでは、インタラクティブノードへの接続手順を説明します。 + +* 認証設定（インタラクティブノード） + + 新規にPuTTYを起動し、SSHの認証情報を設定します。インタラクティブノードの認証は、アクセスサーバと同じです。[アクセスサーバの認証方法](#putty:ssh-auth-as)を参照し、SSHの認証情報を入力してください。 + +* インタラクティブノードへのログイン + + 左のCategoryからSessionを選択し、インタラクティブノードへのログイン情報を入力します。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ホスト名 | localhost | + | TCPポート | [SSHトンネル情報の設定](#ssh-tunnel-with-putty)で設定したポート番号 (画面例: 11022) | + + 入力が完了したら[Open]ボタンをクリックします。 + + ログインに成功すると、以下のような画面が表示されます。 + +
+ +
+ diff --git a/ja/docs/img/02_login_putty_00.png b/ja/docs/tips/putty/login_putty_00.png similarity index 100% rename from ja/docs/img/02_login_putty_00.png rename to ja/docs/tips/putty/login_putty_00.png diff --git a/ja/docs/img/02_login_putty_01.png b/ja/docs/tips/putty/login_putty_01.png similarity index 100% rename from ja/docs/img/02_login_putty_01.png rename to ja/docs/tips/putty/login_putty_01.png diff --git a/ja/docs/img/02_login_putty_02.png b/ja/docs/tips/putty/login_putty_02.png similarity index 100% rename from ja/docs/img/02_login_putty_02.png rename to ja/docs/tips/putty/login_putty_02.png diff --git a/ja/docs/img/02_login_putty_03.png b/ja/docs/tips/putty/login_putty_03.png similarity index 100% rename from ja/docs/img/02_login_putty_03.png rename to ja/docs/tips/putty/login_putty_03.png diff --git a/ja/docs/img/02_login_putty_04.png b/ja/docs/tips/putty/login_putty_04.png similarity index 100% rename from ja/docs/img/02_login_putty_04.png rename to ja/docs/tips/putty/login_putty_04.png diff --git a/ja/docs/img/02_login_putty_05.png b/ja/docs/tips/putty/login_putty_05.png similarity index 100% rename from ja/docs/img/02_login_putty_05.png rename to ja/docs/tips/putty/login_putty_05.png diff --git a/ja/docs/img/02_login_putty_07.png b/ja/docs/tips/putty/login_putty_07.png similarity index 100% rename from ja/docs/img/02_login_putty_07.png rename to ja/docs/tips/putty/login_putty_07.png diff --git a/ja/docs/img/02_login_putty_08.png b/ja/docs/tips/putty/login_putty_08.png similarity index 100% rename from ja/docs/img/02_login_putty_08.png rename to ja/docs/tips/putty/login_putty_08.png diff --git a/ja/docs/img/02_login_putty_09.png b/ja/docs/tips/putty/login_putty_09.png similarity index 100% rename from ja/docs/img/02_login_putty_09.png rename to ja/docs/tips/putty/login_putty_09.png diff --git a/ja/docs/tips/tera-term.md b/ja/docs/tips/tera-term.md new file mode 100644 index 000000000..156d57935 --- /dev/null +++ b/ja/docs/tips/tera-term.md @@ -0,0 +1,134 @@ +# Tera Termの利用 + +ここでは、Windowsな利用可能なSSHクライアントである、Tera Termを用いたインタラクティブノードへのログイン手順を示します。OpenSSHクライアントなどコマンドラインベースのSSHクライアントを利用したログイン手順は、[インタラクティブノードへの接続](../02.md#connecting-to-interactive-node)を参照してください。 + +インタラクティブノードへのログインは、以下手順で実施します。 + +1. Tera Termを起動し、SSHトンネル情報を設定 +2. アクセスサーバ(*as.abci.ai*)にログインして、SSHトンネルを作成 +3. 別のTera Term画面を起動して、SSHトンネルを用いてインタラクティブノードにログイン + +!!! note + 事前に[ABCI利用ポータル](https://portal.abci.ai/user/)にて[SSH公開鍵の登録](https://portal.abci.ai/docs/portal/ja/02/#23)が必要です。 + +## SSHトンネル情報の設定 {#ssh-tunnel} + +* Tera Term の起動 + + Tera Term起動直後に表示される新しい接続画面は[キャンセル]ボタンで閉じ、未接続のTera Termを画面を残します。 + +
+
+↓
+ +
+ +* SSHポート転送画面の表示 + + Tera Termの[設定]メニューを開き[SSH転送]を選択し、SSHポート転送画面を表示します。 + +
+ +
+ +* ポート転送の追加 + + [追加]ボタンをクリックし、SSHポート転送の設定画面を表示してください。 + +
+ +
+ +* SSHポート転送の設定 + + SSHポート転送の設定画面で以下の表の設定値を入力します。ローカルのポートはお使いのシステムで許容されているポート番号の中から任意の値を設定可能ですが、他設定は固定値です。設定が完了したら、[OK]ボタンをクリックして前の画面に戻ります。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ローカルのポート | システムで許されている任意のポート番号 (例: 10022) | + | リモート側ホスト | *es.abci.local* または *es* （固定値）| + | ポート | 22 （固定値）| + +* 設定が追加されていることを確認し、[OK]ボタンをクリックしてTera Term の画面に戻ります。 + +
+ +
+ +!!! warning + Tera Termの画面は閉じないでください。この画面を使って、次節でアクセスサーバへの接続を行います。 + +## アクセスサーバへの接続 {#login-to-access-server} + +ここでは、アクセスサーバの接続手順を説明します。 + +* 接続情報の入力画面の表示 + + 前章で設定したTera Termの[ファイル]メニューを開き、[新しい接続]画面を表示します。 + +
+ +
+ +* アクセスサーバへの新規接続 + + 接続先にアクセスサーバ（*as.abci.ai*）を指定し、SSHで接続します。設定は以下のとおりです。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ホスト | *as.abci.ai* | + | TCPポート | 22 | + | サービス | ssh | + + 設定が完了したら、[OK]ボタンをクリックしてSSHの認証に移ります。 + +* 認証（アクセスサーバ） + + + SSHの認証情報を入力します。設定は以下のとおりです。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ユーザ名 | ABCIアカウント | + | パスフレーズ | 秘密鍵のパスフレーズ | + | 認証方法 | RSA/DSA/ECDSA鍵をつかうにチェック | + | 秘密鍵 | 登録した公開鍵の秘密鍵ファイルパス | + + 設定が完了したら、[OK]ボタンをクリックしてアクセスサーバにログインします。ログインに成功すると以下の画面が表示されます。ABCIにログイン中は、このログインセッションを維持する必要があります。 + +
+ +
+ +!!! warning + 画面上で何らかのキーを入力するとSSH接続が切断されてしますので注意してください。 + +## インタラクティブノードへの接続 {#login-to-interactive-node} + +ここでは、インタラクティブノードへの接続手順を説明します。 + +* Tera Termの起動と接続設定 + + 新規にTera Termを起動し、インタラクティブノードに接続します。設定は以下のとおりです。 + + | 項目 | 画面と設定値 | + |:--|:--| + | 設定画面 | | + | ホスト | localhost(固定） | + | TCPポート | [SSHトンネル情報の設定](#ssh-tunnel-with-teraterm)で設定したポート番号 (画面例: 10022) | + | サービス | ssh （固定）| + + 設定が完了したら、[OK]ボタンをクリックし、SSHの認証に移ります。 + +* 認証（インタラクティブノード） + + インタラクティブノードの認証は、アクセスサーバと同じです。[アクセスサーバの認証方法](#teraterm:ssh-auth-as)を参照し、SSHの認証情報を入力してください。 + + 設定が完了したら、[OK]ボタンをクリックしてインタラクティブノードにログインしてください。ログインに成功すると以下の画面が表示されます。 + +
+ +
diff --git a/ja/docs/img/02_login_teraterm_00_ja.png b/ja/docs/tips/tera-term/login_teraterm_00_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_00_ja.png rename to ja/docs/tips/tera-term/login_teraterm_00_ja.png diff --git a/ja/docs/img/02_login_teraterm_01_ja.png b/ja/docs/tips/tera-term/login_teraterm_01_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_01_ja.png rename to ja/docs/tips/tera-term/login_teraterm_01_ja.png diff --git a/ja/docs/img/02_login_teraterm_02_ja.png b/ja/docs/tips/tera-term/login_teraterm_02_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_02_ja.png rename to ja/docs/tips/tera-term/login_teraterm_02_ja.png diff --git a/ja/docs/img/02_login_teraterm_03_ja.png b/ja/docs/tips/tera-term/login_teraterm_03_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_03_ja.png rename to ja/docs/tips/tera-term/login_teraterm_03_ja.png diff --git a/ja/docs/img/02_login_teraterm_04_ja.png b/ja/docs/tips/tera-term/login_teraterm_04_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_04_ja.png rename to ja/docs/tips/tera-term/login_teraterm_04_ja.png diff --git a/ja/docs/img/02_login_teraterm_05_ja.png b/ja/docs/tips/tera-term/login_teraterm_05_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_05_ja.png rename to ja/docs/tips/tera-term/login_teraterm_05_ja.png diff --git a/ja/docs/img/02_login_teraterm_06_ja.png b/ja/docs/tips/tera-term/login_teraterm_06_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_06_ja.png rename to ja/docs/tips/tera-term/login_teraterm_06_ja.png diff --git a/ja/docs/img/02_login_teraterm_07_ja.png b/ja/docs/tips/tera-term/login_teraterm_07_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_07_ja.png rename to ja/docs/tips/tera-term/login_teraterm_07_ja.png diff --git a/ja/docs/img/02_login_teraterm_08_ja.png b/ja/docs/tips/tera-term/login_teraterm_08_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_08_ja.png rename to ja/docs/tips/tera-term/login_teraterm_08_ja.png diff --git a/ja/docs/img/02_login_teraterm_09_ja.png b/ja/docs/tips/tera-term/login_teraterm_09_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_09_ja.png rename to ja/docs/tips/tera-term/login_teraterm_09_ja.png diff --git a/ja/docs/img/02_login_teraterm_10_ja.png b/ja/docs/tips/tera-term/login_teraterm_10_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_10_ja.png rename to ja/docs/tips/tera-term/login_teraterm_10_ja.png diff --git a/ja/docs/img/02_login_teraterm_99_ja.png b/ja/docs/tips/tera-term/login_teraterm_99_ja.png similarity index 100% rename from ja/docs/img/02_login_teraterm_99_ja.png rename to ja/docs/tips/tera-term/login_teraterm_99_ja.png diff --git a/ja/mkdocs.yml b/ja/mkdocs.yml index 0c616da9d..17eb4a5fd 100644 --- a/ja/mkdocs.yml +++ b/ja/mkdocs.yml @@ -26,6 +26,8 @@ nav: - 'リモートデスクトップの利用': 'tips/remote-desktop.md' - 'AWS CLIの利用': 'tips/awscli.md' - 'GCC 7.3.0の利用': 'tips/gcc-7.3.0.md' + - 'Tera Termの利用': 'tips/tera-term.md' + - 'PuTTYの利用': 'tips/putty.md' - 'NVIDIA GPU Cloud (NGC)': 'ngc.md' - '既知の問題': 'known-issues.md' - 'システム更新履歴': 'system-updates.md'