api

README

Results API Server

Variables

Environment Variable	Description	Example
DB_USER	Postgres Database user	user
DB_PASSWORD	Postgres Database Password	hunter2
DB_HOST	Postgres Database host	/cloudsql/my-project:us-east1:tekton-results
DB_NAME	Postgres Database name	tekton_results
DB_SSLMODE	Database SSL mode	verify-full
DB_SSLROOTCERT	Path to CA cert used to validate Database cert	/etc/tls/db/ca.crt
DB_ENABLE_AUTO_MIGRATION	Auto-migrate the database on startup (create/update schemas). For further details, refer to https://gorm.io/docs/migration.html	true (default)
PROFILING	Enable profiling server	false (default)
PROFILING_PORT	Profiling Server Port	6060 (default)
DB_MAX_IDLE_CONNECTIONS	The number of idle database connections to keep open	2 (default for golang, but specific database drivers may have settings for this too)
DB_MAX_OPEN_CONNECTIONS	The maximum number of database connections, for best performance it should equal DB_MAX_IDLE_CONNECTIONS	unlimited (default for golang, but specific database drivers may have settings for this too)
GRPC_WORKER_POOL	The maximum number of goroutines pre-allocated for process GRPC requests. The GRPC server will also dynamically create threads.	2 (default)
K8S_QPS	The QPS setting for the kubernetes client created.	5 (default)
K8S_BURST	The burst setting for the kubernetes client created.	10 (default)
SERVER_PORT	gRPC and REST Server Port	8080 (default)
PROMETHEUS_PORT	Prometheus Port	9090 (default)
PROMETHEUS_HISTOGRAM	Enable Prometheus histogram metrics to measure latency distributions of RPCs	false (default)
TLS_PATH	Path to TLS files	/etc/tls
AUTH_DISABLE	Disable RBAC check for resources	false (default)
AUTH_IMPERSONATE	Enable RBAC impersonation	true (default)
LOG_LEVEL	Log level for api server	info (default)
LOGS_API	Enable logs storage service	false (default)
LOGS_TYPE	Determine Logs storage backend type	File (default)
LOGS_BUFFER_SIZE	Buffer for streaming logs	32768 (default)
LOGS_PATH	Logs storage path	logs (default)
S3_BUCKET_NAME	S3 Bucket name
S3_ENDPOINT	S3 Endpoint	https://s3.ap-south-1.amazonaws.com
S3_HOSTNAME_IMMUTABLE	S3 Hostname immutable	false (default)
S3_REGION	S3 Region	ap-south-1
S3_ACCESS_KEY_ID	S3 Access Key ID
S3_SECRET_ACCESS_KEY	S3 Secret Access Key
S3_MULTI_PART_SIZE	S3 Multi part size	5242880 (default)
GCS_BUCKET_NAME	GCS Bucket Name
STORAGE_EMULATOR_HOST	GCS Storage Emulator Server	http://localhost:9004
CONVERTER_ENABLE	Whether to start converter of v1beta1 TaskRun/PipelineRun records to v1	true
CONVERTER_DB_LIMIT	How many records to convert at a time in a transaction	50

These values can also be set in the config file located in the config/env/config directory.

Values derived from Postgres DSN

If you use the default postgres database we provide, the DB_HOST can be set as tekton-results-postgres-service.tekton-pipelines.