1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-8076: Add CI/CD layered docs to ROSA

This commit is contained in:
Ben Hardesty
2025-01-15 14:42:44 -05:00
committed by openshift-cherrypick-robot
parent 19376cfa59
commit 904a862dea
14 changed files with 139 additions and 101 deletions

View File

@@ -477,12 +477,11 @@ Topics:
Topics:
- Name: About CI/CD
File: index
# This can be included when Shipwright is ported.
# - Name: Builds using Shipwright
# Dir: builds_using_shipwright
# Topics:
# - Name: Overview of Builds
# File: overview-openshift-builds
- Name: Builds using Shipwright
Dir: builds_using_shipwright
Topics:
- Name: Overview of Builds
File: overview-openshift-builds
- Name: Builds using BuildConfig
Dir: builds
Topics:
@@ -516,18 +515,16 @@ Topics:
File: troubleshooting-builds
# - Name: Setting up additional trusted certificate authorities for builds
# File: setting-up-trusted-ca
# This can be included when Pipelines is ported.
# - Name: Pipelines
# Dir: pipelines
# Topics:
# - Name: About OpenShift Pipelines
# File: about-pipelines
# This can be included when GitOps is ported.
# - Name: GitOps
# Dir: gitops
# Topics:
# - Name: About OpenShift GitOps
# File: about-redhat-openshift-gitops
- Name: Pipelines
Dir: pipelines
Topics:
- Name: About OpenShift Pipelines
File: about-pipelines
- Name: GitOps
Dir: gitops
Topics:
- Name: About OpenShift GitOps
File: about-redhat-openshift-gitops
- Name: Jenkins
Dir: jenkins
Topics:
@@ -535,9 +532,8 @@ Topics:
File: images-other-jenkins
- Name: Jenkins agent
File: images-other-jenkins-agent
# Include this once Pipelines is ported:
# - Name: Migrating from Jenkins to OpenShift Pipelines
# File: migrating-from-jenkins-to-openshift-pipelines
- Name: Migrating from Jenkins to OpenShift Pipelines
File: migrating-from-jenkins-to-openshift-pipelines
- Name: Important changes to OpenShift Jenkins images
File: important-changes-to-openshift-jenkins-images
---

View File

@@ -734,12 +734,11 @@ Topics:
Topics:
- Name: About CI/CD
File: index
# This can be included when Shipwright is ported.
# - Name: Builds using Shipwright
# Dir: builds_using_shipwright
# Topics:
# - Name: Overview of Builds
# File: overview-openshift-builds
- Name: Builds using Shipwright
Dir: builds_using_shipwright
Topics:
- Name: Overview of Builds
File: overview-openshift-builds
- Name: Builds using BuildConfig
Dir: builds
Topics:
@@ -773,18 +772,16 @@ Topics:
File: troubleshooting-builds
# - Name: Setting up additional trusted certificate authorities for builds
# File: setting-up-trusted-ca
# This can be included when Pipelines is ported.
# - Name: Pipelines
# Dir: pipelines
# Topics:
# - Name: About OpenShift Pipelines
# File: about-pipelines
# This can be included when GitOps is ported.
# - Name: GitOps
# Dir: gitops
# Topics:
# - Name: About OpenShift GitOps
# File: about-redhat-openshift-gitops
- Name: Pipelines
Dir: pipelines
Topics:
- Name: About OpenShift Pipelines
File: about-pipelines
- Name: GitOps
Dir: gitops
Topics:
- Name: About OpenShift GitOps
File: about-redhat-openshift-gitops
- Name: Jenkins
Dir: jenkins
Topics:
@@ -792,9 +789,8 @@ Topics:
File: images-other-jenkins
- Name: Jenkins agent
File: images-other-jenkins-agent
# Include this when Pipelines is ported:
# - Name: Migrating from Jenkins to OpenShift Pipelines
# File: migrating-from-jenkins-to-openshift-pipelines
- Name: Migrating from Jenkins to OpenShift Pipelines
File: migrating-from-jenkins-to-openshift-pipelines
- Name: Important changes to OpenShift Jenkins images
File: important-changes-to-openshift-jenkins-images
---

View File

@@ -353,6 +353,75 @@ Topics:
- Name: Upgrading ROSA with HCP
File: rosa-hcp-upgrading
---
Name: CI/CD
Dir: cicd
Distros: openshift-rosa-hcp
Topics:
- Name: CI/CD overview
Dir: overview
Topics:
- Name: About CI/CD
File: index
- Name: Builds using Shipwright
Dir: builds_using_shipwright
Topics:
- Name: Overview of Builds
File: overview-openshift-builds
- Name: Builds using BuildConfig
Dir: builds
Topics:
- Name: Understanding image builds
File: understanding-image-builds
- Name: Understanding build configurations
File: understanding-buildconfigs
- Name: Creating build inputs
File: creating-build-inputs
- Name: Managing build output
File: managing-build-output
- Name: Using build strategies
File: build-strategies
# - Name: Custom image builds with Buildah
# File: custom-builds-buildah
- Name: Performing and configuring basic builds
File: basic-build-operations
- Name: Triggering and modifying builds
File: triggering-builds-build-hooks
- Name: Performing advanced builds
File: advanced-build-operations
- Name: Using Red Hat subscriptions in builds
File: running-entitled-builds
# Dedicated-admin cannot secure builds by strategy
# - Name: Securing builds by strategy
# File: securing-builds-by-strategy
# Dedicated-admin cannot edit build configuration resources
# - Name: Build configuration resources
# File: build-configuration
- Name: Troubleshooting builds
File: troubleshooting-builds
# - Name: Setting up additional trusted certificate authorities for builds
# File: setting-up-trusted-ca
- Name: Pipelines
Dir: pipelines
Topics:
- Name: About OpenShift Pipelines
File: about-pipelines
- Name: GitOps
Dir: gitops
Topics:
- Name: About OpenShift GitOps
File: about-redhat-openshift-gitops
- Name: Jenkins
Dir: jenkins
Topics:
- Name: Configuring Jenkins images
File: images-other-jenkins
- Name: Jenkins agent
File: images-other-jenkins-agent
- Name: Migrating from Jenkins to OpenShift Pipelines
File: migrating-from-jenkins-to-openshift-pipelines
- Name: Important changes to OpenShift Jenkins images
File: important-changes-to-openshift-jenkins-images
---
Name: Storage
Dir: storage
Distros: openshift-rosa-hcp

View File

@@ -69,7 +69,7 @@ include::modules/builds-using-build-volumes.adoc[leveloffset=+2]
// Custom build strategy
// Custom builds require cluster-admin permissions, and are
// generally discouraged for customers.
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
include::modules/builds-strategy-custom-build.adoc[leveloffset=+1]
include::modules/builds-strategy-custom-from-image.adoc[leveloffset=+2]
@@ -79,14 +79,8 @@ include::modules/builds-strategy-custom-secrets.adoc[leveloffset=+2]
include::modules/builds-strategy-custom-environment-variables.adoc[leveloffset=+2]
include::modules/images-custom.adoc[leveloffset=+2]
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
// Pipeline build strategy
// Pipeline builds are deprecated, but OpenShift Pipelines have
// not been added to the OSD/ROSA docs yet. Once added, these
// sections can be added back to the OSD/ROSA docs.
ifndef::openshift-dedicated,openshift-rosa[]
include::modules/builds-strategy-pipeline-build.adoc[leveloffset=+1]
include::modules/builds-understanding-openshift-pipeline.adoc[leveloffset=+2]
@@ -98,7 +92,6 @@ include::modules/builds-strategy-pipeline-environment-variables.adoc[leveloffset
include::modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc[leveloffset=+3]
include::modules/builds-tutorial-pipeline.adoc[leveloffset=+2]
endif::openshift-dedicated,openshift-rosa[]
//include::modules/builds-strategy-force-pull-procedure.adoc[leveloffset=+1]

View File

@@ -28,7 +28,7 @@ include::modules/builds-strategy-docker-entitled-satellite.adoc[leveloffset=+2]
* link:https://access.redhat.com/solutions/5847331[How to use builds with Red Hat Satellite subscriptions and which certificate to use]
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
// Beginning of "Running entitled builds with SharedSecret objects" section
// Tech Preview features are not included in ROSA and OSD. When this feature
@@ -38,15 +38,18 @@ ifndef::openshift-dedicated,openshift-rosa[]
include::modules/builds-running-entitled-builds-with-sharedsecret-objects.adoc[leveloffset=+1]
// End of "Running entitled builds with SharedSecret objects" section
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
[role="_additional-resources"]
== Additional resources
// The following two xrefs are not included in the OSD and ROSA docs.
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../../support/remote_health_monitoring/insights-operator-simple-access.adoc#insights-operator-simple-access[Importing simple content access certificates with Insights Operator]
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
//TODO: Add this xref when the Images book is added to ROSA HCP.
ifndef::openshift-rosa-hcp[]
* xref:../../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
endif::openshift-rosa-hcp[]
* xref:../../cicd/builds/build-strategies.adoc#build-strategies[Build strategies]

View File

@@ -14,10 +14,13 @@ include::modules/builds-webhook-triggers.adoc[leveloffset=+2]
include::modules/unauthenticated-users-system-webhook.adoc[leveloffset=+3]
// TODO: Add xref to ROSA HCP when Authentication book is added.
ifndef::openshift-rosa-hcp[]
[role="_additional-resources"]
.Additional resources
* xref:../../authentication/using-rbac.adoc#unauthenticated-users-cluster-role-bindings-concept_using-rbac[Cluster role bindings for unauthenticated groups]
endif::openshift-rosa-hcp[]
include::modules/builds-using-github-webhooks.adoc[leveloffset=+3]

View File

@@ -13,13 +13,8 @@ include::modules/builds-strategy-docker-build.adoc[leveloffset=+2]
include::modules/builds-strategy-s2i-build.adoc[leveloffset=+2]
// Custom builds require cluster-admin
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
include::modules/builds-strategy-custom-build.adoc[leveloffset=+2]
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
// Pipeline builds are deprecated, but the OpenShift Pipelines
// doc has not been added to the OSD/ROSA docs yet. Once it is
// added, this section can be included in the OSD/ROSA docs.
ifndef::openshift-dedicated,openshift-rosa[]
include::modules/builds-strategy-pipeline-build.adoc[leveloffset=+2]
endif::openshift-dedicated,openshift-rosa[]

View File

@@ -73,7 +73,7 @@ include::modules/images-other-jenkins-memory.adoc[leveloffset=+1]
// This xref points to a topic that is not currently included in the OSD and
// ROSA docs.
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* See xref:../../architecture/understanding-development.adoc#base-image-options[Base image options] for more information about the link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux_atomic_host/7/html-single/getting_started_with_containers/index#using_red_hat_base_container_images_standard_and_minimal[Red Hat Universal Base Images] (UBI).
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* xref:../../cicd/jenkins/important-changes-to-openshift-jenkins-images.adoc#important-changes-to-openshift-jenkins-images[Important changes to OpenShift Jenkins images]

View File

@@ -22,8 +22,11 @@ include::modules/customizing-the-jenkins-image-stream-tag.adoc[leveloffset=+1]
[id="additional-resources_important-changes-to-openshift-jenkins-images_{context}"]
== Additional resources
// TODO: Add xref to ROSA HCP when Images book is added.
ifndef::openshift-rosa-hcp[]
* xref:../../openshift_images/managing_images/tagging-images.adoc#images-add-tags-to-imagestreams_tagging-images[Adding tags to image streams]
* xref:../../openshift_images/image-streams-manage.adoc#images-imagestream-import_image-streams-managing[Configuring periodic importing of image stream tags]
endif::openshift-rosa-hcp[]
* xref:../../cicd/jenkins/images-other-jenkins-agent.adoc#images-other-jenkins-agent[Jenkins agent]
* link:https://catalog.redhat.com/software/containers/search?q=Jenkins%202&p=1[Certified `jenkins` images]
* link:https://catalog.redhat.com/software/containers/search?q=Jenkins%20Agent%20Base&p=1[Certified `jenkins-agent-base` images]

View File

@@ -24,4 +24,7 @@ include::modules/jt-examples-of-common-use-cases.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources
* link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[Understanding {pipelines-shortname}]
// TODO: Add xref to ROSA HCP when Authentication book is added.
ifndef::openshift-rosa-hcp[]
* xref:../../authentication/using-rbac.adoc#using-rbac[Role-based Access Control]
endif::openshift-rosa-hcp[]

View File

@@ -6,24 +6,15 @@ include::_attributes/common-attributes.adoc[]
toc::[]
// The Shipwright, Pipelines, and GitOps content is not currently included
// in the OSD and ROSA docs. As these layered products are added to the
// OSD and ROSA docs, the applicable content and xrefs below should be
// included.
{product-title} is an enterprise-ready Kubernetes platform for developers, which enables organizations to automate the application delivery process through DevOps practices, such as continuous integration (CI) and continuous delivery (CD). To meet your organizational needs, the {product-title} provides the following CI/CD solutions:
* OpenShift Builds
ifndef::openshift-dedicated,openshift-rosa[]
* {pipelines-shortname}
* OpenShift GitOps
endif::openshift-dedicated,openshift-rosa[]
* Jenkins
[id="openshift-builds"]
== OpenShift Builds
// This can be included in the OSD and ROSA docs when Shipwright is ported.
ifndef::openshift-dedicated,openshift-rosa[]
OpenShift Builds provides you the following options to configure and run a build:
* Builds using Shipwright is an extensible build framework based on the Shipwright project. You can use it 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.
@@ -33,32 +24,18 @@ For more information, see link:https://docs.redhat.com/en/documentation/builds_f
* Builds using `BuildConfig` objects is 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.
+
For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
endif::openshift-dedicated,openshift-rosa[]
// This is the same para as above, but without the unordered list.
ifdef::openshift-dedicated,openshift-rosa[]
Builds using `BuildConfig` objects is 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.
For more information, see xref:../../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understanding image builds].
endif::openshift-dedicated,openshift-rosa[]
// This can be included in OSD and ROSA when the Pipelines doc is ported.
ifndef::openshift-dedicated,openshift-rosa[]
[id="openshift-pipelines"]
== {pipelines-shortname}
{pipelines-shortname} provides a Kubernetes-native CI/CD framework to design and run each step of the CI/CD pipeline in its own container. It can scale independently to meet the on-demand pipelines with predictable outcomes.
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines[Red Hat OpenShift Pipelines].
endif::openshift-dedicated,openshift-rosa[]
// This can be included in OSD and ROSA when the GitOps doc is ported.
ifndef::openshift-dedicated,openshift-rosa[]
[id="openshift-gitops"]
== OpenShift GitOps
OpenShift GitOps is an Operator that uses Argo CD as the declarative GitOps engine. It enables GitOps workflows across multicluster OpenShift and Kubernetes infrastructure. Using OpenShift GitOps, administrators can consistently configure and deploy Kubernetes-based infrastructure and applications across clusters and development lifecycles.
For more information, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_gitops[Red Hat OpenShift GitOps].
endif::openshift-dedicated,openshift-rosa[]
[id="jenkins-ci-cd"]
== Jenkins

View File

@@ -14,7 +14,7 @@ Image stream tags grant access to the UBI by using the `registry.redhat.io` cred
.Procedure
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* To create an `ImageStreamTag` resource in the `openshift` namespace, so it is available to developers in all projects, enter the following command:
+
[source,terminal]
@@ -42,7 +42,7 @@ spec:
type: Source
----
====
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* To create an `ImageStreamTag` resource in a single project, enter the following command:
+

View File

@@ -10,9 +10,9 @@ Builds that use Red Hat subscriptions to install content must include the entitl
.Prerequisites
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* You must have access to {op-system-base-full} package repositories through your subscription. The entitlement secret to access these repositories is automatically created by the Insights Operator when your cluster is subscribed.
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
* You must have access to the cluster as a user with the `cluster-admin` role or you have permission to access secrets in the `openshift-config-managed` project.

View File

@@ -51,7 +51,7 @@ spec:
type: ConfigMap # <3>
configMap:
name: my-config # <4>
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
- name: my-csi-volume # <1>
mounts:
- destinationPath: /opt/app-root/src/some_path # <2>
@@ -62,20 +62,20 @@ ifndef::openshift-dedicated,openshift-rosa[]
readOnly: true # <6>
volumeAttributes: # <7>
attribute: value
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
----
<1> Required. A unique name.
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and does not collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
<3> Required. The type of source, `ConfigMap`, `Secret`, or `CSI`.
<4> Required. The name of the source.
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
<5> Required. The driver that provides the ephemeral CSI volume.
<6> Required. This value must be set to `true`. Provides a read-only volume.
<7> Optional. The volume attributes of the ephemeral CSI volume. Consult the CSI driver's documentation for supported attribute keys and values.
:FeatureName: Shared Resource CSI Driver
include::snippets/technology-preview.adoc[]
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
--
endif::dockerstrategy[]
@@ -107,7 +107,7 @@ spec:
type: ConfigMap # <3>
configMap:
name: my-config # <4>
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
- name: my-csi-volume # <1>
mounts:
- destinationPath: /opt/app-root/src/some_path # <2>
@@ -118,26 +118,26 @@ ifndef::openshift-dedicated,openshift-rosa[]
readOnly: true # <6>
volumeAttributes: # <7>
attribute: value
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
----
<1> Required. A unique name.
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and does not collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
<3> Required. The type of source, `ConfigMap`, `Secret`, or `CSI`.
<4> Required. The name of the source.
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
<5> Required. The driver that provides the ephemeral CSI volume.
<6> Required. This value must be set to `true`. Provides a read-only volume.
<7> Optional. The volume attributes of the ephemeral CSI volume. Consult the CSI driver's documentation for supported attribute keys and values.
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
--
endif::sourcestrategy[]
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
:FeatureName: Shared Resource CSI Driver
include::snippets/technology-preview.adoc[]
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
ifeval::["{context}" == "build-strategies-docker"]
:!dockerstrategy: