From 61fb42c27e88447304647dcb606f737ac03862e6 Mon Sep 17 00:00:00 2001 From: Shipra Singh Date: Tue, 17 Oct 2023 15:47:21 +0530 Subject: [PATCH] RHDEVDOCS-5667: Updating install stratagies commands --- _topic_maps/_topic_map.yml | 2 +- about/ob-release-notes.adoc | 4 ++-- about/overview-openshift-builds.adoc | 4 ++-- .../installing-sample-build-strategies.adoc | 11 ++++++--- modules/ob-about-buildah.adoc | 3 +-- modules/ob-about-s2i.adoc | 4 +--- ...b-installing-all-supported-strategies.adoc | 24 +++++++++++++++++++ modules/ob-installing-buildah-strategy.adoc | 7 +++--- modules/ob-installing-s2i-strategy.adoc | 4 +++- 9 files changed, 46 insertions(+), 17 deletions(-) create mode 100644 modules/ob-installing-all-supported-strategies.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 9382ab7319b7..1c42646f1e0b 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -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 diff --git a/about/ob-release-notes.adoc b/about/ob-release-notes.adoc index e42744da72c8..7d24240d5189 100644 --- a/about/ob-release-notes.adoc +++ b/about/ob-release-notes.adoc @@ -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 diff --git a/about/overview-openshift-builds.adoc b/about/overview-openshift-builds.adoc index 820b9c03a89e..58aa1589ac46 100644 --- a/about/overview-openshift-builds.adoc +++ b/about/overview-openshift-builds.adoc @@ -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 diff --git a/installing/installing-sample-build-strategies.adoc b/installing/installing-sample-build-strategies.adoc index 0ed6d60aa9aa..7e22e10ff02e 100644 --- a/installing/installing-sample-build-strategies.adoc +++ b/installing/installing-sample-build-strategies.adoc @@ -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 @@ -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] diff --git a/modules/ob-about-buildah.adoc b/modules/ob-about-buildah.adoc index 71ec14b5c411..d5ea8383cf93 100644 --- a/modules/ob-about-buildah.adoc +++ b/modules/ob-about-buildah.adoc @@ -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. diff --git a/modules/ob-about-s2i.adoc b/modules/ob-about-s2i.adoc index 763255c725a1..e971b286b1d2 100644 --- a/modules/ob-about-s2i.adoc +++ b/modules/ob-about-s2i.adoc @@ -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. diff --git a/modules/ob-installing-all-supported-strategies.adoc b/modules/ob-installing-all-supported-strategies.adoc new file mode 100644 index 000000000000..1de400d55a0b --- /dev/null +++ b/modules/ob-installing-all-supported-strategies.adoc @@ -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 +---- diff --git a/modules/ob-installing-buildah-strategy.adoc b/modules/ob-installing-buildah-strategy.adoc index 0b7aa662cb35..6a742f242ecc 100644 --- a/modules/ob-installing-buildah-strategy.adoc +++ b/modules/ob-installing-buildah-strategy.adoc @@ -6,12 +6,13 @@ [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 @@ -19,5 +20,5 @@ You can install the `buildah` cluster build strategy, which does not require a d + [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 ---- diff --git a/modules/ob-installing-s2i-strategy.adoc b/modules/ob-installing-s2i-strategy.adoc index d43e584ac12a..62fa1339a5e2 100644 --- a/modules/ob-installing-s2i-strategy.adoc +++ b/modules/ob-installing-s2i-strategy.adoc @@ -11,6 +11,8 @@ 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 @@ -18,5 +20,5 @@ You can install the `source-to-image` strategy at cluster level. You can share t + [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 ----