Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-2881

Create a custom console for PAC

XMLWordPrintable

    • 3
    • False
    • None
    • False
    • Hide
      ### Reporting logs URL to Tekton Dashboard or custom Console

      Pipelines as Code have the ability to automatically detect the OpenShift Console and link the logs of the tasks to the
      public URL of the OpenShift Console. If you are using the Tekton Dashboard, you can configure this feature using the
      `tekton-dashboard-url` setting. Simply set this to your dashboard URL, and the pipelinerun status and tasklog will be
      displayed there.

      Alternatively, you can also configure a custom console with the following settings:

      * `custom-console-name`

       Set this to the name of your custom console. example: `MyCorp Console`

      * `custom-console-url`

       Set this to the root URL of your custom console. example: `https://mycorp.com`

      * `custom-console-url-pr-details`

       Set this to the URL where to view the details of the `PipelineRun`. This is
       shown when the PipelineRun is started so the user can follow execution on your
       console or when to see more details about the pipelinerun ion result.

       The URL suports templating for these value:

      * `{{ namespace }}`: The target namespace where the pipelinerun is executed
      * `{{ pr }}`: The PipelineRun name.

       example: `https://mycorp.com/ns/{{ namespace }}/pipelienrun/{{ pr }}`

      * `custom-console-url-pr-tasklog`

       Set this to the URL where to view the log of the taskrun of the `PipelineRun`. This is
       shown when we post a result of the task breakdown to link to the logs of the taskrun.

       The URL suports templating for these value:

      * `{{ namespace }}`: The target namespace where the pipelinerun is executed
      * `{{ pr }}`: The PipelineRun name.
      * `{{ task }}`: The Task name in the PR
      * `{{ pod }}`: The Pod name of the TaskRun
      * `{{ firstFailedStep }}`: The name of the first failed step in the TaskRun

       example: `https://mycorp.com/ns/{{ namespace }}/pipelinerun/{{ pr }}/logs/{{ task }}#{{ pod }}-{{ firstFailedStep }}`
      Show
      ### Reporting logs URL to Tekton Dashboard or custom Console Pipelines as Code have the ability to automatically detect the OpenShift Console and link the logs of the tasks to the public URL of the OpenShift Console. If you are using the Tekton Dashboard, you can configure this feature using the `tekton-dashboard-url` setting. Simply set this to your dashboard URL, and the pipelinerun status and tasklog will be displayed there. Alternatively, you can also configure a custom console with the following settings: * `custom-console-name`  Set this to the name of your custom console. example: `MyCorp Console` * `custom-console-url`  Set this to the root URL of your custom console. example: ` https://mycorp.com ` * `custom-console-url-pr-details`  Set this to the URL where to view the details of the `PipelineRun`. This is  shown when the PipelineRun is started so the user can follow execution on your  console or when to see more details about the pipelinerun ion result.  The URL suports templating for these value: * `{{ namespace }}`: The target namespace where the pipelinerun is executed * `{{ pr }}`: The PipelineRun name.  example: ` https://mycorp.com/ns/ {{ namespace }}/pipelienrun/{{ pr }}` * `custom-console-url-pr-tasklog`  Set this to the URL where to view the log of the taskrun of the `PipelineRun`. This is  shown when we post a result of the task breakdown to link to the logs of the taskrun.  The URL suports templating for these value: * `{{ namespace }}`: The target namespace where the pipelinerun is executed * `{{ pr }}`: The PipelineRun name. * `{{ task }}`: The Task name in the PR * `{{ pod }}`: The Pod name of the TaskRun * `{{ firstFailedStep }}`: The name of the first failed step in the TaskRun  example: ` https://mycorp.com/ns/ {{ namespace }}/pipelinerun/{{ pr }}/logs/{{ task }}#{{ pod }}-{{ firstFailedStep }}`
    • Feature
    • +
    • Pipelines Sprint 235

      Epic Goal

      •  we support openshift console and tekton dashboard, but customer like stonesoup has custom dasboard.

      Why is this important?

      Scenarios

      1. ...

      Acceptance Criteria (Mandatory)

      • CI - MUST be running successfully with tests automated
      • Release Technical Enablement - Provide necessary release enablement details and documents.
      • ...

      Dependencies (internal and external)

      1. ...

      Previous Work (Optional):

      Open questions::

      •  

      Done Checklist

      • Acceptance criteria are met
      • Non-functional properties of the Feature have been validated (such as performance, resource, UX, security or privacy aspects)
      • User Journey automation is delivered
      • Support and SRE teams are provided with enough skills to support the feature in production environment

              cboudjna@redhat.com Chmouel Boudjnah
              cboudjna@redhat.com Chmouel Boudjnah
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved:

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 week
                  1w