You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/OpenShiftPipelinesAsCode.md
+68Lines changed: 68 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,74 @@ them as per their need.
76
76
77
77
Details of the field can be found in [OpenShift Pipelines As Code Settings][pac-config]
78
78
79
+
#### Remote Hub Catalogs
80
+
81
+
Pipelines as Code supports configuring remote hub catalogs to fetch tasks and pipelines. You can configure custom catalogs using the `catalog-{INDEX}-*` settings pattern.
82
+
83
+
Each custom catalog requires the following four fields:
84
+
85
+
| Field | Description | Required |
86
+
|-------|-------------|----------|
87
+
| `catalog-{INDEX}-id` | Unique identifier for the catalog. Users reference tasks from this catalog using this ID as prefix (e.g., `custom://task-name`) | Yes |
88
+
| `catalog-{INDEX}-name` | Name of the catalog within the hub | Yes |
89
+
| `catalog-{INDEX}-url` | Full URL endpoint of the hub API | Yes |
90
+
| `catalog-{INDEX}-type` | Type of hub: `artifacthub`(for Artifact Hub) or `tektonhub` (for Tekton Hub) | Yes |
91
+
92
+
Where `{INDEX}` is a number that can be incremented to add multiple catalogs (e.g., `1`, `2`, `3`).
93
+
94
+
##### Example: Configuring a Custom Hub Catalog
95
+
96
+
```yaml
97
+
apiVersion: operator.tekton.dev/v1alpha1
98
+
kind: OpenShiftPipelinesAsCode
99
+
metadata:
100
+
name: pipelines-as-code
101
+
spec:
102
+
enable: true
103
+
settings:
104
+
catalog-1-id: "custom"
105
+
catalog-1-name: "tekton"
106
+
catalog-1-url: "https://api.custom.hub/v1"
107
+
catalog-1-type: "tektonhub"
108
+
targetNamespace: openshift-pipelines
109
+
```
110
+
111
+
##### Example: Configuring Multiple Hub Catalogs
112
+
113
+
You can configure multiple hub catalogs by incrementing the `catalog-{INDEX}` number:
114
+
115
+
```yaml
116
+
apiVersion: operator.tekton.dev/v1alpha1
117
+
kind: OpenShiftPipelinesAsCode
118
+
metadata:
119
+
name: pipelines-as-code
120
+
spec:
121
+
enable: true
122
+
settings:
123
+
catalog-1-id: "custom"
124
+
catalog-1-name: "tekton"
125
+
catalog-1-url: "https://api.custom.hub/v1"
126
+
catalog-1-type: "tektonhub"
127
+
catalog-2-id: "artifact"
128
+
catalog-2-name: "tekton-catalog-tasks"
129
+
catalog-2-url: "https://artifacthub.io"
130
+
catalog-2-type: "artifacthub"
131
+
targetNamespace: openshift-pipelines
132
+
```
133
+
134
+
##### Referencing Tasks from Custom Catalogs
135
+
136
+
Once configured, users can reference tasks from custom catalogs by adding a prefix matching the catalog ID:
> **Note:** Pipelines-as-Code will not try to fallback to the default or another custom hub if the task referenced is not found (the Pull Request will be set as failed).
144
+
145
+
For more details, see the [Pipelines-as-Code Remote Hub Catalogs documentation](https://pipelinesascode.com/docs/install/settings/#remote-hub-catalogs).
146
+
79
147
#### Additional Pipelines As Code Controller (Optional)
80
148
81
149
If users want to deploy additional Pipelines As Code controller on their cluster along with default Pipelines As Code
Copy file name to clipboardExpand all lines: docs/TektonConfig.md
+62Lines changed: 62 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -564,6 +564,68 @@ platforms:
564
564
secret-github-app-token-scoped: "true"
565
565
```
566
566
567
+
#### Remote Hub Catalogs
568
+
569
+
Pipelines as Code supports configuring remote hub catalogs to fetch tasks and pipelines. You can configure custom catalogs using the `catalog-{INDEX}-*` settings pattern.
570
+
571
+
Each custom catalog requires the following four fields:
572
+
573
+
| Field | Description | Required |
574
+
|-------|-------------|----------|
575
+
| `catalog-{INDEX}-id` | Unique identifier for the catalog. Users reference tasks from this catalog using this ID as prefix (e.g., `custom://task-name`) | Yes |
576
+
| `catalog-{INDEX}-name` | Name of the catalog within the hub | Yes |
577
+
| `catalog-{INDEX}-url` | URL endpoint of the hub API | Yes |
578
+
| `catalog-{INDEX}-type` | Type of hub: `artifacthub`(for Artifact Hub) or `tektonhub` (for Tekton Hub) | Yes |
579
+
580
+
Where `{INDEX}` is a number that can be incremented to add multiple catalogs (e.g., `1`, `2`, `3`).
581
+
582
+
##### Example: Configuring a Custom Hub Catalog
583
+
584
+
```yaml
585
+
platforms:
586
+
openshift:
587
+
pipelinesAsCode:
588
+
enable: true
589
+
settings:
590
+
catalog-1-id: "custom"
591
+
catalog-1-name: "tekton"
592
+
catalog-1-url: "https://api.custom.hub/v1"
593
+
catalog-1-type: "tektonhub"
594
+
```
595
+
596
+
##### Example: Configuring Multiple Hub Catalogs
597
+
598
+
You can configure multiple hub catalogs by incrementing the `catalog-{INDEX}` number:
599
+
600
+
```yaml
601
+
platforms:
602
+
openshift:
603
+
pipelinesAsCode:
604
+
enable: true
605
+
settings:
606
+
catalog-1-id: "custom"
607
+
catalog-1-name: "tekton"
608
+
catalog-1-url: "https://api.custom.hub/v1"
609
+
catalog-1-type: "tektonhub"
610
+
catalog-2-id: "artifact"
611
+
catalog-2-name: "tekton-catalog-tasks"
612
+
catalog-2-url: "https://artifacthub.io"
613
+
catalog-2-type: "artifacthub"
614
+
```
615
+
616
+
##### Referencing Tasks from Custom Catalogs
617
+
618
+
Once configured, users can reference tasks from custom catalogs by adding a prefix matching the catalog ID:
> **Note:** Pipelines-as-Code will not try to fallback to the default or another custom hub if the task referenced is not found (the Pull Request will be set as failed).
626
+
627
+
For more details, see the [Pipelines-as-Code Remote Hub Catalogs documentation](https://pipelinesascode.com/docs/install/settings/#remote-hub-catalogs).
628
+
567
629
**NOTE**: OpenShiftPipelinesAsCode is currently available for the OpenShift Platform only.
0 commit comments