1
0
mirror of https://github.com/tektoncd/catalog.git synced 2025-01-05 10:13:05 +00:00

Update README to change inputs/params levels

Signed-off-by: Vincent Demeester <vdemeest@redhat.com>
This commit is contained in:
Vincent Demeester 2020-03-06 15:18:02 +01:00 committed by tekton-robot
parent cd17f05316
commit 323e8d05f1
26 changed files with 112 additions and 155 deletions

View File

@ -10,9 +10,7 @@ Install `tower-cli` task:
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/ansible-tower-cli/ansible-tower-cli-task.yaml
```
## Inputs `tower-cli-task`
### Parameters
## Parameters
* **ARGS:** args to execute which are appended to `tower-cli` e.g. `user-list` (_default_: `--help`)
* **SSLVERIFY:** args to disable Tower SSL verification (_default_: `false`)

View File

@ -8,9 +8,7 @@ This task syncs (deploys) an [Argo CD](https://argoproj.github.io/argo-cd/) appl
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/argocd/argocd.yaml
```
## Inputs
### Parameters
## Parameters
* **application-name:** Name of the application to sync

View File

@ -8,9 +8,7 @@ This task performs operations on Microsoft Azure resources using `az`.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/azure-cli/azure_cli.yaml
```
## Inputs
### Parameters
## Parameters
* **az-image**: `az` CLI container image to run this task.
@ -18,7 +16,7 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/azure
You can use a specific version of the `az` CLI by specifying the `az-image` param with the `mcr.microsoft.com/azure-cli` image tagged with the specific version of the CLI you would like to use (i.e. version 2.0.70 = `mcr.microsoft.com/azure-cli:2.0.70`). A full list of available version tags can be found under the [Full Tag Listing](https://hub.docker.com/_/microsoft-azure-cli) section of the `az` Docker Hub.
* **ARGS**: The arguments to pass to `az` CLI. This parameter is required to run this task.
* **ARGS**: The arguments to pass to `az` CLI. This parameter is required to run this task.
## Usage

View File

@ -13,9 +13,7 @@ to assemble a container image, then pushes that image to a container registry.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/buildah/buildah.yaml
```
## Inputs
### Parameters
## Parameters
* **BUILDER_IMAGE:**: The name of the image containing the Buildah tool. See
note below. (_default:_ quay.io/buildah/stable:v1.11.0)
@ -26,14 +24,14 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/build
* **TLSVERIFY**: Verify the TLS on the registry endpoint (for push/pull to a
non-TLS registry) (_default:_ `true`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
### Outputs
* **image**: An `image`-type `PipelineResource` specify the image that should
be built.

View File

@ -17,21 +17,18 @@ $ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/bui
task.tekton.dev/buildkit-daemonless created
```
## Inputs
### Parameters
## Parameters
* **DOCKERFILE**: The path to the `Dockerfile` to execute (_default:_ `./Dockerfile`)
* **BUILDKIT_IMAGE**: BuildKit image (_default:_`moby/buildkit:vX.Y.Z@sha256:...`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the source to build.
## Outputs
### Resources
### Outputs
* **image**: An `image`-type `PipelineResource` specifying the image that should be built.
Currently, generating [`resourceResult`](https://github.com/tektoncd/pipeline/blob/master/docs/resources.md#image-resource) is not supported. ([`buildkit#993`](https://github.com/moby/buildkit/issues/993))

View File

@ -53,9 +53,7 @@ $ kubectl apply -f task.yaml
task.tekton.dev/buildkit created
```
## Inputs
### Parameters
## Parameters
* **DOCKERFILE**: The path to the `Dockerfile` to execute (_default:_ `./Dockerfile`)
* **BUILDKIT_CLIENT_IMAGE**: BuildKit client image (_default:_`moby/buildkit:vX.Y.Z@sha256:...`)
@ -63,14 +61,13 @@ task.tekton.dev/buildkit created
* **BUILDKIT_CLIENT_CERTS**: The name of Secret that contains `ca.pem`, `cert.pem`, `key.pem`
for mTLS connection to BuildKit daemon (_default:_`buildkit-client-certs`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the source to build.
## Outputs
### Resources
### Outputs
* **image**: An `image`-type `PipelineResource` specifying the image that should be built.
Currently, generating [`resourceResult`](https://github.com/tektoncd/pipeline/blob/master/docs/resources.md#image-resource) is not supported. ([`buildkit#993`](https://github.com/moby/buildkit/issues/993))

View File

@ -20,9 +20,7 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/build
> **NOTE:** This task is currently only compatible with Tekton **v0.6.0** and above, and CNB Platform API 0.2 (lifecycle v0.6.0 and above). For previous Platform API versions, [see below](#previous-platform-api-versions).
## Inputs
### Parameters
## Parameters
* **`BUILDER_IMAGE`**: The image on which builds will run (must include v3 lifecycle and compatible buildpacks; _required_)
@ -38,14 +36,14 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/build
* **`SOURCE_SUBPATH`**: A subpath within the `source` input where the source to build is located (_default:_ `""`)
### Resources
## Resources
### Inputs
* **`source`**: A `git`-type `PipelineResource` specifying the location of the
source to build. See `SOURCE_SUBPATH` above if source is located within a subpath of this input.
## Outputs
### Resources
### Outputs
* **`image`**: An `image`-type `PipelineResource` specifying the image that should
be built.

View File

@ -62,16 +62,16 @@ $ tkn taskrun logs conftest-example -f
container step-conftest has failed : Error
```
## Inputs
### Parameters
## Parameters
* **files**: The files to test against the specified policies
* **policy**: Where to find the policies (_default:_ `policy`)
* **output**: Which output format to use (_default:_ `stdout`)
* **args**: An array of additional arguments to pass to Conftest (_default `[]`_)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
@ -107,16 +107,16 @@ spec:
value: stable/mysql/policy
```
## Inputs
### Parameters
## Parameters
* **chart**: The chart to test against the specified policies (_default:_ `.`)
* **policy**: Where to find the policies (_default:_ `policy`)
* **output**: Which output format to use (_default:_ `stdout`)
* **args**: An array of additional arguments to pass to Conftest (_default `[]`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.

View File

@ -25,9 +25,7 @@ as well as
* **output**: A workspace for this Task to fetch the git repository in to.
### Inputs
#### Parameters
### Parameters
* **url**: git url to clone (_required_)
* **revision**: git revision to checkout (branch, tag, sha, ref…) (_default:_ master)

View File

@ -28,9 +28,7 @@ informations about the CI statuses or a direct link to the full log.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/set_status.yaml
```
### Inputs
#### Parameters
### Parameters
* **REPO_FULL_NAME:**: The GitHub repository full name, _e.g:_ `tektoncd/catalog`
* **GITHUB_HOST_URL:**: The GitHub host domain _default:_ `api.github.com`
@ -86,9 +84,7 @@ issue.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/add_comment.yaml
```
### Inputs
#### Parameters
### Parameters
* **GITHUB_HOST_URL:**: The GitHub host domain (_default:_ `api.github.com`)
* **REQUEST_URL:**: The GitHub pull request or issue url, _e.g:_
@ -137,9 +133,7 @@ issue.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/github/close_issue.yaml
```
### Inputs
#### Parameters
### Parameters
* **GITHUB_HOST_URL:**: The GitHub host domain (_default:_ `api.github.com`)
* **REQUEST_URL:**: The GitHub pull request or issue url, (_e.g:_

View File

@ -8,13 +8,7 @@ This Task deploys an application to a Google Kubernetes Engine cluster using [`g
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gke-deploy/gke-deploy.yaml
```
## Inputs
### Resources
* **source-repo**: The Git source repository that contains your application's Kubernetes configs.
### Parameters
## Parameters
* **ARGS**: The arguments to pass to `gke-deploy` CLI.
@ -23,6 +17,12 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gke-d
See [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gke-deploy#usage)
for the arguments to `gke-deploy`.
## Resources
### Inputs
* **source-repo**: The Git source repository that contains your application's Kubernetes configs.
## Usage
### Authorizing `gke-deploy` commands
@ -95,13 +95,13 @@ This Pipeline builds, pushes, and deploys your application to a Google Kubernete
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/gke-deploy/build-push-gke-deploy.yaml
```
## Inputs
## Resources
### Resources
### Inputs
* **source-repo**: The Git repository that contains your application's Dockerfile and Kubernetes configs.
### Parameters
## Parameters
* **pathToContext**: The path to the build context relative to your source repo's root. This is used by Kaniko.

View File

@ -12,9 +12,7 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golan
## `golangci-lint`
### Inputs
#### Parameters
### Parameters
* **package**: base package under validation
* **flags**: flags to use for `golangci-lint` command (_default:_--verbose)
@ -23,16 +21,16 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golan
* **GOARCH**: architecture target (_default:_ amd64)
* **GO111MODULE**: value of module support (_default:_ auto)
#### Resources
### Resources
#### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
### `golang-build`
## `golang-build`
### Inputs
#### Parameters
### Parameters
* **package**: base package under test
* **packages**: packages to test (_default:_ ./...)
@ -42,16 +40,16 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golan
* **GOARCH**: architecture target (_default:_ amd64)
* **GO111MODULE**: value of module support (_default:_ auto)
#### Resources
### Resources
#### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
### `golang-test`
## `golang-test`
### Inputs
#### Parameters
### Parameters
* **package**: base package to build in
* **packages**: packages to test (_default:_ ./cmd/...)
@ -61,7 +59,9 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/golan
* **GOARCH**: architecture target (_default:_ amd64)
* **GO111MODULE**: value of module support (_default:_ auto)
#### Resources
### Resources
#### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.

View File

@ -10,21 +10,20 @@ Jib works with [Gradle](https://github.com/GoogleContainerTools/jib/tree/master/
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/jib-gradle/jib-gradle.yaml
```
## Inputs
### Parameters
## Parameters
- **DIRECTORY**: The directory in the source repository where source should be found. (*default: .*)
- **CACHE**: The name of the volume for caching Gradle artifacts, local Maven repository, and base image layers (*default: empty-dir-volume*)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
### Outputs
* **image**: The Docker image name to apply to the newly built image.

View File

@ -10,21 +10,19 @@ Jib works with [Maven](https://github.com/GoogleContainerTools/jib/tree/master/j
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/jib-maven/jib-maven.yaml
```
## Inputs
### Parameters
## Parameters
- **DIRECTORY**: The directory in the source repository where source should be found. (*default: .*)
- **CACHE**: The name of the volume for caching Maven artifacts and base image layers (*default: empty-dir-volume*)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
### Outputs
* **image**: The Docker image name to apply to the newly built image.

View File

@ -18,9 +18,7 @@ makes it a perfect tool to be part of Tekton.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kaniko/kaniko.yaml
```
## Inputs
### Parameters
## Parameters
* **DOCKERFILE**: The path to the `Dockerfile` to execute (_default:_
`./Dockerfile`)
@ -28,14 +26,14 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kanik
* **CONTEXT**: The build context used by Kaniko (_default:_
`./`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
### Outputs
* **image**: An `image`-type `PipelineResource` specifying the image that should
be built.

View File

@ -9,9 +9,7 @@ This Task performs operations on Knative resources (services, revisions, routes)
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kn/kn.yaml
```
## Inputs
### Parameters
## Parameters
* **kn-image**: `kn` CLI container image to run this task.
@ -23,7 +21,9 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/kn/kn
* **ARGS**: The arguments to pass to `kn` CLI. _default_: `["help"]`
### Resources
## Resources
### Inputs
* **image**: An `image`-type `PipelineResource` specifying the location of the
container image to deploy for Knative Service.

View File

@ -10,13 +10,13 @@ only the `deploy` subcommand as of today.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/knctl/knctl-deploy.yaml
```
## Inputs
### Parameters
## Parameters
* **service:**: The name of the service to deploy
### Resources
## Resources
### Inputs
* **image**: A `image`-type `PipelineResource` specifying the location of the
service image to deploy.

View File

@ -37,15 +37,15 @@ spec:
By default the task will recursively scan the provided repository for YAML files and validate them against the Kubernetes schemas. You can change the default behavious, targetting particular directories, files or Kubernetes versions, using the parameters.
## Inputs
### Parameters
## Parameters
* **files**: The files or directories to test to validate against the schemas
* **output**: Which output format to use (_default:_ `stdout`)
* **args**: An arrag of additional arguments to pass to Kubeval (_defaultt `[]`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.

View File

@ -36,12 +36,10 @@ stringData:
Example kubectl command
```
kubectl apply -f server-secret.yaml
kubectl apply -f server-secret.yam
```
## Inputs
### Parameters
## Parameters
* **server**: The name of the secret that has the SMTP server information

View File

@ -42,9 +42,7 @@ kubectl --namespace default create secret generic docker-registry-config --from-
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/makisu/makisu.yaml
```
## Inputs
### Parameters
## Parameters
* **CONTEXTPATH**: The path to the build context (_default:_
`/workspace`)
@ -53,14 +51,14 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/makis
* **REGISTRY_SECRET**: Secret containing information about the used regsitry (_default:_
`docker-registry-config`)
### Resources
## Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
### Outputs
* **image**: An `image`-type `PipelineResource` specify the image that should be built.

View File

@ -8,14 +8,14 @@ This Task can be used to run a Maven build.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/maven/maven.yaml
```
## Inputs
### Parameters
## Parameters
- **GOALS**: Maven `goals` to be executed
- **MAVEN_MIRROR_URL**: Maven mirror url (to be inserted into ~/.m2/settings.xml)
### Resources
## Resources
### Inputs
* **source**: `git`-type `PipelineResource` specifying the location of the source to build.

View File

@ -18,23 +18,21 @@ Install `openshift-client-kubecfg` task:
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client/openshift-client-kubecfg-task.yaml
```
## Inputs `openshift-client`
### Parameters
## Parameters `openshift-client`
* **ARGS:** args to execute which are appended to `oc` e.g. `start-build myapp` (_default_: `help`)
* **SCRIPT:** script of oc commands to execute e.g. `oc get pod $1 -0 yaml` This will take the first value of ARGS as pod name (_default_: `oc $@`)
## Inputs `openshift-client-kubecfg`
### Parameters
## Parameters `openshift-client-kubecfg`
* **ARGS:** args to execute which are appended to `oc` e.g. `start-build myapp` (_default_: `help`)
* **SCRIPT:** script of oc commands to execute e.g. `oc get pod $1 -o yaml` This will take the first value of ARGS as pod name (_default_: `oc $@`)
### Resources
## Resources
### Inputs
* **cluster**: a `cluster`-type `PipelineResource` specifying the target OpenShift cluster to execute the commands against it

View File

@ -14,9 +14,7 @@ source code.
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/s2i/s2i.yaml
```
## Inputs
### Parameters
## Parameters
* **BUILDER_IMAGE**: The location of the s2i builder image.
* **PATH_CONTEXT**: Source path from where s2i command need to be run
@ -24,16 +22,15 @@ kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/s2i/s
* **TLSVERIFY**: Verify the TLS on the registry endpoint (for push/pull to a
non-TLS registry) (_default:_ `true`)
## Resources
### Resources
### Inputs
* **source**: A `git`-type `PipelineResource` specifying the location of the
source to build.
## Outputs
### Resources
* **image**: An `image`-type `PipelineResource` specify the image that should
be built.

View File

@ -31,9 +31,7 @@ Example kubectl command
kubectl apply -f webhook-secret.yaml
```
## Inputs
### Parameters
## Parameters
* **webhook-secret**: The name of the secret that has the webhook URL. The key for the URL is url

View File

@ -6,22 +6,21 @@
## Install the Task
Install `terraform-cli` task for kubernetes 1.6+:
```
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/terraform-cli/terraform-cli-task-kube1.6.yaml
```
This task currently works only on kubernetes 1.6+ support for a task that works on older versions of kubernetes will be added soon.
## Inputs `terraform-cli`
### Parameters
## Parameters
* **ARGS:** args to execute which are appended to `terraform` e.g. `init` (_default_: `--help`)
* **terraform-secret:** the name of the secret containing the authentication information for the chosen provider (_default_: `terraform-creds`)
### Resources
## Resources
## Inputs
* **source:** A `git`-type `PipelineResource` specifying the location of the terraform HCL or JSON files

View File

@ -9,9 +9,7 @@ This task performs operations on Tekton resources using
kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/tkn/tkn.yaml
```
## Inputs
### Parameters
## Parameters
name | description | default
--------- | ------------------------------------------- | -------