diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 266e55c823b7..3c498bdcdd48 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -126,13 +126,6 @@ Topics: - Name: Using buildah-ns tekton task File: using-buildah-ns-tekton-task --- -Name: Custom Tekton Hub instance -Dir: hub -Distros: openshift-pipelines -Topics: -- Name: Using Tekton Hub with OpenShift Pipelines - File: using-tekton-hub-with-openshift-pipelines ---- Name: Pipelines CLI (tkn) reference Dir: tkn_cli Distros: openshift-pipelines diff --git a/create/creating-applications-with-cicd-pipelines.adoc b/create/creating-applications-with-cicd-pipelines.adoc index 3c66ed1d56c5..946b7688d0f3 100644 --- a/create/creating-applications-with-cicd-pipelines.adoc +++ b/create/creating-applications-with-cicd-pipelines.adoc @@ -85,6 +85,5 @@ include::modules/op-validating-pull-requests-using-GitHub-interceptors.adoc[leve * For more details on pipelines in the *Developer* perspective, see the xref:../create/working-with-pipelines-web-console.adoc#working-with-pipelines-web-console[Working with {pipelines-shortname} in the web console] section. * To learn more about Security Context Constraints (SCCs), see the link:https://docs.openshift.com/container-platform/latest/authentication/managing-security-context-constraints.html[Managing Security Context Constraints] section. * For more examples of reusable tasks, see the link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog] repository. Additionally, you can also see the Tekton Catalog in the Tekton project. -* To install and deploy a custom instance of {tekton-hub} for reusable tasks and pipelines, see xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}]. * For more details on re-encrypt TLS termination, see link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination]. * For more details on secured routes, see the link:https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html[Secured routes] section. diff --git a/create/remote-pipelines-tasks-resolvers.adoc b/create/remote-pipelines-tasks-resolvers.adoc index 8e0377994fbf..ba04045d9b9a 100644 --- a/create/remote-pipelines-tasks-resolvers.adoc +++ b/create/remote-pipelines-tasks-resolvers.adoc @@ -17,7 +17,7 @@ In these cases, the _resolvers_ in {pipelines-title} retrieve the pipeline, task The following resolvers are available in a default installation of {pipelines-title}: -Hub resolver:: Retrieves a task, pipeline, or `StepAction` definition from the Pipelines Catalog available on {artifact-hub} or {tekton-hub}. +Hub resolver:: Retrieves a task, pipeline, or `StepAction` definition from the Pipelines Catalog available on {artifact-hub}. Bundles resolver:: Retrieves a task, pipeline, or `StepAction` definition from a Tekton bundle, which is an OCI image available from any OCI repository, such as an OpenShift container repository. Git resolver:: Retrieves a task, pipeline, or `StepAction` definition from a Git repository. You must specify the repository, the branch, and the path. HTTP resolver:: Retrieves a task, pipeline, or `StepAction` definition from a remote HTTP or HTTPS URL. You must specify the URL for authentication. @@ -61,8 +61,3 @@ include::modules/op-resolver-community-tasks-ref.adoc[leveloffset=+1] include::modules/op-resolver-stepactions-ref.adoc[leveloffset=+1] include::modules/op-resolver-tasks-step-actions-about.adoc[leveloffset=+1] - -[role="_additional-resources"] -== Additional resources - -* xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-shortname}] diff --git a/create/working-with-pipelines-web-console.adoc b/create/working-with-pipelines-web-console.adoc index 8d6048235de3..fdb000d803f3 100644 --- a/create/working-with-pipelines-web-console.adoc +++ b/create/working-with-pipelines-web-console.adoc @@ -32,11 +32,6 @@ include::modules/op-editing-pipelines.adoc[leveloffset=+2] include::modules/op-deleting-pipelines.adoc[leveloffset=+2] -[role="_additional-resources"] -.Additional resources - -* xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-shortname}] - // Admin console include::modules/op-creating-pipeline-templates-admin-console.adoc[leveloffset=+1] diff --git a/hub/_attributes b/hub/_attributes deleted file mode 120000 index 93957f02273f..000000000000 --- a/hub/_attributes +++ /dev/null @@ -1 +0,0 @@ -../_attributes \ No newline at end of file diff --git a/hub/docinfo.xml b/hub/docinfo.xml deleted file mode 100644 index c102b4ea9b0f..000000000000 --- a/hub/docinfo.xml +++ /dev/null @@ -1,11 +0,0 @@ -Custom Tekton Hub instance -{product-title} -{product-version} -Installing a custom instance of Tekton Hub - - This document provides information about installing and deploying a custom instance of Tekton Hub. - - - Red Hat OpenShift Documentation Team - - diff --git a/hub/images b/hub/images deleted file mode 120000 index 5e67573196d8..000000000000 --- a/hub/images +++ /dev/null @@ -1 +0,0 @@ -../images \ No newline at end of file diff --git a/hub/modules b/hub/modules deleted file mode 120000 index 464b823aca16..000000000000 --- a/hub/modules +++ /dev/null @@ -1 +0,0 @@ -../modules \ No newline at end of file diff --git a/hub/snippets b/hub/snippets deleted file mode 120000 index 9f5bc7e4dde0..000000000000 --- a/hub/snippets +++ /dev/null @@ -1 +0,0 @@ -../snippets \ No newline at end of file diff --git a/hub/using-tekton-hub-with-openshift-pipelines.adoc b/hub/using-tekton-hub-with-openshift-pipelines.adoc deleted file mode 100644 index 3a053cb24661..000000000000 --- a/hub/using-tekton-hub-with-openshift-pipelines.adoc +++ /dev/null @@ -1,42 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="using-tekton-hub-with-openshift-pipelines"] -= Using {tekton-hub} with {pipelines-shortname} -:context: using-tekton-hub-with-openshift-pipelines - -toc::[] - -:FeatureName: {tekton-hub} -include::snippets/technology-preview.adoc[] - -[role="_abstract"] -{tekton-hub} helps you discover, search, and share reusable tasks and pipelines for your CI/CD workflows. A public instance of {tekton-hub} is available at link:https://hub.tekton.dev/[hub.tekton.dev]. Cluster administrators can also install and deploy a custom instance of {tekton-hub} by modifying the configurations in the `TektonHub` custom resource (CR). - -include::modules/op-installing-and-deploying-tekton-hub-on-an-openshift-cluster.adoc[leveloffset=+1] - -include::modules/op-installing-tekton-hub-without-login-and-rating.adoc[leveloffset=+2] - -include::modules/op-installing-tekton-hub-with-login-and-rating.adoc[leveloffset=+2] - -include::modules/op-using-a-custom-database-in-tekton-hub.adoc[leveloffset=+1] - -include::modules/op-installing-crunchy-postgres-database-and-tekton-hub.adoc[leveloffset=+2] - -include::modules/op-migrating-tekton-hub-data-to-an-existing-crunchy-postgres-database.adoc[leveloffset=+2] - -include::modules/op-updating-tekton-hub-with-custom-categories-and-catalogs.adoc[leveloffset=+1] - -include::modules/op-modifying-catalog-refresh-interval-tekton-hub.adoc[leveloffset=+1] - -include::modules/op-adding-new-users-in-tekton-hub-configuration.adoc[leveloffset=+1] - -include::modules/op-disabling-tekton-hub-authorization-after-upgrade.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* link:https://github.com/tektoncd/hub[{tekton-hub}] - -* xref:../install_config/installing-pipelines.adoc#installing-pipelines[Installing {pipelines-shortname}] - -* xref:../release_notes/op-release-notes-1-22.adoc#op-release-notes-1-22[{pipelines-title} release notes] diff --git a/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc b/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc index 4a84f9c134d2..881aa8f707fa 100644 --- a/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc +++ b/install_config/customizing-configurations-in-the-tektonconfig-cr.adoc @@ -15,7 +15,6 @@ In {pipelines-title}, you can customize the following configurations by using th * Disabling the service monitor * Configuring pipeline resolvers * Disabling pipeline templates -* Disabling the integration of {tekton-hub} * Disabling the automatic creation of RBAC resources * Pruning of task runs and pipeline runs @@ -41,8 +40,6 @@ include::modules/op-disabling-pipeline-templates.adoc[leveloffset=+1] include::modules/op-disabling-pipeline-triggers.adoc[leveloffset=+1] -include::modules/op-disabling-the-integretion-of-tekton-hub.adoc[leveloffset=+1] - include::modules/op-migrating-from-tekton-hub-to-artifact-hub.adoc[leveloffset=+1] include::modules/op-assess-migration-impact.adoc[leveloffset=+2] diff --git a/install_config/installing-pipelines.adoc b/install_config/installing-pipelines.adoc index c0dc0ecdac48..6003b348e4f1 100644 --- a/install_config/installing-pipelines.adoc +++ b/install_config/installing-pipelines.adoc @@ -35,8 +35,6 @@ include::modules/op-pipelines-operator-in-restricted-environment.adoc[leveloffse * xref:../records/using-tekton-results-for-openshift-pipelines-observability.adoc#using-tekton-results-for-openshift-pipelines-observability[Using {tekton-results} for {pipelines-shortname} observability] -* xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}] - * xref:../create/creating-applications-with-cicd-pipelines.adoc#op-mirroring-images-to-run-pipelines-in-restricted-environment_creating-applications-with-cicd-pipelines[Mirroring images to run pipelines in a restricted environment] * link:https://docs.openshift.com/container-platform/latest/openshift_images/configuring-samples-operator.html#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster] diff --git a/modules/op-adding-new-users-in-tekton-hub-configuration.adoc b/modules/op-adding-new-users-in-tekton-hub-configuration.adoc deleted file mode 100644 index bd3d87c79016..000000000000 --- a/modules/op-adding-new-users-in-tekton-hub-configuration.adoc +++ /dev/null @@ -1,68 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="adding-new-users-in-tekton-hub-configuration_{context}"] -= Adding new users in {tekton-hub} configuration - -[role="_abstract"] -Cluster administrators can add new users to {tekton-hub} with different scopes. - -.Procedure -. Change the `TektonHub` CR to add new users with different scopes. -+ -[source,yaml] ----- -... -scopes: - - name: agent:create - users: [, ] - - name: catalog:refresh - users: [, ] - - name: config:refresh - users: [, ] - -default: - scopes: - - rating:read - - rating:write -... ----- -``:: The usernames registered with the Git repository hosting service provider. -+ -[NOTE] -==== -A new user signing in to {tekton-hub} for the first time will have only the default scope. To activate additional scopes, ensure you add the user's username in the `scopes` field of the `TektonHub` CR. -==== - -. Apply the updated `TektonHub` CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Check the status of the {tekton-hub}. The updated `TektonHub` CR might take some time to reach a steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- - -. Refresh the configuration. -+ -[source,terminal] ----- -$ curl -X POST -H "Authorization: " \ - --header "Content-Type: application/json" \ - --data '{"force": true} \ - /system/config/refresh ----- -``:: The JSON Web Token (JWT). diff --git a/modules/op-additional-options-webhooks.adoc b/modules/op-additional-options-webhooks.adoc index 2dd6951e6e3f..c36131b7e29d 100644 --- a/modules/op-additional-options-webhooks.adoc +++ b/modules/op-additional-options-webhooks.adoc @@ -127,25 +127,4 @@ spec: failurePolicy: Fail timeoutSeconds: 20 sideEffects: None ----- -+ -.Example settings for the {tekton-hub} controller -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1 -kind: TektonConfig -metadata: - name: config -spec: - hub: - options: - webhookConfigurationOptions: - validation.webhook.hub.tekton.dev: - failurePolicy: Fail - timeoutSeconds: 20 - sideEffects: None - webhook.hub.tekton.dev: - failurePolicy: Fail - timeoutSeconds: 20 - sideEffects: None ----- +---- \ No newline at end of file diff --git a/modules/op-assess-migration-impact.adoc b/modules/op-assess-migration-impact.adoc index 57b6188aad06..d131ed739adb 100644 --- a/modules/op-assess-migration-impact.adoc +++ b/modules/op-assess-migration-impact.adoc @@ -11,7 +11,6 @@ You must migrate to {artifact-hub} to ensure uninterrupted catalog resolution. You must migrate if: * Your Tekton resources reference `type: tekton` or `catalog: Tekton`. -* You rely on {tekton-hub} as a hosted catalog service. Use the following scripts to identify which Tekton resources require modification and to verify the hub resolver configuration on your cluster. diff --git a/modules/op-configuring-pipeline-resolvers.adoc b/modules/op-configuring-pipeline-resolvers.adoc index 1e50983c721e..55e400d8dd92 100644 --- a/modules/op-configuring-pipeline-resolvers.adoc +++ b/modules/op-configuring-pipeline-resolvers.adoc @@ -11,7 +11,6 @@ You can enable or disable specific pipeline resolvers, such as git, cluster, bun * `enable-bundles-resolver` * `enable-cluster-resolver` * `enable-git-resolver` -* `enable-hub-resolver` .Example [source,yaml] @@ -25,7 +24,6 @@ spec: enable-bundles-resolver: true enable-cluster-resolver: true enable-git-resolver: true - enable-hub-resolver: true ---- You can also give resolver specific configurations in the `TektonConfig` CR. For example, define the following fields in the `map[string]string` format to set configurations for each pipeline resolver: @@ -45,6 +43,4 @@ spec: default-namespace: test git-resolver-config: server-url: localhost.com - hub-resolver-config: - default-tekton-hub-catalog: tekton ---- diff --git a/modules/op-constructing-pipelines-using-pipeline-builder.adoc b/modules/op-constructing-pipelines-using-pipeline-builder.adoc index bcdcecb073bc..b2891bd43535 100644 --- a/modules/op-constructing-pipelines-using-pipeline-builder.adoc +++ b/modules/op-constructing-pipelines-using-pipeline-builder.adoc @@ -14,13 +14,6 @@ In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeli * Reference these pipeline resources in each of the tasks in the pipeline as input and output resources. * If required, reference any additional parameters added to the pipeline in the task. The Pipeline Builder prepopulates the task parameters based on the task specifications. * Use the Operator-installed, reusable snippets and samples to create detailed pipelines. -* Search and add tasks from your configured local {tekton-hub} instance. - -[IMPORTANT] -==== -In the developer perspective, you can create a customized pipeline using your own set of curated tasks. To search, install, and upgrade your tasks directly from the developer console, your cluster administrator needs to install and deploy a local {tekton-hub} instance and link that hub to the {product-title} cluster. For more details, see _Using {tekton-hub} with {pipelines-shortname}_ in the _Additional resources_ section. -If you do not deploy any local {tekton-hub} instance, by default, you can only access namespace tasks and public {tekton-hub} tasks. -==== .Procedure @@ -45,7 +38,7 @@ image::op-pipeline-yaml.png[YAML view of the Pipeline builder] + [NOTE] ==== -The search list has all the {tekton-hub} tasks and tasks available in the cluster. Also, if a task is already installed, it will show *Add* to add the task, whereas it will show *Install and add* to install and add the task. It will show *Update and add* when you add the same task with an updated version. +The search list has all the tasks available in the cluster. Also, if a task is already installed, it will show *Add* to add the task, whereas it will show *Install and add* to install and add the task. It will show *Update and add* when you add the same task with an updated version. ==== *** To add sequential tasks to the pipeline: diff --git a/modules/op-disabling-tekton-hub-authorization-after-upgrade.adoc b/modules/op-disabling-tekton-hub-authorization-after-upgrade.adoc deleted file mode 100644 index 3bc2162221df..000000000000 --- a/modules/op-disabling-tekton-hub-authorization-after-upgrade.adoc +++ /dev/null @@ -1,86 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="disabling-tekton-hub-authorization-after-upgrade.adoc_{context}"] -= Disabling {tekton-hub} authorization after upgrading the {pipelines-title} Operator from 1.7 to 1.8 - -[role="_abstract"] -When you install {tekton-hub} with {pipelines-title} Operator 1.8, the default installation disables login authorization and ratings for the {tekton-hub} artifacts. However, when you upgrade the Operator from 1.7 to 1.8, the instance of the {tekton-hub} on your cluster does not automatically disable the login authorization and ratings. - -To disable login authorization and ratings for {tekton-hub} after upgrading the Operator from 1.7 to 1.8, perform the steps in the following procedure. - -.Prerequisites -* You installed the {pipelines-title} Operator in the default `openshift-pipelines` namespace on the cluster. - -.Procedure - -. Delete the existing {tekton-hub} API secret that you created while manually installing {tekton-hub} for Operator 1.7. -+ -[source,terminal] ----- -$ oc delete secret tekton-hub-api -n ----- -``:: The common namespace for the {tekton-hub} API secret and the {tekton-hub} CR. By default, the target namespace is `openshift-pipelines`. - -. Delete the `TektonInstallerSet` object for the {tekton-hub} API. -+ -[source,terminal] ----- -$ oc get tektoninstallerset -o name | grep tekton-hub-api | xargs oc delete ----- -+ -[NOTE] -==== -After deletion, the Operator automatically creates a new {tekton-hub} API installer set. -==== -+ -Wait and check the status of the {tekton-hub}. Proceed to the next steps when the `READY` column displays `True`. -+ -[source,terminal] ----- -$ oc get tektonhub hub ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub 1.8.0 True https://tekton-hub-api-openshift-pipelines.apps.example.com https://tekton-hub-ui-openshift-pipelines.apps.example.com - ----- - -. Delete the `ConfigMap` object for the {tekton-hub} UI. -+ -[source,terminal] ----- -$ oc delete configmap tekton-hub-ui -n ----- -``:: The common namespace for the {tekton-hub} UI and the {tekton-hub} CR. By default, the target namespace is `openshift-pipelines`. - -. Delete the `TektonInstallerSet` object for the {tekton-hub} UI. -+ -[source,terminal] ----- -$ oc get tektoninstallerset -o name | grep tekton-hub-ui | xargs oc delete ----- -+ -[NOTE] -==== -After deletion, the Operator automatically creates a new {tekton-hub} UI installer set. -==== -+ -Wait and check the status of the {tekton-hub}. Proceed to the next steps when the `READY` column displays `True`. -+ -[source,terminal] ----- -$ oc get tektonhub hub ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub 1.8.0 True https://tekton-hub-api-openshift-pipelines.apps.example.com https://tekton-hub-ui-openshift-pipelines.apps.example.com - ----- \ No newline at end of file diff --git a/modules/op-disabling-the-integretion-of-tekton-hub.adoc b/modules/op-disabling-the-integretion-of-tekton-hub.adoc deleted file mode 100644 index 1034ace6934f..000000000000 --- a/modules/op-disabling-the-integretion-of-tekton-hub.adoc +++ /dev/null @@ -1,24 +0,0 @@ -// This module is included in the following assemblies: -// * install_config/customizing-configurations-in-the-tektonconfig-cr.adoc - -:_mod-docs-content-type: CONCEPT -[id="op-disabling-the-integretion-of-tekton-hub_{context}"] -= Disabling the integration of {tekton-hub} - -[role="_abstract"] -You can disable the {tekton-hub} integration in the {OCP} web console Developer perspective to customize the user experience. The `enable-devconsole-integration` parameter in the `TektonConfig` custom resource (CR) controls this setting. - -.Example of disabling {tekton-hub} - -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonConfig -metadata: - name: config -spec: - hub: - params: - - name: enable-devconsole-integration - value: false ----- diff --git a/modules/op-installing-and-deploying-tekton-hub-on-an-openshift-cluster.adoc b/modules/op-installing-and-deploying-tekton-hub-on-an-openshift-cluster.adoc deleted file mode 100644 index 61804d702949..000000000000 --- a/modules/op-installing-and-deploying-tekton-hub-on-an-openshift-cluster.adoc +++ /dev/null @@ -1,19 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: CONCEPT -[id="installing-and-deploying-tekton-hub-on-an-openshift-cluster_{context}"] -= Installing and deploying {tekton-hub} on a {OCP} cluster - -[role="_abstract"] -{tekton-hub} is an optional component; cluster administrators cannot install it by using the `TektonConfig` custom resource (CR). To install and manage {tekton-hub}, use the `TektonHub` CR. - -You can install {tekton-hub} on your cluster by using two modes: - -* _Without_ login authorization and ratings for {tekton-hub} artifacts -* _with_ login authorization and ratings for {tekton-hub} artifacts - -[NOTE] -==== -If you are using GitHub Enterprise or GitLab Enterprise, install and deploy {tekton-hub} in the same network as the enterprise server. For example, if the enterprise server is running behind a VPN, deploy {tekton-hub} on a cluster that is also behind the VPN. -==== \ No newline at end of file diff --git a/modules/op-installing-crunchy-postgres-database-and-tekton-hub.adoc b/modules/op-installing-crunchy-postgres-database-and-tekton-hub.adoc deleted file mode 100644 index 06d5fe5ba6d6..000000000000 --- a/modules/op-installing-crunchy-postgres-database-and-tekton-hub.adoc +++ /dev/null @@ -1,164 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="installing-crunchy-postgres-database-and-tekton-hub_{context}"] -= Installing Crunchy Postgres database and {tekton-hub} - -[role="_abstract"] -This is an optional procedure. Cluster administrators can install the Crunchy Postgres database and configure {tekton-hub} to use it instead of the default database. - -.Prerequisites - -* Install the Crunchy Postgres Operator from the OperatorHub. -* Create a Postgres instance that initiates a Crunchy Postgres database. - -.Procedure - -. Get into the Crunchy Postgres pod. -+ -.Example output -[source,terminal] ----- -$ oc exec -it -n openshift-operators test-instance1-m7hh-0 -- /bin/sh - -Defaulting container name to database. -Use 'oc describe pod/test-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. -sh-4.4$ psql -U postgres -psql (14.4) -Type "help" for help. ----- - -. Find the `pg_hba.conf` file. -+ -[source,terminal] ----- -postgres=# SHOW hba_file; - hba_file --------------------------- - /pgdata/pg14/pg_hba.conf -(1 row) - -postgres=# ----- - -. Exit from the database. - -. Check if the `pg_hba.conf` file has the entry `host all all 0.0.0.0/0 md5`, required to access all incoming connections. In addition, add the entry at the end of the `pg_hba.conf` file. -+ -.Example: `pg_hba.conf` file -[source,terminal] ----- -sh-4.4$ cat /pgdata/pg14/pg_hba.conf - -# Do not edit this file manually! -# It will be overwritten by Patroni! -local all "postgres" peer -hostssl replication "_crunchyrepl" all cert -hostssl "postgres" "_crunchyrepl" all cert -host all "_crunchyrepl" all reject -hostssl all all all md5 -host all all 0.0.0.0/0 md5 ----- - -. Save the `pg_hba.conf` file and reload the database. -+ -[source,terminal] ----- -sh-4.4$ psql -U postgres -psql (14.4) -Type "help" for help. - -postgres=# SHOW hba_file; - hba_file --------------------------- - /pgdata/pg14/pg_hba.conf -(1 row) - -postgres=# SELECT pg_reload_conf(); - pg_reload_conf ----------------- - t -(1 row) ----- - -. Exit the database. - -. Decode the secret value of the Crunchy Postgres host. -+ -.Example: Decode the secret value of a Crunchy Postgres host -[source,terminal] ----- -$ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode -test-primary.openshift-operators.svc ----- - -. Create a secret named `tekton-hub-db` in the target namespace with the following keys: -* `POSTGRES_HOST` -* `POSTGRES_DB` -* `POSTGRES_USER` -* `POSTGRES_PASSWORD` -* `POSTGRES_PORT` - -+ -.Example: Custom database secrets -[source,yaml] ----- -apiVersion: v1 -kind: Secret -metadata: - name: tekton-hub-db - labels: - app: tekton-hub-db -type: Opaque -stringData: - POSTGRES_HOST: test-primary.openshift-operators.svc - POSTGRES_DB: test - POSTGRES_USER: - POSTGRES_PASSWORD: - POSTGRES_PORT: '5432' -... ----- - -+ -[NOTE] -==== -The default target namespace is `openshift-pipelines`. -==== - -. In the `TektonHub` CR, set the value of the database secret attribute to `tekton-hub-db`. -+ -.Example: Adding custom database secret -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - db: - secret: tekton-hub-db -... ----- - -. Use the updated `TektonHub` CR to associate the custom database with {tekton-hub}. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Check the status of the installation. The `TektonHub` CR might take some time to reach a steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- diff --git a/modules/op-installing-tekton-hub-with-login-and-rating.adoc b/modules/op-installing-tekton-hub-with-login-and-rating.adoc deleted file mode 100644 index 249787a2c19b..000000000000 --- a/modules/op-installing-tekton-hub-with-login-and-rating.adoc +++ /dev/null @@ -1,144 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="installing-tekton-hub-with-login-and-rating_{context}"] -= Installing {tekton-hub} with login and rating - -[role="_abstract"] -You can install {tekton-hub} on your cluster with custom configuration that supports login with authorization and ratings for {tekton-hub} artifacts. - -.Prerequisites -* You installed the {pipelines-title} Operator in the default `openshift-pipelines` namespace on the cluster. - -.Procedure - -. Create an OAuth application with your Git repository hosting provider, and note the Client ID and Client Secret. The supported providers are GitHub, GitLab, and Bitbucket. - -** For a link:https://docs.github.com/en/developers/apps/creating-an-oauth-app[GitHub OAuth application], set the Homepage URL and the Authorization callback URL as ``. - -** For a link:https://docs.gitlab.com/ee/integration/oauth_provider.html#user-owned-applications[GitLab OAuth application], set the `REDIRECT_URI` as `/auth/gitlab/callback`. - -** For a link:https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud[Bitbucket OAuth application], set the `Callback URL` as ``. - -. Edit the `/config/02-api/20-api-secret.yaml` file to include the {tekton-hub} API secrets. For example: -+ -[source,yaml] ----- -apiVersion: v1 -kind: Secret -metadata: - name: tekton-hub-api - namespace: openshift-pipelines -type: Opaque -stringData: - GH_CLIENT_ID: - GH_CLIENT_SECRET: - GL_CLIENT_ID: - GL_CLIENT_SECRET: - BB_CLIENT_ID: - BB_CLIENT_SECRET: - JWT_SIGNING_KEY: - ACCESS_JWT_EXPIRES_IN: - REFRESH_JWT_EXPIRES_IN: - AUTH_BASE_URL: - GHE_URL: - GLE_URL: ----- -`GH_CLIENT_ID`:: The Client ID from the GitHub OAuth application. -`GH_CLIENT_SECRET`:: The Client Secret from the GitHub OAuth application. -`GL_CLIENT_ID`:: The Client ID from the GitLab OAuth application. -`GL_CLIENT_SECRET`:: The Client Secret from the GitLab OAuth application. -`BB_CLIENT_ID`:: The Client ID from the Bitbucket OAuth application. -`BB_CLIENT_SECRET`:: The Client Secret from the Bitbucket OAuth application. -`JWT_SIGNING_KEY`:: A long, random string used to sign the JSON Web Token (JWT) created for users. -`ACCESS_JWT_EXPIRES_IN`:: Add the time limit after which the access token expires. For example, `1m`, where m denotes minutes. The supported units of time are seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). -`REFRESH_JWT_EXPIRES_IN`:: Add the time limit after which the refresh token expires. For example, `1m`, where `m` denotes minutes. The supported units of time are seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). Ensure that the expiry time set for token refresh is greater than the expiry time set for token access. -`AUTH_BASE_URL`:: Route URL for the OAuth application. -`GHE_URL`:: GitHub Enterprise URL, if you are authenticating using GitHub Enterprise. Do not give the URL to the catalog as a value for this field. -`GLE_URL`:: GitLab Enterprise URL, if you are authenticating using GitLab Enterprise. Do not give the URL to the catalog as a value for this field. -+ -[NOTE] -==== -You can delete the unused fields for the Git repository hosting service providers that are irrelevant to your deployment. -==== - -. Create a `TektonHub` CR similar to the following example. -+ -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - db: - secret: tekton-hub-db - - categories: - - Automation - - Build Tools - - CLI - - Cloud - - Code Quality - ... - - catalogs: - - name: tekton - org: tektoncd - type: community - provider: github - url: https://github.com/tektoncd/catalog - revision: main - - scopes: - - name: agent:create - users: [] - - name: catalog:refresh - users: [] - - name: config:refresh - users: [] - - default: - scopes: - - rating:read - - rating:write - - api: - catalogRefreshInterval: 30m ----- -`targetNamespace`:: The namespace in which you install {tekton-hub}; default is `openshift-pipelines`. -`db`:: Optional: Custom database, such as a Crunchy Postgres database. -`secret`:: The name of the database secret must be `tekton-hub-db`. -`categories`:: Optional: Customized categories for tasks and pipelines in {tekton-hub}. -`catalogs`:: Optional: Customized catalogs for {tekton-hub}. -`scopes`:: Optional: Additional users. You can mention many users, such as `[, , ]`. -`default`:: Optional: Customized default scopes. -`catalogRefreshInterval`:: The time interval after which the catalog refreshes automatically. The supported units of time are seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). The default interval is 30 minutes. -+ -[NOTE] -==== -If you do not give custom values for the optional fields in the `TektonHub` CR, the system uses the default values configured in the {tekton-hub} API config map. -==== - -. Apply the `TektonHub` CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Check the status of the installation. The `TektonHub` CR might take some time to reach steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- \ No newline at end of file diff --git a/modules/op-installing-tekton-hub-without-login-and-rating.adoc b/modules/op-installing-tekton-hub-without-login-and-rating.adoc deleted file mode 100644 index 43741ac741ce..000000000000 --- a/modules/op-installing-tekton-hub-without-login-and-rating.adoc +++ /dev/null @@ -1,88 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="installing-tekton-hub-without-login-and-rating.adoc_{context}"] -= Installing {tekton-hub} without login and rating - -[role="_abstract"] -You can install {tekton-hub} on your cluster automatically with default configuration. When using the default configuration, {tekton-hub} does not support login with authorization and ratings for {tekton-hub} artifacts. - -.Prerequisites -* You installed the {pipelines-title} Operator in the default `openshift-pipelines` namespace on the cluster. - -.Procedure - -. Create a `TektonHub` CR similar to the following example. -+ -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - db: # Optional: If you want to use custom database - secret: tekton-hub-db # Name of db secret should be `tekton-hub-db` - - categories: # Optional: If you want to use custom categories - - Automation - - Build Tools - - CLI - - Cloud - - Code Quality - - ... - - catalogs: # Optional: If you want to use custom catalogs - - name: tekton - org: tektoncd - type: community - provider: github - url: https://github.com/tektoncd/catalog - revision: main - - scopes: # Optional: If you want to add new users - - name: agent:create - users: [abc, qwe, pqr] - - name: catalog:refresh - users: [abc, qwe, pqr] - - name: config:refresh - users: [abc, qwe, pqr] - - default: # Optional: If you want to add custom default scopes - scopes: - - rating:read - - rating:write - - api: - catalogRefreshInterval: 30m ----- -`spec.targetNamespace`:: The namespace in which you install {tekton-hub}; default is `openshift-pipelines`. -`spec.api.catalogRefreshInterval`:: The time interval after which the catalog refreshes automatically. The supported units of time are seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). The default interval is 30 minutes. -+ -[NOTE] -==== -If you do not give custom values for the optional fields in the `TektonHub` CR, the system uses the default values configured in the {tekton-hub} API config map. -==== - -. Apply the `TektonHub` CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Check the status of the installation. The `TektonHub` CR might take some time to reach steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- \ No newline at end of file diff --git a/modules/op-migrating-tekton-hub-data-to-an-existing-crunchy-postgres-database.adoc b/modules/op-migrating-tekton-hub-data-to-an-existing-crunchy-postgres-database.adoc deleted file mode 100644 index 8182d11559e4..000000000000 --- a/modules/op-migrating-tekton-hub-data-to-an-existing-crunchy-postgres-database.adoc +++ /dev/null @@ -1,204 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="migrating-tekton-hub-data-to-an-existing-crunchy-postgres-database_{context}"] -= Migrating {tekton-hub} data to an existing Crunchy Postgres database - -[role="_abstract"] -{tekton-hub} supports the use of Crunchy Postgres as a custom database. For a pre-installed {tekton-hub} with the default database, cluster administrators can migrate the data from the default database to an external Crunchy Postgres database. - -.Procedure - -. Dump the existing data from the internal or default database into a file in the pod. -+ -.Example -[source,terminal] ----- -$ pg_dump -Ft -h localhost -U postgres hub -f /tmp/hub.dump ----- -+ -. Copy the file containing the data dump to your local system. -+ -.Command format -[source,terminal] ----- -$ oc cp -n : ----- -+ -.Example -[source,terminal] ----- -$ oc cp -n openshift-pipelines tekton-hub-db-7d6d888c67-p7mdr:/tmp/hub.dump /home/test_user/Downloads/hub.dump ----- -+ -. Copy the file that has the data dump from the local system to the pod running the external Crunchy Postgres database. -+ -.Command format -[source,terminal] ----- -$ oc cp -n : ----- -+ -.Example -[source,terminal] ----- -$ oc cp -n openshift-operators /home/test_user/Downloads/hub.dump test-instance1-spnz-0:/tmp/hub.dump ----- -+ -. Restore the data in the Crunchy Postgres database. -+ -.Command format -[source,terminal] ----- -$ pg_restore -d -h localhost -U postgres ----- -+ -.Example -[source,terminal] ----- -$ pg_restore -d test -h localhost -U postgres /tmp/hub.dump ----- -+ -. Get into the Crunchy Postgres pod. -+ -.Example: Get into the `test-instance1-m7hh-0` pod -[source,terminal] ----- -$ oc exec -it -n openshift-operators test-instance1-m7hh-0 -- /bin/sh - -Defaulting container name to database. -Use 'oc describe pod/test-instance1-m7hh-0 -n openshift-operators' to see all of the containers in this pod. -sh-4.4$ psql -U postgres -psql (14.4) -Type "help" for help. ----- -+ -. Find the `pg_hba.conf` file. -+ -[source,terminal] ----- -postgres=# SHOW hba_file; - hba_file --------------------------- - /pgdata/pg14/pg_hba.conf -(1 row) - -postgres=# ----- -+ -. Exit from the database. -+ -. Check if the `pg_hba.conf` file has the entry `host all all 0.0.0.0/0 md5`, which is necessary for accessing all incoming connections. If necessary, add the entry at the end of the `pg_hba.conf` file. -+ -.Example: `pg_hba.conf` file -[source,terminal] ----- -sh-4.4$ cat /pgdata/pg14/pg_hba.conf - -# Do not edit this file manually! -# It will be overwritten by Patroni! -local all "postgres" peer -hostssl replication "_crunchyrepl" all cert -hostssl "postgres" "_crunchyrepl" all cert -host all "_crunchyrepl" all reject -hostssl all all all md5 -host all all 0.0.0.0/0 md5 ----- -+ -. Save the `pg_hba.conf` file and reload the database. -+ -[source,terminal] ----- -sh-4.4$ psql -U postgres -psql (14.4) -Type "help" for help. - -postgres=# SHOW hba_file; - hba_file --------------------------- - /pgdata/pg14/pg_hba.conf -(1 row) - -postgres=# SELECT pg_reload_conf(); - pg_reload_conf ----------------- - t -(1 row) ----- -+ -. Exit the database. -. Verify that a secret named `tekton-hub-db` in the target namespace has the following keys: -* `POSTGRES_HOST` -* `POSTGRES_DB` -* `POSTGRES_USER` -* `POSTGRES_PASSWORD` -* `POSTGRES_PORT` -+ -.Example: Custom database secrets -[source,yaml] ----- -apiVersion: v1 -kind: Secret -metadata: - name: tekton-hub-db - labels: - app: tekton-hub-db -type: Opaque -stringData: - POSTGRES_HOST: test-primary.openshift-operators.svc - POSTGRES_DB: test - POSTGRES_USER: test - POSTGRES_PASSWORD: woXOisU5>ocJiTF7y{{;1[Q( - POSTGRES_PORT: '5432' -... ----- -+ -[NOTE] -==== -A secret encodes the value of the `POSTGRES_HOST` field. You can decode the value of the Crunchy Postgres host by using the following example. - -.Example: Decode the secret value of a Crunchy Postgres host -[source,terminal] ----- -$ echo 'aGlwcG8tcHJpbWFyeS5vcGVuc2hpZnQtb3BlcmF0b3JzLnN2YyA=' | base64 --decode -test-primary.openshift-operators.svc ----- -==== -+ -. Verify that in the `TektonHub` CR, the value of the database secret attribute is `tekton-hub-db`. -+ -.Example: `TektonHub` CR with the name of the database secret -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - db: - secret: tekton-hub-db -... ----- -+ -. To associate the external Crunchy Postgres database with {tekton-hub}, replace any existing `TektonHub` CR with the updated `TektonHub` CR. -+ -[source,terminal] ----- -$ oc replace -f .yaml ----- -+ -. Check the status of the {tekton-hub}. The updated `TektonHub` CR might take some time to reach a steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- diff --git a/modules/op-modifying-catalog-refresh-interval-tekton-hub.adoc b/modules/op-modifying-catalog-refresh-interval-tekton-hub.adoc deleted file mode 100644 index 3823227340ed..000000000000 --- a/modules/op-modifying-catalog-refresh-interval-tekton-hub.adoc +++ /dev/null @@ -1,47 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="modifying-catalog-refresh-interval-tekton-hub_{context}"] -= Modifying the catalog refresh interval of {tekton-hub} - -[role="_abstract"] -The default catalog refresh interval for {tekton-hub} is 30 minutes. Cluster administrators can change the automatic catalog refresh interval by modifying the value of the `catalogRefreshInterval` field in the `TektonHub` CR. - -.Procedure -. Change the value of the `catalogRefreshInterval` field in the `TektonHub` CR. -+ -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - api: - catalogRefreshInterval: 30m ----- -`targetNamespace`:: The namespace that contains {tekton-hub}; default is `openshift-pipelines`. -`catalogRefreshInterval`:: The time interval after which the catalog refreshes automatically. The supported units of time are seconds (`s`), minutes (`m`), hours (`h`), days (`d`), and weeks (`w`). The default interval is 30 minutes. - -. Apply the `TektonHub` CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Check the status of the installation. The `TektonHub` CR might take some time to reach steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- \ No newline at end of file diff --git a/modules/op-resolver-hub-about.adoc b/modules/op-resolver-hub-about.adoc index ce57114a37f1..ec059e7da260 100644 --- a/modules/op-resolver-hub-about.adoc +++ b/modules/op-resolver-hub-about.adoc @@ -6,14 +6,4 @@ = Specifying a remote pipeline, task, or step action from a Tekton catalog [role="_abstract"] -You can use the hub resolver to specify a remote pipeline, task, or `StepAction` definition from a public Tekton catalog of link:https://artifacthub.io/[{artifact-hub}] or from an instance of {tekton-hub}. - -[NOTE] -==== -The public instance of {tekton-hub} (`hub.tekton.dev`) is deprecated and Red Hat will remove it in a future release. Use link:https://artifacthub.io[{artifact-hub}] as an alternative for Tekton `Pipeline` and `Task` resources: - -* link:https://artifacthub.io/packages/search?repo=tekton-catalog-tasks[Tekton Catalog Tasks] -* link:https://artifacthub.io/packages/search?repo=tekton-catalog-pipelines[Tekton Catalog Pipelines] - -{artifact-hub} is open source and supports self-hosting, providing greater flexibility for managing your Tekton `Pipeline` and `Task` resources. -==== +You can use the hub resolver to specify a remote pipeline, task, or `StepAction` definition from a public Tekton catalog of link:https://artifacthub.io/[{artifact-hub}]. diff --git a/modules/op-resolver-hub-config.adoc b/modules/op-resolver-hub-config.adoc index 1941284a6a74..0e8b92b41f33 100644 --- a/modules/op-resolver-hub-config.adoc +++ b/modules/op-resolver-hub-config.adoc @@ -29,20 +29,14 @@ metadata: spec: pipeline: hub-resolver-config: - default-tekton-hub-catalog: Tekton default-artifact-hub-task-catalog: tekton-catalog-tasks default-artifact-hub-pipeline-catalog: tekton-catalog-pipelines defailt-kind: pipeline - default-type: tekton - tekton-hub-api: "https://my-custom-tekton-hub.example.com" artifact-hub-api: "https://my-custom-artifact-hub.example.com" ---- -`default-tekton-hub-catalog`:: The default {tekton-hub} catalog for pulling a resource. `default-artifact-hub-task-catalog`:: The default {artifact-hub} catalog for pulling a task resource. `default-artifact-hub-pipeline-catalog`:: The default {artifact-hub} catalog for pulling a pipeline resource. `defailt-kind`:: The default object kind for references. -`default-type`:: The default hub for pulling a resource, either `artifact` for {artifact-hub} or `tekton` for {tekton-hub}. -`tekton-hub-api`:: The {tekton-hub} API used, if you set the `default-type` option to `tekton`. `artifact-hub-api`:: Optional: The {artifact-hub} API used, if you set the `default-type` option to `artifact`. + [IMPORTANT] diff --git a/modules/op-resolver-hub.adoc b/modules/op-resolver-hub.adoc index 72afb5dae68a..fc4726b872b1 100644 --- a/modules/op-resolver-hub.adoc +++ b/modules/op-resolver-hub.adoc @@ -7,13 +7,13 @@ = Specifying a remote pipeline, task, or step action using the hub resolver [role="_abstract"] -Specify a remote pipeline, task, or step action from {artifact-hub} or {tekton-hub} by using the hub resolver. +Specify a remote pipeline, task, or step action from {artifact-hub}. -When creating a pipeline run, you can specify a remote pipeline from {artifact-hub} or {tekton-hub}. When creating a pipeline or a task run, you can specify a remote task from {artifact-hub} or {tekton-hub}. When creating a step within a task, you can reference a remote `StepAction` definition from {artifact-hub} or {tekton-hub}. +When creating a pipeline run, you can specify a remote pipeline from {artifact-hub}. When creating a pipeline or a task run, you can specify a remote task from {artifact-hub}. When creating a step within a task, you can reference a remote `StepAction` definition from {artifact-hub}. .Procedure -* To specify a remote pipeline, task, or `StepAction` definition from {artifact-hub} or {tekton-hub}, use the following reference format in the `pipelineRef`, `taskRef`, or `step.ref` spec: +* To specify a remote pipeline, task, or `StepAction` definition from {artifact-hub}, use the following reference format in the `pipelineRef`, `taskRef`, or `step.ref` spec: + [source,yaml] ---- @@ -42,7 +42,7 @@ When creating a pipeline run, you can specify a remote pipeline from {artifact-h | Default: `tekton-catalog-tasks` (for the `task` kind); `tekton-catalog-pipelines` (for the `pipeline` kind). | `type` -| The type of the catalog for pulling the resource. Either `artifact` for {artifact-hub} or `tekton` for {tekton-hub}. +| The type of the catalog for pulling the resource. Use `artifact` for {artifact-hub}. | Default: `artifact` | `kind` diff --git a/modules/op-tkn-hub-interaction.adoc b/modules/op-tkn-hub-interaction.adoc deleted file mode 100644 index ee22a78c2223..000000000000 --- a/modules/op-tkn-hub-interaction.adoc +++ /dev/null @@ -1,93 +0,0 @@ -:_mod-docs-content-type: REFERENCE -// This module is included in the following assemblies: -// * tkn_cli/op-tkn-reference.adoc - -[id="op-tkn-hub-interaction_{context}"] -= Hub interaction commands - -[role="_abstract"] -You can use the `tkn hub` commands to interact with the {tekton-hub} and manage resources such as tasks and pipelines. - -`hub`:: -Interact with hub. -+ -.Example: Display help -[source,terminal] ----- -$ tkn hub -h ----- -+ -.Example: Interact with a hub API server -[source,terminal] ----- -$ tkn hub --api-server https://api.hub.tekton.dev ----- -+ -[NOTE] -==== -For each example, to get the corresponding sub-commands and flags, run `tkn hub --help`. -==== - -`hub downgrade`:: -Roll back an installed resource to an earlier version. -+ -.Example: Roll back the `mytask` task in the `mynamespace` namespace to its older version -[source,terminal] ----- -$ tkn hub downgrade task mytask --to version -n mynamespace ----- - -`hub get`:: -Get a resource manifest by its name, kind, catalog, and version. -+ -.Example: Get the manifest for a specific version of the `myresource` pipeline or task from the `tekton` catalog -[source,terminal] ----- -$ tkn hub get [pipeline | task] myresource --from tekton --version version ----- - -`hub info`:: -Display information about a resource by its name, kind, catalog, and version. -+ -.Example: Display information about a specific version of the `mytask` task from the `tekton` catalog -[source,terminal] ----- -$ tkn hub info task mytask --from tekton --version version ----- - -`hub install`:: -Install a resource from a catalog by its kind, name, and version. -+ -.Example: Install a specific version of the `mytask` task from the `tekton` catalog in the `mynamespace` namespace -[source,terminal] ----- -$ tkn hub install task mytask --from tekton --version version -n mynamespace ----- - -`hub reinstall`:: -Reinstall a resource by its kind and name. -+ -.Example: Reinstall a specific version of the `mytask` task from the `tekton` catalog in the `mynamespace` namespace -[source,terminal] ----- -$ tkn hub reinstall task mytask --from tekton --version version -n mynamespace ----- - -`hub search`:: -Search a resource by a combination of name, kind, and tags. -+ -.Example: Search a resource with a tag `cli` -[source,terminal] ----- -$ tkn hub search --tags cli ----- - -`hub upgrade`:: -Upgrade an installed resource. -+ -.Example: Upgrade the installed `mytask` task in the `mynamespace` namespace to a new version -[source,terminal] ----- -$ tkn hub upgrade task mytask --to version -n mynamespace ----- - diff --git a/modules/op-updating-tekton-hub-with-custom-categories-and-catalogs.adoc b/modules/op-updating-tekton-hub-with-custom-categories-and-catalogs.adoc deleted file mode 100644 index 5d27f35ebbed..000000000000 --- a/modules/op-updating-tekton-hub-with-custom-categories-and-catalogs.adoc +++ /dev/null @@ -1,39 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="updating-tekton-hub-with-custom-categories-and-catalogs_{context}"] -= Updating {tekton-hub} with custom categories and catalogs - -[role="_abstract"] -Cluster administrators can update {tekton-hub} with custom categories, catalogs, scopes, and default scopes that reflect the context of their organization. - -.Procedure - -. Optional: Edit the `categories`, `catalogs`, `scopes`, and `default:scopes` fields in the {tekton-hub} CR. -+ -[NOTE] -==== -The {tekton-hub} API config map gives the default information for categories, catalog, scopes, and default scopes. If you give custom values in the `TektonHub` CR, it overrides the default values. -==== - -. Apply the {tekton-hub} CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -. Observe the {tekton-hub} status. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url https://ui.route.url ----- \ No newline at end of file diff --git a/modules/op-using-a-custom-database-in-tekton-hub.adoc b/modules/op-using-a-custom-database-in-tekton-hub.adoc deleted file mode 100644 index 0aac58e03ddf..000000000000 --- a/modules/op-using-a-custom-database-in-tekton-hub.adoc +++ /dev/null @@ -1,91 +0,0 @@ -// This module is included in the following assemblies: -// * hub/using-tekton-hub-with-openshift-pipelines.adoc - -:_mod-docs-content-type: PROCEDURE -[id="using-a-custom-database-in-tekton-hub_{context}"] -= Using a custom database in {tekton-hub} - -[role="_abstract"] -Cluster administrators can use a custom database with {tekton-hub}, instead of the default PostgreSQL database installed by the Operator. You can associate a custom database at the time of installation, and use it with the `db-migration`, `api`, and `ui` interfaces provided by {tekton-hub}. Or, you can associate a custom database with {tekton-hub} even after the installation with the default database is complete. - -.Procedure - -. Create a secret named `tekton-hub-db` in the target namespace with the following keys: -* `POSTGRES_HOST` -* `POSTGRES_DB` -* `POSTGRES_USER` -* `POSTGRES_PASSWORD` -* `POSTGRES_PORT` -+ -.Example: Custom database secrets -[source,yaml] ----- -apiVersion: v1 -kind: Secret -metadata: - name: tekton-hub-db - labels: - app: tekton-hub-db -type: Opaque -stringData: - POSTGRES_HOST: - POSTGRES_DB: - POSTGRES_USER: - POSTGRES_PASSWORD: - POSTGRES_PORT: -... ----- -+ -[NOTE] -==== -The default target namespace is `openshift-pipelines`. -==== - -. In the `TektonHub` CR, set the value of the database secret attribute to `tekton-hub-db`. -+ -.Example: Adding custom database secret -[source,yaml] ----- -apiVersion: operator.tekton.dev/v1alpha1 -kind: TektonHub -metadata: - name: hub -spec: - targetNamespace: openshift-pipelines - db: - secret: tekton-hub-db - api: - hubConfigUrl: https://raw.githubusercontent.com/tektoncd/hub/main/config.yaml - catalogRefreshInterval: 30m -... ----- - -. Use the updated `TektonHub` CR to associate the custom database with {tekton-hub}. - -.. If you are associating the custom database at the time of installing {tekton-hub} on your cluster, apply the updated `TektonHub` CR. -+ -[source,terminal] ----- -$ oc apply -f .yaml ----- - -.. Or, if you are associating the custom database after the installation of {tekton-hub} is complete, replace the existing `TektonHub` CR with the updated `TektonHub` CR. -+ -[source,terminal] ----- -$ oc replace -f .yaml ----- - -. Check the status of the installation. The `TektonHub` CR might take some time to reach steady state. -+ -[source,terminal] ----- -$ oc get tektonhub.operator.tekton.dev ----- -+ -.Sample output -[source,terminal] ----- -NAME VERSION READY REASON APIURL UIURL -hub v1.9.0 True https://api.route.url/ https://ui.route.url/ ----- \ No newline at end of file diff --git a/tkn_cli/op-tkn-reference.adoc b/tkn_cli/op-tkn-reference.adoc index 5c6a669ab009..a6bf3271e52d 100644 --- a/tkn_cli/op-tkn-reference.adoc +++ b/tkn_cli/op-tkn-reference.adoc @@ -43,6 +43,3 @@ include::modules/op-tkn-pipeline-resource-management.adoc[leveloffset=+1] // Trigger management commands include::modules/op-tkn-trigger-management.adoc[leveloffset=+1] - -// Hub interaction commands -include::modules/op-tkn-hub-interaction.adoc[leveloffset=+1]