Skip to content

Commit 0fb37b8

Browse files
committed
📚 Sync docs from alaudadevops/tektoncd-operator on 8ff6881ccd33fce459233d374d072ac37d861b65
Source: chore: sync from release-4.1 (d29479) Author: qingliu Ref: refs/heads/main Commit: 8ff6881ccd33fce459233d374d072ac37d861b65 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/tektoncd-operator@8ff6881 🤖 Synced on 2025-07-16 14:03:32 UTC
1 parent 233099c commit 0fb37b8

File tree

7 files changed

+334
-245
lines changed

7 files changed

+334
-245
lines changed

‎.github/SYNC_INFO.md‎

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

3-
- **Last synced**: 2025-07-15 09:15:55 UTC
3+
- **Last synced**: 2025-07-16 14:03:32 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [c976658497ec34f8adb9c180191664933c530752](https://github.com/alaudadevops/tektoncd-operator/commit/c976658497ec34f8adb9c180191664933c530752)
5+
- **Source commit**: [8ff6881ccd33fce459233d374d072ac37d861b65](https://github.com/alaudadevops/tektoncd-operator/commit/8ff6881ccd33fce459233d374d072ac37d861b65)
66
- **Triggered by**: l-qing
7-
- **Workflow run**: [#17](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16289173228)
7+
- **Workflow run**: [#20](https://github.com/alaudadevops/tektoncd-operator/actions/runs/16321670900)
88

99
## Files synced:
1010
- docs/

‎docs/en/development/component-quickstart/index.md‎

Lines changed: 294 additions & 214 deletions
Large diffs are not rendered by default.

‎docs/en/development/run_e2e.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Run TektonCD Operator E2E Tests
3-
weight: 40
3+
weight: 14
44
---
55

66
# TektonCD Operator E2E Testing Guide
@@ -252,13 +252,13 @@ Each toolchain contains the following common configuration items:
252252
```bash
253253
# Create workspace directory
254254
mkdir -p workspace
255-
255+
256256
# Copy your kubeconfig to workspace directory
257257
cp /path/to/your/kubeconfig.yaml workspace/config
258-
258+
259259
# Copy your config.yaml to workspace directory
260260
cp config.yaml workspace/config.yaml
261-
261+
262262
# Set the correct permissions for the workspace directory
263263
# The container runs as nonroot user (UID 65532), so we need to give write permissions
264264
chmod -R 777 workspace
@@ -311,7 +311,7 @@ allure open allure-report/
311311
```bash
312312
# Check cluster permissions
313313
kubectl auth can-i create pods --all-namespaces
314-
314+
315315
# If permissions are insufficient, contact cluster administrator
316316
```
317317

@@ -322,7 +322,7 @@ allure open allure-report/
322322
```bash
323323
# Ensure workspace directory has write permissions for all users
324324
chmod -R 777 workspace
325-
325+
326326
# Or set ownership to match the container user (UID 65532)
327327
sudo chown -R 65532:65532 workspace
328328
```
@@ -332,7 +332,7 @@ allure open allure-report/
332332
```bash
333333
# Check network connectivity
334334
curl -I registry.alauda.cn:60070
335-
335+
336336
# Configure image registry authentication
337337
docker login registry.alauda.cn:60070
338338
```
@@ -391,7 +391,7 @@ docker run --entrypoint /bin/bash -it \
391391
# Collect cluster status
392392
kubectl get all --all-namespaces
393393
kubectl describe pods --all-namespaces
394-
394+
395395
# Collect logs
396396
kubectl logs -l app=tektoncd-operator -n tektoncd-operator
397397
```

‎docs/en/development/update-component/index.md‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
created: '2025-07-07'
3-
updated: '2025-07-13'
4-
weight: 20
5-
---
6-
71
# Component Update Guide
82

93
This document describes how to update components in the TektonCD Operator project using the automated update system. The project now uses an automated script to download and process component releases, eliminating the need for manual updates.
@@ -28,21 +22,21 @@ All component configurations are managed in the `components.yaml` file at the pr
2822
```yaml
2923
tektoncd-pipeline:
3024
revision: main
31-
releases:
25+
releases:
3226
- remote_path: pipeline
3327
local_path: tekton-pipeline
3428

3529
tektoncd-hub:
3630
revision: main
37-
releases:
31+
releases:
3832
- remote_path: api
3933
local_path: tekton-hub/api
4034
- remote_path: hub-info
4135
local_path: tekton-hub/hub-info
4236

4337
tektoncd-trigger:
4438
revision: main
45-
releases:
39+
releases:
4640
- remote_path: trigger
4741
local_path: tekton-triggers
4842
- remote_path: bindings
@@ -85,7 +79,7 @@ To use releases from your own branch or specific commit:
8579
```yaml
8680
tektoncd-hub:
8781
revision: your-feature-branch # or specific commit hash
88-
releases:
82+
releases:
8983
- remote_path: api
9084
local_path: tekton-hub/api
9185
- remote_path: hub-info
@@ -118,7 +112,7 @@ To add a new component to the automated update process:
118112
```yaml
119113
your-new-component:
120114
revision: main # or your target branch
121-
releases:
115+
releases:
122116
- remote_path: main
123117
local_path: your-component/main
124118
- remote_path: sidecar
@@ -152,7 +146,7 @@ For a component to work with the automated system, it must:
152146
```yaml
153147
tektoncd-new-component:
154148
revision: v0.1.0
155-
releases:
149+
releases:
156150
- remote_path: controller
157151
local_path: tekton-new-component/controller
158152
- remote_path: webhook
@@ -282,5 +276,6 @@ If you were previously updating components manually:
282276

283277
## Related Documentation
284278

285-
- [Build System Architecture](../../overview/architecture.mdx)
279+
- [Component Configuration Reference](../configure/components.yaml.md)
280+
- [Build System Architecture](../architecture/build-system.md)
286281
- [Development Environment Setup](../component-quickstart/index.md)

‎docs/en/development/update-frontend/index.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
created: '2025-01-10'
3-
updated: '2025-01-10'
4-
weight: 30
3+
sourceSHA: 423aae74086ccd5e58bf95963dba1872dde2b1e215377c15812fd75e0246284b
54
---
65

76
# Update Frontend Images

‎docs/en/overview/lifecycle_policy.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Below is the lifecycle schedule for released versions of the `Alauda DevOps Pipe
1111
| Alauda DevOps Pipelines Version | Release Date | End of Support | Version Type |
1212
| :----: | :----------: | :--------------: | :----: |
1313
| v4.2.x | 2025-08-? | 2026-08-? | LTS |
14-
| v4.1.x | 2025-07-14 | 2025-11-14 | Non-LTS |
14+
| v4.1.x | 2025-07-16 | 2025-11-16 | Non-LTS |
1515
| v4.0.x | 2025-04-08 | 2026-04-08 | LTS |
1616

1717
> For detailed component versions in each version, see the [Compatibility and support matrix](./release_notes.mdx#compatibility-and-support-matrix)

‎docs/en/results/configure/database_configuration.mdx‎

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Tekton Results supports using external PostgreSQL databases. The configuration i
5858
| `db_name` | Database name | `tekton-results` | Yes |
5959
| `db_sslmode` | SSL connection mode | `disable` | No |
6060
| `db_sslrootcert` | SSL root certificate path | Empty | No (required when using SSL) |
61-
| `db_secret_name` | Secret name for database credentials | Empty | Yes |
61+
| `secret_name` | Secret name for database credentials | Empty | Yes |
6262

6363
> The valid options for `db_sslmode` are explained here https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION.
6464
@@ -109,9 +109,14 @@ spec:
109109
db_host: your-postgres-host.example.com
110110
db_port: 5432
111111
db_name: tekton_results
112-
db_secret_name: tekton-results-postgres
112+
db_sslmode: allow
113+
secret_name: tekton-results-postgres
113114
```
114115
116+
:::tip
117+
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).
118+
:::
119+
115120
### 3. Verify Configuration
116121
117122
```bash
@@ -184,7 +189,7 @@ spec:
184189
db_sslmode: verify-full
185190
db_sslrootcert: /etc/tls/db/ca.crt
186191
# Secret configuration
187-
db_secret_name: tekton-results-postgres
192+
secret_name: tekton-results-postgres
188193
# Options for mounting CA certificate
189194
options:
190195
deployments:
@@ -251,6 +256,14 @@ kubectl get pods -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-ap
251256
kubectl get pods -n tekton-pipelines -l app.kubernetes.io/name=tekton-results-retention-policy-agent
252257
```
253258

259+
:::warning
260+
If you update the `db_sslmode` field, you may need to recreate the `TektonResult` resource for the changes to take effect.
261+
262+
```bash
263+
kubectl get tektonresults.operator.tekton.dev result -o yaml | kubectl replace --force -f -
264+
```
265+
:::
266+
254267
### Troubleshooting
255268

256269
#### Common Issues
@@ -297,7 +310,9 @@ kubectl get secret -n <ns-of-postgresql-instance> -l middleware.instance/type=Po
297310

298311
:::info
299312

300-
This Secret contains `host`, `port`, `username`, `password` information. You need to supplement `database` and `sslmode` (set to `allow` or `prefer`) information based on this Secret, and create a new secret in the namespace where the Tekton Results instance is located.
313+
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.
314+
315+
If you need to set `sslmode`, please set `db_sslmode` in `TektonResult` to `allow` or `prefer` etc.
301316

302317
For more PostgreSQL deployment parameters and requirements, please refer to <ExternalSiteLink name="postgresql" href="/installation.html" children="PostgreSQL Deployment Documentation" />.
303318
:::

0 commit comments

Comments
 (0)