第 3 章 使用带有 Git 存储库托管服务提供商的 Pipelines as Code。

流程

1. 在 Administrator 视角中，使用导航窗格进入到 Pipelines。
2. 在 Pipelines 页面中点 Setup GitHub App。
3. 输入您的 GitHub 应用程序名称。例如，pipelines-ci-clustername-testui。
4. 点 Setup。
5. 在浏览器中提示时输入您的 Git 密码。
6. 点 Create GitHub App for <username>，其中 <username> 是您的 GitHub 的用户名。

流程

1. 登录您的 GitHub 帐户。
2. 在 GitHub 菜单中，选择 Settings Developer settings GitHub Apps，然后点 New GitHub App。

3. 在 GitHub App 表单中提供以下信息：

   • GitHub 应用程序名称：OpenShift Pipelines
   • 主页 URL ：OpenShift 控制台 URL

   • Webhook URL ：作为代码路由或入口 URL 的 Pipelines。您可以运行以下命令来找到它：

     $ echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')

     另外，要为额外的 Pipelines 作为代码控制器配置 GitHub 应用程序，请将 pipelines-as-code-controller 替换为您配置的控制器的名称，如下例所示：

     示例命令

     $ echo https://$(oc get route -n openshift-pipelines pac_controller_2 -o jsonpath='{.spec.host}')

   • Webhook secret ：一个任意的机密。您可以运行以下命令来生成 secret：

     $ openssl rand -hex 20

4. 在 Repository permissions 部分中选择以下项目：

   • Checks: Read & Write
   • Contents: Read & Write
   • Issues: Read & Write
   • Metadata: Read-only
   • Pull request: Read & Write

5. 在 Organization permissions 部分中选择以下项目：

   • Members:Read-only
   • 计划 : 只读

6. 订阅以下事件：

   • Check run
   • 检查套件
   • Commit comment
   • Issue comment
   • Pull request
   • push
7. 点 Create GitHub App。
8. 在新创建的 GitHub App 的 Details 页面中，记录顶部显示的 App ID。
9. 在 Private key 部分，点 Generate Private key 自动生成并下载 GitHub 应用的私钥。安全地存储私钥，以备将来参考和使用。
10. 在您要与 Pipelines as Code 一起使用的软件仓库上安装创建的应用程序。

11. 输入以下命令将 Pipelines as Code 配置为访问新创建的 GitHub 应用程序：

    $ oc -n openshift-pipelines create secret generic pipelines-as-code-secret \ 1
            --from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \ 2
            --from-literal github-application-id="<APP_ID>" \ 3
            --from-literal webhook.secret="<WEBHOOK_SECRET>" 4

    1

    如果您创建了额外的 Pipelines as Code 控制器来支持额外的 GitHub 应用程序，并且您要为其他控制器配置应用程序，请将 pipelines-as-code-secret 替换为您在控制器的 secretName 参数中配置的名称。

    2

    配置 GitHub 应用程序时下载的私钥的路径。

    3

    GitHub 应用程序的 App ID。

    4

    创建 GitHub 应用程序时提供的 webhook secret。

流程

1. 在 TektonConfig 自定义资源 (CR) 中，在 pipelinesAsCode.settings spec 中，将 secret-github-app-token-scoped 参数设置为 false。此设置允许将 GitHub 令牌范围到全局和存储库级别配置中列出的私有和公共存储库。

2. 要在 TektonConfig CR 中为 scoping GitHub 令牌设置全局配置，在 pipelinesAsCode.settings spec 中指定 secret-github-app-scope-extra-repos 参数中的额外软件仓库，如下例所示：

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     platforms:
       openshift:
         pipelinesAsCode:
           enable: true
           settings:
             secret-github-app-token-scoped: false
             secret-github-app-scope-extra-repos: "owner2/project2, owner3/project3"

3. 要为 GitHub 令牌设置存储库级别配置，请在 Repository CR 的 github_app_token_scope_repos 参数中指定附加存储库，如下例所示：

   apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
   kind: Repository
   metadata:
     name: test
     namespace: test-repo
   spec:
     url: "https://github.com/linda/project"
     settings:
       github_app_token_scope_repos:
       - "owner/project"
       - "owner1/project1"

   在本例中，Repository 自定义资源与 test-repo 命名空间中的 linda/project 存储库关联。生成的 GitHub 令牌的范围已扩展到 owner/project 和 owner1/project1 存储库，以及 linda/project 存储库。这些存储库必须存在于 test-repo 命名空间下。

   注意

   其他存储库可以是公共或私有存储库，但必须位于与 Repository 资源关联的存储库相同的命名空间中。

   如果命名空间中不存在任何存储库，则 GitHub 令牌的范围会失败，并显示出错信息：

   failed to scope GitHub token as repo owner1/project1 does not exist in namespace test-repo