README
¶
ODS Pipeline
IMPORTANT: This approach is currently being evaluated. This may or may not become part of ODS one day.
Introduction
ODS Pipeline provides a CI/CD pipeline based on OpenShift Pipelines as an alternative to Jenkins. This repository contains everything that relates to it, such as Tekton tasks, container images, Go packages, services, documentation, ...
The ODS Pipeline Introduction describes what ODS pipeline is and how it works. It is important to understand this before looking at further documentation or any other repository content.
Note that this ODS Pipeline repository does not provide tasks for building, packaging and deploying your application. You can use any Tekton task to fullfil those needs, however, there are a few "companion" tasks specifically designed for ODS Pipeline to cover common use cases. See the "Technical Reference" section below for information on those tasks.
Documentation
Getting Started
- Installation & Updating
- Add ODS Pipeline to a repository
- Convert an ODS quickstarter based component
Technical Reference
- Repository configuration (ods.yaml)
- Start task
- Finish task
- Companion tasks: Go build task, Gradle build task, NPM build task, SonarQube scan task, Package image task, Helm deploy task
How-To Guides
Examples
Background Information
- Stakeholder Requirements
- Software Architecture
- Software Requirements Specification
- Software Design Specification
- Architecture Decision Records
- Goals and Non-Goals
- Relationship to Jenkins Shared Library
- Comparison to Pipelines-as-Code
Compatibility
For OpenShift Pipelines releases and its relationship to Tekton and OpenShift versions, see https://docs.openshift.com/container-platform/latest/cicd/pipelines/op-release-notes.html
| ods-pipeline | OpenShift Pipelines | ODS Core/Quickstarters |
|---|---|---|
| 0.15 | 1.12 | 4.x |
| 0.14 | 1.12 | 4.x |
| 0.13 | 1.9 | 4.x |
Contributing
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
artifact-download
Package main provides a programm to download all artifacts related to a revision easily.
|
Package main provides a programm to download all artifacts related to a revision easily. |
|
start
Selective deletion in a directory tree.
|
Selective deletion in a directory tree. |
|
taskdoc
Package taskdoc implements documentation rendering for tasks.
|
Package taskdoc implements documentation rendering for tasks. |
|
taskmanifest
Package taskmanifest implements manifest rendering for tasks.
|
Package taskmanifest implements manifest rendering for tasks. |
|
internal
|
|
|
pkg
|
|
|
logging
Inspired by https://github.com/brandur/wanikaniapi/blob/v0.2.0/logger.go
|
Inspired by https://github.com/brandur/wanikaniapi/blob/v0.2.0/logger.go |
|
odstasktest
Package odstasktest implements ODS Pipeline specific functionality to run Tekton tasks in a KinD cluster on top of package tektontaskrun.
|
Package odstasktest implements ODS Pipeline specific functionality to run Tekton tasks in a KinD cluster on top of package tektontaskrun. |
|
tektontaskrun
Package tektontaskrun implements ODS Pipeline independent functionality to run Tekton tasks in a KinD cluster.
|
Package tektontaskrun implements ODS Pipeline independent functionality to run Tekton tasks in a KinD cluster. |
|
test
|
|