kubiya_runner
resource allows you to create and manage runners in the Kubiya platform. Runners are compute environments where Kubiya agents execute code and perform operations. They provide isolated, secure execution contexts for your automation tasks.
Runners provide dedicated compute environments that ensure consistent performance, security isolation, and resource management for your automation workloads.
Prerequisites
Before using this resource, ensure you have:- A Kubiya account with API access
- An API key (generated from Kubiya dashboard under Admin → Kubiya API Keys)
- Appropriate permissions to create runners in your organization
Quick Start
Configuration Examples
Create runners for different environments with corresponding agents:
Advanced Configurations
Runner with Custom Sources
Runner with Custom Sources
Configure runners with specialized tools and sources:
High-Availability Runner Setup
High-Availability Runner Setup
Configure runners for high-availability scenarios:
Arguments Reference
Required Arguments
The name of the runner. Must be unique within your organization and should be descriptive of the runner’s purpose.
Attributes Reference
In addition to all arguments above, the following attributes are exported:The type of the runner as computed by the system. This reflects the runner’s configuration and capabilities.
Runner Types and Use Cases
Organize runners by deployment environment:
Import
Runners can be imported using their name:Best Practices
Environment Management
- Create separate runners for different environments (dev, staging, prod)
- Use consistent naming conventions that indicate the runner’s purpose
- Implement proper access controls and permissions for each environment
- Consider resource requirements and scaling needs per environment
Workload Optimization
- Design runners for specific workload types (compute, I/O, memory intensive)
- Consider geographic distribution for global workloads
- Plan for peak usage and scaling requirements
- Monitor runner performance and resource utilization
Security & Compliance
- Implement appropriate security controls for runner environments
- Ensure compliance requirements are met for sensitive workloads
- Use dedicated runners for high-security or regulated workloads
- Regularly audit runner configurations and access patterns
Operations & Maintenance
- Document the purpose and configuration of each runner
- Implement monitoring and alerting for runner health
- Plan for disaster recovery and high availability
- Establish clear ownership and maintenance procedures
Special Runner Configurations
Kubiya-Hosted Runner:
The special runner name “kubiya-hosted” refers to Kubiya’s cloud-hosted runners. These are managed by Kubiya and provide:
- Automatic scaling and resource management
- Built-in security and compliance measures
- No infrastructure management overhead
- Global availability and redundancy
Custom Runner Considerations:
When creating custom runners, consider:
- Resource requirements and scaling needs
- Network connectivity and security requirements
- Maintenance and update responsibilities
- Monitoring and observability requirements
Runner Lifecycle Management
Compatibility
Requirements:
- Kubiya Terraform Provider version >= 1.0.0
- Terraform >= 1.0
- Runners must be created before they can be referenced by agents or sources
- Runner names must be unique within your organization
Troubleshooting
Runner Creation Issues
Runner Creation Issues
- Verify you have appropriate permissions to create runners
- Check that the runner name is unique within your organization
- Ensure the runner name follows naming conventions (no special characters)
- Confirm your organization has available runner quota
Agent Association Problems
Agent Association Problems
- Ensure the runner exists before referencing it in agents
- Check that the runner name exactly matches in agent configuration
- Verify the runner is active and available
- Confirm the agent has permissions to use the specified runner
Performance Issues
Performance Issues
- Monitor runner resource utilization and performance metrics
- Consider workload distribution across multiple runners
- Check for resource constraints or bottlenecks
- Review runner capacity and scaling requirements