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
126 changes: 67 additions & 59 deletions _topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,6 @@ Topics:
- Name: Red Hat Enterprise Linux CoreOS
File: architecture-rhcos
Distros: openshift-enterprise,openshift-webscale
- Name: The CI/CD methodology and practice
File: cicd_gitops
Distros: openshift-enterprise,openshift-webscale
- Name: Using ArgoCD
File: argocd
- Name: Admission plug-ins
File: admission-plug-ins
Distros: openshift-enterprise,openshift-webscale,openshift-aro
Expand Down Expand Up @@ -1194,64 +1189,77 @@ Topics:
- Name: Red Hat Operators reference
File: operator-reference
---
Name: Builds
Dir: builds
Name: CI/CD
Dir: cicd
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
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
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Performing basic builds
File: basic-build-operations
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
- Name: Triggering and modifying builds
File: triggering-builds-build-hooks
- Name: Builds
Dir: builds
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
- Name: Performing advanced builds
File: advanced-build-operations
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Using Red Hat subscriptions in builds
File: running-entitled-builds
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Securing builds by strategy
File: securing-builds-by-strategy
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Build configuration resources
File: build-configuration
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Troubleshooting builds
File: troubleshooting-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
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Performing basic builds
File: basic-build-operations
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
- Name: Triggering and modifying builds
File: triggering-builds-build-hooks
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
- Name: Performing advanced builds
File: advanced-build-operations
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Using Red Hat subscriptions in builds
File: running-entitled-builds
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Securing builds by strategy
File: securing-builds-by-strategy
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Build configuration resources
File: build-configuration
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Troubleshooting builds
File: troubleshooting-builds
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Setting up additional trusted certificate authorities for builds
File: setting-up-trusted-ca
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
- Name: Pipelines
Dir: pipelines
Distros: openshift-enterprise,openshift-webscale,openshift-origin
- Name: Setting up additional trusted certificate authorities for builds
File: setting-up-trusted-ca
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
---
Name: Pipelines
Dir: pipelines
Distros: openshift-enterprise,openshift-webscale,openshift-origin
Topics:
- Name: Understanding OpenShift Pipelines
File: understanding-openshift-pipelines
- Name: Installing OpenShift Pipelines
File: installing-pipelines
- Name: Uninstalling OpenShift Pipelines
File: uninstalling-pipelines
- Name: Creating CI/CD solutions for applications using OpenShift Pipelines
File: creating-applications-with-cicd-pipelines
- Name: Working with Pipelines using the Developer perspective
File: working-with-pipelines-using-the-developer-perspective
- Name: OpenShift Pipelines release notes
File: op-release-notes
Topics:
- Name: Understanding OpenShift Pipelines
File: understanding-openshift-pipelines
- Name: Installing OpenShift Pipelines
File: installing-pipelines
- Name: Uninstalling OpenShift Pipelines
File: uninstalling-pipelines
- Name: Creating CI/CD solutions for applications using OpenShift Pipelines
File: creating-applications-with-cicd-pipelines
- Name: Working with Pipelines using the Developer perspective
File: working-with-pipelines-using-the-developer-perspective
- Name: OpenShift Pipelines release notes
File: op-release-notes
#- Name: GitOps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this added, commented out? Or should that happen in a different PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we want to add this, and the entire reorg was initiated due to this component. But we don't have the content in place yet. Hence commented out. Is there a concern merging this commented out?
In the content PR we will add this with changes in the title as required, is that OK? This will come in slightly later, we spoke to Vikram and have an exception for this. Basically this component has an async release cycle from that of OCP.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay.

# Dir: gitops
# Distros: openshift-enterprise,openshift-webscale,openshift-origin
# Topics:
# - Name: Understanding OpenShift GitOps
# File: understanding-openshift-gitops
# - Name: Installing OpenShift GitOps Operator
# File: installing-openshift-gitops-operator
# - Name: Getting started with OpenShift GitOps
# File: getting-satrted-with-openshift-gitops
---
Name: Images
Dir: openshift_images
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The *Developer* perspective in the web console provides you the following option
* *Helm Chart*: Explore the *Developer Catalog* to select the required Helm chart to simplify deployment of applications and services.

ifdef::openshift-enterprise,openshift-webscale[]
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines], xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[OpenShift Serverless], and xref:../../virt/install/installing-virt-web.adoc#virt-subscribing-to-the-catalog_installing-virt-web[OpenShift Virtualization] Operators are installed, respectively.
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines], xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#serverless-install-web-console_installing-openshift-serverless[OpenShift Serverless], and xref:../../virt/install/installing-virt-web.adoc#virt-subscribing-to-the-catalog_installing-virt-web[OpenShift Virtualization] Operators are installed, respectively.
endif::[]

== Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion applications/pruning-objects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::modules/pruning-groups.adoc[leveloffset=+1]
include::modules/pruning-deployments.adoc[leveloffset=+1]
include::modules/pruning-builds.adoc[leveloffset=+1]
.Additional resources
- xref:../builds/advanced-build-operations.adoc#builds-build-pruning-advanced-build-operations[Performing advanced builds -> Pruning builds]
- xref:../cicd/builds/advanced-build-operations.adoc#builds-build-pruning-advanced-build-operations[Performing advanced builds -> Pruning builds]

include::modules/pruning-images.adoc[leveloffset=+1]
include::modules/pruning-images-manual.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion architecture/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ include::modules/architecture-platform-benefits.adoc[leveloffset=+2]
== User facing components
* Workloads (Deployments, Jobs, ReplicaSets, etc)
* Operator Lifecycle Manager
* xref:../builds/understanding-image-builds.adoc[Builds] - The build component
* xref:../cicd/builds/understanding-image-builds.adoc[Builds] - The build component
provides an API and infrastructure for producing new container images using a
variety of techniques including industry standard Dockerfiles and publishing
them to either the cluster image registry, or an external registry. It also
Expand Down
2 changes: 1 addition & 1 deletion architecture/understanding-development.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ to push and pull images.
ifdef::openshift-origin,openshift-enterprise,openshift-webscale[]
For more details on the process of building container images, pushing them to
registries, and running them, see
xref:../builds/custom-builds-buildah.adoc#custom-builds-buildah[Custom image builds with Buildah].
xref:../cicd/builds/custom-builds-buildah.adoc#custom-builds-buildah[Custom image builds with Buildah].
endif::openshift-origin,openshift-enterprise,openshift-webscale[]

[id="container-build-tool-options"]
Expand Down
1 change: 0 additions & 1 deletion builds/images

This file was deleted.

1 change: 0 additions & 1 deletion builds/modules

This file was deleted.

File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ trusted with administrative privileges on the cluster.

== Prerequisites

* Review how to xref:../builds/securing-builds-by-strategy.adoc#securing-builds-by-strategy[grant custom build permissions].
* Review how to xref:../../cicd/builds/securing-builds-by-strategy.adoc#securing-builds-by-strategy[grant custom build permissions].


include::modules/builds-create-custom-build-artifacts.adoc[leveloffset=+1]
Expand Down
1 change: 1 addition & 0 deletions cicd/builds/images
1 change: 1 addition & 0 deletions cicd/builds/modules
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ include::modules/builds-strategy-docker-squash-layers.adoc[leveloffset=+1]

== Additional resources

* See xref:../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
* See xref:../../openshift_images/image-streams-manage.adoc#image-streams-managing[Managing image streams]
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ include::modules/configmap-adding-ca.adoc[leveloffset=+1]

* link:https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#create-a-configmap[Create a `ConfigMap`]
* link:https://kubectl.docs.kubernetes.io/guides/config_management/secrets_configmaps/[Secrets and `ConfigMaps`]
* xref:../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI]
* xref:../../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI]
endif::[]


Expand Down
1 change: 1 addition & 0 deletions cicd/gitops/images
1 change: 1 addition & 0 deletions cicd/gitops/modules
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ This section uses the `pipelines-tutorial` example to demonstrate the preceding
== Prerequisites

* You have access to an {product-title} cluster.
* You have installed xref:../pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines] using the {pipelines-title} Operator listed in the OpenShift OperatorHub. Once installed, it is applicable to the entire cluster.
* You have installed xref:../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines CLI].
* You have installed xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines] using the {pipelines-title} Operator listed in the OpenShift OperatorHub. Once installed, it is applicable to the entire cluster.
* You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines CLI].
* You have forked the front-end link:https://github.com/openshift-pipelines/vote-ui/tree/release-tech-preview-2[`ui-repo`] and back-end link:https://github.com/openshift-pipelines/vote-api/tree/release-tech-preview-2[`api-repo`] Git repositories using your GitHub ID, and have Administrator access to these repositories.
* Optional: You have cloned the link:https://github.com/openshift/pipelines-tutorial/tree/release-tech-preview-2[`pipelines-tutorial`] Git repository.

Expand All @@ -49,6 +49,6 @@ include::modules/op-triggering-a-pipelinerun.adoc[leveloffset=+1]
[id="pipeline-addtl-resources"]
== Additional resources

* For more details on pipelines in the *Developer* perspective, see the xref:../pipelines/working-with-pipelines-using-the-developer-perspective.adoc#working-with-pipelines-using-the-developer-perspective[working with Pipelines in the *Developer* perspective] section.
* To learn more about Security Context Constraints (SCCs), see the xref:../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing Security Context Constraints] section.
* For more details on pipelines in the *Developer* perspective, see the xref:../../cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc#working-with-pipelines-using-the-developer-perspective[working with Pipelines in the *Developer* perspective] section.
* To learn more about Security Context Constraints (SCCs), see the xref:../../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing Security Context Constraints] section.
* For more examples of reusable tasks, see the link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog] repository. Additionally, you can also see the Tekton Catalog in the Tekton project.
1 change: 1 addition & 0 deletions cicd/pipelines/images
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide walks cluster administrators through the process of installing the {p

[NOTE]
====
The {pipelines-title} Operator is supported for installation in a restricted network environment. For more information, see xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
The {pipelines-title} Operator is supported for installation in a restricted network environment. For more information, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
====

// Prerequisites for installing OpenShift Operator
Expand All @@ -20,12 +20,12 @@ The {pipelines-title} Operator is supported for installation in a restricted net
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.

* You have installed `oc` CLI.
* You have installed xref:../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines (`tkn`) CLI] on your local system.
* You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines (`tkn`) CLI] on your local system.

ifdef::openshift-origin[]
* Ensure that you have downloaded the link:https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator.
* Ensure that you have downloaded the link:https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator.
+
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in xref:../post_installation_configuration/preparing-for-users.adoc#olm-installing-operators-from-operatorhub-configure_post-install-preparing-for-users[Configuring {product-title} to use Red Hat Operators].
If you have the pull secret, add the `redhat-operators` catalog to the OperatorHub custom resource (CR) as shown in xref:../../post_installation_configuration/preparing-for-users.adoc#olm-installing-operators-from-operatorhub-configure_post-install-preparing-for-users[Configuring {product-title} to use Red Hat Operators].
endif::[]


Expand All @@ -40,4 +40,4 @@ include::modules/op-installing-pipelines-operator-using-the-cli.adoc[leveloffset

.Additional Resources

* You can learn more about installing Operators on {product-title} in the xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section.
* You can learn more about installing Operators on {product-title} in the xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section.
1 change: 1 addition & 0 deletions cicd/pipelines/modules
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ toc::[]
* Powerful CLI for interacting with pipelines.
* Integrated user experience with the Developer perspective of the {product-title} web console.

For an overview of {pipelines-title}, see xref:../pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding OpenShift Pipelines].
For an overview of {pipelines-title}, see xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding OpenShift Pipelines].

[id="getting-support"]
== Getting support
Expand All @@ -32,10 +32,3 @@ include::modules/op-release-notes-1-2.adoc[leveloffset=+1]
include::modules/op-release-notes-1-1.adoc[leveloffset=+1]

include::modules/op-release-notes-1-0.adoc[leveloffset=+1]

////
[id="additional-resources"]
.Additional resources

* For more information on uninstalling the {pipelines-title} Operator, see the xref:../pipelines/uninstalling-pipelines.adoc#uninstalling-pipelines[uninstalling OpenShift Pipelines] section.
////
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ include::modules/op-about-triggers.adoc[leveloffset=+2]

== Additional resources

* For information on installing Pipelines, see xref:../pipelines/installing-pipelines.adoc#installing-pipelines[Installing OpenShift Pipelines].
* For more details on creating custom CI/CD solutions, see xref:../pipelines/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating applications with CI/CD Pipelines].
* For information on installing Pipelines, see xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[Installing OpenShift Pipelines].
* For more details on creating custom CI/CD solutions, see xref:../../cicd/pipelines/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating applications with CI/CD Pipelines].
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ include::modules/op-uninstalling-the-pipelines-operator.adoc[leveloffset=+1]

.Additional Resources

* You can learn more about uninstalling Operators on {product-title} in the xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster] section.
* You can learn more about uninstalling Operators on {product-title} in the xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster] section.
Loading