Customizing Red Hat Trusted Application Pipeline

Procedure

1. Clone your forked repository, and then open it in your preferred text editor, such as Visual Studio Code.

2. Locate the properties file within your project directory. This file stores the default values that can customize. Open it for editing and update the following key-value pairs according to your environment.

   Key	Description
   export GITHUB_DEFAULT_HOST	Set this to your on-prem GitHub host fully qualified domain name. That is, the URL without the HTTP protocol and without the .git extension. For example github-github.apps.cluster-ljg9z.sandbox219.opentlc.com. Default is github.com.
   export GITLAB_DEFAULT_HOST	Set this to your on-prem GitLab host host fully qualified domain name. That is, the URL without the HTTP protocol and without the .git extension. For example gitlab-gitlab.apps.cluster-ljg9z.sandbox219.opentlc.com. Default is gitlab.com.
   export QUAY_DEFAULT_HOST	The default Quay URL correspond to your specific on-prem image registry URL without the HTTP protocol. For example, quay-tv2pb.apps.cluster-tv2pb.sandbox1194.opentlc.com. The default quay host is quay.io.
   export DEFAULT_DEPLOYMENT_NAMESPACE_PREFIX	The namespace prefix for deployments within RHTAP. Default is rhtap-app. Note Update this if you have modified the default trusted-application-pipeline: namespace during the RHTAP installation process.

   Figure 1.1. The properties file

   

3. Run the generate.sh script in your terminal. This action adjusts the software templates, replacing default host values with your specified inputs.

   ./generate.sh

   Copy to Clipboard

   Figure 1.2. The generate.sh script

   

4. Commit and push the changes to your repository. This automatically updates the template in RHDH. Alternatively, you can import and refresh a single or all customized templates directly in RHDH.

   1. Go to your forked sample template repository on your Git provider.
   2. For a single template, from the templates directory, select select template.yaml. Copy its URL from the browser address bar. For example, https://github.com/<username>/tssc-sample-templates/blob/main/templates/devfile-sample-code-with-quarkus-dance/template.yaml. Otherwise, for all the templates, select all.yaml and copy its URL from the browser address bar. For example, https://github.com/<username>/tssc-sample-templates/blob/main/all.yaml.
   3. Switch back to RHDH platform.
   4. Select Create > Register Existing Component.
   5. In the Select URL field, paste the appropriate URL that you copied in Step 4b.
   6. Select Analyze and then select Import to update the templates in RHDH.

Procedure

1. Access forked sample pipelines repository URL:

   1. Open your forked sample pipelines repository.
   2. Copy the complete URL from the address bar. For example, https://github.com/<username>/tssc-sample-pipelines.

2. Update pac URLs in the sample templates repository

   1. Navigate to your local cloned sample templates repository using your terminal.
   2. Run the following command, replacing {fork_url} with the copied URL from step 1 and {branch_name} with your desired branch name (for example, main):

   ./scripts/update-tekton-definition {fork_url} {branch_name}
   
   # For example, .scripts/update-tekton-definition https://github.com/<username>/tssc-sample-pipelines main

   Copy to Clipboard

3. Review, commit, and push changes:

   1. Review the updated files within your sample templates repository.
   2. Commit the changes with appropriate message.
   3. Push the committed changes to your forked repository.

Procedure

1. Retrieve Webhook URL and Secret Token:

   1. Log in to the OpenShift web console with Administrator privileges.
   2. Navigate to the rhtap project, expand Pipelines, and then select PipelineRuns.
   3. Locate the rhtap-pe-info-<> pipeline run, and then select the Logs tab.
   Note

   These logs contain the webhook URL and secret token required for GitLab configuration.

2. Configure Webhook in GitLab:

   1. Within your GitLab repository, navigate to Settings > Webhooks.
   2. In the URL field, enter the webhook URL copied from Step 1.
   3. In the Secret Token field, enter the secret token copied from Step 1.

   4. In the Trigger section:

      1. Select Push events.
      2. Select Merge request events.
   5. Click Add Webhook.

Verification

1. Push your code changes to the GitLab repository.
2. Navigate to the CI tab in RHDH.
3. Verify that a pipeline run is triggered for your code push.