SSH を使用したデバッグ

多くの場合、問題を解決するには、ジョブへの SSH 接続を行い、ログ ファイル、実行中のプロセス、ディレクトリ パスなどを調べるのが一番の方法です。 CircleCI では、すべてのジョブに SSH でアクセスできます。 SSH を使用した CI/CD パイプラインのデバッグについては、CircleCI の こちらのブログ記事をご参照ください。

SSH を使用してログインする場合、ユーザーは対話型のログインシェルを実行しています。 最初にコマンドが失敗したディレクトリまたは 1 階層上のディレクトリ (例: ~/project/ または ~/) で、そのコマンドを実行してみてください。 どちらの場合も、クリーンな実行は開始されません。 pwd または ls を実行すると、正しいディレクトリにいることを確認できます。

デフォルトの CirclecI パイプラインは、非対話型のシェルでステップを実行することにご注意ください。 対話型ログインを使用したステップの実行は成功する可能性がありますが、非対話型モードでは失敗する可能性があります。

1. SSH キーを GitHub アカウントまたは Bitbucket アカウントに追加していることを確認します。

2. SSH 接続を有効にしてジョブを起動するには、[Rerun Workflow (ワークフローを再実行する)] ドロップダウン メニューから [Rerun job with SSH (SSH でジョブを再実行する)] オプションを選択します。

   注: Rerun job with SSH 機能はデバッグのための機能です。 これらのジョブは元のジョブと同じパイプライン内に作成されます。

3. 接続の詳細情報を確認するには、ジョブ出力の [Enable SSH (SSH を有効にする)] セクションを展開します。

   詳細情報は、ジョブ出力の末尾にある [Wait for SSH (SSH を待機する)] セクションにも再度表示されます。

4. GitHub または Bitbucket で使用している SSH キーと同じキーを使用して、実行中のジョブに SSH 接続し、必要なトラブルシューティングを行います。

Windows Executor を使用している場合は、SSH 接続を行うシェルを渡す必要があります。 For example, To run powershell in your build you would run: ssh -p <remote_ip> -- powershell.exe. 詳細については、 Windows での Hello World を参照してください。

ビルドされた仮想マシン (VM) は、ビルドの実行終了から 10 分間だけ SSH 接続で利用可能な状態になり、その後自動的にシャットダウンされます (キャンセルも可能です)。 ビルドに SSH 接続すると、Free プランのお客様は 1 時間、それ以外のプランのお客様は 2 時間接続が維持されます。

ジョブに並列ステップが含まれる場合、CircleCI ではそれらを実行するために複数の VM をローンチします。 その場合、ビルド出力には、[Enable SSH (SSH を有効にする)] セクションと [Wait for SSH (SSH を待機する)] セクションが複数表示されます。

ジョブに SSH 接続しようとして権限エラーが発生した場合は、以下を試してみてください。

想定どおりにキーがセットアップされているかどうかは、コマンド 1 つでテストできます。 GitHub の場合は、以下を実行します。

ssh git@github.com

Bitbucket の場合は、以下を実行します。

ssh -Tv git@bitbucket.org

すると出力に以下の 2 つが表示されます。

$ Hi :username! You've successfully authenticated...

$ logged in as :username.

上記のような出力が_表示されない_場合は、以下の解決策をお試しください。

• GitHub を使用して SSH キーのトラブルシューティングを行う
• Bitbucket を使用して SSH キーのトラブルシューティングを行う

アカウントを複数持っている場合は、正しいアカウントで認証を行っているか、再度確認してください。 CircleCI ビルドに SSH 接続するには、ビルドするプロジェクトにアクセスできるユーザー名を使用しなければなりません。

誤ったユーザーで認証を行っている場合は、ssh -i で別の SSH キーを提供すれば、この問題を解決できるはずです。 提供しているキーを調べる方法については、次のセクションを参照してください。

正しいユーザーで認証を行っていることが確認できた後も、CircleCI で “Permission denied (権限がありません)” メッセージが表示される場合は、CircleCI に誤った認証情報を提供している可能性があります。

認証を行う GitHub にどのキーを提供しているかを調べるには、以下を実行します。

$ ssh -v git@github.com

または

$ ssh -v git@bitbucket.com

出力から、以下のような箇所を探します。

debug1: Offering public key: /Users/me/.ssh/id_ed25519_github
<...>
debug1: Authentication succeeded (publickey).

この一連の出力は、キー /Users/me/.ssh/id_ed25519_github が、GitHub で受け付けられたキーであることを示しています。

次に、CircleCI ビルドに対し、-vフラグを追加して SSH コマンドを実行します。 出力から、以下のような行を探します。

debug1: Offering public key: ...

GitHub が受け付けたキー (この例では /Users/me/.ssh/id_ed25519_github) が CircleCI にも提供されていることを確認します。

提供されていない場合は、SSH の -i コマンドライン引数を使用してキーを指定します。 例えば下記のようになります。

$ ssh -i /Users/me/.ssh/id_ed25519_github -p 64784 54.224.97.243

-v フラグを追加すると、以下のように詳細モードで複数のオプションを実行して、詳細を取得することもできます。

$ ssh -vv git@github.com

または最大の場合は、

$ ssh -vvv git@github.com

• GitHub との連携
• Bitbucket との連携