From 66cff5cd8d4f477735e9ab8cb423fad8fec43108 Mon Sep 17 00:00:00 2001 From: Misha Ramendik Date: Thu, 14 Sep 2023 17:54:44 +0100 Subject: [PATCH] RHDEVDOCS 5444 switch Pipelines to standalone --- _topic_maps/_topic_map.yml | 40 +------------------ ...lications-using-developer-perspective.adoc | 2 +- cicd/index.adoc | 2 +- ...g-from-jenkins-to-openshift-pipelines.adoc | 4 +- cicd/pipelines/about-pipelines.adoc | 35 ++++++++++++++++ getting_started/openshift-overview.adoc | 2 +- ...virt-managing-vms-openshift-pipelines.adoc | 8 ++-- welcome/index.adoc | 2 +- 8 files changed, 47 insertions(+), 48 deletions(-) create mode 100644 cicd/pipelines/about-pipelines.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index fdf0f22905..1c3f1d1c3f 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1901,44 +1901,8 @@ Topics: Dir: pipelines Distros: openshift-enterprise Topics: - - Name: OpenShift Pipelines release notes - File: op-release-notes - - 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: Managing non-versioned and versioned cluster tasks - File: managing-nonversioned-and-versioned-cluster-tasks - - Name: Using Tekton Hub with OpenShift Pipelines - File: using-tekton-hub-with-openshift-pipelines - - Name: Specifying remote pipelines and tasks using resolvers - File: remote-pipelines-tasks-resolvers - - Name: Using Pipelines as Code - File: using-pipelines-as-code - - Name: Working with OpenShift Pipelines in the web console - File: working-with-pipelines-web-console - - Name: Customizing configurations in the TektonConfig custom resource - File: customizing-configurations-in-the-tektonconfig-cr - - Name: Reducing resource consumption of OpenShift Pipelines - File: reducing-pipelines-resource-consumption - - Name: Setting compute resource quota for OpenShift Pipelines - File: setting-compute-resource-quota-for-openshift-pipelines - - Name: Using pods in a privileged security context - File: using-pods-in-a-privileged-security-context - - Name: Securing webhooks with event listeners - File: securing-webhooks-with-event-listeners - - Name: Authenticating pipelines using git secret - File: authenticating-pipelines-using-git-secret - - Name: Using Tekton Chains for OpenShift Pipelines supply chain security - File: using-tekton-chains-for-openshift-pipelines-supply-chain-security - - Name: Viewing pipeline logs using the OpenShift Logging Operator - File: viewing-pipeline-logs-using-the-openshift-logging-operator - - Name: Unprivileged building of container images using Buildah - File: unprivileged-building-of-container-images-using-buildah + - Name: About OpenShift Pipelines + File: about-pipelines - Name: GitOps Dir: gitops Distros: openshift-enterprise diff --git a/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc b/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc index 4d383059cc..7873354c8f 100644 --- a/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc +++ b/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc @@ -50,7 +50,7 @@ The Managed services option is also available if the RHOAS Operator is installed * *Re-ordering of resources*: Use these resources to re-order pinned resources added to your navigation pane. The drag-and-drop icon is displayed on the left side of the pinned resource when you hover over it in the navigation pane. The dragged resource can be dropped only in the section where it resides. ifdef::openshift-enterprise,openshift-webscale[] -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 Operator], link:https://docs.openshift.com/serverless/1.28/install/install-serverless-operator.html#serverless-install-web-console_install-serverless-operator[{ServerlessOperatorName}], and xref:../../virt/install/installing-virt.adoc#virt-subscribing-cli_installing-virt[OpenShift Virtualization Operator] are installed, respectively. +Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator], link:https://docs.openshift.com/serverless/1.28/install/install-serverless-operator.html#serverless-install-web-console_install-serverless-operator[{ServerlessOperatorName}], and xref:../../virt/install/installing-virt.adoc#virt-subscribing-cli_installing-virt[OpenShift Virtualization Operator] are installed, respectively. endif::[] [id="prerequisites_odc-creating-applications-using-developer-perspective"] diff --git a/cicd/index.adoc b/cicd/index.adoc index e9ed1f0b7a..d3ec1cf468 100644 --- a/cicd/index.adoc +++ b/cicd/index.adoc @@ -29,7 +29,7 @@ For more information, see xref:../cicd/builds/understanding-image-builds.adoc#un == {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 xref:../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding {pipelines-shortname}] +For more information, see xref:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[Understanding {pipelines-shortname}]. [id="openshift-gitops"] == OpenShift GitOps diff --git a/cicd/jenkins/migrating-from-jenkins-to-openshift-pipelines.adoc b/cicd/jenkins/migrating-from-jenkins-to-openshift-pipelines.adoc index 7f8242f2dd..58ac1e671c 100644 --- a/cicd/jenkins/migrating-from-jenkins-to-openshift-pipelines.adoc +++ b/cicd/jenkins/migrating-from-jenkins-to-openshift-pipelines.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can migrate your CI/CD workflows from Jenkins to xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[{pipelines-title}], a cloud-native CI/CD experience based on the Tekton project. +You can migrate your CI/CD workflows from Jenkins to xref:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[{pipelines-title}], a cloud-native CI/CD experience based on the Tekton project. include::modules/jt-comparison-of-jenkins-and-openshift-pipelines-concepts.adoc[leveloffset=+1] @@ -23,5 +23,5 @@ include::modules/jt-examples-of-common-use-cases.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[Understanding {pipelines-shortname}] +* xref:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[Understanding {pipelines-shortname}] * xref:../../authentication/using-rbac.adoc#using-rbac[Role-based Access Control] diff --git a/cicd/pipelines/about-pipelines.adoc b/cicd/pipelines/about-pipelines.adoc new file mode 100644 index 0000000000..72cb79ea2d --- /dev/null +++ b/cicd/pipelines/about-pipelines.adoc @@ -0,0 +1,35 @@ +:_content-type: ASSEMBLY +[id="about-pipelines"] += About {pipelines-title} +:context: about-serverless +include::_attributes/common-attributes.adoc[] + +toc::[] + +{pipelines-title} is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses Tekton building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard custom resource definitions (CRDs) for defining CI/CD pipelines that are portable across Kubernetes distributions. + +[NOTE] +==== +Because {pipelines-title} releases on a different cadence from {product-title}, the {pipelines-title} documentation is now available as separate documentation sets for each minor version of the product. + +The {pipelines-title} documentation is available at link:https://docs.openshift.com/pipelines/[]. + +Documentation for specific versions is available using the version selector drop-down list, or directly by adding the version to the URL, for example, link:https://docs.openshift.com/pipelines/1.11[]. + +In addition, the {pipelines-title} documentation is also available on the Red Hat Customer Portal at https://access.redhat.com/documentation/en-us/red_hat_openshift_pipelines/[]. + + +For additional information about the {pipelines-title} life cycle and supported platforms, refer to the link:https://access.redhat.com/support/policy/updates/openshift#ossrvless[Platform Life Cycle Policy]. +==== + +// add something about CLI tools? + + +[id="additional-resources_about-serverless"] +[role="_additional-resources"] +== Additional resources +ifdef::openshift-enterprise[] +* xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with custom resource definitions] +* xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from custom resource definitions] +endif::[] +// above links only included for OCP currently until CRD docs are available in OSD and ROSA diff --git a/getting_started/openshift-overview.adoc b/getting_started/openshift-overview.adoc index 82aebc6bbe..1381998581 100644 --- a/getting_started/openshift-overview.adoc +++ b/getting_started/openshift-overview.adoc @@ -56,7 +56,7 @@ to see your applications, monitor status, connect and group components, and modi * ** xref:../cli_reference/odo-important-update.adoc#odo-important_update[Use the developer CLI tool (`odo`)]**: The `odo` CLI tool lets developers create single or multi-component applications and automates deployment, build, and service route configurations. It abstracts complex Kubernetes and {product-title} concepts, allowing you to focus on developing your applications. -* **xref:../cicd/pipelines/understanding-openshift-pipelines.adoc#op-key-features[Create CI/CD Pipelines]**: Pipelines are serverless, cloud-native, continuous integration, and continuous deployment systems that run in isolated containers. +* **xref:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html#op-key-features[Create CI/CD Pipelines]**: Pipelines are serverless, cloud-native, continuous integration, and continuous deployment systems that run in isolated containers. They use standard Tekton custom resources to automate deployments and are designed for decentralized teams working on microservices-based architecture. * **Deploy Helm charts**: diff --git a/virt/virtual_machines/virt-managing-vms-openshift-pipelines.adoc b/virt/virtual_machines/virt-managing-vms-openshift-pipelines.adoc index d2fada963b..a871d0f671 100644 --- a/virt/virtual_machines/virt-managing-vms-openshift-pipelines.adoc +++ b/virt/virtual_machines/virt-managing-vms-openshift-pipelines.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -xref:../../cicd/pipelines/understanding-openshift-pipelines.adoc#understanding-openshift-pipelines[{pipelines-title}] is a Kubernetes-native CI/CD framework that allows developers to design and run each step of the CI/CD pipeline in its own container. +xref:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html[{pipelines-title}] is a Kubernetes-native CI/CD framework that allows developers to design and run each step of the CI/CD pipeline in its own container. The Tekton Tasks Operator (TTO) integrates {VirtProductName} with {pipelines-shortname}. TTO includes tasks and example pipelines that allow you to: @@ -23,7 +23,7 @@ include::snippets/technology-preview.adoc[] * You have access to an {product-title} cluster with `cluster-admin` permissions. * You have installed the OpenShift CLI (`oc`). -* You have xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[installed {pipelines-shortname}]. +* You have link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html[installed {pipelines-shortname}]. include::modules/virt-deploying-tto.adoc[leveloffset=+1] @@ -56,5 +56,5 @@ include::modules/virt-running-tto-pipeline-cli.adoc[leveloffset=+2] [role="_additional-resources"] [id="additional-resources_virt-managing-vms-openshift-pipelines"] == Additional resources -* xref:../../cicd/pipelines/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating CI/CD solutions for applications using {pipelines-title}] -* xref:../../virt/virtual_machines/virt-automating-windows-sysprep.adoc#virt-automating-windows-sysprep[Automate Windows VM deployments with `sysprep`] \ No newline at end of file +* https://docs.openshift.com/pipelines/latest/create/creating-applications-with-cicd-pipelines.html[Creating CI/CD solutions for applications using {pipelines-title}] +* xref:../../virt/virtual_machines/virt-automating-windows-sysprep.adoc#virt-automating-windows-sysprep[Automate Windows VM deployments with `sysprep`] diff --git a/welcome/index.adoc b/welcome/index.adoc index 3660ec21f9..3dad016516 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -180,7 +180,7 @@ to see your applications, monitor status, connect and group components, and modi - **xref:../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#understanding-service-binding-operator[Connect your workloads to backing services]**: With the Service Binding Operator, an application developer can bind workloads with Operator-managed backing services by automatically collecting and sharing binding data with the workloads. The Service Binding Operator improves the development lifecycle with a consistent and declarative service binding method that prevents discrepancies in cluster environments. -- **xref:../cicd/pipelines/understanding-openshift-pipelines.adoc#op-key-features[Create CI/CD Pipelines]**: Pipelines are serverless, cloud-native, continuous integration and continuous deployment systems that run in isolated containers. +- **link:https://docs.openshift.com/pipelines/latest/about/understanding-openshift-pipelines.html#op-key-features[Create CI/CD Pipelines]**: Pipelines are serverless, cloud-native, continuous integration and continuous deployment systems that run in isolated containers. Pipelines use standard Tekton custom resources to automate deployments and are designed for decentralized teams that work on microservice-based architecture. ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]