Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Example conversion of Shipwright docs to Asciidoc #1110

Closed
wants to merge 1 commit into from
Closed

Example conversion of Shipwright docs to Asciidoc #1110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
////
Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0
////
:source-highlighter: rouge
:rouge-style: monokai

= 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]
9 changes: 9 additions & 0 deletions docs/adsf.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@


:source-highlighter: rouge
:rouge-style: monokai

[source,ruby]
----
puts "Hello, Rouge!"
----
Loading