Skip to content

Commit 87a0528

Browse files
author
edge-katanomi-app2[bot]
committed
📚 Sync docs from alaudadevops/tektoncd-operator on 92029d77b1695f6e39ab4512b9809cc7ee3503a3
Source: docs: update tekton pipeline configuration documentation (#481) Author: alaudabot Ref: refs/heads/release-4.0 Commit: 92029d77b1695f6e39ab4512b9809cc7ee3503a3 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/92029d77b1695f6e39ab4512b9809cc7ee3503a3 🤖 Synced on 2025-09-05 10:21:05 UTC
1 parent c80889f commit 87a0528

File tree

13 files changed

+376
-251
lines changed

13 files changed

+376
-251
lines changed

‎.github/SYNC_INFO.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-08-12 04:40:19 UTC
3+
- **Last synced**: 2025-09-05 10:21:05 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [8dbf6ef0d36f58b2383b23b46e15b1da88448b4b](https://github.com/alaudadevops/tektoncd-operator/commit/8dbf6ef0d36f58b2383b23b46e15b1da88448b4b)
6-
- **Triggered by**: l-qing
7-
- **Workflow run**: [#34](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16899133783)
5+
- **Source commit**: [92029d77b1695f6e39ab4512b9809cc7ee3503a3](https://github.com/alaudadevops/tektoncd-operator/commit/92029d77b1695f6e39ab4512b9809cc7ee3503a3)
6+
- **Triggered by**: edge-katanomi-app2[bot]
7+
- **Workflow run**: [#49](https://github.com/alaudadevops/tektoncd-operator/actions/runs/17490493559)
88

99
## Files synced:
1010
- docs/

‎docs/en/apis/advanced_apis/results/intro.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ CEL expressions typically correspond one-to-one with JSON/protobuf fields. In Te
448448

449449
#### Using Operators
450450

451-
Now that we can access fields, you can create filters using operators. Here’s a list of operators that can be used in CEL expressions:
451+
Now that we can access fields, you can create filters using operators. Here's a list of operators that can be used in CEL expressions:
452452

453453
| Operator | Description | Example |
454454
| ----------------------- | -------------------------- | -------------------------------------------- |
@@ -463,7 +463,7 @@ Now that we can access fields, you can create filters using operators. Here’s
463463

464464
#### Using Functions
465465

466-
Many functions can be used in CEL expressions. Here’s a list of functions that can be used in CEL expressions. The strings in function parameters represent the expected type of the arguments:
466+
Many functions can be used in CEL expressions. Here's a list of functions that can be used in CEL expressions. The strings in function parameters represent the expected type of the arguments:
467467

468468
| Function | Description | Example |
469469
| ----------------------------------------------------| ----------------------------| -------------------------------------------- |
@@ -482,7 +482,7 @@ You can also nest function calls and mix operators to create complex filtering e
482482

483483
### Using CEL Filtering Expressions with gRPC
484484

485-
You can pass a filter to gRPC requests by specifying `filter=<cel-expression>`. Be sure to use the correct quoting in your queries or escape if necessary. Here’s an example:
485+
You can pass a filter to gRPC requests by specifying `filter=<cel-expression>`. Be sure to use the correct quoting in your queries or escape if necessary. Here's an example:
486486

487487
```bash
488488
grpc_cli call --channel_creds_type=ssl \
@@ -494,7 +494,7 @@ grpc_cli call --channel_creds_type=ssl \
494494

495495
### Using CEL Filtering Expressions with REST
496496

497-
You can pass a filter to REST requests by specifying `filter=<cel-expression>` in your query. Here’s an example:
497+
You can pass a filter to REST requests by specifying `filter=<cel-expression>` in your query. Here's an example:
498498

499499
```bash
500500
curl --insecure \
@@ -505,7 +505,7 @@ curl --insecure \
505505

506506
### Using CEL Filtering Expressions with `tkn-results`
507507

508-
If you have installed `tkn-results` CLI independently or as a plugin to `tkn`, you can filter Results using the `--filter=<cel-expression>` flag. Here’s an example:
508+
If you have installed `tkn-results` CLI independently or as a plugin to `tkn`, you can filter Results using the `--filter=<cel-expression>` flag. Here's an example:
509509

510510
```bash
511511
tkn results records list default/results/- --filter="data.metadata.annotations.contains('bar')"
@@ -544,6 +544,8 @@ To request a list of objects in a specific order, include the `order_by` query p
544544

545545
Fields supported in `order_by`:
546546

547+
<!-- lint ignore table-size -->
548+
547549
| Field Name |
548550
| ---------------- |
549551
| `create_time` |

‎docs/en/configure/customize_options.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,8 @@ Using the `pipeline` component as an example, this section describes how to conf
230230
- Change the number of replicas for `Deployment` `tekton-events-controller` to 2
231231
- Modify the `resources` configuration of `Deployment` `tekton-events-controller`
232232

233+
{/* lint ignore code-block-split-list */}
234+
233235
```yaml
234236
apiVersion: operator.tekton.dev/v1alpha1
235237
kind: TektonConfig

‎docs/en/configure/customize_tekton_pipeline.mdx‎

Lines changed: 55 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ Configure resource quotas related to the [`Pipeline`](../apis/kubernetes_apis/op
2121
- TektonConfig resources must have been automatically created in the environment
2222
- The document on [Adjusting Optional Configuration Items for Subcomponents](./customize_options.mdx) should be read
2323

24+
## Resource Configuration Guidelines
25+
26+
Before configuring resource quotas:
27+
- Assess your cluster's available resources and capacity
28+
- Consider your workload characteristics and performance requirements
29+
- Start with conservative values and adjust based on monitoring data
30+
- Test configurations in non-production environments first
31+
2432
## Steps
2533

2634
<Steps>
@@ -54,116 +62,117 @@ spec:
5462
config-defaults:
5563
data:
5664
# Add default container resource quotas
65+
# Adjust the values below according to your cluster's resource capacity and workload requirements
5766
default-container-resource-requirements: |
5867
place-scripts: # updates resource requirements of a 'place-scripts' container
5968
requests:
60-
memory: "64Mi"
61-
cpu: "50m"
69+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
70+
cpu: "<CPU_REQUEST>" # e.g., "250m"
6271
limits:
63-
memory: "128Mi"
64-
cpu: "100m"
72+
memory: "<MEMORY_LIMIT>" # e.g., "512Mi"
73+
cpu: "<CPU_LIMIT>" # e.g., "500m"
6574
6675
prepare: # updates resource requirements of a 'prepare' container
6776
requests:
68-
memory: "64Mi"
69-
cpu: "50m"
77+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
78+
cpu: "<CPU_REQUEST>" # e.g., "250m"
7079
limits:
71-
memory: "256Mi"
72-
cpu: "100m"
80+
memory: "<MEMORY_LIMIT>" # e.g., "256Mi"
81+
cpu: "<CPU_LIMIT>" # e.g., "500m"
7382
7483
working-dir-initializer: # updates resource requirements of a 'working-dir-initializer' container
7584
requests:
76-
memory: "64Mi"
77-
cpu: "50m"
85+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
86+
cpu: "<CPU_REQUEST>" # e.g., "250m"
7887
limits:
79-
memory: "512Mi"
80-
cpu: "100m"
88+
memory: "<MEMORY_LIMIT>" # e.g., "512Mi"
89+
cpu: "<CPU_LIMIT>" # e.g., "500m"
8190
8291
prefix-scripts: # updates resource requirements of containers which starts with 'scripts-'
8392
requests:
84-
memory: "64Mi"
85-
cpu: "50m"
93+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
94+
cpu: "<CPU_REQUEST>" # e.g., "250m"
8695
limits:
87-
memory: "128Mi"
88-
cpu: "100m"
96+
memory: "<MEMORY_LIMIT>" # e.g., "512Mi"
97+
cpu: "<CPU_LIMIT>" # e.g., "500m"
8998
9099
prefix-sidecar-scripts: # updates resource requirements of containers which starts with 'sidecar-scripts-'
91100
requests:
92-
memory: "64Mi"
93-
cpu: "50m"
101+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
102+
cpu: "<CPU_REQUEST>" # e.g., "250m"
94103
limits:
95-
memory: "128Mi"
96-
cpu: "100m"
104+
memory: "<MEMORY_LIMIT>" # e.g., "512Mi"
105+
cpu: "<CPU_LIMIT>" # e.g., "500m"
97106
98-
sidecar-tekton-log-results: # updates resource requirements of a 'place-scripts' container
107+
sidecar-tekton-log-results: # updates resource requirements of a 'sidecar-tekton-log-results' container
99108
requests:
100-
memory: "64Mi"
101-
cpu: "50m"
109+
memory: "<MEMORY_REQUEST>" # e.g., "128Mi"
110+
cpu: "<CPU_REQUEST>" # e.g., "100m"
102111
limits:
103-
memory: "128Mi"
104-
cpu: "100m"
112+
memory: "<MEMORY_LIMIT>" # e.g., "256Mi"
113+
cpu: "<CPU_LIMIT>" # e.g., "250m"
105114
106115
deployments:
107-
116+
# Adjust the resource values below according to your cluster's capacity and performance requirements
108117
tekton-pipelines-controller:
109118
spec:
110-
replicas: 1
119+
replicas: <REPLICA_COUNT> # e.g., 1
111120
template:
112121
spec:
113122
containers:
114123
- name: tekton-pipelines-controller
115124
resources:
116125
requests:
117-
cpu: 500m
118-
memory: 512Mi
126+
cpu: <CPU_REQUEST> # e.g., "500m"
127+
memory: <MEMORY_REQUEST> # e.g., "512Mi"
119128
limits:
120-
cpu: "1"
121-
memory: 1Gi
129+
cpu: <CPU_LIMIT> # e.g., "1"
130+
memory: <MEMORY_LIMIT> # e.g., "1Gi"
122131

123132
tekton-pipelines-remote-resolvers:
124133
spec:
125-
replicas: 1
134+
replicas: <REPLICA_COUNT> # e.g., 1
126135
template:
127136
spec:
128137
containers:
129138
- name: controller
130139
resources:
131140
requests:
132-
cpu: 200m
133-
memory: 256Mi
141+
cpu: <CPU_REQUEST> # e.g., "200m"
142+
memory: <MEMORY_REQUEST> # e.g., "256Mi"
134143
limits:
135-
cpu: 500m
136-
memory: 512Mi
144+
cpu: <CPU_LIMIT> # e.g., "500m"
145+
memory: <MEMORY_LIMIT> # e.g., "512Mi"
137146

138147
tekton-pipelines-webhook:
139148
spec:
140-
replicas: 1
149+
replicas: <REPLICA_COUNT> # e.g., 1
141150
template:
142151
spec:
143152
containers:
144153
- name: webhook
145154
resources:
146155
requests:
147-
cpu: "500m"
148-
memory: 256Mi
156+
cpu: <CPU_REQUEST> # e.g., "500m"
157+
memory: <MEMORY_REQUEST> # e.g., "256Mi"
149158
limits:
150-
cpu: "1"
151-
memory: 500Mi
159+
cpu: <CPU_LIMIT> # e.g., "1"
160+
memory: <MEMORY_LIMIT> # e.g., "500Mi"
152161

153162
tekton-events-controller:
154163
spec:
155-
replicas: 1
164+
replicas: <REPLICA_COUNT> # e.g., 1
156165
template:
157166
spec:
158167
containers:
159168
- name: tekton-events-controller
160169
resources:
161170
requests:
162-
cpu: 100m
163-
memory: 100Mi
171+
cpu: <CPU_REQUEST> # e.g., "100m"
172+
memory: <MEMORY_REQUEST> # e.g., "100Mi"
164173
limits:
165-
cpu: 200m
166-
memory: 256Mi
174+
cpu: <CPU_LIMIT> # e.g., "200m"
175+
memory: <MEMORY_LIMIT> # e.g., "256Mi"
167176
```
168177
169178
### Step 3

‎docs/en/overview/quick_start.mdx‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ After installing the Tekton Operator, you should verify that it's running proper
5858

5959
1. Check that the Operator pods are running:
6060

61-
```bash
62-
kubectl get pods -n tekton-operator
63-
```
61+
```bash
62+
kubectl get pods -n tekton-operator
63+
```
6464

6565
2. Verify the Operator CRDs (Custom Resource Definitions) are installed:
6666

67-
```bash
68-
kubectl get crds | grep tekton
69-
```
67+
```bash
68+
kubectl get crds | grep tekton
69+
```
7070

7171
### Install Tekton Components
7272

@@ -81,42 +81,42 @@ After installing the Tekton components, you should verify that they are running
8181

8282
1. Check the TektonConfig resource:
8383

84-
```bash
85-
kubectl get tektonconfig config
86-
```
84+
```bash
85+
kubectl get tektonconfig config
86+
```
8787

88-
The results should be similar to the following:
88+
The results should be similar to the following:
8989

90-
```bash
91-
NAME VERSION READY REASON
92-
config v0.74.1-fb53414 True
93-
```
90+
```bash
91+
NAME VERSION READY REASON
92+
config v0.74.1-fb53414 True
93+
```
9494

9595
2. If the TektonConfig resource is not ready, you can continue to check the TektonInstallerSet resource for details.
9696

97-
```bash
98-
kubectl get tektoninstallerset
99-
```
100-
101-
The results should be similar to the following:
102-
103-
```bash
104-
NAME READY REASON
105-
chain-config-5scx2 True
106-
chain-secret-xrq7b True
107-
chain-t6wb6 True
108-
pipeline-main-deployment-9d9cc True
109-
pipeline-main-static-c7zlz True
110-
result-j74p5 True
111-
tekton-hub-api-jl9xj True
112-
tekton-hub-db-5g89c True
113-
tekton-hub-db-migration-q7m8l True
114-
tekton-hub-ui-jn6bw True
115-
tektoncd-pruner-fgzfh True
116-
trigger-main-deployment-q8zkd True
117-
trigger-main-static-8x5w6 True
118-
validating-mutating-webhook-ksz2k True
119-
```
97+
```bash
98+
kubectl get tektoninstallerset
99+
```
100+
101+
The results should be similar to the following:
102+
103+
```bash
104+
NAME READY REASON
105+
chain-config-5scx2 True
106+
chain-secret-xrq7b True
107+
chain-t6wb6 True
108+
pipeline-main-deployment-9d9cc True
109+
pipeline-main-static-c7zlz True
110+
result-j74p5 True
111+
tekton-hub-api-jl9xj True
112+
tekton-hub-db-5g89c True
113+
tekton-hub-db-migration-q7m8l True
114+
tekton-hub-ui-jn6bw True
115+
tektoncd-pruner-fgzfh True
116+
trigger-main-deployment-q8zkd True
117+
trigger-main-static-8x5w6 True
118+
validating-mutating-webhook-ksz2k True
119+
```
120120

121121
### Expected Results
122122

‎docs/en/pipelines/concepts/stepaction_concept.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -300,13 +300,13 @@ spec:
300300
301301
When Expressions allow controlling whether a Step that references a StepAction should execute.
302302
303-
#### Use Cases
303+
### Use Cases
304304
305305
- Conditional execution based on parameters
306306
- Skipping steps based on workspace availability
307307
- Controlling workflow based on previous step results
308308
309-
#### Configuration Example
309+
### Configuration Example
310310
311311
```yaml
312312
apiVersion: tekton.dev/v1
@@ -332,13 +332,13 @@ spec:
332332
333333
StepActions can be referenced from remote locations such as git repositories.
334334
335-
#### Use Cases
335+
### Use Cases
336336
337337
- Centralized StepAction management
338338
- Version controlling StepActions
339339
- Sharing StepActions across organizations
340340
341-
#### Configuration Example
341+
### Configuration Example
342342
343343
```yaml
344344
apiVersion: tekton.dev/v1

0 commit comments

Comments
 (0)