Skip to content

Commit 2b0dd75

Browse files
authored
Merge pull request #63192 from ekristova/RHDEVDOCS-5565
RHDEVDOCS-5565: Expose TEKTON_HUB_API variable in the tektonconfig.
2 parents 7bfdee7 + a96b6ae commit 2b0dd75

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

cicd/pipelines/remote-pipelines-tasks-resolvers.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,43 @@ Git resolver:: Retrieves a task or pipeline binding from a Git repository. You m
2121

2222
[id="resolver-hub_{context}"]
2323
== Specifying a remote pipeline or task from a Tekton catalog
24-
You can specify a remote pipeline or task that is defined in a public Tekton catalog, either link:https://artifacthub.io/[{artifact-hub}] or link:https://hub.tekton.dev/[{tekton-hub}], by using the hub resolver.
24+
You can use the hub resolver to specify a remote pipeline or task that is defined either in a public Tekton catalog of link:https://artifacthub.io/[{artifact-hub}] or in an instance of {tekton-hub}.
25+
26+
[IMPORTANT]
27+
====
28+
The {artifact-hub} project is not supported with {pipelines-title}. Only the configuration of {artifact-hub} is supported.
29+
====
2530

2631
include::modules/op-resolver-hub-config.adoc[leveloffset=+2]
2732
include::modules/op-resolver-hub.adoc[leveloffset=+2]
2833

2934
[id="resolver-bundles_{context}"]
3035
== Specifying a remote pipeline or task from a Tekton bundle
3136

32-
You can specify a remote pipeline or task from a Tekton bundle by using the bundles resolver. A Tekton bundle is an OCI image available from any OCI repository, such as an OpenShift container repository.
37+
You can use the bundles resolver to specify a remote pipeline or task from a Tekton bundle. A Tekton bundle is an OCI image available from any OCI repository, such as an OpenShift container repository.
3338

3439
include::modules/op-resolver-bundle-config.adoc[leveloffset=+2]
3540
include::modules/op-resolver-bundle.adoc[leveloffset=+2]
3641

3742
[id="resolver-cluster_{context}"]
3843
== Specifying a remote pipeline or task from the same cluster
3944

40-
You can specify a remote pipeline or task that is defined in a namespace on the {product-title} cluster where {pipelines-title} is running by using the cluster resolver.
45+
You can use the cluster resolver to specify a remote pipeline or task that is defined in a namespace on the {product-title} cluster where {pipelines-title} is running.
4146

4247
include::modules/op-resolver-cluster-config.adoc[leveloffset=+2]
4348
include::modules/op-resolver-cluster.adoc[leveloffset=+2]
4449

4550
[id="resolver-git_{context}"]
4651
== Specifying a remote pipeline or task from a Git repository
4752

48-
You can specify a remote pipeline or task from a Git repostory by using the Git resolver. The repository must contain a YAML file that defines the pipeline or task. The Git resolver can access a repository either by cloning it anonymously or else by using the authenticated SCM API.
53+
You can use the Git resolver to specify a remote pipeline or task from a Git repostory. The repository must contain a YAML file that defines the pipeline or task. The Git resolver can access a repository either by cloning it anonymously or else by using the authenticated SCM API.
4954

5055
include::modules/op-resolver-git-config-anon.adoc[leveloffset=+2]
5156
include::modules/op-resolver-git-config-scm.adoc[leveloffset=+2]
5257
include::modules/op-resolver-git.adoc[leveloffset=+2]
58+
59+
[role="_additional-resources"]
60+
[id="additional-resources_{context}"]
61+
== Additional resources
62+
63+
* xref:../../cicd/pipelines/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using Tekton Hub with {pipelines-shortname}]

modules/op-resolver-hub-config.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,20 @@ spec:
3333
default-artifact-hub-pipeline-catalog: tekton-catalog-pipelines # <3>
3434
defailt-kind: pipeline # <4>
3535
default-type: tekton # <5>
36+
tekton-hub-api: "https://my-custom-tekton-hub.example.com" # <6>
37+
artifact-hub-api: "https://my-custom-artifact-hub.example.com" # <7>
3638
----
3739
<1> The default {tekton-hub} catalog for pulling a resource.
3840
<2> The default {artifact-hub} catalog for pulling a task resource.
3941
<3> The default {artifact-hub} catalog for pulling a pipeline resource.
4042
<4> The default object kind for references.
4143
<5> The default hub for pulling a resource, either `artifact` for {artifact-hub} or `tekton` for {tekton-hub}.
44+
<6> The {tekton-hub} API used, if the `default-type` option is set to `tekton`.
45+
<7> Optional: The {artifact-hub} API used, if the `default-type` option is set to `artifact`.
46+
+
47+
[IMPORTANT]
48+
====
49+
If you set the `default-type` option to `tekton`, you must configure your own instance of the {tekton-hub} by setting the `tekton-hub-api` value.
50+
51+
If you set the `default-type` option to `artifact` then the resolver uses the public hub API at https://artifacthub.io/ by default. You can configure your own {artifact-hub} API by setting the `artifact-hub-api` value.
52+
====

0 commit comments

Comments
 (0)