Skip to content

Commit

Permalink
RHDEVDOCS-3863 Prep two Shipwright docs for downstream
Browse files Browse the repository at this point in the history
  • Loading branch information
rolfedh committed May 2, 2022
1 parent bd929cb commit f689ba2
Show file tree
Hide file tree
Showing 7 changed files with 2,548 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
////
Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0
////
= Build Controllers

Build or codenamed *build-v2* is an API open-source implementation that build container-images on Kubernetes from a _dockerfile-based_ or a _source-based_ approach.

The whole idea of *Build* is to hide the details of image construction from an application developer, by defining https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Custom Resources] that the *Build* understands.

Through the *Build* CRD´s the user can specify a desired popular strategy, like *source-to-image*, *buildpack-v3*, *kaniko*, *jib* and *buildah*, in order to build an image.

From a high-level perspective:

* xref:build.adoc[`Build`] hosts the user provide information. This defines the strategy, source input and the desired output(_e.g. container registry_).
* xref:buildrun.adoc[`BuildRun`] hosts the details of an image construction, abstracting this from the user and taking advantage of the Tekton Pipelines task to build the image.
* xref:buildstrategies.adoc[`BuildStrategy`] hosts a list of steps to execute in the Tekton Task definition during the *BuildRun* execution.
* xref:buildstrategies.adoc[`ClusterBuildStrategy`] similar to the *BuildStrategy* but it is _cluster-scoped_.
== Learn more

See the following docs referencing each of the Kubernetes resources currently supported:

* xref:build.adoc[`Build`]
* xref:buildrun.adoc[`BuildRun`]
* xref:buildstrategies.adoc[`BuildStrategy`]
* xref:buildstrategies.adoc[`ClusterBuildStrategy`]

== Controllers Flow

The following image illustrate the interactions between the `Build`, `BuildRun` controller and the Tekton `Pipeline` controller.

image::controllers_flow.png[controllers flow]
Loading

0 comments on commit f689ba2

Please sign in to comment.