Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions docs/hub-resolver.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Use resolver type `hub`.

| Param Name | Description | Example Value |
|------------------|-------------------------------------------------------------------------------|------------------------------------------------------------|
| `catalog` | The catalog from where to pull the resource (Optional) | Default: `tekton-catalog-tasks` (for `task` kind); `tekton-catalog-pipelines` (for `pipeline` kind) |
| `catalog` | The catalog from where to pull the resource (Optional) | Default: `tekton-catalog-tasks` (for `task` kind); `tekton-catalog-pipelines` (for `pipeline` kind); no default for `stepaction` kind, so `catalog` must be set explicitly |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting for the step action, I wonder if, as a follow-up, we should have a default for stepaction 🤔

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah that would be great, @copilot create an issue for this

| `type` | The type of Hub from where to pull the resource (Optional). Either `artifact` or `tekton` | Default: `artifact` (recommended). Note: `tekton` type is deprecated. |
| `kind` | Either `task` or `pipeline` (Optional) | Default: `task` |
| `kind` | `task`, `pipeline` or `stepaction` (Optional) | Default: `task` |
| `name` | The name of the task or pipeline to fetch from the hub | `golang-build` |
| `version` | Version or a Constraint (see [below](#version-constraint) of a task or a pipeline to pull in from. Wrap the number in quotes! | `"0.5.0"`, `">= 0.5.0"` |
| `url` | Custom hub API endpoint to query instead of the cluster-configured default (Optional). Must be an absolute HTTP or HTTPS URL. Overrides all other URL configuration (ConfigMap URL lists, environment variables, and defaults). | `https://internal-hub.example.com` |
Expand Down Expand Up @@ -131,6 +131,33 @@ spec:
# overall will not succeed without those parameters.
```

### StepAction Resolution

```yaml
apiVersion: tekton.dev/v1
kind: TaskRun
metadata:
name: hub-stepaction-demo
spec:
taskSpec:
steps:
- name: git-clone
ref:
resolver: hub
params:
- name: catalog
value: git-clone-stepaction
- name: type # optional
value: artifact
- name: kind
value: stepaction
- name: name
value: git-clone
- name: version
value: "1.6.0"
# Note: Artifact Hub StepAction packages use the tekton-stepaction package type
```

### Task Resolution from a Private Hub

```yaml
Expand Down
Loading