Use this reference to verify environment compatibility and plan CloudBees Unify implementation. Check feature requirements against your existing infrastructure to ensure successful setup and avoid compatibility issues during deployment.
For architectural context on these requirements, refer to Understanding CloudBees Unify platform architecture.
Requirements overview
CloudBees Unify features require specific integrations, network configurations, and product editions to function properly. Most features depend on SCM integration as a foundation, with additional requirements based on your specific use cases and organizational infrastructure.
Essential requirements across all features: * SCM integration (GitHub or Bitbucket). * CloudBees Unify subscription (Edition 1 or 2). * Component definitions for application tracking.
Conditional requirements: * Private network access for secure environments. * Jenkins integration for CI insights and test analytics. * Jira integration for flow metrics. * CloudBees workflows for automation and evidence collection.
Core platform prerequisites
Supported SCM providers
CloudBees Unify supports GitHub and Bitbucket in both cloud and enterprise configurations. SCM integration is essential for most platform features including analytics, security scanning, and release orchestration.
Supported providers: * GitHub (cloud and GitHub Enterprise). * Bitbucket (cloud and Bitbucket Server).
Integration requirements: * Repository access permissions for source code analysis. * Webhook configuration for event-driven triggers. * Authentication credentials (OAuth or personal access tokens).
For setup guidance, refer to Connect your CI tool.
Network access requirements
Public environments: Most CloudBees Unify features work with standard internet connectivity to integrate with cloud-based SCM, CI tools, and monitoring systems.
Private environments: Organizations with private SCM, artifact registries, or deployment environments require single-tenant CloudBees Unify deployment to establish secure private connections.
Private network connectivity enables: * Secure connections to private infrastructure. * Compliance with enterprise security requirements. * Network isolation without public internet traversal.
Component creation
Many CloudBees Unify features depend on defining components to represent applications and services. Components link to SCM repositories and track builds, deployments, and security posture across the software delivery lifecycle.
Component requirements: * SCM repository association. * Build and deployment tracking configuration. * Security scanning integration.
Feature requirements matrix
The following table shows requirements for each CloudBees Unify feature:
| Feature | SCM | Private network | Jenkins | Workflows | Jira |
|---|---|---|---|---|---|
Continuous security |
|
(if SCM or security tools are private) |
(Jenkins support coming) |
Optional (to enrich data) |
|
DevOps analytics |
|
(if Jenkins is private) |
(for CI Insights and test results) |
(for DORA, test insights) |
(for flow metrics) |
Release orchestration |
|
(if SCM, Jenkins, or environments are private) |
(Optional) |
(Required) |
|
Integration-specific requirements
CloudBees Unify integrates with external development tools to provide comprehensive software delivery automation. Each integration has specific technical requirements and setup procedures that must be completed for full functionality.
Jenkins and CI tool integration
Jenkins integration enables CI insights, test result collection, and workflow orchestration capabilities. The integration requires plugin installation and authentication configuration between Jenkins and CloudBees Unify.
CloudBees CI plugin requirements: * CloudBees CI Insights plugin installation on Jenkins controllers * Authentication token generated during Jenkins integration configuration * Outbound network access from Jenkins controllers to CloudBees Unify
Supported Jenkins versions: Refer to the CloudBees CI Insights plugin documentation for current Jenkins version compatibility.
CI insights capabilities: * Test result collection for analytics dashboards * Build pipeline insights and performance metrics * Integration with CloudBees workflows for orchestration
GitHub Actions integration
For organizations using GitHub Actions as their primary CI/CD platform, CloudBees provides pre-built actions that integrate with Unify analytics and workflow systems. These actions enable data collection and reporting without requiring separate CI tool setup.
CloudBees provides reusable GitHub Actions for analytics and workflow integration:
Available actions: * Publishing test results to CloudBees Unify analytics. * DORA metrics collection from GitHub workflows. * Security scanning integration.
Requirements: * GitHub repository access. * CloudBees Unify authentication tokens. * Workflow configuration for action execution.
Refer to GitHub Actions documentation for specific action setup and configuration requirements.
Issue tracking integration
Jira integration enables flow metrics that track work items through the entire software delivery lifecycle. This integration provides insights into lead time, cycle time, and work-in-progress optimization.
Jira integration requirements: * Jira Cloud or Jira Server connectivity. * Issue tracking project configuration. * Mapping between Jira issues and software delivery states. * Analytics project setup in CloudBees Unify.
Flow metrics capabilities: * Lead time measurement from issue creation to deployment. * Cycle time tracking through development stages. * Work-in-progress (WIP) monitoring and optimization. * Delivery performance insights.
Workflow and authentication requirements
CloudBees workflows and authentication systems provide the foundation for automation and secure access across the platform. Understanding these requirements is essential for planning workflow development and access management strategies.
CloudBees workflow authoring
CloudBees workflows use YAML-based definitions that execute on Kubernetes via Tekton, providing cloud-native automation capabilities. Workflows integrate with SCM systems for triggering and source access, and support complex multi-stage software delivery processes.
Workflow requirements: * YAML-based workflow definition using CloudBees Actions syntax. * Tekton execution environment (provided by CloudBees Unify). * Integration with SCM for source code access and triggering.
Workflow capabilities: * DORA metrics collection and reporting. * Test insights and result publishing. * Evidence collection for compliance and audit trails. * Release workflow orchestration.
Authentication methods
CloudBees Unify supports multiple authentication methods to accommodate different organizational security requirements and integration patterns. Choose authentication methods based on your security policies and integration needs.
Personal access tokens (PATs): * Generated through CloudBees Unify UI. * Inherit user account permissions. * Used for API access and automation.
OAuth integration: * Standards-based authentication for external tool integration. * Supports GitHub, Bitbucket, and other OAuth providers. * Enables secure, scoped access to external systems.
SAML federation: * Enterprise identity system integration. * Single sign-on (SSO) capabilities. * Centralized user management and access control.
Environment and deployment considerations
Deployment architecture decisions affect security, performance, and integration capabilities. Understanding these considerations helps you choose the appropriate deployment model for your organization’s requirements.
Single-tenant deployment
Single-tenant deployment provides dedicated infrastructure with enhanced security and private network connectivity options. This deployment model is typically required for organizations with strict security requirements or private infrastructure.
When single-tenant deployment is required: * Private SCM, Jenkins, or artifact registry access. * Compliance requirements for network isolation. * Enterprise security policies requiring dedicated infrastructure.
Single-tenant capabilities: * VPC peering or transit gateway connections. * Private endpoint access to internal systems. * Dedicated infrastructure with enhanced security controls.
Capacity and performance considerations
Platform capacity affects workflow execution performance, storage requirements, and operational costs. Planning for appropriate capacity ensures optimal performance as your software delivery automation scales.
Workflow execution scaling: * Kubernetes cluster autoscaling for workflow demand spikes. * Dedicated workflow execution clusters for performance isolation. * Resource allocation based on concurrent workflow requirements.
Storage requirements: * Artifact storage in S3 for build outputs and deployment packages. * Log retention and analytics data storage. * Backup and disaster recovery storage allocation.
Next steps
After reviewing technical requirements:
-
Configure CI tool integration based on your infrastructure.
-
Set up feature-specific configurations using the appropriate setup guides.
For questions about specific requirements or compatibility issues, contact CloudBees Support.