Skip to content

Commit 7372b29

Browse files
committed
📚 Sync documentation from source-docs
Source: chore: Sync workflow to release-4.0 and small doc fix (#191) Author: Daniel Filipe Bruehmueller Morinigo Commit: 1e192edf37f1359d3c6faee623e5407cbcebdb59 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/1e192edf37f1359d3c6faee623e5407cbcebdb59 🤖 Synced on 2025-07-02 07:57:39 UTC
1 parent 4134a10 commit 7372b29

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+291
-8775
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-07-02 06:41:21 UTC
3+
- **Last synced**: 2025-07-02 07:57:39 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [35c2fc38ce5a3fd145e64a1e22acf30ae7ce9d1b](https://github.com/alaudadevops/tektoncd-operator/commit/35c2fc38ce5a3fd145e64a1e22acf30ae7ce9d1b)
6-
- **Triggered by**: lentil1016
7-
- **Workflow run**: [#4](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16017978615)
5+
- **Source commit**: [1e192edf37f1359d3c6faee623e5407cbcebdb59](https://github.com/alaudadevops/tektoncd-operator/commit/1e192edf37f1359d3c6faee623e5407cbcebdb59)
6+
- **Triggered by**: danielfbm
7+
- **Workflow run**: [#6](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16019422334)
88

99
## Files synced:
1010
- docs/

‎docs/en/chains/architecture.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,6 @@ Tekton Chains is deployed as a Kubernetes controller within a cluster:
8484
- **Deployment**: A single deployment manages the controller pods
8585
- **Service Account**: The controller uses a dedicated service account with appropriate permissions
8686
- **Configuration**: Configuration is managed through a ConfigMap called `chains-config`
87-
- By default, Tekton Chains is deployed automatically through the `TektonConfig` resource. You can modify the `TektonConfig` resource to configure Chains.
88-
- Essentially, Tekton Operator will synchronize the Chains configuration from the `TektonConfig` resource to the `TektonChains` resource, and finally reflect in the `chains-config` ConfigMap.
8987
- **Secrets**: Signing keys and credentials are stored as Kubernetes secrets
9088

9189
### High Availability Considerations

‎docs/en/chains/concepts/core_concepts.mdx‎

Lines changed: 15 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -8,98 +8,21 @@ weight: 10
88

99
Supply chain security refers to protecting the integrity, security, and reliability of the software development lifecycle from development to deployment. Tekton Chains is designed to address supply chain security concerns by providing mechanisms to verify that artifacts produced by CI/CD pipelines have not been tampered with and can be trusted.
1010

11-
## SLSA Framework
12-
13-
SLSA (Supply-chain Levels for Software Artifacts) is a security framework that provides a checklist of standards and controls to prevent tampering, improve integrity, and secure packages and infrastructure. Tekton Chains supports multiple SLSA provenance formats:
14-
15-
- **SLSA v0.2**: Supported via `slsa/v1` or `in-toto` formatters
16-
- **SLSA v1.0**: Supported via `slsa/v2alpha3` and `slsa/v2alpha4` formatters
17-
18-
As part of the framework, SLSA has multiple levels of assurances. These levels contain industry-recognized best practices to create four levels of increasing assurance.
19-
20-
> [Security levels](https://slsa.dev/spec/v1.1/levels)
21-
22-
| Track/Level | Requirements | Focus |
23-
| ----------- | ------------ | ----- |
24-
| Build L0 | (none) | (n/a) |
25-
| Build L1 | Provenance showing how the package was built | Mistakes, documentation |
26-
| Build L2 | Signed provenance, generated by a hosted build platform | Tampering after the build |
27-
| Build L3 | Hardened build platform | Tampering during the build |
28-
29-
> Tekton can achieve SLSA Level 2 compliance. For more information, please refer to [Getting To SLSA Level 2 with Tekton and Tekton Chains](https://tekton.dev/blog/2023/04/19/getting-to-slsa-level-2-with-tekton-and-tekton-chains/)
30-
31-
## Signing
11+
## Provenance
3212

33-
Signing is the process of cryptographically signing provenance to ensure its integrity and authenticity. Tekton Chains supports multiple signing methods:
34-
35-
- **x509**: Uses a standard x509 certificate and private key
36-
- **Cosign**: Uses Sigstore's Cosign tool for signing
37-
- **KMS**: Uses cloud provider key management services
38-
- **Keyless**: Uses ephemeral keys with Fulcio certificate authority
39-
40-
## Image attestation
41-
42-
Image attestation is used for storing and verifying metadata information related to images. It provides richer supply chain security information, such as:
43-
44-
- [SLSA Provenance](#slsa-provenance)
45-
- [SBOM](#sbom-software-bill-of-materials)
46-
- [Vulnerability scan results](#vulnerability-scan-results)
47-
- [Custom metadata](#custom-metadata-attestation)
48-
49-
### SLSA Provenance
50-
51-
[SLSA Provenance](https://slsa.dev/provenance/v1) is metadata containing verifiable information about software artifacts, describing how they were built, what sources were used, and who built them. In Tekton Chains, provenance is cryptographically signed to ensure its integrity and authenticity.
13+
Provenance is metadata containing verifiable information about software artifacts, describing how they were built, what sources were used, and who built them. In Tekton Chains, provenance is cryptographically signed to ensure its integrity and authenticity.
5214

5315
There are two types of provenance in Tekton Chains:
5416

5517
- **Task-level provenance**: Captures details about a specific TaskRun execution
5618
- **Pipeline-level provenance**: Captures the entire PipelineRun execution, including all child TaskRuns
5719

58-
### SBOM (Software bill of materials)
59-
60-
[SBOM](https://www.ntia.gov/page/software-bill-materials) is a nested inventory for software, a list of ingredients that make up software components, including:
61-
- Software components
62-
- Component versions
63-
- License information
64-
- Dependency relationships
65-
66-
SBOM can be in various formats, such as:
67-
- [SPDX](https://spdx.dev/use/specifications/)
68-
- [CycloneDX](https://cyclonedx.org/specification/overview/)
69-
70-
### Vulnerability scan results
71-
72-
[Cosign Vulnerability Scan results](https://github.com/sigstore/cosign/blob/main/specs/COSIGN_VULN_ATTESTATION_SPEC.md) record the security assessment of the software build process, including:
73-
- Scanner information (name, version)
74-
- Vulnerability database information
75-
- List of discovered vulnerabilities and their severity
76-
- Remediation recommendations
77-
78-
### Custom metadata
79-
80-
Custom metadata can be added as needed to support specific security requirements.
81-
82-
For example, grype can generate vulnerability scan results, and these results can be uploaded to the image registry as a custom type.
83-
84-
## Attestation verification
85-
86-
The verification mechanism is highly flexible and can be customized to validate any metadata present in the attestation. This means that any information stored in the attestation can be used as validation criteria, allowing organizations to implement precise security controls based on their specific requirements.
87-
88-
The flexibility of attestation verification is demonstrated through various validation methods:
89-
90-
- Kyverno [JMESPath](https://jmespath.org/) Validation
91-
- Uses JMESPath syntax for JSON query and validation
92-
93-
- [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/) Policy Validation
94-
- Leverages Open Policy Agent (OPA) for complex policy enforcement
95-
- Supports declarative policy rules and custom validation logic
96-
- Example: Validating builder information and build environment
20+
## SLSA Framework
9721

98-
- [CUE](https://cuelang.org/) Validation
99-
- Provides type system and constraint system for validation
100-
- Enables schema validation and data consistency checks
101-
- Supports complex data structure validation
22+
SLSA (Supply-chain Levels for Software Artifacts) is a security framework that provides a checklist of standards and controls to prevent tampering, improve integrity, and secure packages and infrastructure. Tekton Chains supports multiple SLSA provenance formats:
10223

24+
- **SLSA v0.2**: Supported via `slsa/v1` or `in-toto` formatters
25+
- **SLSA v1.0**: Supported via `slsa/v2alpha3` and `slsa/v2alpha4` formatters
10326

10427
## Artifacts
10528

@@ -117,6 +40,15 @@ Type hinting is a mechanism used by Tekton Chains to understand the input and ou
11740
- For image outputs: `IMAGES` or parameters/results with the suffix `IMAGE_URL` and `IMAGE_DIGEST`
11841
- For generic outputs: Parameters or results with the suffix `ARTIFACT_OUTPUTS`
11942

43+
## Signing
44+
45+
Signing is the process of cryptographically signing provenance to ensure its integrity and authenticity. Tekton Chains supports multiple signing methods:
46+
47+
- **x509**: Uses a standard x509 certificate and private key
48+
- **Cosign**: Uses Sigstore's Cosign tool for signing
49+
- **KMS**: Uses cloud provider key management services
50+
- **Keyless**: Uses ephemeral keys with Fulcio certificate authority
51+
12052
## Storage Backends
12153

12254
Storage backends are where Tekton Chains stores the generated provenance and signatures. Supported backends include:

0 commit comments

Comments
 (0)