Skip to content

Commit 8e3936f

Browse files
committed
RHDEVDOCS-5484-update: Updating the docs structure for Builds
1 parent 9364192 commit 8e3936f

File tree

7 files changed

+49
-9
lines changed

7 files changed

+49
-9
lines changed

_topic_maps/_topic_map.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1888,7 +1888,13 @@ Distros: openshift-enterprise,openshift-origin,openshift-online
18881888
Topics:
18891889
- Name: CI/CD overview
18901890
File: index
1891-
- Name: Builds
1891+
- Name: Builds using Shipwright
1892+
Dir: builds_using_shipwright
1893+
Distros: openshift-enterprise
1894+
Topics:
1895+
- Name: Overview of Builds
1896+
File: overview-openshift-builds
1897+
- Name: Builds using BuildConfig
18921898
Dir: builds
18931899
Distros: openshift-enterprise,openshift-origin,openshift-online
18941900
Topics:
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../_attributes/

cicd/builds_using_shipwright/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images/

cicd/builds_using_shipwright/modules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
:_content-type: ASSEMBLY
2+
[id="overview-openshift-builds"]
3+
= Overview of Builds
4+
:context: overview-openshift-builds
5+
include::_attributes/common-attributes.adoc[]
6+
7+
toc::[]
8+
9+
10+
Builds is an extensible build framework based on the link:https://shipwright.io/[Shipwright project], which you can use to build container images on an {product-title} cluster. You can build container images from source code and Dockerfiles by using image build tools, such as Source-to-Image (S2I) and Buildah. You can create and apply build resources, view logs of build runs, and manage builds in your {product-title} namespaces.
11+
12+
Builds includes the following capabilities:
13+
14+
* Standard Kubernetes-native API for building container images from source code and Dockerfiles
15+
* Support for Source-to-Image (S2I) and Buildah build strategies
16+
* Extensibility with your own custom build strategies
17+
* Execution of builds from source code in a local directory
18+
* Shipwright CLI for creating and viewing logs, and managing builds on the cluster
19+
* Integrated user experience with the *Developer* perspective of the {product-title} web console
20+
21+
22+
Builds consists of the following custom resources (CRs):
23+
24+
* `Build`
25+
* `BuildStrategy` and `ClusterBuildStrategy`
26+
* `BuildRun`

cicd/builds_using_shipwright/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../snippets/

cicd/index.adoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ toc::[]
1515
1616
[id="openshift-builds"]
1717
== OpenShift Builds
18-
With OpenShift Builds, you can create cloud-native apps by using a declarative build process. You can define the build process in a YAML file that you use to create a BuildConfig object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the BuildConfig object typically builds a runnable image and pushes it to a container image registry.
19-
20-
OpenShift Builds provides the following extensible support for build strategies:
21-
22-
* Docker build
23-
* Source-to-image (S2I) build
24-
* Custom build
25-
18+
OpenShift Builds provides you the following two options to configure and run a build:
19+
20+
* Builds using Shipwright
21+
+
22+
An extensible build framework based on the Shipwright project, which you can use to build container images on an {product-title} cluster. You can build container images from source code and Dockerfile by using image build tools, such as Source-to-Image (S2I) and Buildah.
23+
+
24+
For more information, see link:https://docs.openshift.com/builds/latest/about/overview-openshift-builds.html[Overview of Builds].
25+
26+
* Builds using BuildConfig
27+
+
28+
A declarative build process to create cloud-native apps. You can define the build process in a YAML file that you use to create a `BuildConfig` object. This definition includes attributes such as build triggers, input parameters, and source code. When deployed, the `BuildConfig` object builds a runnable image and pushes the image to a container image registry. With the `BuildConfig` object, you can create a Docker, Source-to-image (S2I), or custom build.
29+
+
2630
For more information, see xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds]
2731

2832
[id="openshift-pipelines"]

0 commit comments

Comments
 (0)