为 Red Hat Developer Hub 安装 Ansible 插件

1. 从 Red Hat Ansible Automation Platform 产品软件下载页面 下载 插件的最新 .tar 文件。文件名格式为 ansible-backstage-rhaap-bundle-x.y.z.tar.gz。替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

2. 在本地机器上创建一个目录来存储 .tar 文件。

   $ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>

3. 设置环境变量($DYNAMIC_PLUGIN_ROOT_DIR)来代表目录路径。

   $ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>

4. 将 ansible-backstage-rhaap-bundle-<version-number>.tar.gz 内容提取到 $DYNAMIC_PLUGIN_ROOT_DIR。

   $ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

流程

1. 使用凭证登录到 OpenShift Container Platform 实例，以创建新应用程序。

2. 打开 Red Hat Developer Hub OpenShift 项目。

   $ oc project <YOUR_DEVELOPER_HUB_PROJECT>

3. 运行以下命令，在 OpenShift 集群中创建插件 registry 构建。

   $ oc new-build httpd --name=plugin-registry --binary
   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
   $ oc new-app --image-stream=plugin-registry

1. 点插件 registry 查看日志。

   

   (1)开发人员 hub 实例

   (2)插件 registry

2. 单击 terminal 选项卡，再登录容器。

3. 在终端中，运行 ls 以确认 .tar 文件位于插件 registry 中。

   ansible-plugin-backstage-rhaap-x.y.z.tgz
   ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
   ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz

   版本号和文件名可能会有所不同。

1. 在 OpenShift 控制台中，选择 Topology 视图。
2. 点 developer-hub 实例上的 More actions alsa，然后选择 Edit backstage 以打开 Backstage 详情页面。
3. 选择 YAML 选项卡。

4. 在编辑窗格中，在 spec.deployment.patch.spec.template.spec 块中添加 containers 块：

   apiVersion: rhdh.redhat.com/v1alpha3
   kind: Backstage
   metadata:
     name: developer-hub
   spec:
     deployment:
       patch:
         spec:
           template:
             spec:
               containers:
                 - command:
                     - adt
                     - server
                   image: registry.redhat.io/ansible-automation-platform-25/ansible-dev-tools-rhel8:latest
                   imagePullPolicy: always
                   ports:
                     - containerPort:8000
                       protocol: TCP
                   terminationMessagePolicy: file

5. 点击 Save。

1. 从 Red Hat Ansible Automation Platform 产品软件下载页面 下载 插件的最新 .tar 文件。文件名格式为 ansible-backstage-rhaap-bundle-x.y.z.tar.gz。替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

2. 在本地机器上创建一个目录来存储 .tar 文件。

   $ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>

3. 设置环境变量($DYNAMIC_PLUGIN_ROOT_DIR)来代表目录路径。

   $ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>

4. 将 ansible-backstage-rhaap-bundle-<version-number>.tar.gz 内容提取到 $DYNAMIC_PLUGIN_ROOT_DIR。

   $ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

流程

1. 使用凭证登录到 OpenShift Container Platform 实例，以创建新应用程序。

2. 打开 Red Hat Developer Hub OpenShift 项目。

   $ oc project <YOUR_DEVELOPER_HUB_PROJECT>

3. 运行以下命令，在 OpenShift 集群中创建插件 registry 构建。

   $ oc new-build httpd --name=plugin-registry --binary
   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait
   $ oc new-app --image-stream=plugin-registry

1. 点插件 registry 查看日志。

   

   (1)开发人员 hub 实例

   (2)插件 registry

2. 单击 terminal 选项卡，再登录容器。

3. 在终端中，运行 ls 以确认 .tar 文件位于插件 registry 中。

   ansible-plugin-backstage-rhaap-x.y.z.tgz
   ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
   ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz

   版本号和文件名可能会有所不同。

流程

1. 在 OpenShift 控制台导航窗格中选择 ConfigMap。
2. 从列表中选择 rhaap-dynamic-plugins-config ConfigMap。
3. 选择 YAML 选项卡来编辑 rhaap-dynamic-plugins-config ConfigMap。

4. 在 data.dynamic-plugins.yaml.plugins 块中，添加插件 registry 的三个动态插件。

   • 对于 完整性 哈希值，请使用与每个插件对应的 $DYNAMIC_PLUGIN_ROOT_DIR 目录中的 .integrity 文件，例如，使用 ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity 用于 ansible-plugin-backstage-rhaap-x.y.z.tgz 插件。

   • 将 x.y.z 替换为正确的插件版本。

     kind: ConfigMap
     apiVersion: v1
     metadata:
      name: rhaap-dynamic-plugins-config
     data:
      dynamic-plugins.yaml: |
        ...
        plugins:
          - disabled: false
            package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
            integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
            pluginConfig:
              dynamicPlugins:
                frontend:
                  ansible.plugin-backstage-rhaap:
                    appIcons:
                      - importName: AnsibleLogo
                        name: AnsibleLogo
                    dynamicRoutes:
                      - importName: AnsiblePage
                        menuItem:
                          icon: AnsibleLogo
                          text: Ansible
                        path: /ansible
          - disabled: false
            package: >-
              http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
            integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
            pluginConfig:
              dynamicPlugins:
                backend:
                  ansible.plugin-backstage-rhaap-backend: null
          - disabled: false
            package: >-
              http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
            integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
            pluginConfig:
              dynamicPlugins:
                backend:
                  ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
          - ...<REDACTED>

5. 点击 Save。

6. 查看滚动重启的进度：

   1. 在 Topology 视图中，选择部署 pod，再单击 View logs。
   2. 从容器列表中选择 install-dynamic-plugins。

验证

1. 在 OpenShift 控制台中，选择 Topology 视图。
2. 单击部署 Pod 上的 Open URL 图标，在浏览器窗口中打开 Red Hat Developer Hub 实例。

流程

1. 编辑您在 添加自定义 ConfigMap 中创建的自定义 Red Hat Developer Hub 配置映射 app-config-rhdh。

2. 将以下代码添加到 Red Hat Developer Hub app-config-rhdh.yaml 文件中。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: app-config-rhdh
   ...
   data:
     app-config-rhdh.yaml: |-
       ansible:
         creatorService:
           baseUrl: 127.0.0.1
           port: '8000'
   ...

流程

1. 按照自动化控制器的 添加令牌 部分，使用 自动化控制器中的 "Read"范围创建个人访问令牌(PAT)。
2. 编辑自定义 Red Hat Developer Hub 配置映射，如 app-config-rhdh。

3. 将您的 Ansible Automation Platform 详情添加到 app-config-rhdh.yaml。

   1. 使用自动化控制器 URL 设置 baseURL 密钥。
   2. 使用在第 1 步中创建的生成的令牌值设置 令牌 密钥。

   3. 将 checkSSL 密钥设为 true 或 false。

      如果 checkSSL 设为 true，Ansible 插件将验证 SSL 证书是否有效。

      data:
        app-config-rhdh.yaml: |
          ...
          ansible:
          ...
            rhaap:
              baseUrl: '<https://MyControllerUrl>'
              token: '<AAP Personal Access Token>'
              checkSSL: true

流程

1. 编辑自定义 Red Hat Developer Hub 配置映射，如 app-config-rhdh。
2. 将以下代码添加到 Red Hat Developer Hub app-config-rhdh.yaml 文件中。

1. 验证 Ansible Automation Platform 是否可从 ConfigMap 的 rhaap 部分中访问并正确配置。
2. 确保为您的环境正确设置了 checkSSL 密钥。
3. 更正配置详情后，重启 Red Hat Developer Hub pod 以启动订阅查询。

1. 验证 Ansible 插件中配置的自动化控制器个人访问令牌(PAT)是否正确。如需更多信息，请参阅 自动化控制器用户指南 的 Applications 部分。
2. 更正身份验证详情后，重启 Red Hat Developer Hub pod 以启动订阅查询。

1. 验证 Ansible 插件 ConfigMap 的 rhaap 部分是否已正确配置，并且包含所有必要的条目。如需更多信息，请参阅配置 Ansible Automation Platform 详情。
2. 更正配置后，重启 Red Hat Developer Hub pod 以启动订阅查询。

1. 请联系您的红帽客户团队以获取新的订阅权利。
2. 了解有关 帐户合规性 的更多信息。
3. 当订阅合规时，重启 Red Hat Developer Hub pod 以启动新的订阅查询。

1. 请联系您的红帽客户团队以获取新的订阅权利或启动 Ansible Automation Platform 试用。
2. 更新订阅后，重启 Red Hat Developer Hub pod 以启动新的订阅查询。

1. 从 Red Hat Ansible Automation Platform 产品软件下载页面 下载 插件的最新 .tar 文件。文件名格式为 ansible-backstage-rhaap-bundle-x.y.z.tar.gz。替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

2. 在本地机器上创建一个目录来存储 .tar 文件。

   $ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>

3. 设置环境变量($DYNAMIC_PLUGIN_ROOT_DIR)来代表目录路径。

   $ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>

4. 将 ansible-backstage-rhaap-bundle-<version-number>.tar.gz 内容提取到 $DYNAMIC_PLUGIN_ROOT_DIR。

   $ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

流程

1. 使用凭证登录到 OpenShift Container Platform 实例，以创建新应用程序。

2. 打开 Red Hat Developer Hub OpenShift 项目。

   $ oc project <YOUR_DEVELOPER_HUB_PROJECT>

3. 运行以下命令，以更新 OpenShift 集群中的插件 registry 构建。命令假定 $DYNAMIC_PLUGIN_ROOT_DIR 代表您的 .tar 文件的目录。如果您选择了不同的环境变量名称，请在命令中替换它。

   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

4. 当 registry 启动时，输出会显示以下信息：

   Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build …
   Uploading finished
   build.build.openshift.io/plugin-registry-1 started

1. 在 OpenShift UI 中，单击 Topology。
2. 单击 redhat-developer-hub 图标，以查看插件 registry 的 pod。
3. 点插件 registry pod 的 View logs。
4. 打开 Terminal 选项卡，再运行 ls 来查看 插件 registry 中的 .tar 文件。
5. 验证新 .tar 文件是否已上传。

流程

1. 登录您的 OpenShift Container Platform 实例。
2. 在 OpenShift Developer UI 中，导航到 Helm → developer-hub → Actions → Upgrade → Yaml view。

3. 更新 Ansible 插件版本号及关联的 .integrity 文件值。

   ...
   global:
   ...
       plugins:
         - disabled: false
           integrity: <SHA512 value>
           package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
           pluginConfig:
             dynamicPlugins:
               frontend:
                 ansible.plugin-backstage-rhaap:
                   appIcons:
                     - importName: AnsibleLogo
                       name: AnsibleLogo
                   dynamicRoutes:
                     - importName: AnsiblePage
                       menuItem:
                         icon: AnsibleLogo
                         text: Ansible
                       path: /ansible
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-backstage-rhaap-backend: null

4. 单击 Upgrade。

   开发人员 hub pod 重启并安装了插件。

验证

1. 在 OpenShift UI 中，单击 Topology。
2. 确保 Red Hat Developer Hub 实例可用。

1. 从 Red Hat Ansible Automation Platform 产品软件下载页面 下载 插件的最新 .tar 文件。文件名格式为 ansible-backstage-rhaap-bundle-x.y.z.tar.gz。替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

2. 在本地机器上创建一个目录来存储 .tar 文件。

   $ mkdir /path/to/<ansible-backstage-plugins-local-dir-changeme>

3. 设置环境变量($DYNAMIC_PLUGIN_ROOT_DIR)来代表目录路径。

   $ export DYNAMIC_PLUGIN_ROOT_DIR=/path/to/<ansible-backstage-plugins-local-dir-changeme>

4. 将 ansible-backstage-rhaap-bundle-<version-number>.tar.gz 内容提取到 $DYNAMIC_PLUGIN_ROOT_DIR。

   $ tar --exclude='*code*' -xzf ansible-backstage-rhaap-bundle-x.y.z.tar.gz -C $DYNAMIC_PLUGIN_ROOT_DIR

   替换 Ansible 插件发行版本，如 1.0.0，如 x.y.z。

流程

1. 使用凭证登录到 OpenShift Container Platform 实例，以创建新应用程序。

2. 打开 Red Hat Developer Hub OpenShift 项目。

   $ oc project <YOUR_DEVELOPER_HUB_PROJECT>

3. 运行以下命令，以更新 OpenShift 集群中的插件 registry 构建。命令假定 $DYNAMIC_PLUGIN_ROOT_DIR 代表您的 .tar 文件的目录。如果您选择了不同的环境变量名称，请在命令中替换它。

   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

   $ oc start-build plugin-registry --from-dir=$DYNAMIC_PLUGIN_ROOT_DIR --wait

4. 当 registry 启动时，输出会显示以下信息：

   Uploading directory "/path/to/dynamic_plugin_root" as binary input for the build …
   Uploading finished
   build.build.openshift.io/plugin-registry-1 started

1. 在 OpenShift UI 中，单击 Topology。
2. 单击 redhat-developer-hub 图标，以查看插件 registry 的 pod。
3. 点插件 registry pod 的 View logs。
4. 打开 Terminal 选项卡，再运行 ls 来查看 插件 registry 中的 .tar 文件。
5. 验证新 .tar 文件是否已上传。

流程

1. 登录您的 OpenShift Container Platform 实例。
2. 在 OpenShift UI 中，打开您在安装过程中添加 Ansible 插件的 ConfigMap。本例使用名为 rhaap-dynamic-plugins-config 的 ConfigMap 文件。
3. 使用更新的 Ansible 插件的版本号更新 x.y.z。

4. 使用从对应的 Ansible 插件 .tar 文件中对应的 .integrity 值更新每个插件的完整性值。

   kind: ConfigMap
   apiVersion: v1
   metadata:
    name: rhaap-dynamic-plugins-config
   data:
    dynamic-plugins.yaml: |
      ...
      plugins: # Update the Ansible plug-in entries below with the updated plugin versions
        - disabled: false
          package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
          integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-x.y.z.tgz.integrity
   	 ...
        - disabled: false
          package: >-
            http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
          integrity: <SHA512 value> # Use hash in ansible-plugin-backstage-rhaap-backend-x.y.z.tgz.integrity
          ...
        - disabled: false
          package: >-
            http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
          integrity: <SHA512 value> # Use hash in ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz.integrity
   	 ...

5. 点击 Save。

   开发人员 hub pod 重启并安装了插件。

验证

1. 在 OpenShift UI 中，单击 Topology。
2. 确保 Red Hat Developer Hub 实例可用。

流程

1. 在 Red Hat Developer Hub 中，删除使用 ansible:content:create 操作的任何软件模板。
2. 在 OpenShift Developer UI 中，导航到 Helm → developer-hub → Actions → Upgrade → Yaml view。

3. 删除 plugins 部分下的 Ansible 插件配置。

   ...
   global:
   ...
       plugins:
         - disabled: false
           integrity: <SHA512 value>
           package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
           pluginConfig:
             dynamicPlugins:
               frontend:
                 ansible.plugin-backstage-rhaap:
                   appIcons:
                     - importName: AnsibleLogo
                       name: AnsibleLogo
                   dynamicRoutes:
                     - importName: AnsiblePage
                       menuItem:
                         icon: AnsibleLogo
                         text: Ansible
                       path: /ansible
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-scaffolder-backend-module-backstage-rhaap: null
         - disabled: false
           integrity: <SHA512 value>
           package: >-
             http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
           pluginConfig:
             dynamicPlugins:
               backend:
                 ansible.plugin-backstage-rhaap-backend: null

4. 删除 extraContainers 部分。

   upstream:
     backstage: |
       ...
       extraContainers:
         - command:
             - adt
             - server
           image: >-
             registry.redhat.io/ansible-automation-platform-25/ansible-dev-tools-rhel8:latest
           imagePullPolicy: IfNotPresent
           name: ansible-devtools-server
           ports:
             - containerPort: 8000
       image:
         pullPolicy: Always
         pullSecrets:
           - ...
           - rhdh-secret-registry
       ...

5. 单击 Upgrade。
6. 编辑自定义 Red Hat Developer Hub 配置映射，如 app-config-rhdh。

7. 删除 ansible 部分。

   data:
     app-config-rhdh.yaml: |
       ...
       ansible:
         analytics:
           enabled: true
         devSpaces:
           baseUrl: '<https://MyOwnDevSpacesUrl/>'
         creatorService:
           baseUrl: '127.0.0.1'
           port: '8000'
         rhaap:
           baseUrl: '<https://MyAapSubcriptionUrl>'
           token: '<TopSecretAAPToken>'
           checkSSL: true
         automationHub:
           baseUrl: '<https://MyOwnPAHUrl/>'

8. 重启 Red Hat Developer Hub 部署。

9. 删除 plugin-registry OpenShift 应用。

   oc delete all -l app=plugin-registry

流程

1. 打开您引用 Ansible 插件的自定义 ConfigMap。在本例中，ConfigMap 名称为 rhaap-dynamic-plugins-config。

2. 在 plugins: block 中找到动态插件。

   • 要禁用插件，请将这三个插件的 disabled 属性更新为 true。

   • 要删除插件，请从 plugins: 块中删除引用插件的行：

     kind: ConfigMap
     apiVersion: v1
     metadata:
      name: rhaap-dynamic-plugins-config
     data:
      dynamic-plugins.yaml: |
        ...
        plugins: # Remove the Ansible plug-ins entries below the ‘plugins’ YAML key
          - disabled: false
            package: 'http://plugin-registry:8080/ansible-plugin-backstage-rhaap-x.y.z.tgz'
            integrity: <SHA512 value>
     	 ...
          - disabled: false
            package: >-
              http://plugin-registry:8080/ansible-plugin-backstage-rhaap-backend-x.y.z.tgz
            integrity: <SHA512 value>
            ...
          - disabled: false
            package: >-
              http://plugin-registry:8080/ansible-plugin-scaffolder-backend-module-backstage-rhaap-x.y.z.tgz
            integrity: <SHA512 value>
     	 ...

3. 点击 Save。

流程

1. 打开自定义 Red Hat Developer Hub ConfigMap，在其中为模板添加配置并连接到 Ansible Automation Platform 和 Dev Spaces。在本例中，Red Hat Developer Hub ConfigMap 名称是 app-config-rhdh。

   kind: ConfigMap
   apiVersion: v1
   metadata:
    name: rhdh-app-config
   data:
    app-config-custom.yaml: |
      ...
      catalog:
        ...
        locations: # Remove the YAML entry below the 'locations' YAML key
          - type: url
            target: https://github.com/ansible/ansible-rhdh-templates/blob/main/all.yaml
            rules:
              - allow: [Template]
        ...
      # Remove the entire 'ansible' YAML key and all sub-entries
      ansible:
        devSpaces:
          baseUrl: '<https://YOUR_DEV_SPACES_URL>'
        creatorService:
          baseUrl: '127.0.0.1'
          port: '8000'
        rhaap:
          baseUrl: '<https://YOUR_AAP_URL>'
          token: <REDACTED>
          checkSSL: false

2. 删除 location : 块中的 url，以从 RHDH 实例中删除模板。
3. 删除 ansible: 块，以删除 Ansible 特定的配置。
4. 点击 Save。

流程

1. 在 OpenShift 控制台中，选择 Topology 视图。
2. 点 developer-hub 实例上的 More actions alsa，然后选择 Edit backstage 来编辑基本 ConfigMap。
3. 选择 YAML 选项卡。

4. 在编辑窗格中，从 spec.deployment.patch.spec.template.spec 块中删除 sidecar 容器的 containers 块：

   ...
   spec:
     deployment:
       patch:
         spec:
           template:
             spec:
               containers:
                 - command:
                     - adt
                     - server
                   image: ghcr.io/ansible/community-ansible-dev-tools:latest
                   imagePullPolicy: always
                   ports:
                     - containerPort:8000
                       protocol: TCP
                   terminationMessagePolicy: file

5. 点击 Save。