Skip to content

Commit 0225862

Browse files
committed
Add TektonResult to TektonConfig doc
This will add the instructions in TektonConfig doc how to install and manage Results component through Tekton Config TektonConfig doc and updates TektonResult doc Signed-off-by: Shiv Verma
1 parent fc83072 commit 0225862

File tree

2 files changed

+42
-24
lines changed

2 files changed

+42
-24
lines changed

docs/TektonConfig.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Operator provides support for installing and managing following operator compone
1818
Other than the above components depending on the platform operator also provides support for
1919
- On both Kubernetes and OpenShift
2020
- [TektonChain](./TektonChain.md)
21+
- [TektonResult](./TektonResult.md)
2122
- On Kubernetes
2223
- [TektonDashboard](./TektonDashboard.md)
2324
- On OpenShift
@@ -113,6 +114,10 @@ The TektonConfig CR provides the following features
113114
configMaps: {}
114115
deployments: {}
115116
webhookConfigurationOptions: {}
117+
result:
118+
disabled: false
119+
is_external_db: false
120+
options: {}
116121
platforms:
117122
openshift:
118123
pipelinesAsCode:
@@ -165,8 +170,8 @@ By default, namespace would be `tekton-pipelines` for Kubernetes and `openshift-
165170

166171
This allows user to choose which all components to install on the cluster.
167172
There are 3 profiles available:
168-
- `all`: This profile will install all components (TektonPipeline, TektonTrigger and TektonChain)
169-
- `basic`: This profile will install only TektonPipeline, TektonTrigger and TektonChain component
173+
- `all`: This profile will install all components (TektonPipeline, TektonTrigger,TektonResult and TektonChain)
174+
- `basic`: This profile will install only TektonPipeline, TektonTrigger, TektonResult and TektonChain component
170175
- `lite`: This profile will install only TektonPipeline component
171176

172177
On Kubernetes, `all` profile will install `TektonDashboard` and on OpenShift `TektonAddon` will be installed.
@@ -284,6 +289,39 @@ chain:
284289
transparency.url: #value
285290
```
286291
292+
### Result
293+
294+
Result section allows user to customize the Tekton Result component, Refer to [Result Spec](https://github.com/tektoncd/operator/blob/main/docs/TektonResult.md#spec) section in TektonResult for available options.
295+
296+
Example:
297+
298+
```yaml
299+
result:
300+
disabled: false # - `disabled` : if the value set as `true`, result component will be disabled (default: `false`)
301+
targetNamespace: tekton-pipelines
302+
is_external_db: false # If it's true use external database and Result gets it's database from kubernetes secret named `tekton-results-postgres`
303+
db_host: localhost
304+
db_port: 5342
305+
db_sslmode: verify-full
306+
db_sslrootcert: /etc/tls/db/ca.crt
307+
db_enable_auto_migration: true
308+
log_level: debug
309+
logs_api: true
310+
logs_type: File
311+
logs_buffer_size: 90kb
312+
logs_path: /logs
313+
auth_disable: true
314+
logging_pvc_name: tekton-logs
315+
secret_name: # optional
316+
gcs_creds_secret_name: <value>
317+
gcc_creds_secret_key: <value>
318+
gcs_bucket_name: <value>
319+
loki_stack_name: #optional
320+
loki_stack_namespace: #optional
321+
prometheus_port: 9090
322+
prometheus_histogram: false
323+
```
324+
287325
### Pruner
288326
Pruner provides auto clean up feature for the Tekton `pipelinerun` and `taskrun` resources. In the background pruner container runs `tkn` command.
289327

docs/TektonResult.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,9 @@ weight: 5
88

99
TektonResult custom resource allows user to install and manage [Tekton Result][result].
1010

11-
TektonResult is an optional component and currently cannot be installed through TektonConfig. It has to be installed seperately.
11+
TektonResult is installed through [TektonConfig](./TektonConfig.md).
1212

13-
To install Tekton Result on your cluster follow steps as given below:
14-
- Make sure Tekton Pipelines is installed on your cluster, using the Operator.
15-
- Generate a database root password.
16-
A database root password must be generated and stored in a [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/)
17-
before installing results. By default, Tekton Results expects this secret to have
18-
the following properties:
19-
20-
- namespace: `tekton-pipelines`
21-
- name: `tekton-results-postgres`
22-
- contains the fields:
23-
- `user=<user name>`
24-
- `password=<your password>`
25-
26-
If you are not using a particular password management strategy, the following
27-
command will generate a random password for you:
28-
Update namespace value in the command if Tekton Pipelines is installed in a different namespace..
29-
30-
```sh
31-
export NAMESPACE="tekton-pipelines"
32-
kubectl create secret generic tekton-results-postgres --namespace=${NAMESPACE} --from-literal=POSTGRES_USER=result --from-literal=POSTGRES_PASSWORD=$(openssl rand -base64 20)
33-
```
13+
TektonResult will be installed on OpnShift platform by default, to install on kubernetes platform follow steps as given below:
3414
- Generate cert/key pair.
3515
Note: Feel free to use any cert management software to do this!
3616

0 commit comments

Comments
 (0)