Jira Cloud

借助 Jira Cloud 连接器,您可以对模拟为数据库的 Jira 数据执行插入、删除、更新和读取操作。

支持的版本

Jira Cloud 连接器使用 JIRA Cloud REST API 版本 2 和 3。这些均由内部管理 您无需进行任何额外的配置。

准备工作

在使用 Jira Cloud 连接器之前,请先完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号

    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

配置连接器

配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:

  1. Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表,请参阅位置

    2. 点击下一步
  4. 连接详情部分中,完成以下操作:
    1. 连接器:从可用连接器的下拉列表中选择 Jira Cloud
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 连接名称字段中,输入连接实例的名称。

      连接名称必须符合以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
    4. (可选)输入连接实例的说明
    5. (可选)启用 Cloud Logging。 然后选择一个日志级别默认情况下,日志级别设置为 Error
    6. 服务账号:选择具有所需角色的服务账号。
    7. 如需将连接用于事件订阅,请选择启用事件订阅。正在选择 时,系统会显示以下选项:
      • Enable event subscription with entity and actions(启用包含实体和操作的事件订阅):选择此选项可以 将连接用于事件订阅和连接器操作(实体和操作)。
      • 仅启用事件订阅:选择此选项可仅将连接用于事件订阅。如果您选择此选项,请点击下一步,然后 配置事件订阅
    8. (可选)配置连接节点设置

      • 节点数下限:输入连接节点数下限。
      • 节点数上限:输入连接节点数上限。

      节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。

    9. 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
      • 代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
        • 基本:基本 HTTP 身份验证。
        • 摘要:摘要 HTTP 身份验证。
      • 代理用户:用于向代理服务器进行身份验证的用户名。
      • 代理密码:用户密码的 Secret Manager 密文。
      • 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
        • 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
        • 始终:连接始终启用 SSL。
        • 永不:连接未启用 SSL。
        • 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
      • 代理服务器部分中,输入代理服务器的详细信息。
        1. 点击+ 添加目标
        2. 选择目标类型
          • 主机地址:指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接,请执行以下操作:

    10. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    11. 点击下一步
  5. 目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
    1. 目标类型:选择目标类型
      • 主机地址:指定目的地的主机名或 IP 地址。

        如果您想与后端建立专用连接,请执行以下操作:

      要输入其他目标,请点击 + 添加目标

    2. 点击下一步
  6. Authentication(身份验证)部分中,输入身份验证详细信息。
    1. 选择身份验证类型,然后输入相关详细信息。

      Jira Cloud 连接支持以下身份验证类型:

      • 用户名和密码
    2. 如需了解如何配置这些身份验证类型,请参阅配置身份验证

    3. 点击下一步
  7. 如果您已启用事件订阅,则连接创建页面上会显示事件订阅详情部分。为了了解 请参阅配置事件订阅
  8. 查看:查看您的连接和身份验证详细信息。
  9. 点击创建

配置事件订阅

如果您启用了事件订阅,请在 Event Subscription Details 部分中输入以下值:

  1. 选择目标类型
    • 主机地址:在 host 字段中输入后端系统的注册网址。
  2. 输入身份验证详细信息。
    1. 用户名:输入用户名。
    2. API 令牌:选择包含 API 令牌的 Secret Manager 密钥。
    3. Secret 版本:选择 Secret 版本。
  3. 选择启用专用连接以在后端应用之间实现安全连接 以及你的人脉关系如果您选择此选项,则必须在创建连接后执行其他配置步骤。如需了解详情,请参阅适用于事件订阅的专用连接
  4. 输入死信配置。如果您配置了死信,则连接会写入 将未处理的事件发送到指定的 Pub/Sub 主题。输入以下详细信息:
    1. 死信项目 ID :您在其中配置了死信 Pub/Sub 主题的 Google Cloud 项目的 ID。
    2. 死信主题:您要将未处理事件的详细信息写入的 Pub/Sub 主题。
  5. 如果您想使用代理连接到后端(用于事件订阅),请输入以下详细信息:
    1. 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。请选择任意一项 以下身份验证类型之一:
      • 始终:连接始终为事件订阅启用 SSL。
      • 从不:表示事件订阅未启用 SSL 连接。
    2. 代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。 支持以下身份验证类型:
      • 基本:基本 HTTP 身份验证。
    3. 代理用户:输入用于向代理服务器进行身份验证的用户名。
    4. 代理密码:选择用户密码的 Secret Manager 密文。
    5. Secret 版本:选择 Secret 版本。
    6. 代理服务器部分,输入代理服务器的详细信息。
      1. 点击 + 添加目的地,然后选择目的地类型 作为主机地址
      2. 输入代理服务器的主机名或 IP 地址,以及代理服务器的端口号。

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码
    • 用户名:用于连接的 Jira Cloud 用户名。
    • API 令牌:用户名的密码将是 API 令牌。选择 Secret Manager Secret,包含与 Jira Cloud 用户名关联的 API 令牌。
  • OAuth 2.0 - 授权代码
    • 客户端 ID:由外部应用提供的客户端 ID。
    • 范围:权限范围。offline_access 范围必须与 Jira Cloud 连接器搭配使用。为了了解 范围的运作方式,并查看 Jira Cloud 的所有可用范围, 请参阅范围
    • 客户端密钥:选择 Secret Manager 密钥。您应该先创建 Secret Manager 密钥,然后再配置此授权。
    • 密钥版本:客户端密钥的 Secret Manager 密钥版本。

    对于 Authorization code 身份验证类型,在创建连接后,您需要 应该执行一些额外的步骤来配置身份验证。如需更多信息 请参阅创建连接后的其他步骤

创建连接后的其他步骤

如果您选择OAuth 2.0 - Authorization code 身份验证,您必须在创建连接后执行以下额外步骤:

  1. “连接”页面中, 找到新创建的连接。

    请注意,新连接器的状态将为需要授权

  2. 点击需要授权

    此时将显示修改授权窗格。

  3. 重定向 URI 值复制到您的外部应用。
  4. 验证授权详情。
  5. 点击 Authorize(授权)。

    如果授权成功,连接状态将在 “关联”页面

为授权代码重新授权

如果您使用的是 Authorization code 身份验证类型,并在 Jira Cloud 应用中更改了配置, 您必须重新授权 Jira Cloud 连接。如需重新授权连接,请执行以下步骤:

  1. “连接”页面中点击所需的连接。

    系统随即会打开连接详情页面。

  2. 点击修改以修改连接详情。
  3. 身份验证部分中,验证 OAuth 2.0 - 授权代码详细信息。

    根据需要进行必要的更改。

  4. 点击保存。系统随即会转到连接详情页面。
  5. 点击身份验证部分中的修改授权。系统随即会显示 Authorize(授权)窗格。
  6. 点击 Authorize(授权)。

    如果授权成功,“连接”页面中的连接状态将设置为有效

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。

    但是,连接器可能不支持或不支持任何实体,在这种情况下, “Entities”列表将为空。

  • 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:

    从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。但是,如果连接器不支持任何实体操作, 操作未在 Operations 列表中列出。

  • 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作有一些输入参数和一个输出 参数。但可能的情况是,连接器不支持任何动作,在这种情况下,Actions 列表将为空。

系统限制

Jira Cloud 连接器每个节点每秒最多可以处理 10 笔事务,并会对超出此限制的所有事务进行节流。默认情况下,Integration Connectors 会为连接分配 2 个节点(以提高可用性)。

如需了解适用于 Integration Connectors 的限制,请参阅限制

使用 Terraform 创建连接

您可以使用 Terraform 资源以创建新连接。

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

如需查看用于创建连接的 Terraform 模板示例,请参阅示例模板

使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:

参数名称 数据类型 必需 说明
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括:AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 Jira Cloud 连接

创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在 Application Integration 中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛

后续步骤