📚 Sync docs from alaudadevops/tektoncd-operator on de73530dc026f3e96e3729bb7d2a7f5ec3f4a675

Source: [Cherry-pick #1516] docs: update Tekton operator docs (#1537)
Author: edge-katanomi-app2[bot]
Ref: refs/heads/release-4.2
Commit: de73530dc026f3e96e3729bb7d2a7f5ec3f4a675

This commit automatically syncs documentation changes from the source-docs repository.

🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/de73530dc026f3e96e3729bb7d2a7f5ec3f4a675
🤖 Synced on 2026-03-31 07:45:54 UTC

Author: edge-katanomi-app2[bot]

.github/SYNC_INFO.md

@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2026-03-30 13:27:40 UTC
+- **Last synced**: 2026-03-31 07:45:54 UTC
 - **Source repository**: alaudadevops/tektoncd-operator
-- **Source commit**: [50e11286975a242b1aa4c39d61aa26321e94da9c](https://github.com/alaudadevops/tektoncd-operator/commit/50e11286975a242b1aa4c39d61aa26321e94da9c)
+- **Source commit**: [de73530dc026f3e96e3729bb7d2a7f5ec3f4a675](https://github.com/alaudadevops/tektoncd-operator/commit/de73530dc026f3e96e3729bb7d2a7f5ec3f4a675)
 - **Triggered by**: edge-katanomi-app2[bot]
-- **Workflow run**: [#169](https://github.com/alaudadevops/tektoncd-operator/actions/runs/23747165167)
+- **Workflow run**: [#171](https://github.com/alaudadevops/tektoncd-operator/actions/runs/23786310700)
 
 ## Files synced:
 - docs/

docs/en/apis/kubernetes_apis/operator/tektonresults.mdx

@@ -6,3 +6,5 @@ sourceSHA: 5ba913e5ea306392d1815b7c6b244f466c87171c0a63feb25ff36c8ff42e7636
 # TektonResult [operator.tekton.dev/v1alpha1]
 
 <K8sCrd name="tektonresults.operator.tekton.dev" />
+
+> Note: In current Alauda DevOps Pipelines versions, Tekton Results should be enabled and configured through `TektonConfig.spec.result`.

docs/en/concepts/tektonconfig_concept.mdx

@@ -136,7 +136,7 @@ spec:
       - name: enable-devconsole-integration
         value: "false"
 
-  results:
+  result:
     enable: false
 
   chain:
@@ -158,7 +158,7 @@ spec:
    - **pipeline**: Configuration for the Pipeline controller
    - **trigger**: Configuration for the Triggers controller
    - **hub**: Configuration for Tekton Hub
-   - **results**: Configuration for Tekton Results
+   - **result**: Configuration for Tekton Results
    - **chain**: Configuration for Tekton Chains
 
 4. **Pruner**: Configuration for automatic cleanup of resources
@@ -212,7 +212,7 @@ spec:
   hub:
     enable: true
 
-  results:
+  result:
     enable: true
 
   chain:
@@ -276,4 +276,4 @@ pruner:
 - [Tekton Operator Documentation](https://tekton.dev/docs/operator/)
 - [TektonConfig Official Documentation](https://tekton.dev/docs/operator/tektonconfig/)
 - [Tekton Pipeline Configuration](https://tekton.dev/docs/pipelines/)
-- [Tekton Triggers Configuration](https://tekton.dev/docs/triggers/)
+- [Tekton Triggers Configuration](https://tekton.dev/docs/triggers/)

docs/en/configure/customize_options.mdx

@@ -14,7 +14,7 @@ This document introduces the configuration items supported by `options`, as well
 
 ## Use Cases
 
-Tekton supports the deployment of subcomponents through the [`TektonConfig`](../apis/kubernetes_apis/operator/tektonconfig.mdx) resource. This resource has a common configuration item `options` under the fields of `spec.pipeline`, `spec.trigger`, `spec.hub`, `spec.chain`, and `spec.results`.
+Tekton supports the deployment of subcomponents through the [`TektonConfig`](../apis/kubernetes_apis/operator/tektonconfig.mdx) resource. This resource has a common configuration item `options` under the fields of `spec.pipeline`, `spec.trigger`, `spec.hub`, `spec.chain`, and `spec.result`.
 
 Through the `options` configuration, you can achieve:
 

docs/en/how_to/deploy_global.mdx

@@ -66,36 +66,37 @@ spec:
 
 If users have deployed tekton-results in a global cluster, they also need to configure the `options` for the results component. Similar to the pipeline configuration, you need to configure both ingress and deployment settings for the `tektoncd-results-api` component.
 
-Add the following configuration to the `spec.results.options` section:
+Add the following configuration to the `spec.result.options` section:
 
 ```yaml
 apiVersion: operator.tekton.dev/v1alpha1
-kind: TektonResult
+kind: TektonConfig
 metadata:
-  name: result
+  name: config
 spec:
-  options:
-    ingress:
-      tektoncd-results-api:
-        spec:
-          ingressClassName: global-alb2
-    deployments:
-      tektoncd-results-api:
-        spec:
-          template:
-            spec:
-              containers:
-                - env:
-                    - name: KUBERNETES_PORT_443_TCP
-                      value: tcp://erebus.cpaas-system:443
-                    - name: KUBERNETES_PORT_443_TCP_ADDR
-                      value: erebus.cpaas-system
-                    - name: KUBERNETES_PORT
-                      value: tcp://erebus.cpaas-system:443
-                    - name: EREBUS
-                      value: https://erebus.cpaas-system:443
-                    - name: KUBERNETES_SERVICE_HOST
-                      value: erebus.cpaas-system
-                  name: tektoncd-results-api
+  result:
+    options:
+      ingress:
+        tektoncd-results-api:
+          spec:
+            ingressClassName: global-alb2
+      deployments:
+        tektoncd-results-api:
+          spec:
+            template:
+              spec:
+                containers:
+                  - env:
+                      - name: KUBERNETES_PORT_443_TCP
+                        value: tcp://erebus.cpaas-system:443
+                      - name: KUBERNETES_PORT_443_TCP_ADDR
+                        value: erebus.cpaas-system
+                      - name: KUBERNETES_PORT
+                        value: tcp://erebus.cpaas-system:443
+                      - name: EREBUS
+                        value: https://erebus.cpaas-system:443
+                      - name: KUBERNETES_SERVICE_HOST
+                        value: erebus.cpaas-system
+                    name: tektoncd-results-api
     disabled: false
 ```

docs/en/install.mdx

@@ -146,7 +146,8 @@ First, delete the `TektonConfig` CR and any other Tekton component CRs if they e
 - Click **Delete** to confirm the deletion of the CR.
   - Deleting the `TektonConfig` resource will cascade delete the automatically created `TektonPipelines`, `TektonTriggers`, `TektonHubs`, `TektonChains`, etc. components.
 - Repeat these steps for any other Tekton component CRs that may exist.
-  - If you manually created `TektonResults` or `OpenShiftPipelinesAsCodes`, you may need to manually delete it.
+  - If you manually created `OpenShiftPipelinesAsCodes`, you may need to manually delete it.
+  - For older clusters that still have a standalone `TektonResult` resource, delete it manually before uninstalling.
 
 ### Uninstalling the `Alauda DevOps Pipelines` Operator
 

docs/en/overview/architecture.mdx

@@ -48,7 +48,7 @@ The webhook component provides validation and defaulting for the custom resource
    - Creates necessary CRDs and RBAC permissions
 
 2. **Resource Creation**
-   - User creates a TektonConfig resource (or individual component resources)
+   - User creates a TektonConfig resource (for Tekton Results, configure `spec.result`)
    - Defines the desired state and configuration
 
 3. **Component Installation**

docs/en/overview/quick_start.mdx

@@ -96,7 +96,7 @@ After installing the Tekton Operator, you should verify that it's running proper
 
 The Tekton Operator uses custom resources to manage Tekton components.
 By default, the Operator will install Pipeline, Triggers, Chains, and Hub automatically.
-You can install Results, Pipelines-as-Code by creating these custom resources.
+To enable Tekton Results, configure the `spec.result` section in the `TektonConfig` custom resource. Pipelines-as-Code can be installed by creating its corresponding custom resource.
 
 
 ### Verify Component Installation
@@ -156,4 +156,4 @@ Now that you have successfully installed the Tekton Operator and components, you
 
 1. Learn how to create and run Tekton [Pipeline Tasks and Pipelines](../pipelines/quick_start.mdx)
 2. Set up [Tekton Triggers](../triggers/quick_start.mdx) for event-driven pipelines
-3. Configure advanced settings for your Tekton components using the Operator
+3. Configure advanced settings for your Tekton components using the Operator

docs/en/results/configure/database_configuration.mdx

@@ -46,7 +46,7 @@ CREATE DATABASE tekton_results;
 Tekton Results supports using external PostgreSQL databases. The configuration is divided into two parts:
 
 1. **Database credentials** (username and password) are stored in Kubernetes Secrets
-2. **Database connection parameters** (host, port, database name, SSL settings) are configured in the TektonResult custom resource
+2. **Database connection parameters** (host, port, database name, SSL settings) are configured in the TektonConfig custom resource under `spec.result`
 
 ### Configuration Parameters Reference
 
@@ -55,10 +55,10 @@ Tekton Results supports using external PostgreSQL databases. The configuration i
 | `is_external_db` | Whether to use external database | `false` | Yes (set to `true` for external DB) |
 | `db_host` | Database host address | `localhost` | Yes |
 | `db_port` | Database port | `5432` | Yes |
-| `db_name` | Database name | `tekton-results` | Yes |
+| `db_name` | Database name | `tekton_results` | Yes |
 | `db_sslmode` | SSL connection mode | `disable` | No |
 | `db_sslrootcert` | SSL root certificate path | Empty | No (required when using SSL) |
-| `secret_name` | Secret name for database credentials | Empty  | Yes |
+| `db_secret_name` | Secret name for database credentials | Empty  | Yes |
 
 > The valid options for `db_sslmode` are explained here https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION.
 
@@ -97,30 +97,31 @@ data:
   POSTGRES_PASSWORD: <base64 encoded password>
 ```
 
-### 2. Configure TektonResult Resource
+### 2. Configure TektonConfig Resource
 
 ```yaml
 apiVersion: operator.tekton.dev/v1alpha1
-kind: TektonResult
+kind: TektonConfig
 metadata:
-  name: result
+  name: config
 spec:
-  is_external_db: true
-  db_host: your-postgres-host.example.com
-  db_port: 5432
-  db_name: tekton_results
-  db_sslmode: allow
-  secret_name: tekton-results-postgres
+  result:
+    is_external_db: true
+    db_host: your-postgres-host.example.com
+    db_port: 5432
+    db_name: tekton_results
+    db_sslmode: allow
+    db_secret_name: tekton-results-postgres
 ```
 
 :::tip
-This document only lists the database-related configuration fields. For the complete list of fields, please refer to [Quick Start](../quick_start.mdx#installing-using-operator-crd).
+This document only lists the database-related configuration fields. For the complete list of fields, please refer to [Quick Start](../quick_start.mdx#installing-using-tektonconfig-cr).
 :::
 
 ### 3. Verify Configuration
 
 ```bash
-kubectl get tektonresults.operator.tekton.dev result
+kubectl get tektonconfig config
 kubectl get pods -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-api
 ```
 
@@ -171,56 +172,57 @@ If you have a CA certificate file named `root.crt`, create a ConfigMap:
 kubectl create configmap db-root-crt -n tekton-pipelines --from-file ca.crt=./root.crt
 ```
 
-#### Step 2: Configure TektonResult with Volume Mounts
+#### Step 2: Configure TektonConfig with Volume Mounts
 
-To make the CA certificate available in the containers, you need to configure the TektonResult resource with additional `options` to mount the ConfigMap:
+To make the CA certificate available in the containers, you need to configure the TektonConfig resource with additional `options` under `spec.result` to mount the ConfigMap:
 
 ```yaml
 apiVersion: operator.tekton.dev/v1alpha1
-kind: TektonResult
+kind: TektonConfig
 metadata:
-  name: result
+  name: config
 spec:
-  is_external_db: true
-  # Database connection configuration
-  db_host: your-postgres-host.example.com
-  db_port: 5432
-  db_name: tekton_results
-  db_sslmode: verify-full
-  db_sslrootcert: /etc/tls/db/ca.crt
-  # Secret configuration
-  secret_name: tekton-results-postgres
-  # Options for mounting CA certificate
-  options:
-    deployments:
-      tekton-results-api:
-        spec:
-          template:
-            spec:
-              containers:
-                - name: api
-                  volumeMounts:
-                    - mountPath: /etc/tls/db
-                      name: postgredb-tls-ca
-                      readOnly: true
-              volumes:
-                - configMap:
-                    name: db-root-crt
-                  name: postgredb-tls-ca
-      tekton-results-retention-policy-agent:
-        spec:
-          template:
-            spec:
-              containers:
-                - name: retention-policy-agent
-                  volumeMounts:
-                    - mountPath: /etc/tls/db
-                      name: postgredb-tls-ca
-                      readOnly: true
-              volumes:
-                - configMap:
-                    name: db-root-crt
-                  name: postgredb-tls-ca
+  result:
+    is_external_db: true
+    # Database connection configuration
+    db_host: your-postgres-host.example.com
+    db_port: 5432
+    db_name: tekton_results
+    db_sslmode: verify-full
+    db_sslrootcert: /etc/tls/db/ca.crt
+    # Secret configuration
+    db_secret_name: tekton-results-postgres
+    # Options for mounting CA certificate
+    options:
+      deployments:
+        tekton-results-api:
+          spec:
+            template:
+              spec:
+                containers:
+                  - name: api
+                    volumeMounts:
+                      - mountPath: /etc/tls/db
+                        name: postgredb-tls-ca
+                        readOnly: true
+                volumes:
+                  - configMap:
+                      name: db-root-crt
+                    name: postgredb-tls-ca
+        tekton-results-retention-policy-agent:
+          spec:
+            template:
+              spec:
+                containers:
+                  - name: retention-policy-agent
+                    volumeMounts:
+                      - mountPath: /etc/tls/db
+                        name: postgredb-tls-ca
+                        readOnly: true
+                volumes:
+                  - configMap:
+                      name: db-root-crt
+                    name: postgredb-tls-ca
 ```
 
 With this configuration:
@@ -243,10 +245,10 @@ kubectl delete pod -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-
 kubectl delete pod -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-retention-policy-agent
 ```
 
-**Option 2: Recreate the TektonResult resource**
+**Option 2: Recreate the TektonConfig resource**
 ```bash
-# Get the current TektonResult resource and recreate it
-kubectl get tektonresults.operator.tekton.dev result -o yaml | kubectl replace --force -f -
+# Get the current TektonConfig resource and recreate it
+kubectl get tektonconfig config -o yaml | kubectl replace --force -f -
 ```
 
 **Verify the changes:**
@@ -257,10 +259,10 @@ kubectl get pods -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-re
 ```
 
 :::warning
-If you update the `db_sslmode` field, you may need to recreate the `TektonResult` resource for the changes to take effect.
+If you update the `db_sslmode` field, you may need to recreate the `TektonConfig` resource for the changes to take effect.
 
 ```bash
-kubectl get tektonresults.operator.tekton.dev result -o yaml | kubectl replace --force -f -
+kubectl get tektonconfig config -o yaml | kubectl replace --force -f -
 ```
 :::
 
@@ -285,8 +287,8 @@ kubectl get tektonresults.operator.tekton.dev result -o yaml | kubectl replace -
 #### Verification Commands
 
 ```bash
-# Check TektonResult status
-kubectl get tektonresults.operator.tekton.dev result -o yaml
+# Check TektonConfig status
+kubectl get tektonconfig config -o yaml
 
 # Check pod logs
 kubectl logs -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-api
@@ -312,7 +314,7 @@ kubectl get secret -n <ns-of-postgresql-instance> -l middleware.instance/type=Po
 
 This Secret contains `host`, `port`, `username`, `password` information. You need to supplement `database` information based on this Secret, and create a new secret in the namespace where the Tekton Results instance is located.
 
-If you need to set `sslmode`, please set `db_sslmode` in `TektonResult` to `allow` or `prefer` etc.
+If you need to set `sslmode`, please set `db_sslmode` in the `TektonConfig` `spec.result` section to `allow` or `prefer`, etc.
 
 For more PostgreSQL deployment parameters and requirements, please refer to <ExternalSiteLink name="postgresql" href="/installation.html" children="PostgreSQL Deployment Documentation" />.
 :::