From 85b322bf5e45a0248f1e6218e1b294a08a363bf2 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Wed, 11 Mar 2020 13:53:25 +0530 Subject: [PATCH 1/4] Edit Changes for COncept Topics --- .../ROOT/pages/con_pipelines-concepts.adoc | 14 ++++++------- modules/ROOT/pages/index.adoc | 20 ++++++++----------- 2 files changed, 15 insertions(+), 19 deletions(-) diff --git a/modules/ROOT/pages/con_pipelines-concepts.adoc b/modules/ROOT/pages/con_pipelines-concepts.adoc index 81a576ac..f2f229b7 100644 --- a/modules/ROOT/pages/con_pipelines-concepts.adoc +++ b/modules/ROOT/pages/con_pipelines-concepts.adoc @@ -1,17 +1,17 @@ [id='pipelines-concepts_{context}'] = Pipelines concepts -The Custom Resource Definitions (CRDs) provided by OpenShift Pipelines include: `Task`,`Pipeline`,`PipelineRun`, `TaskRun`, and `PipelineResource`. +Openshift Pipelines provide the following set of standard CRDs that act as the building blocks from which you can assemble a CI/CD pipeline for your application: -* A `Task` is the smallest configurable unit in a `Pipeline` and is essentially a function of inputs and outputs that inform the `Pipeline` build. It can run individually or as a part of a `Pipeline`. A `Pipeline` includes one or more `Tasks`, with a `Task` consisting of one or more steps. Steps are a series of commands that are sequentially executed by the `Task`. +* _Task_ is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. -* A `Pipeline` is a series of `Tasks` that are executed to build complex workflows that automate the build, deployment and delivery of applications. It is a collection of `PipelineResources`,`Parameters`, and one or more `Tasks`. A `Pipeline` interacts with the outside world, by using `PipelineResources`, which are given to `Tasks` as inputs and outputs. +* _Pipeline_ is a series of Tasks that are executed to construct complex workflows that automate the build, deployment and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world, by using PipelineResources, which are given to Tasks as inputs and outputs. -* A `PipelineRun` is used to run and manage the execution of the `Pipeline`. `PipelineRun` initiates the creation of a `TaskRun` for each `Task` being executed in the `Pipeline`. +* _PipelineRun_ is used to run and manage the execution of the Pipeline. PipelineRun initiates the creation of a _TaskRun_ for each Task being executed in the Pipeline. -* `TaskRun` is auto-created by a `PipelineRun` for each `Task` in a `Pipeline` and results from running an instance of a `Task`. It can also be manually created if a `Task` runs outside of a `Pipeline`. +* _TaskRun_ is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. -* A `PipelineResource` is an object that is used as an input and output for pipeline `Tasks`. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as `PipelineResources`. `PipelineResources` currently support Git Resources, Image Resources, Cluster Resources, and Storage Resources. +* _PipelineResource_ is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. image::tekton_architecture.png[] @@ -20,4 +20,4 @@ image::tekton_architecture.png[] [discrete] == Additional resources -* For more information on pipeline concepts, see the link:https://github.com/tektoncd/pipeline/tree/master/docs#learn-more[Tekton documentation]. +* For more information how to define and create the CRDs, see the link:https://github.com/tektoncd/pipeline/tree/master/docs#learn-more[Tekton documentation]. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index f2715374..6ea69307 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,21 +1,17 @@ [id="openshift-pipelines_{context}"] = OpenShift Pipelines -[IMPORTANT] -==== -OpenShift Pipelines project is based on the upstream project link:https://github.com/tektoncd[Tekton] and is available as a Developer Preview release. Developer Preview releases have features and functionality that might not be fully tested. Customers are encouraged to use and provide feedback on Developer Preview releases. Red Hat does not commit to fixing any reported issues and the provided features may not be available in future releases. +//:FeatureName: OpenShift Pipelines +//include::modules/technology-preview.adoc[leveloffset=+1] -Developer Preview releases are not production ready and customers are advised to avoid running the software for production or business-critical workloads. Limited documentation is available for Developer Preview releases. Customers are NOT able to open support cases against the Developer Preview releases. +OpenShift Pipelines is a cloud-native, continuous integration and continuous delivery (CI/CD) solution based on Kubernetes resources. It uses link:https://tekton.dev[Tekton] building blocks to automate deployments across multiple platforms by abstracting away the underlying implementation details. Tekton introduces a number of standard link:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Custom Resource Definitions (CRDs)] for defining pipelines that are portable across Kubernetes distributions. -If you need assistance with OpenShift Pipelines, reach out on the following mailing list where a member of the Red Hat Development Team will be happy to assist you based on availability and work schedules: pipelines-interest@redhat.com -==== +== Key features -OpenShift Pipelines are cloud-native, continuous integration and continuous delivery (CI/CD) solutions based on Kubernetes resources. It uses link:https://tekton.dev[Tekton] Pipelines to automate deployments across multiple platforms by abstracting away the underlying details. Tekton introduces a number of standard link:https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/[Custom Resource Definitions (CRDs)] for defining pipelines that are portable across Kubernetes distributions. - -* OpenShift Pipelines are designed for microservices and decentralized teams. -* OpenShift Pipelines uses standard CI/CD pipeline definitions that are easy to extend and integrate with existing Kubernetes tools, enabling you to scale on-demand. -* You can use them to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko and are portable across any Kubernetes platform. -* You can use the OpenShift Developer Console to create Tekton resources, view logs of pipeline runs, and manage pipelines under OpenShift project namespaces. +* OpenShift Pipelines are designed for decentralized teams which work on microservice based architecture. +* OpenShift Pipelines use standard CI/CD pipeline definitions that are easy to extend and integrate with the existing Kubernetes tools, enabling you to scale on-demand. +* You can use Openshift Pipelines to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko and are portable across any Kubernetes platform. +* You can use the OpenShift Developer Console to create Tekton resources, view logs of pipeline runs, and manage pipelines under your OpenShift project namespaces. == Additional resources From 07ff6046079d50fa5668f4720c19d5ca7c2e999a Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Mon, 23 Mar 2020 07:26:56 +0530 Subject: [PATCH 2/4] Comments Incorporated --- modules/ROOT/pages/con_pipelines-concepts.adoc | 14 +++++++------- modules/ROOT/pages/index.adoc | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/con_pipelines-concepts.adoc b/modules/ROOT/pages/con_pipelines-concepts.adoc index f2f229b7..bd4207f2 100644 --- a/modules/ROOT/pages/con_pipelines-concepts.adoc +++ b/modules/ROOT/pages/con_pipelines-concepts.adoc @@ -1,17 +1,17 @@ [id='pipelines-concepts_{context}'] = Pipelines concepts -Openshift Pipelines provide the following set of standard CRDs that act as the building blocks from which you can assemble a CI/CD pipeline for your application: +OpenShift Pipelines provide the following set of standard CRDs that act as the building blocks from which you can assemble a CI/CD pipeline for your application: -* _Task_ is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. +Task:: Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. -* _Pipeline_ is a series of Tasks that are executed to construct complex workflows that automate the build, deployment and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world, by using PipelineResources, which are given to Tasks as inputs and outputs. +Pipeline:: Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world, by using PipelineResources, which are added to Tasks as inputs and outputs. -* _PipelineRun_ is used to run and manage the execution of the Pipeline. PipelineRun initiates the creation of a _TaskRun_ for each Task being executed in the Pipeline. +PipelineRun:: PipelineRun is the running instance of a Pipeline. PipelineRun initiates a Pipeline and manages the creation of a _TaskRun_ for each Task being executed in the Pipeline. -* _TaskRun_ is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. +TaskRun:: is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. -* _PipelineResource_ is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. +PipelineResource:: is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. image::tekton_architecture.png[] @@ -20,4 +20,4 @@ image::tekton_architecture.png[] [discrete] == Additional resources -* For more information how to define and create the CRDs, see the link:https://github.com/tektoncd/pipeline/tree/master/docs#learn-more[Tekton documentation]. +* For more information on defining and creating the CRDs, see the link:https://github.com/tektoncd/pipeline/tree/master/docs#learn-more[Tekton documentation]. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 6ea69307..a3c90f24 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -8,9 +8,9 @@ OpenShift Pipelines is a cloud-native, continuous integration and continuous del == Key features -* OpenShift Pipelines are designed for decentralized teams which work on microservice based architecture. +* OpenShift Pipelines are designed for decentralized teams that work on microservice based architecture. * OpenShift Pipelines use standard CI/CD pipeline definitions that are easy to extend and integrate with the existing Kubernetes tools, enabling you to scale on-demand. -* You can use Openshift Pipelines to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko and are portable across any Kubernetes platform. +* You can use Openshift Pipelines to build images with Kubernetes tools such as Source-to-Image (S2I), Buildah, Buildpacks, and Kaniko that are portable across any Kubernetes platform. * You can use the OpenShift Developer Console to create Tekton resources, view logs of pipeline runs, and manage pipelines under your OpenShift project namespaces. From e82057454761ee06ecee63689303a0181e0c486d Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Mon, 23 Mar 2020 17:47:41 +0530 Subject: [PATCH 3/4] Minor comments --- modules/ROOT/pages/con_pipelines-concepts.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/con_pipelines-concepts.adoc b/modules/ROOT/pages/con_pipelines-concepts.adoc index bd4207f2..deaeca68 100644 --- a/modules/ROOT/pages/con_pipelines-concepts.adoc +++ b/modules/ROOT/pages/con_pipelines-concepts.adoc @@ -5,13 +5,13 @@ OpenShift Pipelines provide the following set of standard CRDs that act as the b Task:: Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. -Pipeline:: Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world, by using PipelineResources, which are added to Tasks as inputs and outputs. +Pipeline:: Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world by using PipelineResources, which are added to Tasks as inputs and outputs. PipelineRun:: PipelineRun is the running instance of a Pipeline. PipelineRun initiates a Pipeline and manages the creation of a _TaskRun_ for each Task being executed in the Pipeline. -TaskRun:: is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. +TaskRun:: TaskRun is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. -PipelineResource:: is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. +PipelineResource:: PipelineResource is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. image::tekton_architecture.png[] From 7ccf77e1c015497d4c1aa9194c7305e3c4f730d4 Mon Sep 17 00:00:00 2001 From: Nidhi Kakkar Date: Tue, 24 Mar 2020 16:45:31 +0530 Subject: [PATCH 4/4] Minor changes --- modules/ROOT/pages/con_pipelines-concepts.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/con_pipelines-concepts.adoc b/modules/ROOT/pages/con_pipelines-concepts.adoc index deaeca68..1cb4f4a7 100644 --- a/modules/ROOT/pages/con_pipelines-concepts.adoc +++ b/modules/ROOT/pages/con_pipelines-concepts.adoc @@ -3,15 +3,15 @@ OpenShift Pipelines provide the following set of standard CRDs that act as the building blocks from which you can assemble a CI/CD pipeline for your application: -Task:: Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. +Task:: A Task is the smallest configurable unit in a Pipeline. It is essentially a function of inputs and outputs that form the Pipeline build. It can run individually or as a part of a Pipeline. A Pipeline includes one or more Tasks, where each Task consists of one or more steps. Steps are a series of commands that are sequentially executed by the Task. -Pipeline:: Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world by using PipelineResources, which are added to Tasks as inputs and outputs. +Pipeline:: A Pipeline consists of a series of Tasks that are executed to construct complex workflows that automate the build, deployment, and delivery of applications. It is a collection of PipelineResources, Parameters, and one or more Tasks. A Pipeline interacts with the outside world by using PipelineResources, which are added to Tasks as inputs and outputs. -PipelineRun:: PipelineRun is the running instance of a Pipeline. PipelineRun initiates a Pipeline and manages the creation of a _TaskRun_ for each Task being executed in the Pipeline. +PipelineRun:: A PipelineRun is the running instance of a Pipeline. PipelineRun initiates a Pipeline and manages the creation of a _TaskRun_ for each Task being executed in the Pipeline. -TaskRun:: TaskRun is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. +TaskRun:: A TaskRun is auto-created by a PipelineRun for each Task in a Pipeline. It is a result of running an instance of a Task in a Pipeline. It can also be manually created if a Task runs outside of a Pipeline. -PipelineResource:: PipelineResource is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. +PipelineResource:: A PipelineResource is an object that is used as an input and output for pipeline Tasks. For example, if an input is a Git repository and an output is a container image built from that Git repository, these are both classified as PipelineResources. PipelineResources currently support Git resources, Image resources, Cluster resources, Storage Resources and Cloud Event resources. image::tekton_architecture.png[]