CircleCI に SSH キーを登録する

5 months ago1 min read

クラウド

Server v4.x

Server v3.x

このページの内容

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

概要

GitHubやBitbucketからコードをチェックアウトするためにSSHキーを設定したい場合は、 GitHub または Bitbucket の連携ページを参照してください。

GitLabを使用している場合、または他のサービスにアクセスするために追加のSSHキーが必要な場合は、使用しているCircleCIのバージョンに応じて以下の手順に従って、プロジェクトにSSHキーを追加してください。

注: SSH キーを登録するにはパブリックキーを ~/.ssh/authorized_keys に登録する必要がある場合があります。

SSHキーを追加する手順

注: CircleCI が SSH キーを復号化できるよう、キーには常に空のパスフレーズを設定してください。以下の例はmacOSの場合です。 SSHキーの作成に関する詳細は、 GitHub または Bitbucket のドキュメントを参照してください。

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

ジョブに SSH キーを登録する

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

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

セルフホストランナーの場合、システムに ssh-agent があり add_ssh_keys ステップが正常に使用できることを確認して下さい。 SSH キーは、$HOME/.ssh/id_rsa_<fingerprint> に記述されます。$HOME は、ジョブを実行するように設定されたユーザーのホームディレクトリで、<fingerprint> はこのキーのフィンガープリントです。ホストエントリーは、キーを使用するための関連する IdentityFile オプションと一緒に $HOME/.ssh/config にも追加されます。

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

注: fingerprints リスト内のすべてのフィンガープリントが、CircleCI アプリケーションを通じて登録されたキーと一致している必要があります。 CircleCI環境変数にある Fingerprints は失敗します。

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

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

関連項目

ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。ご協力いただき、ありがとうございます。

このページの編集をご提案ください (最初に「コントリビューションガイド」をご覧ください)。
ドキュメントの問題点を報告する、またはフィードバックやコメントを送信するには、GitHub で issue を作成してください。
CircleCI は、ユーザーの皆様の弊社プラットフォームにおけるエクスペリエンスを向上させる方法を常に模索しています。フィードバックをお寄せいただける場合は、リサーチコミュニティにご参加ください。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、サポートサイトから、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.