Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Distros: openshift-builds
Topics:
- Name: Installing Builds
File: installing-openshift-builds
- Name: Installing sample build strategies
- Name: Installing build strategies
File: installing-sample-build-strategies
---
Name: Configure
Expand Down
4 changes: 2 additions & 2 deletions about/ob-release-notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ toc::[]

Release notes contain information about new and deprecated features, breaking changes, and known issues. The following release notes apply for the most recent {builds-shortname} releases on {ocp-product-title}.

{builds-shortname} is an extensible build framework based on the link:https://shipwright.io/[Shipwright project], which you can use to build container images on an {ocp-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. You can create and apply build resources, view logs of build runs, and manage builds in your {ocp-product-title} namespaces.
{builds-shortname} is an extensible build framework based on the link:https://shipwright.io/[Shipwright project], which you can use to build container images on an {ocp-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 {ocp-product-title} namespaces.

{builds-shortname} includes the following capabilities:

* Standard Kubernetes-native API for building container images from source code and Dockerfile
* Standard Kubernetes-native API for building container images from source code and Dockerfiles
* Support for Source-to-Image (S2I) and Buildah build strategies
* Extensibility with your own custom build strategies
* Execution of builds from source code in a local directory
Expand Down
4 changes: 2 additions & 2 deletions about/overview-openshift-builds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ include::_attributes/common-attributes.adoc[]
toc::[]


{builds-shortname} is an extensible build framework based on the link:https://shipwright.io/[Shipwright project], which you can use to build container images on an {ocp-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. You can create and apply build resources, view logs of build runs, and manage builds in your {ocp-product-title} namespaces.
{builds-shortname} is an extensible build framework based on the link:https://shipwright.io/[Shipwright project], which you can use to build container images on an {ocp-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 {ocp-product-title} namespaces.

{builds-shortname} includes the following capabilities:

* Standard Kubernetes-native API for building container images from source code and Dockerfile
* Standard Kubernetes-native API for building container images from source code and Dockerfiles
* Support for Source-to-Image (S2I) and Buildah build strategies
* Extensibility with your own custom build strategies
* Execution of builds from source code in a local directory
Expand Down
11 changes: 8 additions & 3 deletions installing/installing-sample-build-strategies.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="installing-sample-build-strategies"]
= Installing sample build strategies
= Installing build strategies
include::_attributes/common-attributes.adoc[]
:context: installing-sample-build-strategies

Expand All @@ -27,7 +27,12 @@ include::modules/ob-about-s2i.adoc[leveloffset=+1]

include::modules/ob-installing-s2i-strategy.adoc[leveloffset=+2]

include::modules/ob-installing-all-supported-strategies.adoc[leveloffset=+1]

// [role="_additional-resources"]
// == Additional resources

[role="_additional-resources"]
[id="additional-resources_installing-sample-build-strategies"]
== Additional resources

* xref:../installing/installing-openshift-builds#installing-builds-with-operator_installing-openshift-builds[Installing {builds-shortname} by using the web console]
* xref:../installing/installing-openshift-builds#creating-a-shipwright-build-resource-console_installing-openshift-builds[Creating a ShipwrightBuild resource by using the web console]
3 changes: 1 addition & 2 deletions modules/ob-about-buildah.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@
[id="about-buildah_{context}"]
= Buildah

The `buildah` cluster build strategy uses a Dockerfile to build and push a container image. You must specify the Dockerfile in your `Build` CR.
The `buildah` cluster build strategy uses a Dockerfile to build a container image and pushes it to the target registry. You must specify the Dockerfile in the `spec.paramValues` field of the `Build` CR.

You can install the `buildah` strategy at cluster level.
4 changes: 1 addition & 3 deletions modules/ob-about-s2i.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@
[id="about-s2i_{context}"]
= Source-to-image

This build strategy is composed of `source-to-image` and `buildah` strategies. You can use this strategy to generate a container file and prepare the application to build with a builder image.

The `source-to-image` strategy requires a specially crafted builder image, which you can pass as a parameter in the `spec.paramValues` field of the `Build` CR.
This build strategy is composed of `source-to-image` and `buildah`. You can use this strategy to generate a container file and prepare the application to build with a builder image. You must specify the builder image in the `spec.paramValues` field of the `Build` CR.
24 changes: 24 additions & 0 deletions modules/ob-installing-all-supported-strategies.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// This module is included in the following assembly:
//
// * installing/installing-sample-build-strategies.adoc

:_content-type: PROCEDURE
[id="ob-installing-all-supported-strategies_{context}"]
= Installing all supported strategies

You can install all the supported cluster build strategies by executing a single command.

.Prerequisites

* You have installed the `oc` CLI.
* You have installed the {builds-operator}.
* You have created a `ShipwrightBuild` resource.

.Procedure

* To install all the supported cluster build strategies, run the following command:
+
[source,terminal]
----
$ oc apply -f https://github.com/redhat-developer/openshift-builds-catalog/releases/download/0.1.0/release-strategies.yaml
----
7 changes: 4 additions & 3 deletions modules/ob-installing-buildah-strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@
[id="installing-buildah-strategy_{context}"]
= Installing buildah strategy

You can install the `buildah` cluster build strategy, which does not require a daemon to run and is available for unprivileged users. By using the `buildah-strategy-managed-push` resource for installing `buildah`, you can push the image to the target repository without any further processing.

You can install the `buildah` strategy at cluster level. You can share the `buildah` strategy across different namespaces within your cluster by installing it at cluster level.

.Prerequisites

* You have installed the `oc` CLI.
* You have installed the {builds-operator}.
* You have created a `ShipwrightBuild` resource.
.Procedure

* To install the `buildah` strategy, run the following command:
+
[source,terminal]
----
$ oc apply -f https://raw.githubusercontent.com/shipwright-io/build/main/samples/buildstrategy/buildah/buildstrategy_buildah_strategy_managed_push_cr.yaml
$ oc apply -f https://raw.githubusercontent.com/redhat-developer/openshift-builds-catalog/main/clusterBuildStrategy/buildah/buildah.yaml
----
4 changes: 3 additions & 1 deletion modules/ob-installing-s2i-strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ You can install the `source-to-image` strategy at cluster level. You can share t
.Prerequisites

* You have installed the `oc` CLI.
* You have installed the {builds-operator}.
* You have created a `ShipwrightBuild` resource.

.Procedure

* To install the `source-to-image` strategy at cluster level, run the following command:
+
[source,terminal]
----
$ oc apply -f https://raw.githubusercontent.com/shipwright-io/build/main/samples/buildstrategy/source-to-image/buildstrategy_source-to-image-redhat_cr.yaml
$ oc apply -f https://raw.githubusercontent.com/redhat-developer/openshift-builds-catalog/main/clusterBuildStrategy/source-to-image/source_to_image.yaml
----