Skip to content

Commit 45ec16f

Browse files
stevsmitSteven Smith
and
Steven Smith
authored
Migrates content from Using to Builders (#1111)
* Migrates content from Using to Builders * Second commit for Github OAuth info --------- Co-authored-by: Steven Smith <[email protected]>
1 parent dd46d96 commit 45ec16f

27 files changed

+996
-1215
lines changed

builders_and_image_automation/master.adoc

+27-17
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,39 @@ include::modules/attributes.adoc[]
55
= Builders and image automation
66
:context: quay-builders-image-automation
77

8+
The following guide shows you how to configure the {productname} _builds_ feature on both bare metal and virtual machines.
89

10+
include::modules/builds-overview.adoc[leveloffset=+1]
11+
include::modules/proc_use-quay-build-dockerfiles.adoc[leveloffset=+2]
12+
include::modules/configuring-openshift-tls-component-builds.adoc[leveloffset=+1]
913

10-
//need to be moved out in a future pr
11-
//docker files
14+
//bare metal builders
1215
include::modules/proc_use-quay-build-workers-dockerfiles.adoc[leveloffset=+1]
13-
include::modules/proc_use-quay-build-dockerfiles.adoc[leveloffset=+1]
14-
15-
//custom trigger
16-
include::modules/proc_use-quay-git-trigger.adoc[leveloffset=+2]
17-
18-
//include::modules/proc_use-quay-skip-trigger.adoc[leveloffset=+1]
19-
20-
//include::modules/proc_github-build-triggers.adoc[leveloffset=+1]
21-
22-
16+
include::modules/prepare-ocp-for-bare-metal-builds.adoc[leveloffset=+2]
17+
ifdef::upstream[]
18+
include::modules/setting-up-builds-aws.adoc[leveloffset=+3]
19+
endif::upstream[]
20+
include::modules/openshift-routes-limitations.adoc[leveloffset=+3]
2321

2422
// Virtual builders
2523
include::modules/build-enhancements.adoc[leveloffset=+1]
26-
include::modules/build-enhanced-arch.adoc[leveloffset=+2]
27-
include::modules/build-limitations.adoc[leveloffset=+2]
2824
include::modules/builders-virtual-environment.adoc[leveloffset=+2]
25+
include::modules/red-hat-quay-s3-bucket-modify.adoc[leveloffset=+3]
26+
include::modules/red-hat-quay-gcp-bucket-modify.adoc[leveloffset=+3]
27+
28+
//Starting a new build
29+
include::modules/starting-a-build.adoc[leveloffset=+1]
30+
31+
//Build triggers with UI
32+
include::modules/build-trigger-overview.adoc[leveloffset=+1]
33+
include::modules/red-hat-quay-builders-ui.adoc[leveloffset=+2]
34+
include::modules/proc_use-quay-git-trigger.adoc[leveloffset=+3]
35+
include::modules/understanding-tag-naming-build-triggers.adoc[leveloffset=+3]
36+
include::modules/skipping-source-control-triggered-build.adoc[leveloffset=+3]
37+
include::modules/manually-triggering-a-build-trigger.adoc[leveloffset=+2]
2938

39+
// Github OAUTH
40+
include::modules/proc_github-app.adoc[leveloffset=+1]
3041

31-
//cosign
32-
//include::modules/cosign-oci-intro.adoc[leveloffset=+2]
33-
//include::modules/cosign-oci-with-quay.adoc[leveloffset=+2]
42+
//Troubleshooting
43+
include::modules/troubleshooting-builds.adoc[leveloffset=+1]

images/register-app.png

-96.9 KB
Loading

images/view-credentials.png

-239 KB
Loading

modules/build-enhancements.adoc

+11-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
:_content-type: PROCEDURE
22
[id="red-hat-quay-builders-enhancement"]
3-
= {productname} build enhancements
3+
= Virtual builds with {productname-ocp}
44

5-
{productname} builds can be run on virtualized platforms. Backwards compatibility to run previous build configurations are also available.
5+
_Virtual builds_ can be run on virtualized machines with {productname-ocp}. With this method, the _build manager_ first creates the `Job Object` resource. Then, the `Job Object` creates a pod using the `quay-builder-image`. The `quay-builder-image` contains the `quay-builder` binary and the Podman service. The created pod runs as `unprivileged`. The `quay-builder` binary then builds the image while communicating status and retrieving build information from the _build manager_.
6+
7+
[id="quay-builds-limitations"]
8+
== Virtual builds limitations
9+
10+
The following limitations apply to the _virtual builds_ feature:
11+
12+
* Running _virtual builds_ with {productname-ocp} in an unprivileged context might cause some commands that were working under the previous build strategy to fail. Attempts to change the build strategy could potentially cause performance issues and reliability with the build.
13+
14+
* Running _virtual builds_ directly in a container does not have the same isolation as using virtual machines. Changing the build environment might also cause builds that were previously working to fail.

modules/build-pre-configuration.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:_content-type: CONCEPT
2+
[id="build-pre-configuration"]
3+
= Setting up {productname} builders with {ocp}
4+
5+
You must pre-configure {productname-ocp} to allow the use of the _builder_ workers before using the _builds_ feature.

modules/build-trigger-overview.adoc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:_content-type: PROCEDURE
2+
[id="build-trigger-overview"]
3+
= Build triggers
4+
5+
_Build triggers_ are automated mechanisms that start a container image build when specific conditions are met, such as changes to source code, updates to dependencies, or link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/use_red_hat_quay/#webhook[creating a webhook call]. These triggers help automate the image-building process and ensure that the container images are always up-to-date without manual intervention.
6+
7+
The following sections cover content related to creating a build trigger, tag naming conventions, how to skip a source control-triggered build, starting a _build_, or manually triggering a _build_.

0 commit comments

Comments
 (0)