CircleCI に SSH 鍵を登録する

サーバーへのデプロイに SSH アクセスが必要な場合は、CircleCI に SSH 鍵を登録する必要があります。

概要

CircleCI に SSH 鍵を登録する必要があるケースは、以下の 2 パターンです。

バージョン管理システムからコードをチェックアウトする
実行中のプロセスが他のサービスにアクセスできるようにする

1 つ目の目的で SSH 鍵を登録する場合は、GitHub と Bitbucket のインテグレーションに関するドキュメントを参照してください。

それ以外の場合は、お使いのCircleCIのバージョン(クラウド/サーバー)に応じた以下の手順で、プロジェクトにSSHキーを追加してください。

複数の SSH 鍵をまとめてコンテナに登録するには、設定ファイル内の適切なジョブを選択して、add_ssh_keys という特別なステップを実行します。

手順

Note: Since CircleCI cannot decrypt SSH keys, every new key must have an empty passphrase.

Cloud 版 CircleCI の場合

ターミナルで、ssh-keygen -t ed25519 -C "your_email@example.com" コマンドを実行して鍵を生成します。詳細については、Secure Shell (SSH) のドキュメントを参照してください。
CircleCI アプリケーションで、 Project Settings ボタン (作業対象のプロジェクトの Pipelines ページの右上にあります) をクリックして、プロジェクトの設定に移動します。
Project Settings ページにて、 SSH Keys をクリックします (画面左側のメニューにあります)。
スクロールし、 Additional SSH Keys のセクションに移動します。
Add SSH Key ボタンをクリックします。
Hostname フィールドに鍵に関連付けるホスト名を入力します (例: git.heroku.com)。ホスト名を指定しない場合は、どのホストに対しても同じ鍵が使われます。
Private Key フィールドに登録する SSH 鍵を貼り付けます。
Add SSH Key ボタンをクリックします。

CircleCI Server の場合

ターミナルで、ssh-keygen -t ed25519 -C "your_email@example.com" コマンドを実行して鍵を生成します。詳細については、Secure Shell (SSH) のドキュメントを参照してください。
CircleCI アプリケーションで、プロジェクトの横にある歯車のアイコンをクリックして、プロジェクトの設定に移動します。
Permissions セクションで、SSH Permissions をクリックします。
Add SSH Key ボタンをクリックします。
Hostname フィールドに鍵に関連付けるホスト名を入力します (例: git.heroku.com)。ホスト名を指定しない場合は、どのホストに対しても同じ鍵が使われます。
Private Key フィールドに登録する SSH 鍵を貼り付けます。
Add SSH Key ボタンをクリックします。

ジョブに SSH 鍵を登録する

すべての CircleCI ジョブは、ssh-agent を使用して登録済みのすべての SSH 鍵に自動的に署名します。ただし、コンテナに実際に鍵を登録するには、add_ssh_keys キーを使用する必要があります。

SSH キーをコンテナに追加するには、特別なステップであるadd_ssh_keys を設定ファイルの適切なジョブの中で使用します。

version: 2
jobs:
  deploy-job:
    steps:
      - add_ssh_keys:
          fingerprints:
            - "SO:ME:FIN:G:ER:PR:IN:T"

メモ: fingerprints リスト内のすべてのフィンガープリントが、CircleCI アプリケーションを通じて登録された鍵と一致している必要があります。

ホスト名を指定せずに複数の鍵を登録する

ホスト名を指定せずに複数の SSH 鍵をプロジェクトに登録するには、CircleCI のデフォルトの SSH 設定に変更を加える必要があります。たとえば、同じホストに別々の目的でアクセスする複数の SSH 鍵がある場合、デフォルトの IdentitiesOnly no が設定され、接続では ssh-agent が使用されます。このとき、その鍵が正しい鍵がどうかにかかわらず、常に最初の鍵が使用されます。コンテナに SSH 鍵を登録している場合は、適切なブロックに IdentitiesOnly no を設定するか、ssh-add -D コマンドを実行し、ssh-add /path/to/key コマンドで登録された鍵を読み取って、このジョブで使用する ssh-agent からすべての鍵を削除します。