Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/cmd/tkn.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ CLI for tekton pipelines
* [tkn completion](tkn_completion.md) - Prints shell completion scripts
* [tkn customrun](tkn_customrun.md) - Manage CustomRuns
* [tkn eventlistener](tkn_eventlistener.md) - Manage EventListeners
* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn pipeline](tkn_pipeline.md) - Manage pipelines
* [tkn pipelinerun](tkn_pipelinerun.md) - Manage PipelineRuns
* [tkn task](tkn_task.md) - Manage Tasks
Expand Down
36 changes: 24 additions & 12 deletions docs/cmd/tkn_hub.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## tkn hub

Interact with tekton hub
Interact with artifacthub

### Usage

Expand All @@ -10,26 +10,38 @@ tkn hub

### Synopsis

Interact with tekton hub
Interact with artifacthub

Deprecation Notice: Tekton Hub support in CLI is being deprecated in favor of Artifact Hub.
The following commands currently only work with Tekton Hub and may support Artifact Hub in a future release:
- check-upgrade
- downgrade
- get
- info
- reinstall
- search
- upgrade

Action Required: Users should migrate to Artifact Hub by using the '--type artifact' flag
with the install command. For example:
tkn hub install task foo --type artifact --from tekton-catalog-tasks

When using '--type tekton', a deprecation warning will now be displayed.
Artifact Hub (https://artifacthub.io) will become the only supported hub in future releases.

### Options

```
--api-server string Hub API Server URL (default 'https://api.hub.tekton.dev' for 'tekton' type; default 'https://artifacthub.io' for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'TEKTON_HUB_API_SERVER'/'ARTIFACT_HUB_API_SERVER'.
--api-server string Hub API Server URL.
For artifact type: default 'https://artifacthub.io' (env: ARTIFACT_HUB_API_SERVER)
For tekton type (DEPRECATED): default 'https://api.hub.tekton.dev' (env: TEKTON_HUB_API_SERVER)
Can also be set in '$HOME/.tekton/hub-config'.
-h, --help help for hub
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (default "tekton")
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release) (default "artifact")
```

### SEE ALSO

* [tkn](tkn.md) - CLI for tekton pipelines
* [tkn hub check-upgrade](tkn_hub_check-upgrade.md) - Check for upgrades of resources if present
* [tkn hub downgrade](tkn_hub_downgrade.md) - Downgrade an installed resource
* [tkn hub get](tkn_hub_get.md) - Get resource manifest by its name, kind, catalog, and version
* [tkn hub info](tkn_hub_info.md) - Display info of resource by its name, kind, catalog, and version
* [tkn hub install](tkn_hub_install.md) - Install a resource from a catalog by its kind, name and version
* [tkn hub reinstall](tkn_hub_reinstall.md) - Reinstall a resource by its kind and name
* [tkn hub search](tkn_hub_search.md) - Search resource by a combination of name, kind, categories, platforms, and tags
* [tkn hub upgrade](tkn_hub_upgrade.md) - Upgrade an installed resource

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_check-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ Check for upgrades of resources if present

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub check-upgrade task](tkn_hub_check-upgrade_task.md) - Check updates for Task installed via Hub CLI

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_downgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ Downgrade an installed resource

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub downgrade task](tkn_hub_downgrade_task.md) - Downgrade an installed Task by its name to a lower version

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Get resource manifest by its name, kind, catalog, and version

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub get pipeline](tkn_hub_get_pipeline.md) - Get Pipeline by name, catalog and version
* [tkn hub get task](tkn_hub_get_task.md) - Get Task by name, catalog and version

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ Display info of resource by its name, kind, catalog, and version

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub info task](tkn_hub_info_task.md) - Display info of Task by its name, catalog and version

10 changes: 6 additions & 4 deletions docs/cmd/tkn_hub_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,15 @@ Install a resource from a catalog by its kind, name and version
### Options inherited from parent commands

```
--api-server string Hub API Server URL (default 'https://api.hub.tekton.dev' for 'tekton' type; default 'https://artifacthub.io' for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'TEKTON_HUB_API_SERVER'/'ARTIFACT_HUB_API_SERVER'.
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (default "tekton")
--api-server string Hub API Server URL.
For artifact type: default 'https://artifacthub.io' (env: ARTIFACT_HUB_API_SERVER)
For tekton type (DEPRECATED): default 'https://api.hub.tekton.dev' (env: TEKTON_HUB_API_SERVER)
Can also be set in '$HOME/.tekton/hub-config'.
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release) (default "artifact")
```

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub install task](tkn_hub_install_task.md) - Install Task from a catalog by its name and version

18 changes: 10 additions & 8 deletions docs/cmd/tkn_hub_install_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ Install Task from a catalog by its name and version
### Examples


Install a Task of name 'foo':
Install a Task of name 'foo' from Artifact Hub:

tkn hub install task foo
tkn hub install task foo --type artifact --from tekton-catalog-tasks --version 0.3.0

or

Install a Task of name 'foo' of version '0.3' from Catalog 'Tekton':
Install a Task of name 'foo' from Tekton Hub (DEPRECATED):

tkn hub install task foo --version 0.3 --from tekton

Note that the resources in Artifact Hub follow full SemVer - <major>.<minor>.<patch> (e.g. 0.3.0),
please double check the version used
Note: Tekton Hub is deprecated. Use '--type artifact' with Artifact Hub instead.
Resources in Artifact Hub follow full SemVer - <major>.<minor>.<patch> (e.g. 0.3.0).


### Options
Expand All @@ -38,13 +38,15 @@ please double check the version used
### Options inherited from parent commands

```
--api-server string Hub API Server URL (default 'https://api.hub.tekton.dev' for 'tekton' type; default 'https://artifacthub.io' for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub-config' with a variable 'TEKTON_HUB_API_SERVER'/'ARTIFACT_HUB_API_SERVER'.
--api-server string Hub API Server URL.
For artifact type: default 'https://artifacthub.io' (env: ARTIFACT_HUB_API_SERVER)
For tekton type (DEPRECATED): default 'https://api.hub.tekton.dev' (env: TEKTON_HUB_API_SERVER)
Can also be set in '$HOME/.tekton/hub-config'.
-c, --context string Name of the kubeconfig context to use (default: kubectl config current-context)
--from string Name of Catalog to which resource belongs.
-k, --kubeconfig string Kubectl config file (default: $HOME/.kube/config)
-n, --namespace string Namespace to use (default: from $KUBECONFIG)
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (default "tekton")
--type string The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release) (default "artifact")
--version string Version of Resource
```

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_reinstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ Reinstall a resource by its kind and name

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub reinstall task](tkn_hub_reinstall_task.md) - Reinstall a Task by its name

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Search resources using tag 'cli':

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub

2 changes: 1 addition & 1 deletion docs/cmd/tkn_hub_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ Upgrade an installed resource

### SEE ALSO

* [tkn hub](tkn_hub.md) - Interact with tekton hub
* [tkn hub](tkn_hub.md) - Interact with artifacthub
* [tkn hub upgrade task](tkn_hub_upgrade_task.md) - Upgrade a Task by its name

24 changes: 13 additions & 11 deletions docs/man/man1/tkn-hub-install-task.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ Install Task from a catalog by its name and version
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-server\fP=""
Hub API Server URL (default '
\[la]https://api.hub.tekton.dev'\[ra] for 'tekton' type; default '
\[la]https://artifacthub.io'\[ra] for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'TEKTON\_HUB\_API\_SERVER'/'ARTIFACT\_HUB\_API\_SERVER'.
Hub API Server URL.
For artifact type: default '
\[la]https://artifacthub.io'\[ra] (env: ARTIFACT\_HUB\_API\_SERVER)
For tekton type (DEPRECATED): default '
\[la]https://api.hub.tekton.dev'\[ra] (env: TEKTON\_HUB\_API\_SERVER)
Can also be set in '$HOME/.tekton/hub\-config'.

.PP
\fB\-c\fP, \fB\-\-context\fP=""
Expand All @@ -49,8 +51,8 @@ URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'T
Namespace to use (default: from $KUBECONFIG)

.PP
\fB\-\-type\fP="tekton"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton'
\fB\-\-type\fP="artifact"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release)

.PP
\fB\-\-version\fP=""
Expand All @@ -59,13 +61,13 @@ URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'T

.SH EXAMPLE
.PP
Install a Task of name 'foo':
Install a Task of name 'foo' from Artifact Hub:

.PP
.RS

.nf
tkn hub install task foo
tkn hub install task foo \-\-type artifact \-\-from tekton\-catalog\-tasks \-\-version 0.3.0

.fi
.RE
Expand All @@ -74,7 +76,7 @@ tkn hub install task foo
or

.PP
Install a Task of name 'foo' of version '0.3' from Catalog 'Tekton':
Install a Task of name 'foo' from Tekton Hub (DEPRECATED):

.PP
.RS
Expand All @@ -86,8 +88,8 @@ tkn hub install task foo \-\-version 0.3 \-\-from tekton
.RE

.PP
Note that the resources in Artifact Hub follow full SemVer \- <major>\&.<minor>\&.<patch> (e.g. 0.3.0),
please double check the version used
Note: Tekton Hub is deprecated. Use '\-\-type artifact' with Artifact Hub instead.
Resources in Artifact Hub follow full SemVer \- <major>\&.<minor>\&.<patch> (e.g. 0.3.0).


.SH SEE ALSO
Expand Down
14 changes: 8 additions & 6 deletions docs/man/man1/tkn-hub-install.1
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,16 @@ Install a resource from a catalog by its kind, name and version
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-api\-server\fP=""
Hub API Server URL (default '
\[la]https://api.hub.tekton.dev'\[ra] for 'tekton' type; default '
\[la]https://artifacthub.io'\[ra] for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'TEKTON\_HUB\_API\_SERVER'/'ARTIFACT\_HUB\_API\_SERVER'.
Hub API Server URL.
For artifact type: default '
\[la]https://artifacthub.io'\[ra] (env: ARTIFACT\_HUB\_API\_SERVER)
For tekton type (DEPRECATED): default '
\[la]https://api.hub.tekton.dev'\[ra] (env: TEKTON\_HUB\_API\_SERVER)
Can also be set in '$HOME/.tekton/hub\-config'.

.PP
\fB\-\-type\fP="tekton"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton'
\fB\-\-type\fP="artifact"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release)


.SH SEE ALSO
Expand Down
41 changes: 32 additions & 9 deletions docs/man/man1/tkn-hub.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

.SH NAME
.PP
tkn\-hub \- Interact with tekton hub
tkn\-hub \- Interact with artifacthub


.SH SYNOPSIS
Expand All @@ -15,26 +15,49 @@ tkn\-hub \- Interact with tekton hub

.SH DESCRIPTION
.PP
Interact with tekton hub
Interact with artifacthub

.PP
Deprecation Notice: Tekton Hub support in CLI is being deprecated in favor of Artifact Hub.
The following commands currently only work with Tekton Hub and may support Artifact Hub in a future release:
\- check\-upgrade
\- downgrade
\- get
\- info
\- reinstall
\- search
\- upgrade

.PP
Action Required: Users should migrate to Artifact Hub by using the '\-\-type artifact' flag
with the install command. For example:
tkn hub install task foo \-\-type artifact \-\-from tekton\-catalog\-tasks

.PP
When using '\-\-type tekton', a deprecation warning will now be displayed.
Artifact Hub (
\[la]https://artifacthub.io\[ra]) will become the only supported hub in future releases.


.SH OPTIONS
.PP
\fB\-\-api\-server\fP=""
Hub API Server URL (default '
\[la]https://api.hub.tekton.dev'\[ra] for 'tekton' type; default '
\[la]https://artifacthub.io'\[ra] for 'artifact' type).
URL can also be defined in a file '$HOME/.tekton/hub\-config' with a variable 'TEKTON\_HUB\_API\_SERVER'/'ARTIFACT\_HUB\_API\_SERVER'.
Hub API Server URL.
For artifact type: default '
\[la]https://artifacthub.io'\[ra] (env: ARTIFACT\_HUB\_API\_SERVER)
For tekton type (DEPRECATED): default '
\[la]https://api.hub.tekton.dev'\[ra] (env: TEKTON\_HUB\_API\_SERVER)
Can also be set in '$HOME/.tekton/hub\-config'.

.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for hub

.PP
\fB\-\-type\fP="tekton"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton'
\fB\-\-type\fP="artifact"
The type of Hub from where to pull the resource. Either 'artifact' or 'tekton' (DEPRECATED: tekton type will be removed in a future release)


.SH SEE ALSO
.PP
\fBtkn(1)\fP, \fBtkn\-hub\-check\-upgrade(1)\fP, \fBtkn\-hub\-downgrade(1)\fP, \fBtkn\-hub\-get(1)\fP, \fBtkn\-hub\-info(1)\fP, \fBtkn\-hub\-install(1)\fP, \fBtkn\-hub\-reinstall(1)\fP, \fBtkn\-hub\-search(1)\fP, \fBtkn\-hub\-upgrade(1)\fP
\fBtkn(1)\fP, \fBtkn\-hub\-install(1)\fP
Loading
Loading