Getting started with TSF
After installing and verifying TSF, onboard your first application to see the secure build pipeline in action. This guide walks through the developer workflow: creating an application, onboarding a component from a Git repository, triggering a build, configuring a release, and verifying signed artifacts.
Persona: Developer — builds and ships applications using the software factory that the Platform Engineer installed.
Prerequisites
-
You can log in to the Konflux UI.
-
You have a Git repository with source code that you want to build. If you do not have one, fork the sample-component-golang repository.
-
Your Git provider integration (GitHub or GitLab) is configured as part of the installation.
Log in to the Konflux UI
-
Open the Konflux UI URL in a web browser.
-
Log in with your OCP credentials.
-
Authorize the
dex-clientservice account when prompted.
The Konflux dashboard displays the Get started with Konflux landing page.
Create an application
An application in Konflux is a logical grouping of one or more components that are built, tested, and released together.
-
In the Konflux UI, click Create an application.
-
Enter a name for your application, for example,
my-app. -
Click Create application.
For more details, see Creating an application in the Konflux documentation.
Create a component
A component maps to a single Git repository and branch. When you create a component, Konflux onboards the repository and configures the build pipeline.
-
From your application page, click Add component.
-
Enter the Git repository URL for your source code. For example:
https://github.com/konflux-ci/sample-component-golang. -
Select the branch to build from.
-
Review the detected build pipeline and click Create component.
For more details, see Creating a component in the Konflux documentation.
What happens after you create a component
After you create a component, Konflux automatically:
-
Sends a pull request to your Git repository. This PR adds Tekton pipeline definitions (
.tekton/directory) that trigger on pull request and push events targeting the onboarded branch. Those pipelines control the lifecycle of changes submitted to the repository. -
Configures a default integration test pipeline. This pipeline runs automatically after each build to evaluate the artifacts against the configured policy. The integration test definition is stored as a Custom Resource in OCP and is not visible in your Git repository.
To view the integration test Custom Resource:
oc get integrationtestscenarios -n <tenant-namespace> -
Creates CI checks on the pull request. Konflux creates checks for both GitHub and GitLab. The difference is how the integration with Konflux is managed: for GitHub, a GitHub App is created ahead of time during installation; for GitLab, the webhook is created when the repository is onboarded. Two checks appear:
-
One for the build pipeline status
-
One for the integration test pipeline status
You can click through to view logs and additional information.
-
| Do not merge this pull request yet. Configure a release first so you can see the full end-to-end flow. |
Configure a release
By default, onboarded components are not automatically released. A Platform Engineer must configure the release criteria and destination before artifacts can be released.
The release configuration process involves creating various Custom Resources in OpenShift. Use the setup-release.sh wrapper script to simplify this process.
Log in to the OCP cluster as the Platform Engineer (cluster admin) and run the script:
./setup-release.sh --application <application_name> --component <component_name>
This script creates the necessary release plan, release policy, and release pipeline resources.
Trigger a release
After you create a component and configure a release, releases happen automatically from push events.
-
Go to your Git repository and merge the pull request that Konflux created.
-
Merging triggers a push event (commit added to the target branch), which starts another build pipeline.
-
After the build pipeline succeeds, the integration test pipeline runs automatically.
-
After both pipelines pass, navigate to the Releases tab in the Konflux UI. A release starts automatically.
-
Track the release progress in the UI. At the end of the release, the image is available in a Quay repository.
Verify the build artifacts
After the build and release complete, verify the security artifacts that TSF produced:
-
Signed container image in Quay:
-
Navigate to your Quay organization. A new repository has been created with the built container image.
-
The image is signed using Red Hat Trusted Artifact Signer.
-
-
SLSA provenance and attestation:
-
The build produces SLSA Level 3 provenance that records how the image was built.
-
Attestations are signed and stored alongside the image.
-
-
SBOM in Red Hat Trusted Profile Analyzer:
-
Open the Red Hat Trusted Profile Analyzer UI.
-
The software bill of materials (SBOM) is available, showing all packages and dependencies.
-
The UI displays vulnerability reports and license information.
-
-
Signature verification:
Verify the image signature using
cosign:cosign tree <image-reference>View the Rekor transparency log entry for the signing event.
Next steps
-
Onboard more components to build your full application stack.
-
Customize the build pipeline by editing the
.tekton/files in your repository. -
Configure policy using Conforma to enforce your organization’s security requirements.
-
Configure additional integration tests to validate your builds against custom criteria.