Skip to content

Commit f0373dc

Browse files
author
edge-katanomi-app2[bot]
committed
📚 Sync docs from alaudadevops/tektoncd-operator on e19af982df30bbc64c0c1ef7991a731ee8307572
Source: docs: update tekton pipeline configuration documentation (#480) Author: alaudabot Ref: refs/heads/release-4.1 Commit: e19af982df30bbc64c0c1ef7991a731ee8307572 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/e19af982df30bbc64c0c1ef7991a731ee8307572 🤖 Synced on 2025-09-05 09:56:22 UTC
1 parent 3672e7e commit f0373dc

21 files changed

+485
-339
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-02 02:38:47 UTC
3+
- **Last synced**: 2025-09-05 09:56:22 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [5cca5b6d0e45d64059ff5e4df66593cb8b0b53d1](https://github.com/alaudadevops/tektoncd-operator/commit/5cca5b6d0e45d64059ff5e4df66593cb8b0b53d1)
6-
- **Triggered by**: l-qing
7-
- **Workflow run**: [#29](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16688979512)
5+
- **Source commit**: [e19af982df30bbc64c0c1ef7991a731ee8307572](https://github.com/alaudadevops/tektoncd-operator/commit/e19af982df30bbc64c0c1ef7991a731ee8307572)
6+
- **Triggered by**: edge-katanomi-app2[bot]
7+
- **Workflow run**: [#48](https://github.com/alaudadevops/tektoncd-operator/actions/runs/17489936504)
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/chains/concepts/understanding_tekton_chains.mdx‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ There are several ways to specify input and output artifacts:
178178
- Used to track source code repository details
179179
- Helps in provenance generation for source code
180180
181+
{/* lint ignore code-block-split-list */}
182+
181183
```yaml
182184
results:
183185
- name: CHAINS-GIT_URL
@@ -186,7 +188,7 @@ results:
186188
type: string
187189
```
188190
189-
:::details{title="Example TaskRun"}
191+
:::details \{title="Example TaskRun"}
190192
```yaml
191193
apiVersion: tekton.dev/v1
192194
kind: TaskRun
@@ -228,6 +230,8 @@ spec:
228230
- Used to specify input artifacts that influenced the build process
229231
- Helps track dependencies and source materials
230232

233+
{/* lint ignore code-block-split-list */}
234+
231235
```yaml
232236
results:
233237
- name: first-ARTIFACT_INPUTS
@@ -237,7 +241,7 @@ results:
237241
digest: {}
238242
```
239243

240-
:::details{title="Example TaskRun"}
244+
:::details \{title="Example TaskRun"}
241245
```yaml
242246
apiVersion: tekton.dev/v1
243247
kind: TaskRun
@@ -280,7 +284,7 @@ results:
280284
type: string
281285
```
282286

283-
:::details{title="Example TaskRun"}
287+
:::details \{title="Example TaskRun"}
284288
```yaml
285289
apiVersion: tekton.dev/v1
286290
kind: TaskRun
@@ -310,13 +314,15 @@ spec:
310314
- Can specify multiple images, separated by commas or newlines
311315
- Each image must include the complete digest
312316

317+
{/* lint ignore code-block-split-list */}
318+
313319
```yaml
314320
results:
315321
- name: IMAGES
316322
type: string
317323
```
318324

319-
:::details{title="Example TaskRun"}
325+
:::details \{title="Example TaskRun"}
320326
```yaml
321327
apiVersion: tekton.dev/v1
322328
kind: TaskRun
@@ -342,6 +348,8 @@ spec:
342348
- Similar to IMAGE_URL/IMAGE_DIGEST but with different naming convention
343349
- Used for specifying artifact location and its digest
344350

351+
{/* lint ignore code-block-split-list */}
352+
345353
```yaml
346354
results:
347355
- name: first-ARTIFACT_URI
@@ -355,6 +363,8 @@ results:
355363
- Uses object type results
356364
- Must include uri and digest fields
357365

366+
{/* lint ignore code-block-split-list */}
367+
358368
```yaml
359369
results:
360370
- name: first-ARTIFACT_OUTPUTS
@@ -364,7 +374,7 @@ results:
364374
digest: {}
365375
```
366376

367-
:::details{title="Example TaskRun"}
377+
:::details \{title="Example TaskRun"}
368378
```yaml
369379
apiVersion: tekton.dev/v1
370380
kind: TaskRun

‎docs/en/chains/how_to/image_signature_verification.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ spec:
138138
ignoreTlog: true
139139
```
140140
141-
:::details{title="Explanation of YAML fields"}
141+
:::details \{title="Explanation of YAML fields"}
142+
{/* lint ignore no-deep-list */}
142143
- `spec.rules[].match.any[].resources`: The resources to be matched and validated.
143144
- `kinds`: The kinds of the resources to be matched and validated.
144145
- `Pod`: The Pod resources.

‎docs/en/chains/how_to/sbom_verification.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ In production environments, you would typically:
213213
3. This approach ensures proper version control and maintains the separation between code and pipeline configuration
214214
:::
215215

216-
:::details{title="Explanation of YAML fields"}
216+
:::details \{title="Explanation of YAML fields"}
217217
- The same as in [Step 4: Create a Sample Pipeline](../quick_start/signed_provenance.mdx#step-4-create-a-sample-pipeline), but adds the following content:
218218
- `workspaces`:
219219
- `signkey`: The workspace for private keys and passwords used for image signatures.
@@ -261,7 +261,7 @@ spec:
261261
storageClassName: <nfs>
262262
```
263263

264-
:::details{title="Explanation of YAML fields"}
264+
:::details \{title="Explanation of YAML fields"}
265265
- The same as in [Step 5: Run a Sample Pipeline](../quick_start/signed_provenance.mdx#step-5-run-a-sample-pipeline). Below only introduces the differences.
266266
- `workspaces`
267267
- `signkey`: the secret name of the signing key.
@@ -342,7 +342,7 @@ $ cosign verify-attestation --key cosign.pub --type cyclonedx $IMAGE | jq -r '.p
342342

343343
The output will be similar to the following, which contains the components information of the image.
344344

345-
:::details{title="cyclonedx SBOM attestation"}
345+
:::details \{title="cyclonedx SBOM attestation"}
346346
```json
347347
{
348348
"_type": "https://in-toto.io/Statement/v0.1",
@@ -384,7 +384,8 @@ The output will be similar to the following, which contains the components infor
384384
```
385385
:::
386386

387-
:::details{title="Description of the fields"}
387+
:::details \{title="Description of the fields"}
388+
{/* lint ignore no-deep-list */}
388389
- `predicateType`: The type of the predicate.
389390
- `predicate`:
390391
- `components`: The components of the image.
@@ -485,7 +486,7 @@ spec:
485486
PkgIDs: {{ scanner.result.Results[].Vulnerabilities[?CVSS.redhat.V3Score > `1.0`].PkgID[] }}.
486487
```
487488

488-
:::details{title="Explanation of YAML fields"}
489+
:::details \{title="Explanation of YAML fields"}
489490
- The policy is largely consistent with the one in [Image Signature Verification](../how_to/image_signature_verification.mdx#step-81-create-a-kyverno-policy-to-allow-only-signed-images-to-be-deployed)
490491
- `spec.rules[0].verifyImages[].attestations[0].conditions`
491492
- `type`: The cyclonedx SBOM attestation type is `https://cyclonedx.org/bom`

‎docs/en/chains/how_to/vulnerability_scanning_verification.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ In production environments, you would typically:
247247
3. This approach ensures proper version control and maintains the separation between code and pipeline configuration
248248
:::
249249

250-
:::details{title="Explanation of YAML fields"}
250+
:::details \{title="Explanation of YAML fields"}
251251
- The same as in [Step 4: Create a Sample Pipeline](../quick_start/signed_provenance.mdx#step-4-create-a-sample-pipeline), but adds the following content:
252252
- `workspaces`:
253253
- `signkey`: The workspace for private keys and passwords used for image signatures.
@@ -299,7 +299,7 @@ spec:
299299
storageClassName: <nfs>
300300
```
301301

302-
:::details{title="Explanation of YAML fields"}
302+
:::details \{title="Explanation of YAML fields"}
303303
- The same as in [Step 5: Run a Sample Pipeline](../quick_start/signed_provenance.mdx#step-5-run-a-sample-pipeline). Below only introduces the differences.
304304
- `workspaces`
305305
- `signkey`: the secret name of the signing key.
@@ -379,7 +379,7 @@ $ cosign verify-attestation --key cosign.pub --type vuln $IMAGE | jq -r '.payloa
379379
```
380380
The output will be similar to the following, which contains the vulnerability scan results.
381381

382-
:::details{title="cosign vuln attestation"}
382+
:::details \{title="cosign vuln attestation"}
383383
```json
384384
{
385385
"_type": "https://in-toto.io/Statement/v0.1",
@@ -479,7 +479,8 @@ The output will be similar to the following, which contains the vulnerability sc
479479
```
480480
:::
481481

482-
:::details{title="Description of the fields"}
482+
:::details \{title="Description of the fields"}
483+
{/* lint ignore no-deep-list */}
483484
- `predicateType`: The type of the predicate.
484485
- `predicate.scanner`:
485486
- `uri`: The URI of the scanner.
@@ -589,7 +590,7 @@ spec:
589590
PkgIDs: {{ scanner.result.Results[].Vulnerabilities[?CVSS.redhat.V3Score > `1.0`].PkgID[] }}.
590591
```
591592
592-
:::details{title="Explanation of YAML fields"}
593+
:::details \{title="Explanation of YAML fields"}
593594
- The policy is largely consistent with the one in [Image Signature Verification](../how_to/image_signature_verification.mdx#step-81-create-a-kyverno-policy-to-allow-only-signed-images-to-be-deployed)
594595
- `spec.rules[0].verifyImages[].attestations[0].conditions`
595596
- `type`: The cosign vuln attestation type is `https://cosign.sigstore.dev/attestation/vuln/v1`

‎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

0 commit comments

Comments
 (0)