Red Hat Developer Hub 入门

Red Hat Developer Hub 1.0

Red Hat Customer Content Services

摘要

本文档介绍了安装和配置 Red Hat Developer Hub 的要求和说明。

前言
复制链接

作为开发者，您可以使用 Red Hat Developer Hub 体验简化的开发环境。Red Hat Developer Hub 由集中软件目录驱动，为您的微服务和基础架构提供效率。它使您的产品团队能够在没有任何影响的情况下提供质量代码。

Red Hat Developer Hub 支持
复制链接

如果您在执行本文档所述的某个流程时遇到问题，请访问红帽客户门户网站 http://access.redhat.com。您可以使用红帽客户门户网站搜索或浏览有关红帽产品的技术支持文章。您还可以为红帽全球支持服务(GSS)创建支持问题单。https://access.redhat.com/support/cases/#/case/new/get-support?caseCreate=true请选择 "Red Hat Developer Hub" 作为产品并选择适当的产品版本。

第 1 章 Red Hat Developer Hub 概述
复制链接

Red Hat Developer Hub (Developer Hub)充当专为构建开发人员门户设计的开放开发人员平台。通过开发人员 Hub，工程团队可以访问统一平台，以简化开发流程，并提供各种工具和资源，以便有效地构建高质量的软件。

Developer Hub 的目标是通过以下方式解决与创建和持续开发人员门户相关的困难：

中央化仪表板，用于查看所有可用的开发人员工具和资源，以提高生产力
自助服务功能以及 guardrails，适用于符合企业级最佳实践的云原生应用程序开发
对整个企业的所有开发人员进行适当的安全性和监管

Red Hat Developer Hub 通过提供开发人员体验来简化对内部批准的工具、编程语言以及自助管理门户网站中各种开发人员资源的决策。这种方法有助于加速应用程序开发和维护代码质量，同时促进创新。

第 2 章使用 Helm Chart 安装 Red Hat Developer Hub
复制链接

您可以使用 Red Hat OpenShift (OpenShift)中的 Helm Chart 来安装 Red Hat Developer Hub，它是一个灵活的安装方法。

Helm 是 OpenShift 上的软件包管理器，它提供以下功能：

使用自定义 hook 应用常规应用程序更新
管理复杂应用程序的安装
提供可在公共和私有服务器上托管的图表
支持回滚到以前的应用程序版本

Red Hat Developer Hub Helm Chart 在 Red Hat OpenShift Dedicated 和 OpenShift Container Platform (OCP)的 Helm 目录中提供。

先决条件

您已使用 OpenShift Web 控制台登录 OCP。
您已在项目中配置了适当的角色和权限来创建应用程序。

流程

在 OpenShift 中创建项目（如果不存在）。
有关在 OpenShift 中创建项目的更多信息，请参阅 Red Hat OpenShift 文档。
在 Red Hat OpenShift Web 控制台中切换到 Developer 模式。
点 +Add。
在 Developer Catalog 面板中点 Helm Chart。
在搜索栏中搜索 Developer Hub，然后选择 Red Hat Developer Hub 卡。
点 Create。
对于不想指定自定义 HOSTNAME 的用户，将 OpenShift 路由器主机（例如： apps.<clusterName>.com）复制到 Root Schema → global → Shorthand。仅与 DEFAULT upstream.backstage.appConfig 值和启用了 OCP Route 的 OCP Route 一起使用，并在需要时调整其他值。
或者，将 OpenShift 路由器主机（例如： apps.<clusterName>.com）复制到 global.clusterRouterBase，并根据需要调整其他值，如 global.clusterRouterBase: apps.example.com。
在前面的步骤中，会复制有关主机的信息，由 Developer Hub 后端访问。
当自动生成 OCP 路由时，路由的主机值会被推断出来，相同的主机信息会发送到 Developer Hub。另外，如果自定义域中存在使用值手动设置主机，则自定义主机将具有优先权。
点 Create 并等待数据库和 Red Hat Developer Hub 启动。
点 Open URL 选项开始使用 Red Hat Developer Hub 平台。

注意

如果您的 developer-hub pod 一直在 CrashLoopBackOff 中，您会看到以下日志：

Loaded config from app-config-from-configmap.yaml, env
...
2023-07-24T19:44:46.223Z auth info Configuring "database" as KeyStore provider type=plugin
Backend failed to start up Error: Missing required config value at 'backend.database.client'

然后，验证配置文件。这是因为 RHDH 容器无法访问配置文件。

第 3 章 Red Hat Developer Hub 支持的配置
复制链接

本节论述了访问 Red Hat Developer Hub 所需的配置，包括：

自定义应用程序配置
Developer Hub 目录的源控制配置

3.1. 在 Red Hat OpenShift 中添加自定义应用程序配置文件
复制链接

要访问 Red Hat Developer Hub，您必须将自定义应用程序配置文件添加到 OpenShift 中。在 OpenShift 中，您可以使用以下内容作为基础模板，创建名为 app-config-rhdh 的 ConfigMap：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    app:
      title: Red Hat Developer Hub

先决条件

您已在 Red Hat OpenShift 中创建了帐户。

流程

导航到 OpenShift 并选择 ConfigMap 选项卡。
点 Create ConfigMap。
此时会出现 创建 ConfigMap 页面。
在 Configure via 中选择 YAML view 选项，并根据需要对文件进行更改。
点 Create。
进入 Helm 标签页。
Helm Releases 列表会出现在页面中。
点 Helm 发行版本的三个点并选择 Upgrade。
在 Root Schema → Backstage Chart Schema → Backstage Parameters → Extra App Configuration files 添加到 inline 中命令参数中 ：
- configMapRef:app-config-rhdh
- filename: app-config-rhdh.yaml
单击 Upgrade。
或者，进入 helm 值的 YAML 视图，并将 upstream.backstage.command 的值设置为 []。
单击 Upgrade。

3.2. 在 Red Hat Developer Hub 中为目录添加源控制
复制链接

要在 Red Hat Developer Hub 中填充目录，您需要添加软件模板，并添加模板，您必须启用源控制，如 GitHub、GitLab 或 BitBucket。

3.2.1. 设置 GitHub 集成和身份验证
复制链接

在 Red Hat Developer Hub 中启用 GitHub 插件需要 GitHub 集成和身份验证。

先决条件

您有一个 GitHub 帐户。
在 Red Hat OpenShift 中有一个帐户

流程

在 OpenShift 中，单击 ConfigMap。

修改 app-config-rhdh 文件，使其包含 GitHub 配置，如下所示：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    app:
      title: Red Hat Developer Hub
    integrations:
      github:
        - host: github.com
          apps:
            - appId: ${GITHUB_APP_APP_ID}
              clientId: ${GITHUB_APP_CLIENT_ID}
              clientSecret: ${GITHUB_APP_CLIENT_SECRET}
              webhookUrl: ${GITHUB_APP_WEBHOOK_URL}
              webhookSecret: ${GITHUB_APP_WEBHOOK_SECRET}
              privateKey: |
                ${GITHUB_APP_PRIVATE_KEY}
    auth:
      # see https://backstage.io/docs/auth/ to learn about auth providers
      environment: development
      providers:
        github:
          development:
            clientId: ${GITHUB_APP_CLIENT_ID}
            clientSecret: ${GITHUB_APP_CLIENT_SECRET}

点击 Save。
按照以下步骤，使用环境变量作为之前代码片段中的键或值 Secret 文件，创建名为 rhdh-secrets 的 Secret 文件：
1. 在 Red Hat OpenShift 中，进入 Secrets 选项卡，再点 Create。
2. 输入 Secret name 作为 rhdh-secrets。
3. 将环境变量添加为 Key 和 Value，再单击 Create。
要使用 GitHub 应用程序登录，请确保 GitHub 应用程序中的 Callback URL 配置为如下：
https://developer-hub-<NAMESPACE_NAME>.<OPENSHIFT_ROUTE_HOST>/api/auth/github/handler/frame
在之前的 Callback URL 示例中，OPENSHIFT_ROUTE_HOST 是添加到 Root Schema → global → clusterRouteBase 字段中的 API URL。
以下是 Callback URL 的示例：

注意
要在 Developer Hub 的 Overview 页面上访问 GitHub 安全 insights 小部件，请确保您的 GitHub 应用程序具有只读 Dependabot Alerts 权限。
进入 Helm 选项卡并选择 Upgrade。
在 Root Schema → Backstage Chart Schema → Backstage Parameters → Backstage container 环境变量 下，添加 rhdh-secrets 作为值。
单击 Upgrade。

3.2.2. 在 Red Hat Developer Hub 中启用 GitHub 发现
复制链接

您可以为 Developer Hub 中的组件启用 GitHub 发现功能，如包含 catalog-info.yaml 文件的任何存储库。

先决条件

您已设置 GitHub 集成。如需更多信息，请参阅第 3.2.1 节 “设置 GitHub 集成和身份验证”。

流程

在 Red Hat Openshift 中，进入 Helm 选项卡并升级 Developer Hub 发行版本。
在 global → Dynamic plugins configuration → 在 backstage 应用程序中安装的动态插件列表下。→ 要安装的动态插件的 Package 规格。它应该可以被 npm pack 命令使用。添加以下值：
./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
单击 Upgrade。

在 ConfigMap 中添加以下代码：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    ...
      catalog:
        providers:
          github:
            providerId:
              organization: '${GITHUB_ORG}'
              schedule:
                frequency:
                  minutes: 30
                initialDelay:
                  seconds: 15
                timeout:
                  minutes: 3
    ...

在前面的代码中，将 ${GITHUB_ORG} 替换为您要发现组件的 GitHub 组织。另外，如果只有一个供应商，可以在 ConfigMap 中添加以下代码：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    ...
    catalog:
      providers:
        github:
          organization: ${GITHUB_ORG}
          schedule:
            frequency: { minutes: 1 }
            timeout: { minutes: 1 }
            initialDelay: { seconds: 100 }
    ...

当存在列表时，需要前面的代码中的 providerId 来识别提供程序。

点击 Save。

3.2.3. 在 Red Hat Developer Hub 中启用 GitHub 机构成员发现
复制链接

您还可以为 GitHub 组织的成员启用 GitHub 发现功能。

先决条件

您已设置 GitHub 集成。如需更多信息，请参阅第 3.2.1 节 “设置 GitHub 集成和身份验证”。

流程

在 Red Hat Openshift 中，进入 Helm 选项卡并升级 Developer Hub 发行版本。
在 global → Dynamic plugins configuration → 在 backstage 应用程序中安装的动态插件列表下。→ 要安装的动态插件的 Package 规格。它应该可以被 npm pack 命令使用。添加以下值：
./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic
单击 Upgrade。

在 ConfigMap 中添加以下代码：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    ...
    catalog:
      providers:
        githubOrg:
          default:
            id: production
            orgUrl: '${GITHUB_ORG_URL}'
    ...

在前面的代码中，将 ${GITHUB_ORG_URL} 替换为您要从中模拟用户的 GitHub 组织。

点击 Save。

第 4 章自定义 Red Hat Developer Hub 中的主页
复制链接

在 Red Hat Developer Hub 中，Home 页面数据是可配置的，它可以作为代理传递给 app-config.yaml 文件。您可以使用以下方法提供主页数据：

使用托管或 GitHub 或 GitLab 的 JSON 文件。要从 JSON 文件访问数据，您可以在 app-config.yaml 文件中添加以下代码：

proxy:
  endpoints:
    # Other Proxies
    # customize developer hub instance
    '/developer-hub':
      target: <DOMAIN_URL> # i.e https://raw.githubusercontent.com/
      pathRewrite:
        '^/api/proxy/developer-hub': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/homepage/data.json
      changeOrigin: true
      secure: true
      # Change to "false" in case of using self hosted cluster with a self-signed certificate
      headers:
	<HEADER_KEY>: <HEADER_VALUE> # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo

使用单独的服务，使用 API 以 JSON 格式提供 Home 页面数据。
注意
不需要同一服务提供 Home 页面和 Tech Radar 数据。
您可以使用 red-hat-developer-hub-customization-provider 作为示例服务，该服务为 Home page 和 Tech Radar 提供数据。red-hat-developer-hub-customization-provider 服务提供与默认的 Developer Hub 数据相同的数据。如果需要，您可以从 GitHub 中 fork red-hat-developer-hub-customization-provider 服务存储库，并使用您自己的数据进行修改。

本节论述了如何将 red-hat-developer-hub-customization-provider 服务部署到部署 Developer Hub Helm Chart 的集群。

先决条件

已使用 Helm Chart 安装 Red Hat Developer Hub。如需更多信息，请参阅第 2 章 使用 Helm Chart 安装 Red Hat Developer Hub。

流程

在 Red Hat OpenShift 中，选择 +Add 并点 Import from Git 选项。
将 Git 存储库的 URL 添加到 Git Repo URL 字段中。
要使用 red-hat-developer-hub-customization-provider 服务，您可以添加 red-hat-developer-hub-customization-provider 存储库的 URL。
在 General 部分中，将 Name 字段中的值重命名为 rhdh-customization-provider，再单击 Create。
前往 Advanced Options，再从 Target Port 复制值。
Target Port 用于自动生成 Kubernetes 或 OpenShift 服务以与之进行通信。

要查看服务，请导航到 OpenShift Administrator 视图，再前往 Networking → Service 部分。

您还可以在 Topology 视图中查看 Service Resources。

如果您使用示例遵循这个步骤，则调用 rhdh-customization-provider 服务，并包含 8080 端口。为 Home 页面提供的 API URL 必须以 JSON 格式返回数据，如下例所示：

[
  {
    "title": "Dropdown 1",
    "isExpanded": false,
    "links": [
      {
        "iconUrl": "https://imagehost.com/image.png",
        "label": "Dropdown 1 Item 1",
        "url": "https://example.com/"
      },
      {
        "iconUrl": "https://imagehost2.org/icon.png",
        "label": "Dropdown 1 Item 2",
        "url": ""
      }
    ]
  },
  {
    "title": "Dropdown 2",
    "isExpanded": true,
    "links": [
      {
        "iconUrl": "http://imagehost3.edu/img.jpg",
        "label": "Dropdown 2 Item 1",
        "url": "http://example.com"
      }
    ]
  }
]

如果请求调用失败或没有配置，Developer Hub 实例会回退到默认的本地数据。

要访问 Red Hat Developer Hub 中的 Home 页面，基本 URL 必须包含 /developer-hub 代理。

将以下代码添加到 app-config-rhdh.yaml 文件中：

proxy:
  endpoints:
    # Other Proxies
    # customize developer hub instance
    '/developer-hub':
      target: ${HOMEPAGE_DATA_URL}
      changeOrigin: true
      # Change to "false" in case of using self-hosted cluster with a self-signed certificate
      secure: true

确保 API 请求调用以 JSON 格式返回响应。

将 HOMEPAGE_DATA_URL 定义为 http://<SERVICE_NAME>:8080。例如： http://rhdh-customization-provider:8080。
您可以通过将 URL 添加到 rhdh-secrets 或直接在自定义 ConfigMap 中替换它来替换 HOMEPAGE_DATA_URL。

删除 Developer Hub Pod 以拉取更改。

如果镜像或图标没有加载，则通过将镜像或图标主机 URL 添加到自定义 ConfigMap 中的内容安全策略(csp) img-src 中列入白名单，如下所示：

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    app:
      title: Red Hat Developer Hub
    backend:
      csp:
        connect-src:
          - "'self'"
          - 'http:'
          - 'https:'
        img-src:
          - "'self'"
          - 'data:'
          - <image host url 1>
          - <image host url 2>
          - <image host url 3>
    # Other Configurations

之后，删除 pod 以确保正确载入新配置。

第 5 章在 Red Hat Developer Hub 中自定义 Tech Radar 页面
复制链接

在 Red Hat Developer Hub 中，不能使用 Helm Chart 中的动态插件功能启用 Tech Radar 页面。

与 Home page 自定义类似，基础技术 Radar URL 必须包含 /developer-hub/tech-radar 代理。您可以使用以下方法提供 Tech Radar 页面数据：

使用托管或 GitHub 或 GitLab 的 JSON 文件。要从 JSON 文件访问数据，您可以在 app-config.yaml 文件中添加以下代码：

proxy:
  endpoints:
    # Other Proxies
    # customize developer hub instance
    '/developer-hub':
      target: <DOMAIN_URL> # i.e https://raw.githubusercontent.com/
      pathRewrite:
        '^/api/proxy/developer-hub/tech-radar': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/tech-radar/data-default.json
	 '^/api/proxy/developer-hub': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/homepage/data.json
      changeOrigin: true
      secure: true

      # Change to "false" in case of using self hosted cluster with a self-signed certificate
      headers:
	<HEADER_KEY>: <HEADER_VALUE> # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo

注意

随着在用于 tech-radar 和 homepage 快速访问代理的 pathRewrites 之间重叠，则 tech-radar (^api/proxy/developer-hub/tech-radar)的配置必须在 主页 配置之前存在。

有关在 Red Hat Developer Hub 中自定义 Home 页面的更多信息，请参阅第 4 章 自定义 Red Hat Developer Hub 中的主页。

使用单独的服务，使用 API 以 JSON 格式提供 Tech Radar 数据。

先决条件

已使用 Helm Chart 安装 Red Hat Developer Hub。如需更多信息，请参阅第 2 章 使用 Helm Chart 安装 Red Hat Developer Hub。

流程

将以下代码添加到 app-config-rhdh.yaml 文件中：

proxy:
  endpoints:
    # Other Proxies
    '/developer-hub/tech-radar':
      target: ${TECHRADAR_DATA_URL}
      changeOrigin: true
      # Change to "false" in case of using self hosted cluster with a self-signed certificate
      secure: true

确保 API 请求调用以 JSON 格式返回响应。

将 TECHRADAR_DATA_URL' 定义为 http://<SERVICE_NAME>/tech-radar，例如 http://rhdh-customization-provider/tech-radar。
注意
您可以通过将其添加到 rhdh-secrets 或直接将其替换为自定义 ConfigMap 中的值来定义 TECHRADAR_DATA_URL。
删除 Developer Hub Pod 以拉取更改。

第 6 章 Red Hat Developer Hub 中的其他自定义
复制链接

本节论述了您可以应用到 Red Hat Developer Hub 的额外自定义选项。

自定义标签页提示

要自定义标签页提示，请在 app-config-rhdh.yaml 文件中添加以下内容：

app:
  title: My custom developer hub

自定义 Developer Hub 实例的品牌

要自定义 Developer Hub 实例品牌，请在 app-config-rhdh.yaml 文件中添加以下内容：

app:
  branding:
    fullLogo: ${BASE64_EMBEDDED_FULL_LOGO}
    iconLogo: ${BASE64_EMBEDDED_ICON_LOGO}
    theme:
      light:
        primaryColor: ${PRIMARY_LIGHT_COLOR}
        headerColor1: ${HEADER_LIGHT_COLOR_1}
        headerColor2: ${HEADER_LIGHT_COLOR_2}
        navigationIndicatorColor: ${NAV_INDICATOR_LIGHT_COLOR}
      dark:
        primaryColor: ${PRIMARY_DARK_COLOR}
        headerColor1: ${HEADER_DARK_COLOR_1}
        headerColor2: ${HEADER_DARK_COLOR_2}
        navigationIndicatorColor: ${NAV_INDICATOR_DARK_COLOR}

在前面的配置中，

fullLogo 是展开(pinned)侧边栏上的徽标，并需要一个 base64 编码镜像。
iconLogo 是折叠(unpinned)侧边栏上的徽标，并需要一个 base64 编码镜像。
primaryColor 是链接的颜色，以及输入颜色的大部分按钮。primaryColor 支持的格式包括：
- #nnn
- #nnnnnn
- rgb()
- rgba()
- hsl()
- hsla()
- color()
headerColor1 （横幅旁边）和 headerColor2 （横幅的右边）会更改每个页面标题横幅的颜色，以及模板卡的横幅。headerColor1 和 headerColor2 支持的格式包括：
- #nnn
- #nnnnnn
- rgb()
- rgba()
- hsl()
- hsla()
- color()
navigationIndicatorColor 在侧边栏中更改指示您要所处的标签页的颜色。navigationIndicatorColor 支持的格式包括：
- #nnn
- #nnnnnn
- rgb()
- rgba()
- hsl()
- hsla()
- color()

第 7 章在 Red Hat Developer Hub 中自定义主题
复制链接

您可以自定义 Red Hat Developer Hub (Developer Hub)主题模式。

RHDH 支持以下主题模式：

轻型主题（默认）
dark 主题
auto

先决条件

已登陆到 RHDH web 控制台。

流程

单击 Settings。
在 Appearance 面板中，单击 LIGHT THEME、DARK THEME 或 AUTO 以更改主题模式。

第 8 章 Red Hat Developer Hub 中的 ServiceNow Custom 操作
复制链接

重要

这些功能仅用于技术预览。红帽产品服务级别协议（SLA）不支持技术预览功能，且其功能可能并不完善，因此红帽不建议在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能，并有机会在开发阶段提供反馈意见。

有关红帽技术预览功能的更多信息，请参阅技术预览功能范围。

在 Red Hat Developer Hub 中，您可以访问 ServiceNow 自定义操作（自定义操作），以便在目录中获取和注册资源。

Developer Hub 中的自定义操作可让您促进和自动化记录管理。使用自定义操作，您可以执行以下操作：

创建、更新或删除记录
检索有关单个记录或多个记录的信息

8.1. 在 Red Hat Developer Hub 中启用 ServiceNow 自定义操作插件
复制链接

在 Red Hat Developer Hub 中，ServiceNow 自定义操作作为预加载插件提供，该插件默认为禁用。您可以按照以下流程启用自定义操作插件。

先决条件

Red Hat Developer Hub 已安装并运行。有关安装 Developer Hub 的更多信息，请参阅第 2 章 使用 Helm Chart 安装 Red Hat Developer Hub。
您已在 Developer Hub 中创建项目。

流程

要激活自定义操作插件，请使用插件名称 添加软件包，并更新 Helm Chart 中的 disabled 字段，如下所示：
```
global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: ./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-servicenow-dynamic
        disabled: false
```
注意
插件的默认配置从 dynamic-plugins.default.yaml 文件中提取，但您可以使用 pluginConfig 条目来覆盖默认配置。

在 Helm Chart 中设置以下变量来访问自定义操作：

servicenow:
  # The base url of the ServiceNow instance.
  baseUrl: ${SERVICENOW_BASE_URL}
  # The username to use for authentication.
  username: ${SERVICENOW_USERNAME}
  # The password to use for authentication.
  password: ${SERVICENOW_PASSWORD}

8.2. Red Hat Developer Hub 中支持的 ServiceNow 自定义操作
复制链接

ServiceNow 自定义操作可让您管理 Red Hat Developer Hub 中的记录。自定义操作支持以下 API 请求的 HTTP 方法：

GET: 从指定资源端点检索指定信息
POST ：创建或更新资源
PUT ：修改资源
PATCH ：更新资源
DELETE ：删除资源

8.2.1. ServiceNow 自定义操作
复制链接

[GET] servicenow:now:table:retrieveRecord

从 Developer Hub 中的表检索指定记录的信息。

Expand

表 8.1. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	要从中检索记录的表名称
`sysId`	`string`	必填	要检索的记录的唯一标识符
`sysparmDisplayValue`	`enum("true", "false", "all")`	选填	返回字段显示值，如 `true`，实际值为 `false`，或两者。默认值为 `false`。
`sysparmExcludeReferenceLink`	`布尔值`	选填	设置为 `true` 以排除参考字段的 Table API 链接。默认值为 `false`。
`sysparmFields`	`string[]`	选填	响应中返回的字段数组
`sysparmView`	`string`	选填	根据指定的 UI 视图呈现响应。您可以使用 `sysparm_fields` 覆盖此参数。
`sysparmQueryNoDomain`	`布尔值`	选填	如果授权，则设置为 `true` 以访问跨域的数据。默认值为 `false`。

Expand

表 8.2. 输出参数
Name	类型	描述
`result`	`record<PropertyKey, unknown>`	请求的响应正文

[GET] servicenow:now:table:retrieveRecords

从 Developer Hub 中的表检索有关多个记录的信息。

Expand

表 8.3. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	要从中检索记录的表名称
`sysparamQuery`	`string`	选填	用于过滤结果的编码查询字符串
`sysparmDisplayValue`	`enum("true", "false", "all")`	选填	返回字段显示值，如 `true`，实际值为 `false`，或两者。默认值为 `false`。
`sysparmExcludeReferenceLink`	`布尔值`	选填	设置为 `true` 以排除参考字段的 Table API 链接。默认值为 `false`。
`sysparmSuppressPaginationHeader`	`布尔值`	选填	设置为 `true` 以阻止分页标头。默认值为 `false`。
`sysparmFields`	`string[]`	选填	响应中返回的字段数组
`sysparmLimit`	`int`	选填	每页返回的最大结果数。默认值为 `10,000`。
`sysparmView`	`string`	选填	根据指定的 UI 视图呈现响应。您可以使用 `sysparm_fields` 覆盖此参数。
`sysparmQueryCategory`	`string`	选填	用于查询的查询类别的名称
`sysparmQueryNoDomain`	`布尔值`	选填	如果授权，则设置为 `true` 以访问跨域的数据。默认值为 `false`。
`sysparmNoCount`	`布尔值`	选填	不要在表上执行 select count DomainMapping。默认值为 `false`。

Expand

表 8.4. 输出参数
Name	类型	描述
`result`	`record<PropertyKey, unknown>`	请求的响应正文

[POST] servicenow:now:table:createRecord

在 Developer Hub 的表中创建记录。

Expand

表 8.5. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	要保存记录的表的名称
`requestBody`	`record<PropertyKey, unknown>`	选填	在指定记录中定义的每个参数的字段名称和关联的值
`sysparmDisplayValue`	`enum("true", "false", "all")`	选填	返回字段显示值，如 `true`，实际值为 `false`，或两者。默认值为 `false`。
`sysparmExcludeReferenceLink`	`布尔值`	选填	设置为 `true` 以排除参考字段的 Table API 链接。默认值为 `false`。
`sysparmFields`	`string[]`	选填	响应中返回的字段数组
`sysparmInputDisplayValue`	`布尔值`	选填	使用其显示值（如 `true` 或实际值）设置字段值，如 `false`。默认值为 `false`。
`sysparmSuppressAutoSysField`	`布尔值`	选填	设置为 `true`，以禁止自动生成系统字段。默认值为 `false`。
`sysparmView`	`string`	选填	根据指定的 UI 视图呈现响应。您可以使用 `sysparm_fields` 覆盖此参数。

Expand

表 8.6. 输出参数
Name	类型	描述
`result`	`record<PropertyKey, unknown>`	请求的响应正文

[PUT] servicenow:now:table:modifyRecord

修改 Developer Hub 中表中的记录。

Expand

表 8.7. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	要从中修改记录的表名称
`sysId`	`string`	必填	要修改的记录的唯一标识符
`requestBody`	`record<PropertyKey, unknown>`	选填	在指定记录中定义的每个参数的字段名称和关联的值
`sysparmDisplayValue`	`enum("true", "false", "all")`	选填	返回字段显示值，如 `true`，实际值为 `false`，或两者。默认值为 `false`。
`sysparmExcludeReferenceLink`	`布尔值`	选填	设置为 `true` 以排除参考字段的 Table API 链接。默认值为 `false`。
`sysparmFields`	`string[]`	选填	响应中返回的字段数组
`sysparmInputDisplayValue`	`布尔值`	选填	使用其显示值（如 `true` 或实际值）设置字段值，如 `false`。默认值为 `false`。
`sysparmSuppressAutoSysField`	`布尔值`	选填	设置为 `true`，以禁止自动生成系统字段。默认值为 `false`。
`sysparmView`	`string`	选填	根据指定的 UI 视图呈现响应。您可以使用 `sysparm_fields` 覆盖此参数。
`sysparmQueryNoDomain`	`布尔值`	选填	如果授权，则设置为 `true` 以访问跨域的数据。默认值为 `false`。

Expand

表 8.8. 输出参数
Name	类型	描述
`result`	`record<PropertyKey, unknown>`	请求的响应正文

[PATCH] 服务现在：now:table:updateRecord

更新 Developer Hub 中的表中的记录。

Expand

表 8.9. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	要更新记录的表的名称
`sysId`	`string`	必填	要更新的记录的唯一标识符
`requestBody`	`record<PropertyKey, unknown>`	选填	在指定记录中定义的每个参数的字段名称和关联的值
`sysparmDisplayValue`	`enum("true", "false", "all")`	选填	返回字段显示值，如 `true`，实际值为 `false`，或两者。默认值为 `false`。
`sysparmExcludeReferenceLink`	`布尔值`	选填	设置为 `true` 以排除参考字段的 Table API 链接。默认值为 `false`。
`sysparmFields`	`string[]`	选填	响应中返回的字段数组
`sysparmInputDisplayValue`	`布尔值`	选填	使用其显示值（如 `true` 或实际值）设置字段值，如 `false`。默认值为 `false`。
`sysparmSuppressAutoSysField`	`布尔值`	选填	设置为 `true`，以禁止自动生成系统字段。默认值为 `false`。
`sysparmView`	`string`	选填	根据指定的 UI 视图呈现响应。您可以使用 `sysparm_fields` 覆盖此参数。
`sysparmQueryNoDomain`	`布尔值`	选填	如果授权，则设置为 `true` 以访问跨域的数据。默认值为 `false`。

Expand

表 8.10. 输出参数
Name	类型	描述
`result`	`record<PropertyKey, unknown>`	请求的响应正文

[DELETE] servicenow:now:table:deleteRecord

从 Developer Hub 中的表中删除记录。

Expand

表 8.11. 输入参数
Name	类型	要求	描述
`tableName`	`string`	必填	从中删除记录的表名称
`sysId`	`string`	必填	要删除的记录的唯一标识符
`sysparmQueryNoDomain`	`布尔值`	选填	如果授权，则设置为 `true` 以访问跨域的数据。默认值为 `false`。

法律通告
复制链接

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat Developer Hub 入门

前言
复制链接

Red Hat Developer Hub 支持
复制链接

第 1 章 Red Hat Developer Hub 概述
复制链接

第 2 章使用 Helm Chart 安装 Red Hat Developer Hub
复制链接

第 3 章 Red Hat Developer Hub 支持的配置
复制链接

3.1. 在 Red Hat OpenShift 中添加自定义应用程序配置文件
复制链接

3.2. 在 Red Hat Developer Hub 中为目录添加源控制
复制链接

3.2.1. 设置 GitHub 集成和身份验证
复制链接

3.2.2. 在 Red Hat Developer Hub 中启用 GitHub 发现
复制链接

3.2.3. 在 Red Hat Developer Hub 中启用 GitHub 机构成员发现
复制链接

第 4 章自定义 Red Hat Developer Hub 中的主页
复制链接

第 5 章在 Red Hat Developer Hub 中自定义 Tech Radar 页面
复制链接

第 6 章 Red Hat Developer Hub 中的其他自定义
复制链接

第 7 章在 Red Hat Developer Hub 中自定义主题
复制链接

第 8 章 Red Hat Developer Hub 中的 ServiceNow Custom 操作
复制链接

8.1. 在 Red Hat Developer Hub 中启用 ServiceNow 自定义操作插件
复制链接

8.2. Red Hat Developer Hub 中支持的 ServiceNow 自定义操作
复制链接

8.2.1. ServiceNow 自定义操作
复制链接

法律通告
复制链接

学习

尝试、购买和销售

社区

關於紅帽

让开源更具包容性

关于红帽文档

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Red Hat Developer Hub 入门

前言复制链接链接已复制到粘贴板!

Red Hat Developer Hub 支持复制链接链接已复制到粘贴板!

第 1 章 Red Hat Developer Hub 概述复制链接链接已复制到粘贴板!

第 2 章 使用 Helm Chart 安装 Red Hat Developer Hub复制链接链接已复制到粘贴板!

第 3 章 Red Hat Developer Hub 支持的配置复制链接链接已复制到粘贴板!

3.1. 在 Red Hat OpenShift 中添加自定义应用程序配置文件复制链接链接已复制到粘贴板!

3.2. 在 Red Hat Developer Hub 中为目录添加源控制复制链接链接已复制到粘贴板!

3.2.1. 设置 GitHub 集成和身份验证复制链接链接已复制到粘贴板!

3.2.2. 在 Red Hat Developer Hub 中启用 GitHub 发现复制链接链接已复制到粘贴板!

3.2.3. 在 Red Hat Developer Hub 中启用 GitHub 机构成员发现复制链接链接已复制到粘贴板!

第 4 章 自定义 Red Hat Developer Hub 中的主页复制链接链接已复制到粘贴板!

第 5 章 在 Red Hat Developer Hub 中自定义 Tech Radar 页面复制链接链接已复制到粘贴板!

第 6 章 Red Hat Developer Hub 中的其他自定义复制链接链接已复制到粘贴板!

第 7 章 在 Red Hat Developer Hub 中自定义主题复制链接链接已复制到粘贴板!

第 8 章 Red Hat Developer Hub 中的 ServiceNow Custom 操作复制链接链接已复制到粘贴板!

8.1. 在 Red Hat Developer Hub 中启用 ServiceNow 自定义操作插件复制链接链接已复制到粘贴板!

8.2. Red Hat Developer Hub 中支持的 ServiceNow 自定义操作复制链接链接已复制到粘贴板!

8.2.1. ServiceNow 自定义操作复制链接链接已复制到粘贴板!

法律通告复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

關於紅帽

让开源更具包容性

关于红帽文档

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

前言
复制链接

Red Hat Developer Hub 支持
复制链接

第 1 章 Red Hat Developer Hub 概述
复制链接

第 2 章使用 Helm Chart 安装 Red Hat Developer Hub
复制链接

第 3 章 Red Hat Developer Hub 支持的配置
复制链接

3.1. 在 Red Hat OpenShift 中添加自定义应用程序配置文件
复制链接

3.2. 在 Red Hat Developer Hub 中为目录添加源控制
复制链接

3.2.1. 设置 GitHub 集成和身份验证
复制链接

3.2.2. 在 Red Hat Developer Hub 中启用 GitHub 发现
复制链接

3.2.3. 在 Red Hat Developer Hub 中启用 GitHub 机构成员发现
复制链接

第 4 章自定义 Red Hat Developer Hub 中的主页
复制链接

第 5 章在 Red Hat Developer Hub 中自定义 Tech Radar 页面
复制链接

第 6 章 Red Hat Developer Hub 中的其他自定义
复制链接

第 7 章在 Red Hat Developer Hub 中自定义主题
复制链接

第 8 章 Red Hat Developer Hub 中的 ServiceNow Custom 操作
复制链接

8.1. 在 Red Hat Developer Hub 中启用 ServiceNow 自定义操作插件
复制链接

8.2. Red Hat Developer Hub 中支持的 ServiceNow 自定义操作
复制链接

8.2.1. ServiceNow 自定义操作
复制链接

法律通告
复制链接