Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 11d01af

Browse files
authored
Merge pull request #115 from Chr1st1anSears/update-upgrading-pipeline-doc
Updates doc per dev feedback
2 parents 07c0f45 + 8296bbf commit 11d01af

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/modules/ROOT/pages/how-to-guides/proc_upgrade_build_pipeline.adoc

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
= Upgrading the build pipeline
22

3-
To reinforce the security of your application, and to customize the way that {ProductName} builds the components of your application, you must upgrade your build pipeline.
3+
By default, {ProductName} builds the components of your applications using, as the name suggests, the default build pipeline. This pipeline offers quick and easy containerized deployment. It also secures your supply chain, by conforming to the specification for SLSA Build Level 3.
44

5-
By default, {ProductName} builds the components of applications using, as the name suggests, the default build pipeline. This pipeline offers quick and easy containerized deployment. Default build pipelines also create, for each component, the same three container images as upgraded build pipelines:
5+
However, there are three reasons you might want to upgrade your build pipeline to a custom build:
66

7-
* A business application container image, which runs when your component deploys
8-
* A signature image, to verify that the business application container image came from a trusted source
9-
* An attestation image, to verify who built the component, how it was built, and if it was built correctly
10-
11-
However, the default build pipeline skips many tasks that {ProductName} can perform to further secure your application. Again, to perform these checks and scans on any given component, you must upgrade that component’s build pipeline.
7+
* Customize: Upgrading the build pipeline enables you to tailor the build process that {ProductName} uses for the components of your application, to better meet your specific needs.
8+
* Reinforce security: When you upgrade, {ProductName} adds a variety of security checks and scans on your pipeline that get run on each build.
9+
* Continuous integration: Upgraded build pipelines automatically rebuild your components every time a new commit is merged into the main branch of their repositories.
1210
1311
.Prerequisites
1412

1513
* You must have an application that {ProductName} has successfully built and deployed using the default build pipeline.
1614
1715
.Procedure
16+
1817
To upgrade the build pipeline:
1918

2019
. In the *Overview* tab of your application, scroll down and select *Manage build pipelines*.
@@ -32,13 +31,21 @@ If you want to restrict the GitHub application’s access to certain repositorie
3231
. Let {ProductName} complete another PipelineRun for the newly-upgraded build pipeline.
3332

3433
.Verification
34+
3535
Confirm that most of the build pipeline tasks that {ProductName} previously skipped are now included in the recent PipelineRun:
3636

3737
. Go to *Activity > Pipeline runs*.
3838
. Select the most recent *PipelineRun*.
3939
. View the build pipeline tasks and scroll down to view the vulnerabilities scan, which summarizes the results of the `clair-scan`.
4040

41+
.Updates
42+
43+
If you upgrade your build pipeline for a component, then whenever we release a new `build-definition` for upgraded pipelines, the {ProductName} bot submits a pull request (PR) to the git repository of your component. These PRs only change the `.tekton` directory of the component repository; they do not alter the source code specific to your component in any way.
44+
45+
When you see a PR from the {ProductName} bot, please merge it to keep your pipeline updated. If you do not merge these PRs, {ProductName} might not be able to build or test your components correctly.
46+
4147
.Customization
48+
4249
After upgrading the build pipeline, you can also customize it:
4350

4451
. Upgrade the build pipeline of your component, as previously described.

0 commit comments

Comments
 (0)