红帽全球峰会在 Red Hat Developer Hub 中配置插件
摘要
前言
Red Hat Developer Hub 是一个企业级集成开发人员平台，通过插件扩展，有助于减少开发人员的欺诈和令人满意的提高。
Red Hat Developer Hub 支持
如果您在执行本文档所述的某个流程时遇到问题，请访问红帽客户门户。您可以使用红帽客户门户网站来实现以下目的：
- 要搜索或浏览红帽知识库，了解有关红帽产品的技术支持文章。
- 要为红帽全球支持服务(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 应用程序中的插件生态系统，您可以访问任何类型的开发基础架构或软件开发工具。
Developer Hub 中的插件通过保持整体用户体验的一致性，最大程度提高工作效率并简化开发工作流。
第 2 章 动态插件安装
动态插件支持基于 backend 插件管理器软件包，它是一个在应用程序配置中扫描配置的根目录(dynamicPlugins.rootDirectory )的服务，用于动态插件软件包并动态加载它们。
您可以使用预安装 Red Hat Developer Hub 的动态插件，或者从公共 NPM registry 安装外部动态插件。
2.1. 查看已安装的插件
使用 Dynamic Plugins Info 前端插件，您可以查看当前安装在 Red Hat Developer Hub 应用程序中的插件。此插件默认是启用的。
流程
- 打开 Developer Hub 应用程序，然后点 Administration。
- 转至 Plugins 选项卡，以查看已安装的插件和相关信息的列表。
2.2. 预安装的动态插件
Red Hat Developer Hub 预安装了特定的动态插件。有关此 Developer Hub 发行版本中包含的动态插件的完整列表，请参阅 动态插件支持列表。
以下预安装的动态插件默认是启用的：
-
@janus-idp/backstage-plugin-analytics-provider-segment -
@janus-idp/backstage-scaffolder-backend-module-quay -
@janus-idp/backstage-scaffolder-backend-module-regex -
@backstage/plugin-techdocs-backend -
@backstage/plugin-techdocs
默认禁用需要自定义配置的动态插件。
在应用程序启动时，对于默认禁用的每个插件，Developer Hub pod 日志中的 install-dynamic-plugins init 容器 会显示类似如下的消息：
======= Skipping disabled dynamic plugin ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
要启用此插件，请在 Helm Chart 中添加具有相同名称的软件包，并将 disabled 字段中的值改为 'false'。例如：
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
disabled: false
插件的默认配置是从 dynamic-plugins.default.yaml' 文件中提取的，但您可以使用 pluginConfig 条目来覆盖默认配置。
2.3. 预安装的动态插件描述和详情
2.3.1. 红帽和合作伙伴插件
红帽及其合作伙伴支持以下 16 个插件：
| Name | 插件 | Version | 路径和所需变量 |
|---|---|---|---|
| 分析供应商分割 | 1.7.2 |
| |
| Argo CD | 1.6.2 |
| |
| Argo CD | 2.6.5 |
| |
| Argo CD | 3.0.3 |
| |
| Keycloak | 1.13.1 |
| |
| Kubernetes | 0.18.3 |
| |
| OCM | 4.4.4 |
| |
| OCM | 4.4.0 |
| |
| Quy | 1.11.3 |
| |
| Quy | 1.7.1 |
| |
| RBAC | 1.29.0 |
| |
| regex | 1.7.1 |
| |
| TechDocs | 1.10.7 |
| |
| TechDocs | 1.10.9 |
| |
| Tekton | 3.12.3 |
| |
| Topology | 1.27.0 |
|
- 有关配置 Keycloak 的更多信息，请参阅 安装和配置 Keycloak。
- 有关配置 TechDocs 的更多信息，请参阅在 Red Hat Developer Hub 中配置 TechDocs 插件。
2.3.2. 技术预览插件
红帽包括特定的技术预览(TP)插件，可供客户配置和启用。这些插件提供了每个技术预览术语的支持范围，可能并不完善，红帽不建议在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能，并有机会在开发阶段提供反馈意见。有关红帽技术预览功能支持范围的更多信息，请参阅技术预览功能支持范围。有关红帽如何为捆绑社区动态插件提供支持的更多详细信息，请参阅 Red Hat Developer Support Policy 页面。
2.3.2.1. 红帽技术预览插件
红帽为以下 7 插件提供技术预览支持：
| Name | 插件 | Version | 路径和所需变量 |
|---|---|---|---|
| AAP | 1.9.3 |
| |
| ACR | 1.7.11 |
| |
| 批量导入 | 1.4.1 |
| |
| JFrog Artifactory | 1.7.5 |
| |
| Nexus 存储库管理器 | 1.9.5 |
| |
| ServiceNow | 1.7.2 |
| |
| SonarQube | 1.7.1 |
|
2.3.2.2. 社区插件
Developer Hub 包括以下 42 社区插件：
| Name | 插件 | Version | 路径和所需变量 |
|---|---|---|---|
| 3scale | 1.8.2 |
| |
| Argo CD | 1.1.27 |
| |
| Azure | 0.1.14 |
| |
| Azure Devops | 0.4.4 |
| |
| Azure Devops | 0.6.5 |
| |
| Azure Repositories |
| 0.3.0 |
|
| Bitbucket 云 | 0.2.9 |
| |
| Bitbucket 云 | 0.1.12 |
| |
| Bitbucket 服务器 | 0.1.36 |
| |
| Bitbucket 服务器 |
| 0.1.12 |
|
| 批量导入 | 1.3.0 |
| |
| Datadog | 2.3.0 |
| |
| Dynatrace | 10.0.4 |
| |
| Gerrit | 0.1.14 |
| |
| GitHub | 0.6.5 |
| |
| GitHub | 0.4.0 |
| |
| GitHub 操作 | 0.6.16 |
| |
| GitHub Insights | 2.3.31 |
| |
| GitHub 问题 | 0.4.2 |
| |
| GitHub 机构 | 0.1.17 |
| |
| GitHub 拉取请求 | 2.5.27 |
| |
| GitLab | 6.6.0 |
| |
| GitLab | 0.3.21 |
| |
| GitLab | 6.6.0 |
| |
| GitLab | 0.4.4 |
| |
| GitLab Org | 0.0.5 |
| |
| HTTP 请求 | 4.3.2 |
| |
| Jenkins | 0.9.10 |
| |
| Jenkins | 0.4.5 |
| |
| Jira | 2.5.8 |
| |
| Kubernetes | 0.11.12 |
| |
| ldap | 0.7.0 |
| |
| lighthouse | 0.4.20 |
| |
| Logs | 0.0.1 |
| |
| MS Graph | 0.5.30 |
| |
| PagerDuty | 0.15.0 |
| |
| Scaffolder Relation Processor |
| 1.2.6 |
|
| 安全 Insights | 2.3.19 |
| |
| SonarQube | 0.7.17 |
| |
| SonarQube | 0.2.20 |
| |
| 技术 Radar | 0.7.4 |
| |
| utils | 1.17.1 |
|
2.4. 使用 Red Hat Developer Hub Operator 配置动态插件
您可以将动态插件的配置存储在 Backstage 自定义资源(CR)可引用的 ConfigMap 对象中。
如果 pluginConfig 字段引用环境变量，则必须在 secrets-rhdh secret 中定义变量。
流程
- 在 OpenShift Container Platform Web 控制台中选择 ConfigMaps 选项卡。
- 点 Create ConfigMap。
在 Create ConfigMap 页面中，选择 Configure via 中的 YAML view 选项，并根据需要编辑该文件。
使用 GitHub 动态插件的
ConfigMap对象示例kind: ConfigMap apiVersion: v1 metadata: name: dynamic-plugins-rhdh data: dynamic-plugins.yaml: | includes: - dynamic-plugins.default.yaml plugins: - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic' disabled: false pluginConfig: catalog: providers: github: organization: "${GITHUB_ORG}" schedule: frequency: { minutes: 1 } timeout: { minutes: 1 } initialDelay: { seconds: 100 }- 点 Create。
- 进入 Topology 视图。
点您要使用的 Red Hat Developer Hub 实例的溢出菜单，然后选择 Edit Backstage 以加载 Red Hat Developer Hub 实例的 YAML 视图。
将
dynamicPluginsConfigMapName字段添加到BackstageCR。例如：apiVersion: rhdh.redhat.com/v1alpha1 kind: Backstage metadata: name: my-rhdh spec: application: # ... dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...- 点击 Save。
- 返回到 Topology 视图并等待 Red Hat Developer Hub pod 启动。
- 点 Open URL 图标以使用 Red Hat Developer Hub 平台以及新的配置更改。
验证
通过在 Red Hat Developer Hub root URL 中附加
/api/dynamic-plugins-info/loaded-plugins并检查插件列表来确保动态插件配置已被加载：插件列表示例
[ { "name": "backstage-plugin-catalog-backend-module-github-dynamic", "version": "0.5.2", "platform": "node", "role": "backend-plugin-module" }, { "name": "backstage-plugin-techdocs", "version": "1.10.0", "role": "frontend-plugin", "platform": "web" }, { "name": "backstage-plugin-techdocs-backend-dynamic", "version": "1.9.5", "platform": "node", "role": "backend-plugin" }, ]
2.5. 使用 Helm Chart 安装动态插件
您可以使用 Helm Chart 部署 Developer Hub 实例，它是一个灵活的安装方法。使用 Helm Chart，您可以侧将动态插件加载到 Developer Hub 实例中，而无需重新编译代码或重建容器。
要使用 Helm 在 Developer Hub 中安装动态插件，请在 Helm Chart 中添加以下 global.dynamic 参数：
插件：用于安装的动态插件列表。默认情况下，列表为空。您可以使用以下字段填充 plugins 列表：-
软件包：您要安装的动态插件软件包的软件包规格。您可以使用软件包进行本地或外部动态插件安装。对于本地安装，请使用包含动态插件的本地文件夹的路径。对于外部安装，请使用公共 NPM 存储库中的软件包规格。 -
完整性（外部软件包必需）：一个特定于软件包的 <alg>-<digest> 形式的完整性校验和。支持的算法包括sha256、sha384和sha512。 -
pluginConfig：特定于插件的app-configYAML 片段。如需更多信息，请参阅插件配置。 -
disabled：如果设为true，则禁用动态插件。默认值：false。
-
-
包括：使用相同语法的 YAML 文件列表。
includes 文件中的 plugins 列表与主 Helm 值中的 plugins 列表合并。如果这两个插件列表中都提到了插件软件包，则主 Helm 值中的 字段。默认配置包含 plugins 字段会覆盖 includes 文件中的 plugins dynamic-plugins.default.yaml 文件，其中包含 Developer Hub 中预安装的所有动态插件，无论是默认启用还是禁用。
2.5.1. 获取完整性 checksum
要获取完整性 checksum，请输入以下命令：
npm view <package name>@<version> dist.integrity2.5.2. 动态插件安装的 Helm Chart 配置示例
以下示例演示了如何为特定类型的动态插件安装配置 Helm Chart。
当外部插件需要特定的 app-config 时，配置本地插件和外部插件
global:
dynamic:
plugins:
- package: <alocal package-spec used by npm pack>
- package: <external package-spec used by npm pack>
integrity: sha512-<some hash>
pluginConfig: ...从包含的文件禁用插件
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: <some imported plugins listed in dynamic-plugins.default.yaml>
disabled: true从包含的文件启用插件
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: <some imported plugins listed in dynamic-plugins.custom.yaml>
disabled: false启用在所含文件中禁用的插件
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: <some imported plugins listed in dynamic-plugins.custom.yaml>
disabled: false2.5.3. 使用 Helm Chart 安装外部动态插件
NPM registry 包含可用于演示目的的外部动态插件。例如，以下社区插件在 NPMJS 存储库中的 janus-idp 组织中提供：
- 通知（前端和后端）
- Kubernetes 操作(scaffolder 操作)
要安装 Notifications 和 Kubernetes 操作插件，请将它们包含在 global.dynamic.plugins 列表中的 Helm Chart 值中，如下例所示：
global:
dynamic:
plugins:
- package: '@janus-idp/plugin-notifications-backend-dynamic@1.3.6'
# Integrity can be found at https://registry.npmjs.org/@janus-idp/plugin-notifications-backend-dynamic
integrity: 'sha512-Qd8pniy1yRx+x7LnwjzQ6k9zP+C1yex24MaCcx7dGDPT/XbTokwoSZr4baSSn8jUA6P45NUUevu1d629mG4JGQ=='
- package: '@janus-idp/plugin-notifications@1.1.12
'
# https://registry.npmjs.org/@janus-idp/plugin-notifications
integrity: 'sha512-GCdEuHRQek3ay428C8C4wWgxjNpNwCXgIdFbUUFGCLLkBFSaOEw+XaBvWaBGtQ5BLgE3jQEUxa+422uzSYC5oQ=='
pluginConfig:
dynamicPlugins:
frontend:
janus-idp.backstage-plugin-notifications:
appIcons:
- name: notificationsIcon
module: NotificationsPlugin
importName: NotificationsActiveIcon
dynamicRoutes:
- path: /notifications
importName: NotificationsPage
module: NotificationsPlugin
menuItem:
icon: notificationsIcon
text: Notifications
config:
pollingIntervalMs: 5000
- package: '@janus-idp/backstage-scaffolder-backend-module-kubernetes-dynamic@1.3.5'
# https://registry.npmjs.org/@janus-idp/backstage-scaffolder-backend-module-kubernetes-dynamic
integrity: 'sha512-19ie+FM3QHxWYPyYzE0uNdI5K8M4vGZ0SPeeTw85XPROY1DrIY7rMm2G0XT85L0ZmntHVwc9qW+SbHolPg/qRA=='
proxy:
endpoints:
/explore-backend-completed:
target: 'http://localhost:7017'
- package: '@dfatwork-pkgs/search-backend-module-explore-wrapped-dynamic@0.1.3-next.1'
# https://registry.npmjs.org/@dfatwork-pkgs/search-backend-module-explore-wrapped-dynamic
integrity: 'sha512-mv6LS8UOve+eumoMCVypGcd7b/L36lH2z11tGKVrt+m65VzQI4FgAJr9kNCrjUZPMyh36KVGIjYqsu9+kgzH5A=='
- package: '@dfatwork-pkgs/plugin-catalog-backend-module-test-dynamic@0.0.0'
# https://registry.npmjs.org/@dfatwork-pkgs/plugin-catalog-backend-module-test-dynamic
integrity: 'sha512-YsrZMThxJk7cYJU9FtAcsTCx9lCChpytK254TfGb3iMAYQyVcZnr5AA/AU+hezFnXLsr6gj8PP7z/mCZieuuDA=='2.6. 使用自定义 NPM registry 进行动态插件软件包
您可以通过设置自定义 NPM registry，在 air-gapped 环境中安装外部插件。
您可以使用 Helm Chart 为动态插件软件包配置 NPM registry URL 和身份验证信息。对于通过 npm pack 获取的动态插件软件包，您可以使用 .npmrc 文件。
使用 Helm Chart，使用以下内容创建名为 dynamic-plugins-npmrc 的 secret，将 .npmrc 文件添加到 NPM registry 中：
apiVersion: v1
kind: Secret
metadata:
name: dynamic-plugins-npmrc
type: Opaque
stringData:
.npmrc: |
registry=<registry-url>
//<registry-url>:_authToken=<auth-token>
...2.7. 动态插件的基本配置
有些动态插件需要设置环境变量。如果没有设置必需的环境变量，并且启用了插件，则应用程序可能会在启动时失败。
各个插件的强制环境变量列在 Dynamic plugins 支持列表中。
ZiB-bomb 检测在安装包含大型文件的一些动态插件时，如果安装脚本认为软件包存档是 Zib-Bomb，安装会失败。
要增加软件包存档中文件允许的最大大小，您可以从默认大小为 20000000 字节增加部署 install-dynamic-plugins initContainer 的 MAX_ENTRY_SIZE 环境值。
2.8. 为 Red Hat Developer Hub 安装和使用 Ansible 插件
Red Hat Developer Hub 的 Ansible 插件通过策展的学习路径、一键式内容创建、集成开发工具和其他建议资源提供 Ansible 特定的门户体验。
Ansible 插件只是一个技术预览功能。
红帽产品服务级别协议（SLA）不支持技术预览功能，且其功能可能并不完善，因此红帽不建议在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能，并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息，请参阅技术预览功能支持范围。
Red Hat Developer Support Policy 页中提供了有关红帽如何提供对捆绑社区动态插件的支持的更多详情。
2.8.1. 对于管理员
要安装和配置 Ansible 插件，请参阅为 Red Hat Developer Hub 安装 Ansible 插件。
2.8.2. 对于用户
要使用 Ansible 插件，请参阅为 Red Hat Developer Hub 使用 Ansible 插件。
2.9. 安装并配置 Keycloak
将 Keycloak 集成到 Developer Hub 的 Keycloak 后端插件具有以下功能：
- 在域中同步 Keycloak 用户。
- 在域中同步 Keycloak 组及其用户。
2.9.1. 对于管理员
2.9.1.1. 安装
Keycloak 插件在 Developer Hub 中预加载，具有基本配置属性。要启用它，请将 disabled 属性设置为 false，如下所示：
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
disabled: false2.9.1.2. 基本配置
要启用 Keycloak 插件，您必须设置以下环境变量：
-
KEYCLOAK_BASE_URL -
KEYCLOAK_LOGIN_REALM -
KEYCLOAK_REALM -
KEYCLOAK_CLIENT_ID -
KEYCLOAK_CLIENT_SECRET
2.9.1.3. 高级配置
调度配置
您可以在 app-config.yaml 文件中配置调度，如下所示：
catalog:
providers:
keycloakOrg:
default:
# ...
# highlight-add-start
schedule: # optional; same options as in TaskScheduleDefinition
# supports cron, ISO duration, "human duration" as used in code
frequency: { minutes: 1 }
# supports ISO duration, "human duration" as used in code
timeout: { minutes: 1 }
initialDelay: { seconds: 15 }
# highlight-add-end
如果您在 app-config.yaml 文件中对调度进行任何更改，请重新启动以应用更改。
Keycloak 查询参数
您可以覆盖 app-config.yaml 文件中的默认 Keycloak 查询参数，如下所示：
catalog:
providers:
keycloakOrg:
default:
# ...
# highlight-add-start
userQuerySize: 500 # Optional
groupQuerySize: 250 # Optional
# highlight-add-end使用 Keycloak API 启用 Developer Hub 和 Keycloak 之间的通信。用户名和密码或客户端凭证是支持的身份验证方法。
下表描述了您可以在 app-config.yaml 文件中的 catalog.providers.keycloakOrg.<ENVIRONMENT_NAME > 对象中启用插件的参数：
| Name | 描述 | 默认值 | 必填 |
|---|---|---|---|
|
|
Keycloak 服务器的位置，如 | "" | 是 |
|
| 要同步的域 |
| 否 |
|
| 用于验证的域 |
| 否 |
|
| 用于身份验证的用户名 | "" | 如果使用基于密码的身份验证，则为 |
|
| 进行验证的密码 | "" | 如果使用基于密码的身份验证，则为 |
|
| 进行身份验证的客户端 ID | "" | 如果使用基于客户端凭证的身份验证，则为 |
|
| 要进行身份验证的客户端 Secret | "" | 如果使用基于客户端凭证的身份验证，则为 |
|
| 一次要查询的用户数 |
| 否 |
|
| 一次要查询的组数 |
| 否 |
使用客户端凭据时，访问类型必须设置为 confidential，并且必须启用服务帐户。您还必须从 realm-management 客户端角色中添加以下角色：
-
query-groups -
query-users -
view-users
2.9.1.4. 限制：
如果您有自签名或公司证书问题，您可以在启动 Developer Hub 前设置以下环境变量：
NODE_TLS_REJECT_UNAUTHORIZED=0
不建议设置环境变量的解决方案。
2.9.2. 对于用户
2.9.2.1. 使用 Keycloak 插件在 Developer Hub 中导入用户和组
成功配置插件后，插件在每次启动时都会导入用户和组。
如果您设置了调度，则会导入用户和组。
第一次导入完成后，您可以从目录页面中选择 User 来列出用户：
您可以在页面中查看用户列表：
选择用户时，您可以看到从 Keycloak 导入的信息：
您还可以选择一个组，查看列表，然后选择或从 Keycloak 导入的信息：
2.10. Nexus 存储库管理器的安装和配置
Nexus Repository Manager 插件显示 Developer Hub 应用中构建工件的信息。构建工件在 Nexus 存储库管理器中提供。
Nexus 存储库管理器插件只是一个技术预览功能。
红帽产品服务级别协议（SLA）不支持技术预览功能，且其功能可能并不完善，因此红帽不建议在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能，并有机会在开发阶段提供反馈意见。
有关红帽技术预览功能支持范围的更多信息，请参阅技术预览功能支持范围。
Red Hat Developer Support Policy 页中提供了有关红帽如何提供对捆绑社区动态插件的支持的更多详情。
2.10.1. 对于管理员
2.10.1.1. 安装和配置 Nexus 存储库管理器插件
安装
Nexus 存储库管理器插件在 Developer Hub 中预加载，具有基本配置属性。要启用它，请将 disabled 属性设置为 false，如下所示：
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager
disabled: false配置
在
app-config.yaml文件中将代理设置为所需的 Nexus Repository Manager 服务器，如下所示：proxy: '/nexus-repository-manager': target: 'https://<NEXUS_REPOSITORY_MANAGER_URL>' headers: X-Requested-With: 'XMLHttpRequest' # Uncomment the following line to access a private Nexus Repository Manager using a token # Authorization: 'Bearer <YOUR TOKEN>' changeOrigin: true # Change to "false" in case of using self hosted Nexus Repository Manager instance with a self-signed certificate secure: true可选：更改 Nexus 存储库管理器代理的基本 URL，如下所示：
nexusRepositoryManager: # default path is `/nexus-repository-manager` proxyPath: /custom-path可选：启用以下实验性注解：
nexusRepositoryManager: experimentalAnnotations: true使用以下注解注解您的实体：
metadata: annotations: # insert the chosen annotations here # example nexus-repository-manager/docker.image-name: `<ORGANIZATION>/<REPOSITORY>`,
2.10.2. 对于用户
2.10.2.1. 在 Developer Hub 中使用 Nexus 存储库管理器插件
Nexus Repository Manager 是一个前端插件，可让您查看有关构建工件的信息。
先决条件
- 您的 Developer Hub 应用程序已安装并运行。
- 已安装 Nexus Repository Manager 插件。有关安装过程请查看 第 2.10.1.1 节 “安装和配置 Nexus 存储库管理器插件”。
流程
- 打开 Developer Hub 应用程序，并在 Catalog 页面中选择一个组件。
转至 BUILD ARTIFACTS 选项卡。
BUILD ARTIFACTS 选项卡包含构建工件和相关信息的列表，如 VERSION、REPOSITORY、REPOSITORY TYPE、MANIFEST、MODIFIED 和 SIZE。
2.11. Tekton 的安装和配置
您可以使用 Tekton 插件来视觉化在 Kubernetes 或 OpenShift 集群中运行的 CI/CD 管道的结果。通过插件，用户可以视觉化查看管道中所有相关任务的高级别状态。
2.11.1. 对于管理员
2.11.1.1. 安装
先决条件
-
已安装并配置了
@backstage/plugin-kubernetes和@backstage/plugin-kubernetes-backend动态插件。 -
您已将 Kubernetes 插件配置为使用
ServiceAccount连接到集群。 必须为自定义资源(PipelineRuns 和 TaskRuns)授予访问集群的ServiceAccount。注意如果您配置了 RHDH Kubernetes 插件，则已授予
ClusterRole。-
要查看 pod 日志，您被授予了
pod/log的权限。 您可以使用以下代码为自定义资源和 pod 日志授予
ClusterRole：kubernetes: ... customResources: - group: 'tekton.dev' apiVersion: 'v1' plural: 'pipelineruns' - group: 'tekton.dev' apiVersion: 'v1' ... apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: backstage-read-only rules: - apiGroups: - "" resources: - pods/log verbs: - get - list - watch ... - apiGroups: - tekton.dev resources: - pipelineruns - taskruns verbs: - get - list您可以将准备的清单用于只读
ClusterRole，它为 Kubernetes 插件和 Tekton 插件提供访问权限。在实体的
catalog-info.yaml文件中添加以下注解，以识别实体是否包含 Kubernetes 资源：annotations: ... backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>您还可以添加
backstage.io/kubernetes-namespace注解，以使用定义的命名空间来识别 Kubernetes 资源。annotations: ... backstage.io/kubernetes-namespace: <RESOURCE_NS>将以下注解添加到实体的
catalog-info.yaml文件中，以启用 RHDH 中的 Tekton 相关功能。注解的值标识 RHDH 实体的名称：annotations: ... janus-idp.io/tekton : <BACKSTAGE_ENTITY_NAME>添加自定义标签选择器，它 RHDH 用于查找 Kubernetes 资源。标签选择器优先于 ID 注解。
annotations: ... backstage.io/kubernetes-label-selector: 'app=my-app,component=front-end'在资源中添加以下标签，以便 Kubernetes 插件从请求的实体获取 Kubernetes 资源：
labels: ... backstage.io/kubernetes-id: <BACKSTAGE_ENTITY_NAME>注意使用标签选择器时，上述标签必须存在于资源上。
流程
Tekton 插件在带有基本配置属性的 RHDH 中预加载。要启用它，请将 disabled 属性设置为 false，如下所示：
global: dynamic: includes: - dynamic-plugins.default.yaml plugins: - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton disabled: false
2.11.2. 对于用户
2.11.2.1. 在 RHDH 中使用 Tekton 插件
您可以使用 Tekton 前端插件来查看 PipelineRun 资源。
先决条件
- 已安装 Red Hat Developer Hub (RHDH)。
- 已安装 Tekton 插件。有关安装过程，请参阅 安装和配置 Tekton 插件。
流程
- 打开您的 RHDH 应用程序，然后从 Catalog 页面中选择一个组件。
转至 CI 选项卡。
CI 选项卡显示与 Kubernetes 集群关联的 PipelineRun 资源列表。列表中包含管道运行详细信息，如 NAME、VULNERABILITIES、STATUS、VDaySTATUS、STARTED 和 DURATION。
点击列表中的 PipelineRun 名称旁边的展开行按钮来查看 PipelineRun visualization。管道运行资源包括要完成的任务。当您将鼠标指针悬停在任务卡上时，您可以查看步骤来完成该特定任务。
2.12. 启用并配置 Argo CD 插件
您可以使用 Argo CD 插件来视觉化 OpenShift GitOps 中的持续交付(CD)工作流。此插件提供对应用的状态、部署详情、提交消息、提交者、提升到环境和部署历史记录的容器镜像的可视化概述。
2.12.1. 对于管理员
2.12.1.1. 启用 Argo CD 插件
先决条件
在
app-config.yamlconfigmap 中添加 Argo CD 实例信息，如下例所示：argocd: appLocatorMethods: - type: 'config' instances: - name: argoInstance1 url: https://argoInstance1.com username: ${ARGOCD_USERNAME} password: ${ARGOCD_PASSWORD} - name: argoInstance2 url: https://argoInstance2.com username: ${ARGOCD_USERNAME} password: ${ARGOCD_PASSWORD}将以下注解添加到实体的
catalog-info.yaml文件中，以识别 Argo CD 应用程序。annotations: ... # The label that Argo CD uses to fetch all the applications. The format to be used is label.key=label.value. For example, rht-gitops.com/janus-argocd=quarkus-app. argocd/app-selector: '${ARGOCD_LABEL_SELECTOR}'（可选）在实体的
catalog-info.yaml文件中添加以下注解，以在 Argo CD 实例间切换，如下例所示：annotations: ... # The Argo CD instance name used in `app-config.yaml`. argocd/instance-name: '${ARGOCD_INSTANCE}'注意如果没有设置此注解，Argo CD 插件默认为
app-config.yaml中配置的第一个 Argo CD 实例。
流程
将以下内容添加到 dynamic-plugins ConfigMap 中以启用 Argo CD 插件。
global: dynamic: includes: - dynamic-plugins.default.yaml plugins: - package: ./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic disabled: false - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-argocd disabled: false
2.12.2. 对于用户
先决条件
- 您已在 Red Hat Developer Hub RHDH 中启用了 Argo CD 插件。
流程
- 选择 Catalog 选项卡，再选择要使用的组件。
选择 CD 选项卡查看 Argo CD 管理的部署的见解。
选择适当的卡来查看部署详情（例如，提交消息、作者名称和部署历史记录）。
-
点击链接图标
以打开 Argo CD 中的部署详情。
-
点击链接图标
选择 Overview 选项卡，再导航到 Deployment summary 部分，以检查应用程序跨命名空间部署概述。另外，选择适当的 Argo CD 应用程序在 Argo CD 中打开部署详情，或者从 Revision 列中选择一个提交 ID，以查看 GitLab 或 GitHub 中的更改。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}