The page you’re looking for does not exist. It may have been moved.
58 |If you arrived on this page by clicking on a link, please notify the owner of the site that the link is broken. 61 | If you typed the URL of this page manually, please double check that you entered the address correctly.
62 |PipelineResources are a set of objects that are used as inputs to a Task and can be output by a Task. A Task can have multiple inputs and outputs.
The following PipelineResources are currently supported:
Git Resource
162 |Pull Request Resource
165 |Image Resource
168 |Cluster Resource
171 |
To define a configuration file for PipelineResources, you must specify the following fields:
Required:
182 |apiVersion- Specifies the API version.
kind - Specifies the PipelineResource resource object.
metadata - Specifies data to uniquely identify the PipelineResource object, for example a name.
spec- Specifies the configuration information for the PipelineResource object.
type - Specifies the type of PipelineResource.
Optional:
204 |params - Parameters which are specific to each type of PipelineResource.
A Pull Request resource represents a pull request event from a source control system. Adding the Pull Request resource as an input to a Task populates the workspace with a set of files containing generic pull request related metadata such as base/head commit, comments, and labels.
Adding the Pull Request resource as an output of a Task updates the source control system.
/workspace/
163 | /workspace/<resource>/
164 | /workspace/<resource>/labels/
165 | /workspace/<resource>/labels/<label>
166 | /workspace/<resource>/status/
167 | /workspace/<resource>/status/<status>
168 | /workspace/<resource>/comments/
169 | /workspace/<resource>/comments/<comment>
170 | /workspace/<resource>/head
171 | /workspace/<resource>/baseThe Custom Resource Definitions (CRDs) provided by OpenShift Pipelines include: Task,Pipeline,PipelineRun, TaskRun, and PipelineResource.
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.
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.
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.
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.
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.
176 | For more information on pipeline concepts, see the Tekton documentation.
183 |You can examine the logs for PipelineRuns to verify its status.
Check the PipelineRun logs as it runs using the tkn pipeline logs command, which interactively allows you to chose the required pipelinerun and inspect the logs:
$ tkn pipeline logs -f 163 | ? Select pipeline : petclinic-deploy-pipeline 164 | ? Select pipelinerun : petclinic-deploy-pipeline-run-tsv92 started 39 seconds ago 165 | 166 | ... 167 | [build : nop] Build successful 168 | [deploy : build-step-oc] deploymentconfig.apps.openshift.io/spring-petclinic rolled out 169 | [deploy : nop] Build successful170 |
Check the Project Status in the OpenShift Web Console to verify that the PetClinic image is successfully built and deployed.
175 |
178 | To rerun the last pipelinerun, using the same pipeline resources and service account used in the previous pipeline, use:
183 |tkn pipeline start petclinic-deploy-pipeline --last186 |
PipelineResources are artifacts that are used as inputs to a Task and can be output by a Task.
After you create Task s, create PipelineResources that contain the specifics of the Git repository and the image registry to be used in the Pipeline during execution as follows:
Create a PipelineResource YAML file with a PipelineResource that defines the Git repository and reference for the PetClinic application as follows:
apiVersion: tekton.dev/v1alpha1 166 | kind: PipelineResource 167 | metadata: 168 | name: petclinic-git 169 | spec: 170 | type: git 171 | params: 172 | - name: url 173 | value: https://github.com/spring-projects/spring-petclinic174 |
To the above PipelineResource YAML file, add another PipelineResource that defines the OpenShift internal registry to which you want to push the PetClinic image, as shown below, and save it.
apiVersion: tekton.dev/v1alpha1 182 | kind: PipelineResource 183 | metadata: 184 | name: petclinic-image 185 | spec: 186 | type: image 187 | params: 188 | - name: url 189 | value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/spring-petclinic190 |
Create the above pipeline resources as follows:
195 |$ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/resources/petclinic-resources.yaml198 |
Verify the resources created as follows:
203 |$ tkn resource ls 206 | 207 | NAME TYPE DETAILS 208 | petclinic-git git url: https://github.com/spring-projects/spring-petclinic 209 | petclinic-image image url: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/spring-petclinic210 |
A PipelineRun starts a Pipeline and ties it to the Git and image resources that should be used for the specific invocation.
Start the Pipeline as follows:
$ tkn pipeline start petclinic-deploy-pipeline \ 163 | -r app-git=petclinic-git \ 164 | -r app-image=petclinic-image \ 165 | -s pipeline 166 | 167 | Pipelinerun started: petclinic-deploy-pipeline-run-q62p8168 |
The -r flag specifies the PipelineResource s that should be provided to the pipeline
The -s flag specifies the service account to be used for running the pipeline
Starting a pipeline instantiates the PipelineRun and creates a number of pods to execute the tasks that are defined in the pipeline. The PipelineRun automatically creates and triggers the TaskRuns for each Task in the pipeline.
After a few minutes, verify that the Pipeline ran successfully by listing all the PipelineRuns as follows:
$ tkn pipeline list 189 | 190 | NAME AGE LAST RUN STARTED DURATION STATUS 191 | petclinic-deploy-pipeline 7 minutes ago petclinic-deploy-pipeline-run-tsv92 5 minutes ago 4 minutes Succeeded192 |
In the OpenShift Web Console, navigate to Home > Projects .
160 |Select the pipelines project, on the listed page.
Right click the menu icon on the pipelines row.
Select Delete Project.
169 |Confirm deletion by typing pipelines in the field that appears.
172 |Click Delete.
175 |The project is now deleted from the Projects list and cluster.
178 |Go to Catalog > OperatorHub in the Web Console.
191 |Click on the OpenShift Pipelines Operator tile. The operator tile will indicate it is installed.
194 |The Show Community Operator` dialog box will appear. Click Continue to proceed.
197 |Once, the OpenShift Pipelines Operator descriptor screen appears, click Uninstall.
200 |Select Also completely remove the Operator from the selected namespace, in the Remove Operator Subscription dialog box.
203 |Click Remove.
206 |PipelineResources are a set of objects that are used as inputs to a Task and can be output by a Task. A Task can have multiple inputs and outputs.
The following PipelineResources are currently supported:
Git Resource
168 |Pull Request Resource
171 |Image Resource
174 |Cluster Resource
177 |
To define a configuration file for PipelineResources, you must specify the following fields:
Required:
188 |apiVersion- Specifies the API version.
kind - Specifies the PipelineResource resource object.
metadata - Specifies data to uniquely identify the PipelineResource object, for example a name.
spec- Specifies the configuration information for the PipelineResource object.
type - Specifies the type of PipelineResource.
Optional:
210 |params - Parameters which are specific to each type of PipelineResource.
A Pull Request resource represents a pull request event from a source control system. Adding the Pull Request resource as an input to a Task populates the workspace with a set of files containing generic pull request related metadata such as base/head commit, comments, and labels.
Adding the Pull Request resource as an output of a Task updates the source control system.
/workspace/
169 | /workspace/<resource>/
170 | /workspace/<resource>/labels/
171 | /workspace/<resource>/labels/<label>
172 | /workspace/<resource>/status/
173 | /workspace/<resource>/status/<status>
174 | /workspace/<resource>/comments/
175 | /workspace/<resource>/comments/<comment>
176 | /workspace/<resource>/head
177 | /workspace/<resource>/baseYou can examine the logs for PipelineRuns to verify its status.
Check the PipelineRun logs as it runs using the tkn pipeline logs command, which interactively allows you to chose the required pipelinerun and inspect the logs:
$ tkn pipeline logs -f 169 | ? Select pipeline : petclinic-deploy-pipeline 170 | ? Select pipelinerun : petclinic-deploy-pipeline-run-tsv92 started 39 seconds ago 171 | 172 | ... 173 | [build : nop] Build successful 174 | [deploy : build-step-oc] deploymentconfig.apps.openshift.io/spring-petclinic rolled out 175 | [deploy : nop] Build successful176 |
Check the Project Status in the OpenShift Web Console to verify that the PetClinic image is successfully built and deployed.
181 |
184 | To rerun the last pipelinerun, using the same pipeline resources and service account used in the previous pipeline, use:
189 |tkn pipeline start petclinic-deploy-pipeline --last192 |
PipelineResources are a set of objects that are used as inputs to a Task and can be output by a Task. A Task can have multiple inputs and outputs.
The following PipelineResources are currently supported:
Git Resource
171 |Pull Request Resource
174 |Image Resource
177 |Cluster Resource
180 |
To define a configuration file for PipelineResources, you must specify the following fields:
Required:
191 |apiVersion- Specifies the API version.
kind - Specifies the PipelineResource resource object.
metadata - Specifies data to uniquely identify the PipelineResource object, for example a name.
spec- Specifies the configuration information for the PipelineResource object.
type - Specifies the type of PipelineResource.
Optional:
213 |params - Parameters which are specific to each type of PipelineResource.
A Pull Request resource represents a pull request event from a source control system. Adding the Pull Request resource as an input to a Task populates the workspace with a set of files containing generic pull request related metadata such as base/head commit, comments, and labels.
Adding the Pull Request resource as an output of a Task updates the source control system.
/workspace/
172 | /workspace/<resource>/
173 | /workspace/<resource>/labels/
174 | /workspace/<resource>/labels/<label>
175 | /workspace/<resource>/status/
176 | /workspace/<resource>/status/<status>
177 | /workspace/<resource>/comments/
178 | /workspace/<resource>/comments/<comment>
179 | /workspace/<resource>/head
180 | /workspace/<resource>/baseYou can examine the logs for PipelineRuns to verify its status.
Check the PipelineRun logs as it runs using the tkn pipeline logs command, which interactively allows you to chose the required pipelinerun and inspect the logs:
$ tkn pipeline logs -f 172 | ? Select pipeline : petclinic-deploy-pipeline 173 | ? Select pipelinerun : petclinic-deploy-pipeline-run-tsv92 started 39 seconds ago 174 | 175 | ... 176 | [build : nop] Build successful 177 | [deploy : build-step-oc] deploymentconfig.apps.openshift.io/spring-petclinic rolled out 178 | [deploy : nop] Build successful179 |
Check the Project Status in the OpenShift Web Console to verify that the PetClinic image is successfully built and deployed.
184 |
187 | To rerun the last pipelinerun, using the same pipeline resources and service account used in the previous pipeline, use:
192 |tkn pipeline start petclinic-deploy-pipeline --last195 |
You can install OpenShift Pipelines operator from the OperatorHub using the CLI.
163 |Access to an OpenShift cluster using an admin account.
169 |oc is installed on your system.
172 |Create a Subscription object YAML file to subscribe a namespace to the OpenShift Pipelines Operator,
180 | for example, sub.yaml:
apiVersion: operators.coreos.com/v1alpha1 184 | kind: Subscription 185 | metadata: 186 | name: openshift-pipelines-operator 187 | namespace: openshift-operators 188 | spec: 189 | channel: dev-preview 190 | name: openshift-pipelines-operator 191 | source: community-operators 192 | sourceNamespace: openshift-marketplace193 |
Create the Subscription object:
198 |$ oc apply -f sub.yaml201 |
The OpenShift Pipelines operator is now installed in the default target namespace openshift-pipelines.
15 | The page you requested has been relocated to 16 | https://docs.openshift.com/container-platform/latest/pipelines/understanding-openshift-pipelines.html. 20 |
21 | -------------------------------------------------------------------------------- /old_bin/ant-include.sh: -------------------------------------------------------------------------------- 1 | # consider using preprocessor instead of this script 2 | 3 | # until antora includes a feature that enables allow-uri-read for asciidoctor 4 | # need to run this script to populate content from other repos 5 | 6 | wget https://raw.githubusercontent.com/asciidoctor/asciidoctor-extensions-lab/master/scripts/asciidoc-coalescer.rb 7 | 8 | find modules -type f -name '*.inc' |\ 9 | while IFS= read -r inc_path 10 | do 11 | inc_dirname=$(dirname "${inc_path}") 12 | ruby asciidoc-coalescer.rb -a allow-uri-read $inc_path > $inc_path-rantora.adoc 13 | 14 | done 15 | 16 | rm asciidoc-coalescer.rb 17 | -------------------------------------------------------------------------------- /old_bin/asciidoc-coalescer.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | # This script coalesces the AsciiDoc content from a document master into a 4 | # single output file. It does so by resolving all preprocessor directives in 5 | # the document, and in any files which are included. The resolving of include 6 | # directives is likely of most interest to users of this script. 7 | # 8 | # This script works by using Asciidoctor's PreprocessorReader to read and 9 | # resolve all the lines in the specified input file. The script then writes the 10 | # result to the output. 11 | # 12 | # The script only recognizes attributes passed in as options or those defined 13 | # in the document header. It does not currently process attributes defined in 14 | # other, arbitrary locations within the document. 15 | 16 | # TODO 17 | # - add cli option to write attributes passed to cli to header of document 18 | # - escape all preprocessor directives after lines are processed (these are preprocessor directives that were escaped in the input) 19 | 20 | require 'asciidoctor' 21 | require 'optparse' 22 | 23 | options = { attributes: [], output: '-' } 24 | OptionParser.new do |opts| 25 | opts.banner = 'Usage: ruby asciidoc-coalescer.rb [OPTIONS] FILE' 26 | opts.on('-a', '--attribute key[=value]', 'A document attribute to set in the form of key[=value]') do |a| 27 | options[:attributes] << a 28 | end 29 | opts.on('-o', '--output FILE', 'Write output to FILE instead of stdout.') do |o| 30 | options[:output] = o 31 | end 32 | end.parse! 33 | 34 | unless (source_file = ARGV.shift) 35 | warn 'Please specify an AsciiDoc source file to coalesce.' 36 | exit 1 37 | end 38 | 39 | unless (output_file = options[:output]) == '-' 40 | if (output_file = File.expand_path output_file) == (File.expand_path source_file) 41 | warn 'Source and output cannot be the same file.' 42 | exit 1 43 | end 44 | end 45 | 46 | # NOTE first, resolve attributes defined at the end of the document header 47 | # QUESTION can we do this in a single load? 48 | doc = Asciidoctor.load_file source_file, safe: :unsafe, header_only: true, attributes: options[:attributes] 49 | # NOTE quick and dirty way to get the attributes set or unset by the document header 50 | header_attr_names = (doc.instance_variable_get :@attributes_modified).to_a 51 | header_attr_names.each {|k| doc.attributes[%(#{k}!)] = '' unless doc.attr? k } 52 | 53 | doc = Asciidoctor.load_file source_file, safe: :unsafe, parse: false, attributes: doc.attributes 54 | # FIXME also escape ifdef, ifndef, ifeval and endif directives 55 | # FIXME do this more carefully by reading line by line; if input differs by output by leading backslash, restore original line 56 | lines = doc.reader.read.gsub(/^include::(?=.*\[\]$)/m, '\\include::') 57 | 58 | if output_file == '-' 59 | puts lines 60 | else 61 | File.open(output_file, 'w') {|f| f.write lines } 62 | end 63 | -------------------------------------------------------------------------------- /old_bin/createFile.sh: -------------------------------------------------------------------------------- 1 | TEMPLATE=./docs/template.adoc 2 | slug=$1 3 | file=$2 4 | export heading=$(q -H -d , "SELECT heading FROM ./docs/arotna.csv WHERE slug = '$slug'") 5 | 6 | echo $heading 7 | cat $TEMPLATE | sed -e s/{slug}/$slug/g | sed -e s/{heading}/"$heading"/g > $file -------------------------------------------------------------------------------- /old_bin/quick-build.sh: -------------------------------------------------------------------------------- 1 | # Build website 2 | # 3 | # Run from root level of repo, eg ./bin/quick-build.sh local-site.yml 4 | 5 | # create nav.adoc 6 | q -H -d , "SELECT prefix ||' xref::' ||slug||'.adoc[' ||navtext|| ']' FROM ./docs/arotna.csv" > ./docs/nav.adoc 7 | 8 | # create files if necessary 9 | mapfile -t file_array < <( q -H -d , "SELECT slug FROM ./docs/arotna.csv" ) 10 | 11 | for slug in "${file_array[@]}" 12 | do 13 | file="./docs/pages/$slug.adoc" 14 | echo $file 15 | if [ ! -f $file ]; then 16 | echo "File not found!" 17 | ./bin/createFile.sh $slug $file 18 | 19 | fi 20 | done 21 | 22 | 23 | # create toc into _partials 24 | 25 | q -H -d , "SELECT prefix ||' xref::' ||slug||'.adoc[' ||heading|| ']' FROM ./docs/arotna.csv" > ./docs/pages/_partials/toc.adoc 26 | 27 | # create rendered assembly 28 | 29 | echo ':toc:' > ./docs/master.adoc 30 | 31 | echo 'include::pages/index.adoc[leveloffset=0,tags=!excludeDownstream]' >> ./docs/master.adoc 32 | 33 | q -H -d , "SELECT 'include::pages/' ||slug||'.adoc[leveloffset='|| level ||']' FROM ./docs/arotna.csv" >> ./docs/master.adoc 34 | 35 | # create single.adoc 36 | 37 | ./bin/asciidoc-coalescer.rb ./docs/master.adoc > ./docs/pages/single.adoc 38 | 39 | # generate html 40 | 41 | antora $1 42 | 43 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "antora-ui-default", 3 | "description": "An archetype project that produces a UI for creating documentation sites with Antora", 4 | "homepage": "https://gitlab.com/antora/antora-ui-default", 5 | "license": "MPL-2.0", 6 | "repository": { 7 | "type": "git", 8 | "url": "https://gitlab.com/antora/antora-ui-default.git" 9 | }, 10 | "engines": { 11 | "node": ">= 8.0.0" 12 | }, 13 | "browserslist": [ 14 | "last 2 versions" 15 | ], 16 | "devDependencies": { 17 | "asciidoctor.js": "1.5.9", 18 | "autoprefixer": "~9.6", 19 | "browser-pack-flat": "~3.4", 20 | "browserify": "~16.5", 21 | "cssnano": "~4.1", 22 | "eslint": "~6.3", 23 | "eslint-config-standard": "~14.1", 24 | "eslint-plugin-import": "~2.18", 25 | "eslint-plugin-node": "~9.2", 26 | "eslint-plugin-promise": "~4.2", 27 | "eslint-plugin-standard": "~4.0", 28 | "fs-extra": "~8.1", 29 | "gulp": "~4.0", 30 | "gulp-concat": "~2.6", 31 | "gulp-connect": "~5.7", 32 | "gulp-eslint": "~6.0", 33 | "gulp-imagemin": "~6.1", 34 | "gulp-postcss": "~8.0", 35 | "gulp-stylelint": "~9.0", 36 | "gulp-uglify": "~3.0", 37 | "gulp-vinyl-zip": "~2.1 >=2.1.2", 38 | "handlebars": "^4.7.6", 39 | "highlight.js": "~9.15", 40 | "js-yaml": "~3.13", 41 | "merge-stream": "~2.0", 42 | "postcss-calc": "~7.0", 43 | "postcss-custom-properties": "~9.0", 44 | "postcss-import": "~12.0", 45 | "postcss-url": "~8.0", 46 | "prettier-eslint": "~9.0", 47 | "require-directory": "~2.1", 48 | "require-from-string": "~2.0", 49 | "stylelint": "~10.1", 50 | "stylelint-config-standard": "~18.3", 51 | "through2": "~3.0", 52 | "typeface-roboto": "0.0.75", 53 | "typeface-roboto-mono": "0.0.75", 54 | "vinyl-buffer": "~1.0", 55 | "vinyl-fs": "~3.0" 56 | }, 57 | "dependencies": { 58 | "@antora/cli": "^2.3.3", 59 | "@antora/site-generator-default": "^2.3.3" 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /site.yml: -------------------------------------------------------------------------------- 1 | site: 2 | title: OpenShift Pipelines 3 | url: https://openshift.github.io/pipelines-docs/ 4 | start_page: 0.10.5@docs::index.adoc 5 | content: 6 | sources: 7 | - url: https://github.com/openshift/pipelines-docs.git 8 | branches: [op-0.10-master, op-0.8-master, op-0.5-master, op-0.7-master] 9 | ui: 10 | bundle: 11 | url: https://github.com/openshift/pipelines-docs/blob/master/ui-bundle.zip?raw=true 12 | snapshot: true 13 | -------------------------------------------------------------------------------- /ui-bundle.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openshift/pipelines-docs/25ef2f8db3932e5c38933da9b8a772d0734dddb6/ui-bundle.zip --------------------------------------------------------------------------------