Skip to content

Commit 92091fc

Browse files
sheriff-rhsheriff-rh
authored
Merge pull request #87105 from bhardesty/osdocs-8076-cicd-layered-docs
2 parents 3231845 + b444e0c commit 92091fc

14 files changed

+139
-101
lines changed

‎_topic_maps/_topic_map_osd.yml

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -477,12 +477,11 @@ Topics:
477477
Topics:
478478
- Name: About CI/CD
479479
File: index
480-
# This can be included when Shipwright is ported.
481-
# - Name: Builds using Shipwright
482-
# Dir: builds_using_shipwright
483-
# Topics:
484-
# - Name: Overview of Builds
485-
# File: overview-openshift-builds
480+
- Name: Builds using Shipwright
481+
Dir: builds_using_shipwright
482+
Topics:
483+
- Name: Overview of Builds
484+
File: overview-openshift-builds
486485
- Name: Builds using BuildConfig
487486
Dir: builds
488487
Topics:
@@ -516,28 +515,25 @@ Topics:
516515
File: troubleshooting-builds
517516
# - Name: Setting up additional trusted certificate authorities for builds
518517
# File: setting-up-trusted-ca
519-
# This can be included when Pipelines is ported.
520-
# - Name: Pipelines
521-
# Dir: pipelines
522-
# Topics:
523-
# - Name: About OpenShift Pipelines
524-
# File: about-pipelines
525-
# This can be included when GitOps is ported.
526-
# - Name: GitOps
527-
# Dir: gitops
528-
# Topics:
529-
# - Name: About OpenShift GitOps
530-
# File: about-redhat-openshift-gitops
518+
- Name: Pipelines
519+
Dir: pipelines
520+
Topics:
521+
- Name: About OpenShift Pipelines
522+
File: about-pipelines
523+
- Name: GitOps
524+
Dir: gitops
525+
Topics:
526+
- Name: About OpenShift GitOps
527+
File: about-redhat-openshift-gitops
531528
- Name: Jenkins
532529
Dir: jenkins
533530
Topics:
534531
- Name: Configuring Jenkins images
535532
File: images-other-jenkins
536533
- Name: Jenkins agent
537534
File: images-other-jenkins-agent
538-
# Include this once Pipelines is ported:
539-
# - Name: Migrating from Jenkins to OpenShift Pipelines
540-
# File: migrating-from-jenkins-to-openshift-pipelines
535+
- Name: Migrating from Jenkins to OpenShift Pipelines
536+
File: migrating-from-jenkins-to-openshift-pipelines
541537
- Name: Important changes to OpenShift Jenkins images
542538
File: important-changes-to-openshift-jenkins-images
543539
---

‎_topic_maps/_topic_map_rosa.yml

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -734,12 +734,11 @@ Topics:
734734
Topics:
735735
- Name: About CI/CD
736736
File: index
737-
# This can be included when Shipwright is ported.
738-
# - Name: Builds using Shipwright
739-
# Dir: builds_using_shipwright
740-
# Topics:
741-
# - Name: Overview of Builds
742-
# File: overview-openshift-builds
737+
- Name: Builds using Shipwright
738+
Dir: builds_using_shipwright
739+
Topics:
740+
- Name: Overview of Builds
741+
File: overview-openshift-builds
743742
- Name: Builds using BuildConfig
744743
Dir: builds
745744
Topics:
@@ -773,28 +772,25 @@ Topics:
773772
File: troubleshooting-builds
774773
# - Name: Setting up additional trusted certificate authorities for builds
775774
# File: setting-up-trusted-ca
776-
# This can be included when Pipelines is ported.
777-
# - Name: Pipelines
778-
# Dir: pipelines
779-
# Topics:
780-
# - Name: About OpenShift Pipelines
781-
# File: about-pipelines
782-
# This can be included when GitOps is ported.
783-
# - Name: GitOps
784-
# Dir: gitops
785-
# Topics:
786-
# - Name: About OpenShift GitOps
787-
# File: about-redhat-openshift-gitops
775+
- Name: Pipelines
776+
Dir: pipelines
777+
Topics:
778+
- Name: About OpenShift Pipelines
779+
File: about-pipelines
780+
- Name: GitOps
781+
Dir: gitops
782+
Topics:
783+
- Name: About OpenShift GitOps
784+
File: about-redhat-openshift-gitops
788785
- Name: Jenkins
789786
Dir: jenkins
790787
Topics:
791788
- Name: Configuring Jenkins images
792789
File: images-other-jenkins
793790
- Name: Jenkins agent
794791
File: images-other-jenkins-agent
795-
# Include this when Pipelines is ported:
796-
# - Name: Migrating from Jenkins to OpenShift Pipelines
797-
# File: migrating-from-jenkins-to-openshift-pipelines
792+
- Name: Migrating from Jenkins to OpenShift Pipelines
793+
File: migrating-from-jenkins-to-openshift-pipelines
798794
- Name: Important changes to OpenShift Jenkins images
799795
File: important-changes-to-openshift-jenkins-images
800796
---

‎_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,75 @@ Topics:
353353
- Name: Upgrading ROSA with HCP
354354
File: rosa-hcp-upgrading
355355
---
356+
Name: CI/CD
357+
Dir: cicd
358+
Distros: openshift-rosa-hcp
359+
Topics:
360+
- Name: CI/CD overview
361+
Dir: overview
362+
Topics:
363+
- Name: About CI/CD
364+
File: index
365+
- Name: Builds using Shipwright
366+
Dir: builds_using_shipwright
367+
Topics:
368+
- Name: Overview of Builds
369+
File: overview-openshift-builds
370+
- Name: Builds using BuildConfig
371+
Dir: builds
372+
Topics:
373+
- Name: Understanding image builds
374+
File: understanding-image-builds
375+
- Name: Understanding build configurations
376+
File: understanding-buildconfigs
377+
- Name: Creating build inputs
378+
File: creating-build-inputs
379+
- Name: Managing build output
380+
File: managing-build-output
381+
- Name: Using build strategies
382+
File: build-strategies
383+
# - Name: Custom image builds with Buildah
384+
# File: custom-builds-buildah
385+
- Name: Performing and configuring basic builds
386+
File: basic-build-operations
387+
- Name: Triggering and modifying builds
388+
File: triggering-builds-build-hooks
389+
- Name: Performing advanced builds
390+
File: advanced-build-operations
391+
- Name: Using Red Hat subscriptions in builds
392+
File: running-entitled-builds
393+
# Dedicated-admin cannot secure builds by strategy
394+
# - Name: Securing builds by strategy
395+
# File: securing-builds-by-strategy
396+
# Dedicated-admin cannot edit build configuration resources
397+
# - Name: Build configuration resources
398+
# File: build-configuration
399+
- Name: Troubleshooting builds
400+
File: troubleshooting-builds
401+
# - Name: Setting up additional trusted certificate authorities for builds
402+
# File: setting-up-trusted-ca
403+
- Name: Pipelines
404+
Dir: pipelines
405+
Topics:
406+
- Name: About OpenShift Pipelines
407+
File: about-pipelines
408+
- Name: GitOps
409+
Dir: gitops
410+
Topics:
411+
- Name: About OpenShift GitOps
412+
File: about-redhat-openshift-gitops
413+
- Name: Jenkins
414+
Dir: jenkins
415+
Topics:
416+
- Name: Configuring Jenkins images
417+
File: images-other-jenkins
418+
- Name: Jenkins agent
419+
File: images-other-jenkins-agent
420+
- Name: Migrating from Jenkins to OpenShift Pipelines
421+
File: migrating-from-jenkins-to-openshift-pipelines
422+
- Name: Important changes to OpenShift Jenkins images
423+
File: important-changes-to-openshift-jenkins-images
424+
---
356425
Name: Storage
357426
Dir: storage
358427
Distros: openshift-rosa-hcp

‎cicd/builds/build-strategies.adoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ include::modules/builds-using-build-volumes.adoc[leveloffset=+2]
6969
// Custom build strategy
7070
// Custom builds require cluster-admin permissions, and are
7171
// generally discouraged for customers.
72-
ifndef::openshift-dedicated,openshift-rosa[]
72+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7373
include::modules/builds-strategy-custom-build.adoc[leveloffset=+1]
7474

7575
include::modules/builds-strategy-custom-from-image.adoc[leveloffset=+2]
@@ -79,14 +79,8 @@ include::modules/builds-strategy-custom-secrets.adoc[leveloffset=+2]
7979
include::modules/builds-strategy-custom-environment-variables.adoc[leveloffset=+2]
8080

8181
include::modules/images-custom.adoc[leveloffset=+2]
82-
endif::openshift-dedicated,openshift-rosa[]
82+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
8383

84-
// Pipeline build strategy
85-
// Pipeline builds are deprecated, but OpenShift Pipelines have
86-
// not been added to the OSD/ROSA docs yet. Once added, these
87-
// sections can be added back to the OSD/ROSA docs.
88-
89-
ifndef::openshift-dedicated,openshift-rosa[]
9084
include::modules/builds-strategy-pipeline-build.adoc[leveloffset=+1]
9185

9286
include::modules/builds-understanding-openshift-pipeline.adoc[leveloffset=+2]
@@ -98,7 +92,6 @@ include::modules/builds-strategy-pipeline-environment-variables.adoc[leveloffset
9892
include::modules/builds-strategy-pipeline-mapping-buildconfig-jenkins.adoc[leveloffset=+3]
9993

10094
include::modules/builds-tutorial-pipeline.adoc[leveloffset=+2]
101-
endif::openshift-dedicated,openshift-rosa[]
10295

10396
//include::modules/builds-strategy-force-pull-procedure.adoc[leveloffset=+1]
10497

‎cicd/builds/running-entitled-builds.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::modules/builds-strategy-docker-entitled-satellite.adoc[leveloffset=+2]
2828

2929
* link:https://access.redhat.com/solutions/5847331[How to use builds with Red Hat Satellite subscriptions and which certificate to use]
3030

31-
ifndef::openshift-dedicated,openshift-rosa[]
31+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3232
// Beginning of "Running entitled builds with SharedSecret objects" section
3333

3434
// Tech Preview features are not included in ROSA and OSD. When this feature
@@ -38,15 +38,18 @@ ifndef::openshift-dedicated,openshift-rosa[]
3838
include::modules/builds-running-entitled-builds-with-sharedsecret-objects.adoc[leveloffset=+1]
3939

4040
// End of "Running entitled builds with SharedSecret objects" section
41-
endif::openshift-dedicated,openshift-rosa[]
41+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4242

4343
[role="_additional-resources"]
4444
== Additional resources
4545

4646
// The following two xrefs are not included in the OSD and ROSA docs.
47-
ifndef::openshift-dedicated,openshift-rosa[]
47+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4848
* xref:../../support/remote_health_monitoring/insights-operator-simple-access.adoc#insights-operator-simple-access[Importing simple content access certificates with Insights Operator]
4949
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
50-
endif::openshift-dedicated,openshift-rosa[]
50+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
51+
//TODO: Add this xref when the Images book is added to ROSA HCP.
52+
ifndef::openshift-rosa-hcp[]
5153
* xref:../../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
54+
endif::openshift-rosa-hcp[]
5255
* xref:../../cicd/builds/build-strategies.adoc#build-strategies[Build strategies]

‎cicd/builds/triggering-builds-build-hooks.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,13 @@ include::modules/builds-webhook-triggers.adoc[leveloffset=+2]
1414

1515
include::modules/unauthenticated-users-system-webhook.adoc[leveloffset=+3]
1616

17+
// TODO: Add xref to ROSA HCP when Authentication book is added.
18+
ifndef::openshift-rosa-hcp[]
1719
[role="_additional-resources"]
1820
.Additional resources
1921
2022
* xref:../../authentication/using-rbac.adoc#unauthenticated-users-cluster-role-bindings-concept_using-rbac[Cluster role bindings for unauthenticated groups]
23+
endif::openshift-rosa-hcp[]
2124
2225
include::modules/builds-using-github-webhooks.adoc[leveloffset=+3]
2326

‎cicd/builds/understanding-image-builds.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ include::modules/builds-strategy-docker-build.adoc[leveloffset=+2]
1313
include::modules/builds-strategy-s2i-build.adoc[leveloffset=+2]
1414

1515
// Custom builds require cluster-admin
16-
ifndef::openshift-dedicated,openshift-rosa[]
16+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1717
include::modules/builds-strategy-custom-build.adoc[leveloffset=+2]
18-
endif::openshift-dedicated,openshift-rosa[]
18+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919

20-
// Pipeline builds are deprecated, but the OpenShift Pipelines
21-
// doc has not been added to the OSD/ROSA docs yet. Once it is
22-
// added, this section can be included in the OSD/ROSA docs.
23-
ifndef::openshift-dedicated,openshift-rosa[]
2420
include::modules/builds-strategy-pipeline-build.adoc[leveloffset=+2]
25-
endif::openshift-dedicated,openshift-rosa[]

‎cicd/jenkins/images-other-jenkins.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ include::modules/images-other-jenkins-memory.adoc[leveloffset=+1]
7373

7474
// This xref points to a topic that is not currently included in the OSD and
7575
// ROSA docs.
76-
ifndef::openshift-dedicated,openshift-rosa[]
76+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7777
* 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).
78-
endif::openshift-dedicated,openshift-rosa[]
78+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7979
* xref:../../cicd/jenkins/important-changes-to-openshift-jenkins-images.adoc#important-changes-to-openshift-jenkins-images[Important changes to OpenShift Jenkins images]

‎cicd/jenkins/important-changes-to-openshift-jenkins-images.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ include::modules/customizing-the-jenkins-image-stream-tag.adoc[leveloffset=+1]
2222
[id="additional-resources_important-changes-to-openshift-jenkins-images_{context}"]
2323
== Additional resources
2424

25+
// TODO: Add xref to ROSA HCP when Images book is added.
26+
ifndef::openshift-rosa-hcp[]
2527
* xref:../../openshift_images/managing_images/tagging-images.adoc#images-add-tags-to-imagestreams_tagging-images[Adding tags to image streams]
2628
* xref:../../openshift_images/image-streams-manage.adoc#images-imagestream-import_image-streams-managing[Configuring periodic importing of image stream tags]
29+
endif::openshift-rosa-hcp[]
2730
* xref:../../cicd/jenkins/images-other-jenkins-agent.adoc#images-other-jenkins-agent[Jenkins agent]
2831
* link:https://catalog.redhat.com/software/containers/search?q=Jenkins%202&p=1[Certified `jenkins` images]
2932
* link:https://catalog.redhat.com/software/containers/search?q=Jenkins%20Agent%20Base&p=1[Certified `jenkins-agent-base` images]

‎cicd/jenkins/migrating-from-jenkins-to-openshift-pipelines.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,7 @@ include::modules/jt-examples-of-common-use-cases.adoc[leveloffset=+1]
2424
[role="_additional-resources"]
2525
== Additional resources
2626
* link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[Understanding {pipelines-shortname}]
27+
// TODO: Add xref to ROSA HCP when Authentication book is added.
28+
ifndef::openshift-rosa-hcp[]
2729
* xref:../../authentication/using-rbac.adoc#using-rbac[Role-based Access Control]
30+
endif::openshift-rosa-hcp[]

0 commit comments

Comments
 (0)