Quick Start
This guide helps you quickly understand and creating your first configuration for Tekton Pruner.
Prerequisites
- Environment Requirements
Tekton Operatorinstalled- Ensure that
Tekton Pipelinesis installed and ready through the Operator
- Required Tools
kubectlcommand line tool
Step 1: Configure Tekton Pruner
Important: Tekton Pruner is a event-based pruner, and is disabled by default. To enable the event-based pruner, the existing job-based pruner MUST be disabled.
- Both pruners (
job-basedandevent-based) cannot be enabled simultaneously - The
event-basedpruner responds to resource events in real-time, providing more efficient cleanup
If you want to use job-based pruner, please refer to Regular Cleanup of TaskRun and PipelineRun Resources.
Enabling the Pruner deletes runs at once, in every namespace it covers. Before you enable it, read the warning in Recommended Settings of Namespace Configuration and follow the steps there.
Configure Tekton Pruner to delete completed resources after 5 minutes and keep the last 3 runs by applying the following configuration:
The enforcedConfigLevel determines the configuration hierarchy:
global: Cluster-wide defaults apply to all namespaces (no namespace overrides allowed)namespace: Allows namespace-level overrides via ConfigMaps in individual namespaces
For more information, please refer to Pruner Configuration.
Step 2: Test the Configuration
Create test PipelineRuns to verify pruning:
Next Steps
- Pruner Configuration - Detail of the configuration options
- Namespace Configuration - Per-namespace settings and validation boundaries
- Resource Groups - Fine-grained control with selectors
- Time-based Pruning - TTL strategies for different environments
- History-based Pruning - Retention strategies by status