JBoss 项目
红帽
主页 / 文档 / 操作指南 / 为 OpenShift Online 配置 SSH 密钥

操作指南

为 OpenShift Online 配置 SSH 密钥

OpenShift Online 使用 SSH 身份验证来执行直接与齿轮交互的开发任务，例如将代码更改推送到 OpenShift Online Git 存储库、读取应用程序日志文件、列出和设置环境变量以及端口转发。

在使用 OpenShift 工具功能创建、编辑和管理 OpenShift Online 应用程序之前，您必须为 OpenShift Online 帐户配置 SSH 密钥对。这需要私钥-公钥对，私钥存储在本地系统上，其位置在 IDE 中指定，并且关联的公钥存储在 OpenShift Online 服务器上并与您的帐户关联。

OpenShift 工具使您能够借助多功能 SSH 向导快速完成这些要求。如果您是 OpenShift Online 的新手，向导可以帮助您配置新的或现有的 SSH 密钥对。如果您已经通过 Web 界面或 RHC 客户端工具使用 OpenShift Online，则只需在 IDE 首选项中指定私钥位置即可完成 SSH 密钥配置。

此处的说明演示了如何完成以下任务

  1. 创建和使用新的 SSH 密钥对

  2. 使用现有的 SSH 密钥对

  3. 指定现有的私钥文件

选项 A：创建和使用新的 SSH 密钥对

您可以使用 OpenShift 工具的“管理 SSH 密钥”向导来创建新的 SSH 密钥对。除了创建 SSH 密钥对之外，此向导还通过自动将公钥上传到 OpenShift Online 服务器并在 IDE 首选项中设置相应私钥的位置来完成 OpenShift Online SSH 配置过程。如果您以前没有使用您的系统与 OpenShift Online 交互，则此选项可能适用。

要创建和使用新的 SSH 密钥对，请完成以下步骤

  1. 在“OpenShift 资源管理器”视图中，右键单击连接，然后单击“管理 SSH 密钥”。

  2. 在“管理 SSH 密钥”向导中，单击“新建”。

  3. 完成有关新 SSH 密钥的字段，如下所示

    • 在“名称”字段中，键入一个名称以将密钥对与连接的任何其他密钥区分开来。

    • 从“密钥类型”列表中选择“SSH_RSA”。

    • 确保“SSH2 主目录”字段包含您要创建与密钥对关联的文件的位置。要更改位置，请清除“默认”复选框，然后在“SSH2 主目录”字段中键入位置，或单击“浏览”导航到所需位置。

    • 在“私钥文件名”字段中，键入私钥文件的名称。“公钥文件名”字段会自动完成，并显示在私钥文件名后追加的“.pub”。

      Completed Fields for the New SSH Key Pair
      图 1. 新 SSH 密钥对的已完成字段

  4. 单击“完成”，然后单击“确定”关闭“管理 SSH 密钥”向导。

选项 B：使用现有的 SSH 密钥对

您可以使用 OpenShift 工具的“管理 SSH 密钥”向导将已生成的 SSH 密钥对与 OpenShift Online 一起使用。此向导会将公钥上传到 OpenShift Online 服务器，并在 IDE 首选项中设置相应私钥的位置。如果您已从 OpenShift 帐户中删除了 SSH 密钥对，但仍然在系统上保留了生成的密钥文件，并且想要将其重新与 OpenShift 帐户关联，则此选项可能适用。

要使用现有的 SSH 密钥对，请完成以下步骤

  1. 在“OpenShift 资源管理器”视图中，右键单击连接，然后单击“管理 SSH 密钥”。

  2. 单击“添加现有”。

  3. 完成有关现有 SSH 公钥的字段，如下所示

    • 在“名称”字段中，键入 SSH 密钥的名称。

    • 在“公钥”字段中，键入公钥文件的路径，或单击“浏览”以找到公钥文件。

      Completed Fields for Adding an Existing SSH Public Key
      图 2. 添加现有 SSH 公钥的已完成字段

  4. 单击“SSH2 首选项”链接。

  5. 在“私钥”字段中，单击“添加私钥”并找到私钥文件。

  6. 单击“应用”，然后单击“确定”关闭“首选项”窗口。

  7. 单击“完成”，然后单击“确定”。

选项 C：指定现有的私钥文件

当使用已上传到 OpenShift Online 的公钥时，您必须确保在 IDE 首选项中设置了相应私钥的位置。如果您是现有的 OpenShift Online 用户，并且尚未从 IDE 工作区访问 OpenShift Online，或者您使用多个 IDE 工作区，则此选项可能适用。

要指定现有的私钥文件，请完成以下步骤

  1. 单击 窗口  首选项  常规  网络连接  SSH2。

  2. 在“常规”选项卡中，单击“添加私钥”并找到私钥文件。

  3. 单击“应用”，然后单击“确定”关闭“首选项”窗口。

你知道吗？

  • 要快速打开“OpenShift 资源管理器”视图，请在“IDE 快速访问”字段中键入“OpenShift 资源管理器”，然后从项目列表中选择“OpenShift 资源管理器”视图。

  • 为了提高安全性，您可以在创建与 OpenShift 帐户关联的私有 SSH 密钥时为其添加密码。您必须在每次 OpenShift 工具操作使用 SSH 密钥对 OpenShift Online 进行身份验证时输入特定密钥的密码。

  • IDE 首选项是特定于工作区的，因此您必须在每个工作区的“首选项”下指定私钥位置。

  • 您可以使用“管理 SSH 密钥”向导从 OpenShift Online 帐户中删除现有的 SSH 公钥。请注意，这只会将密钥与您的 OpenShift 帐户分离。与已删除的 SSH 密钥对关联的文件仍保留在它们生成的位置，并且私钥仍在 IDE 首选项中设置。

  • 如果您使用 OpenShift Online Web 界面或 RHC 客户端工具来同时管理 SSH 密钥和 OpenShift 工具，则 OpenShift 工具指定的有关密钥的信息可能不同步。您可以在“管理 SSH 密钥”向导中使用“刷新”按钮重新同步信息。

  • 您可以更改 IDE 用于存储新创建的 SSH 密钥的默认位置。单击 窗口  首选项  常规  网络连接  SSH2。在“常规”选项卡的“SSH2 主目录”字段中键入新位置。

排查 SSH 密钥问题

“您的 OpenShift 帐户中没有 SSH 公钥”

错误消息

您的 OpenShift 帐户 user@example.com 中还没有 SSH 公钥，请添加您的密钥或创建新的密钥。

No SSH Key Window Displaying the Error Message
图 3. 显示错误消息的“没有 SSH 密钥”窗口
问题

您的 OpenShift 帐户中没有分配 SSH 公钥。在您从 IDE 连接到 OpenShift Online 后，“没有 SSH 密钥”窗口会显示，通知您您的帐户中没有关联的 SSH 公钥。

解决方案

在“没有 SSH 密钥”窗口中，单击“添加现有”或“新建”，并将 SSH 公钥添加到 OpenShift Online 帐户，如上面的选项 A，“创建和使用新的 SSH 密钥对”和选项 B，“使用现有的 SSH 密钥对”中所述。

“请确保您已将您的私钥添加到 ssh 首选项中。”

错误消息

无法克隆存储库。身份验证失败。请确保您已将您的私钥添加到 ssh 首选项中。

Problem Occured Window Displaying the Error Message
图 4. 显示错误消息的“出现问题”窗口
问题

SSH 公钥与 OpenShift Online 帐户关联，但 IDE 无法找到配套的私钥。因此，IDE 无法完成与您帐户关联的 OpenShift 应用程序的操作。在创建新的 OpenShift 应用程序或将现有的 OpenShift 应用程序导入 IDE 时，可能会遇到此错误。

解决方案

单击“确定”关闭“出现问题”窗口。“OpenShift 应用程序”向导将打开。单击“SSH2 首选项”链接以添加私钥，如上面的选项 C，“指定现有的私钥位置”中所述。

返回顶部