mirror of
https://github.com/tektoncd/catalog.git
synced 2024-11-23 06:08:46 +00:00
112 lines
2.9 KiB
Markdown
112 lines
2.9 KiB
Markdown
# Tekton Catalog
|
|
|
|
**If you want `v1alpha1` resources, you need to go to the
|
|
[`v1alpha1`](https://github.com/tektoncd/catalog/tree/v1alpha1)
|
|
branch. The
|
|
[`master`](https://github.com/tektoncd/catalog/tree/master) branch
|
|
will be synced with
|
|
[`v1beta1`](https://github.com/tektoncd/catalog/tree/v1beta1) on 2020,
|
|
15th June.**
|
|
|
|
This repository contains a catalog of `Task` resources (and someday
|
|
`Pipeline`s and `Resource`s), which are designed to be reusable in many
|
|
pipelines.
|
|
|
|
Each `Task` is provided in a separate directory along with a README.md and a
|
|
Kubernetes manifest, so you can choose which `Task`s to install on your
|
|
cluster. A directory can hold more than one task (e.g. [`golang`](golang)).
|
|
|
|
_See [our project roadmap](roadmap.md)._
|
|
|
|
|
|
## `Task` Kinds
|
|
|
|
There are two kinds of `Task`s:
|
|
|
|
1. `ClusterTask` with a Cluster scope, which can be installed by a cluster
|
|
operator and made available to users in all namespaces
|
|
2. `Task` with a Namespace scope, which is designed to be installed and used
|
|
only within that namespace.
|
|
|
|
`Task`s in this repo are namespace-scoped `Task`s, but can be installed as
|
|
`ClusterTask`s by changing the `kind`.
|
|
|
|
|
|
## Using `Task`s
|
|
|
|
First, install a `Task` onto your cluster:
|
|
|
|
```
|
|
$ kubectl apply -f golang/build.yaml
|
|
task.tekton.dev/golang-build created
|
|
```
|
|
|
|
You can see which `Task`s are installed using `kubectl` as well:
|
|
|
|
```
|
|
$ kubectl get tasks
|
|
NAME AGE
|
|
golang-build 3s
|
|
```
|
|
|
|
With the `Task` installed, you can define a `TaskRun` that runs that `Task`,
|
|
being sure to provide values for required input parameters and resources:
|
|
|
|
```
|
|
apiVersion: tekton.dev/v1beta1
|
|
kind: TaskRun
|
|
metadata:
|
|
name: example-run
|
|
spec:
|
|
taskRef:
|
|
name: golang-build
|
|
params:
|
|
- name: package
|
|
value: github.com/tektoncd/pipeline
|
|
workspaces:
|
|
- name: source
|
|
persistentVolumeClaim:
|
|
claimName: my-source
|
|
```
|
|
|
|
Next, create the `TaskRun` you defined:
|
|
|
|
```
|
|
$ kubectl apply -f example-run.yaml
|
|
taskrun.tekton.dev/example-run created
|
|
```
|
|
|
|
You can check the status of the `TaskRun` using `kubectl`:
|
|
|
|
```
|
|
$ kubectl get taskrun example-run -oyaml
|
|
apiVersion: tekton.dev/v1beta1
|
|
kind: TaskRun
|
|
metadata:
|
|
name: example-run
|
|
spec:
|
|
...
|
|
status:
|
|
completionTime: "2019-04-25T18:10:09Z"
|
|
conditions:
|
|
- lastTransitionTime: "2019-04-25T18:10:09Z"
|
|
status: True
|
|
type: Succeeded
|
|
...
|
|
```
|
|
|
|
## Contributing and Support
|
|
|
|
If you want to contribute to this repository, please see our [contributing](./CONTRIBUTING.md) guidelines.
|
|
|
|
If you are looking for support, enter an [issue](https://github.com/tektoncd/catalog/issues/new) or join our [Slack workspace](https://github.com/tektoncd/community/blob/master/contact.md#slack)
|
|
|
|
## Status of the Project
|
|
|
|
This project is still under active development, so you might run into
|
|
[issues](https://github.com/tektoncd/catalog/issues). If you do,
|
|
please don't be shy about letting us know, or better yet, contribute a
|
|
fix or feature. Its folder structure is not yet set in stone either.
|
|
|
|
_See [our project roadmap](roadmap.md)._
|