# Buildkite Pipelines Documentation > Buildkite documentation for Buildkite Pipelines, covering getting started, architecture, configuration, best practices, and API integration. ## Pipelines - [Overview](https://buildkite.com/docs/pipelines.md): Landing page for Buildkite Pipelines CI/CD product documentation. ### Introduction #### Why Buildkite Pipelines - [Advantages of Buildkite Pipelines](https://buildkite.com/docs/pipelines/advantages/buildkite-pipelines.md): Why teams choose Buildkite Pipelines: hybrid architecture that keeps code on your infrastructure, unlimited concurrency, dynamic pipelines, extensible plugins and hooks, developer experience features, AI workflow support, and predictable concurrency-based pricing. - [Advantages over GitHub Actions](https://buildkite.com/docs/pipelines/advantages/buildkite-vs-gha.md): Comparison of Buildkite vs GitHub Actions covering scaling limits, dynamic pipelines, reliability, and hosted machine performance. - [Advantages over CircleCI](https://buildkite.com/docs/pipelines/advantages/buildkite-vs-circleci.md): Comparison of Buildkite vs CircleCI covering infrastructure control, concurrency caps, dynamic pipelines, monorepo support, and predictable pricing. - [Advantages over Jenkins](https://buildkite.com/docs/pipelines/advantages/buildkite-vs-jenkins.md): Comparison of Buildkite vs Jenkins covering managed control plane, ephemeral agents, scaling, YAML pipelines, and dynamic pipelines. - [Advantages over GitLab](https://buildkite.com/docs/pipelines/advantages/buildkite-vs-gitlab.md): Comparison of Buildkite vs GitLab covering lightweight agents, flexible pipelines without rigid stages, monorepo support, and pricing. - [Frequently asked questions](https://buildkite.com/docs/pipelines/advantages/faq.md): Frequently asked questions about Buildkite Pipelines covering speed, security, dynamic pipelines, comparisons to GitHub Actions, Jenkins, and GitLab, monorepo support, and AI/ML workloads. - [Getting started](https://buildkite.com/docs/pipelines/getting-started.md): Step-by-step tutorial for creating your first pipeline, running a build, and understanding Pipelines fundamentals. - [Create your own pipeline](https://buildkite.com/docs/pipelines/create-your-own.md): Tutorial for writing a pipeline definition for your own code after completing the getting started guide. - [Buildkite Pipelines architecture](https://buildkite.com/docs/pipelines/architecture.md): Explains the self-hosted (hybrid) and Buildkite hosted architecture models for build environments. - [Dashboard walkthrough](https://buildkite.com/docs/pipelines/dashboard-walkthrough.md): Guide to the Pipelines dashboard UI including pipeline status, build history, speed, reliability metrics, and favorites. - [Build page](https://buildkite.com/docs/pipelines/build-page.md): Guide to the redesigned build page UI with sidebar navigation, step search, log viewing, and summary/steps/annotations views. #### Pipeline converter - [Overview](https://buildkite.com/docs/pipelines/converter.md): Overview of the AI-powered pipeline converter tool that translates CI configs from GitHub Actions, Jenkins, CircleCI, and others. - [GitHub Actions](https://buildkite.com/docs/pipelines/converter/github-actions.md): How the converter translates GitHub Actions workflows to Buildkite pipelines, including jobs, triggers, matrix, and secrets mapping. - [Jenkins](https://buildkite.com/docs/pipelines/converter/jenkins.md): How the converter translates Jenkins Scripted and Declarative pipelines to Buildkite, including stages, parameters, and concurrency. - [CircleCI](https://buildkite.com/docs/pipelines/converter/circleci.md): How the converter translates CircleCI configs to Buildkite pipelines, including workflows, orbs, executors, and matrix strategies. - [Bitbucket Pipelines](https://buildkite.com/docs/pipelines/converter/bitbucket-pipelines.md): How the converter translates Bitbucket Pipelines configs to Buildkite, including steps, branch pipelines, and parallel execution. - [Glossary](https://buildkite.com/docs/pipelines/glossary.md): Definitions of key Pipelines terms: agent, artifact, build, cluster, dynamic pipeline, job, pipeline, queue, step, and more. ### Connect source control - [Overview](https://buildkite.com/docs/pipelines/source-control.md): Index of supported source control integrations: GitHub, GitHub Enterprise, GitLab, Bitbucket, Bitbucket Server, Phabricator, and Git. - [GitHub](https://buildkite.com/docs/pipelines/source-control/github.md): Setting up GitHub integration using the GitHub App or OAuth, permissions, webhooks, PR builds, and commit statuses. - [GitHub Enterprise](https://buildkite.com/docs/pipelines/source-control/github-enterprise.md): Setting up GitHub Enterprise Server integration with OAuth app registration, webhooks, and commit status updates. - [GitLab](https://buildkite.com/docs/pipelines/source-control/gitlab.md): Setting up GitLab and GitLab Self-Managed integration with webhooks and commit status updates. - [Bitbucket](https://buildkite.com/docs/pipelines/source-control/bitbucket.md): Setting up Bitbucket Cloud integration with webhooks and commit status updates. - [Bitbucket Server](https://buildkite.com/docs/pipelines/source-control/bitbucket-server.md): Setting up Bitbucket Server integration with webhooks for triggering builds on code pushes and pull requests. - [Phabricator](https://buildkite.com/docs/pipelines/source-control/phabricator.md): Setting up Phabricator integration using Harbormaster build plans and webhooks for build status reporting. - [Other Git servers](https://buildkite.com/docs/pipelines/source-control/git.md): Triggering builds from non-integrated Git servers using post-receive hooks and the Buildkite REST API. ### Migration - [Overview](https://buildkite.com/docs/pipelines/migration.md): Overview of migration tools and guides for moving to Buildkite from Jenkins, GitHub Actions, Bamboo, and other CI/CD platforms. - [From GitHub Actions](https://buildkite.com/docs/pipelines/migration/from-githubactions.md): Migration guide from GitHub Actions covering architecture, checkout behavior, workflow translation, secrets, and OIDC setup. - [From CircleCI](https://buildkite.com/docs/pipelines/migration/from-circleci.md): Migration guide from CircleCI covering architecture differences, orbs vs plugins, executor mapping, workspace handling, and pipeline translation. - [From Jenkins](https://buildkite.com/docs/pipelines/migration/from-jenkins.md): Migration guide from Jenkins covering architecture differences, pipeline translation, agents, plugins, and secrets. - [From Bitbucket Pipelines](https://buildkite.com/docs/pipelines/migration/from-bitbucket-pipelines.md) - [From Bamboo](https://buildkite.com/docs/pipelines/migration/from-bamboo.md): Migration guide from Bamboo covering how plans, stages, tasks, agents, variables, and deployments map to Buildkite concepts. ### Best practices - [Overview](https://buildkite.com/docs/pipelines/best-practices.md) - [Pipeline design and structure](https://buildkite.com/docs/pipelines/best-practices/pipeline-design-and-structure.md): Patterns for maintainable pipelines: modularity, monorepo builds, fast feedback loops, YAML structure, and versioning. - [Agent management](https://buildkite.com/docs/pipelines/best-practices/agent-management.md): Best practices for agent infrastructure: cloud compute, Kubernetes, hosted agents, queue design, lifecycle, and autoscaling. - [Docker-based builds](https://buildkite.com/docs/pipelines/best-practices/docker-containerized-builds.md): Running builds in Docker containers using the Docker and Docker Compose plugins, with configuration examples. - [Parallelizing builds](https://buildkite.com/docs/pipelines/best-practices/parallel-builds.md): Running steps in parallel across multiple agents and using job parallelism to split test suites for faster builds. - [Working with monorepos](https://buildkite.com/docs/pipelines/best-practices/working-with-monorepos.md): Static and dynamic approaches for running monorepo pipelines with change detection using if_changed and diff plugins. - [Environment and dependency management](https://buildkite.com/docs/pipelines/best-practices/environment-and-dependency.md): Best practices for containerized builds, dependency locking, caching, environment variable management, and tool versioning. - [Secrets management](https://buildkite.com/docs/pipelines/best-practices/secrets-management.md): Recommendations for secrets management: native tools, rotation, scoping, and audit logging. - [Infrastructure as code recommendations](https://buildkite.com/docs/pipelines/best-practices/iac.md): Managing Buildkite organizations, pipelines, and agents as code using Terraform, GitOps workflows, and OIDC. - [Git checkout optimization](https://buildkite.com/docs/pipelines/best-practices/git-checkout-optimization.md): Optimizing Git checkout performance with sparse checkout and Git mirrors for large repositories. - [Plugin management](https://buildkite.com/docs/pipelines/best-practices/plugin-management.md): Best practices for plugin standardization: common use cases, plugin sources, versioning, and security vetting. - [Caching](https://buildkite.com/docs/pipelines/best-practices/caching.md): Caching strategies for dependencies, Docker layers, and Git mirrors using hosted cache volumes and cache plugins. - [Monitoring and observability](https://buildkite.com/docs/pipelines/best-practices/monitoring-and-observability.md): Best practices for telemetry, metrics collection, alerting, log management, and integrating with observability tools. - [Platform controls](https://buildkite.com/docs/pipelines/best-practices/platform-controls.md): How platform teams maintain centralized control over agent infrastructure, pipeline templates, and developer autonomy. - [Enforcing security controls](https://buildkite.com/docs/pipelines/best-practices/security-controls.md): Security engineering guide covering authentication, source code integrity, supply chain, artifact, and pipeline hardening. ### Tutorials - [Using Bazel on Buildkite](https://buildkite.com/docs/pipelines/tutorials/bazel.md): Setting up Bazel builds on Buildkite with installation, workspace configuration, and example pipelines. - [Dynamic pipelines and annotations using Bazel](https://buildkite.com/docs/pipelines/tutorials/dynamic-pipelines-and-annotations-using-bazel.md): Tutorial for creating dynamic pipelines and build annotations using Bazel with a monorepo example project. - [Migrating to YAML steps](https://buildkite.com/docs/pipelines/tutorials/pipeline-upgrade.md): Migrating from the web-based step editor to the YAML Steps editor, including compatibility and bulk migration. - [Using GitHub merge queues](https://buildkite.com/docs/pipelines/tutorials/github-merge-queue.md): Configuring Buildkite to work with GitHub merge queues, including build behavior, conditionals, and environment variables. - [Triggering Pipelines Using GitHub Actions](https://buildkite.com/docs/pipelines/tutorials/github-actions.md): Using the Trigger Buildkite Pipeline GitHub Action to create Buildkite builds from GitHub Actions workflows. - [Attributing AWS agent costs](https://buildkite.com/docs/pipelines/tutorials/attributing-aws-agent-costs.md) ### Configure pipelines - [Overview](https://buildkite.com/docs/pipelines/configure.md): Overview of pipeline configuration concepts: what pipelines are, step types, and links to key configuration topics. - [Defining steps](https://buildkite.com/docs/pipelines/configure/defining-steps.md): How to define pipeline steps in YAML, set up webhooks, configure step defaults, and manage pipeline.yml files. #### Step types - [Overview](https://buildkite.com/docs/pipelines/configure/step-types.md): Index of available step types: command, wait, block, input, trigger, and group steps. - [Command step](https://buildkite.com/docs/pipelines/configure/step-types/command-step.md): Reference for command steps: running shell commands, all attributes, plugins, matrix, soft_fail, and agent targeting. - [Wait step](https://buildkite.com/docs/pipelines/configure/step-types/wait-step.md): Reference for wait steps that pause builds until all previous steps complete, with continue_on_failure option. - [Block step](https://buildkite.com/docs/pipelines/configure/step-types/block-step.md): Reference for block steps that pause builds for manual approval, with optional text and select input fields. - [Input step](https://buildkite.com/docs/pipelines/configure/step-types/input-step.md): Reference for input steps that collect user information using text and select fields without creating implicit dependencies. - [Trigger step](https://buildkite.com/docs/pipelines/configure/step-types/trigger-step.md): Reference for trigger steps that create builds on other pipelines, with permissions, async mode, and attribute details. - [Group step](https://buildkite.com/docs/pipelines/configure/step-types/group-step.md): Reference for group steps that display sub-steps as a single logical group on the build page. #### Dynamic pipelines - [Overview](https://buildkite.com/docs/pipelines/configure/dynamic-pipelines.md): Generating pipeline steps at runtime using scripts that output YAML/JSON and pipe to buildkite-agent pipeline upload. - [Using if_changed](https://buildkite.com/docs/pipelines/configure/dynamic-pipelines/if-changed.md): Using the if_changed step attribute to skip steps based on Git diff file changes, with glob patterns, monorepo workflows, and comparison strategies. - [Buildkite SDK](https://buildkite.com/docs/pipelines/configure/dynamic-pipelines/sdk.md): Multi-language SDK (JS, Python, Go, Ruby, C#) for programmatically generating dynamic pipeline steps. - [Annotations](https://buildkite.com/docs/pipelines/configure/annotations.md) - [Writing build scripts](https://buildkite.com/docs/pipelines/configure/writing-build-scripts.md): Guidelines for writing shell scripts for builds, including Bash options, debugging, and exit status handling. - [Using conditionals](https://buildkite.com/docs/pipelines/configure/conditionals.md): Using if/unless expressions with C-like syntax to conditionally run steps or filter pipeline builds from webhooks. - [Depends on](https://buildkite.com/docs/pipelines/configure/depends-on.md): Managing step execution order with implicit dependencies (wait/block) and explicit dependencies (depends_on). - [Environment variables](https://buildkite.com/docs/pipelines/configure/environment-variables.md): Complete reference of Buildkite environment variables available in build steps, hooks, and plugins. - [Skipping builds](https://buildkite.com/docs/pipelines/configure/skipping.md): Skipping or canceling intermediate builds, and skipping builds using commit messages or the API. - [Canceling builds](https://buildkite.com/docs/pipelines/configure/canceling-builds.md) - [Retry](https://buildkite.com/docs/pipelines/configure/retry.md): Configuring automatic and manual retry for command step jobs, including exit status, signal, signal_reason conditions, retry limits, and retry behavior. - [Soft fail](https://buildkite.com/docs/pipelines/configure/soft-fail.md) - [Build artifacts](https://buildkite.com/docs/pipelines/configure/artifacts.md): Uploading, downloading, and managing build artifacts using step attributes, CLI commands, and the API. - [Build timeouts](https://buildkite.com/docs/pipelines/configure/build-timeouts.md): Configuring command step timeouts and scheduled job expiration at step, pipeline, and organization levels. - [Pipeline tags](https://buildkite.com/docs/pipelines/configure/tags.md): Tagging pipelines with emoji and text labels for filtering and searching on the dashboard. - [Build retention](https://buildkite.com/docs/pipelines/configure/build-retention.md): Build data retention periods by plan tier and the lifecycle of build data removal. - [Public pipelines](https://buildkite.com/docs/pipelines/configure/public-pipelines.md): Making pipelines publicly visible for open-source projects, providing read-only access to builds and logs. - [Using build meta-data](https://buildkite.com/docs/pipelines/configure/build-meta-data.md): Storing and retrieving key-value metadata across build steps using the buildkite-agent meta-data command. - [Managing log output](https://buildkite.com/docs/pipelines/configure/managing-log-output.md): Formatting build log output with collapsible groups, ANSI colors, redaction, and log limits. - [Links and images in log output](https://buildkite.com/docs/pipelines/configure/links-and-images-in-log-output.md): Embedding clickable links and inline images in build logs using ANSI escape codes. - [Notify](https://buildkite.com/docs/pipelines/configure/notify.md): Configuring build notifications for Slack, email, GitHub statuses, PagerDuty, webhooks, and Basecamp. - [Glob pattern syntax](https://buildkite.com/docs/pipelines/configure/glob-pattern-syntax.md): Syntax reference for glob patterns used in artifact uploads and if_changed step conditions. - [Example pipelines](https://buildkite.com/docs/pipelines/configure/example-pipelines.md): Gallery of example pipelines for various languages, frameworks, build systems, and techniques. #### Workflows - [Job priority](https://buildkite.com/docs/pipelines/configure/workflows/job-priority.md): Setting job priority values to control dispatch order, including per-step and pipeline-wide priority. - [Controlling concurrency](https://buildkite.com/docs/pipelines/configure/workflows/controlling-concurrency.md): Using concurrency limits and concurrency groups to serialize deployments or limit parallel job execution. - [Build matrix](https://buildkite.com/docs/pipelines/configure/workflows/build-matrix.md): Expanding a single step template into multiple jobs using matrix element arrays with adjustments. - [Branch configuration](https://buildkite.com/docs/pipelines/configure/workflows/branch-configuration.md): Filtering builds and steps by branch patterns at the pipeline, step, and pull request levels. - [Scheduled builds](https://buildkite.com/docs/pipelines/configure/workflows/scheduled-builds.md): Creating cron-based build schedules with predefined intervals or custom crontab syntax. - [Archive and delete](https://buildkite.com/docs/pipelines/configure/workflows/archiving-and-deleting-pipelines.md): How to archive pipelines to preserve history or permanently delete them and their build data. ### Security - [Overview](https://buildkite.com/docs/pipelines/security.md): Security overview covering data flow, infrastructure, encryption, logging, audit, and compliance controls. #### Secrets - [Overview](https://buildkite.com/docs/pipelines/security/secrets.md): Overview of secrets management options: managing secrets, risk considerations, and Buildkite secrets service. - [Managing](https://buildkite.com/docs/pipelines/security/secrets/managing.md): Best practices for managing pipeline secrets using secrets storage services, environment hooks, and agent hooks. - [Risk considerations](https://buildkite.com/docs/pipelines/security/secrets/risk-considerations.md): Security risks to avoid: storing secrets in pipeline settings, YAML env blocks, or build logs. ##### Buildkite secrets - [Overview](https://buildkite.com/docs/pipelines/security/secrets/buildkite-secrets.md): Buildkite's encrypted key-value secret store scoped to clusters, with creation, usage, and redaction details. - [Access policies](https://buildkite.com/docs/pipelines/security/secrets/buildkite-secrets/access-policies.md): YAML-based access policies that restrict Buildkite secret access by pipeline, branch, user, and other build attributes. #### Clusters - [Overview](https://buildkite.com/docs/pipelines/security/clusters.md): Clusters for organizing agents, queues, and pipelines into isolated groups with self-service management. - [Manage clusters](https://buildkite.com/docs/pipelines/security/clusters/manage.md): Creating, updating, and deleting clusters; managing maintainers, agent tokens, and pipeline assignments. - [Migrate from unclustered to clustered agents](https://buildkite.com/docs/pipelines/security/clusters/migrate-from-unclustered-to-clustered-agents.md): Step-by-step guide for migrating unclustered agents and pipelines to clustered agent infrastructure. ##### Rules - [Overview](https://buildkite.com/docs/pipelines/security/clusters/rules.md): Rules for cross-cluster pipeline triggering and cross-pipeline artifact access with source/target conditions. - [Manage rules](https://buildkite.com/docs/pipelines/security/clusters/rules/manage.md): Creating and managing rules using the Buildkite interface, REST API, and GraphQL API. - [Incoming webhooks](https://buildkite.com/docs/pipelines/security/incoming-webhooks.md): Security FAQ for incoming webhooks from source control providers, including IP filtering and logging. #### OIDC - [Overview](https://buildkite.com/docs/pipelines/security/oidc.md): Overview of OIDC token issuance by Buildkite agents for federated authentication with AWS, GCP, Azure, and others. - [OIDC with AWS](https://buildkite.com/docs/pipelines/security/oidc/aws.md): Step-by-step setup for OIDC federation between Buildkite agents and AWS IAM using assume-role-with-web-identity. - [OIDC with Azure](https://buildkite.com/docs/pipelines/security/oidc/azure.md): Step-by-step setup for OIDC federation between Buildkite Pipelines and Microsoft Azure using Entra ID federated identity credentials, with a Terraform example. - [Permissions](https://buildkite.com/docs/pipelines/security/permissions.md): Configuring user, team, and pipeline permissions at organization, team, and pipeline levels. ### Governance - [Overview](https://buildkite.com/docs/pipelines/governance.md): Overview of governance features for compliance and auditing: pipeline templates and build exports. - [Pipeline templates](https://buildkite.com/docs/pipelines/governance/templates.md): Enterprise feature for defining reusable pipeline step configurations as centrally managed templates. - [Build exports](https://buildkite.com/docs/pipelines/governance/build-exports.md): Enterprise feature to export build data to S3 or GCS buckets for long-term retention beyond the plan limit. - [Job log archiving](https://buildkite.com/docs/pipelines/governance/job-log-archiving.md) ### Deployments - [Overview](https://buildkite.com/docs/pipelines/deployments.md): Architectures and patterns for manual and continuous deployment pipelines, including block steps and trigger steps. - [Deploying to AWS Lambda](https://buildkite.com/docs/pipelines/deployments/to-aws-lambda.md): Tutorial for deploying Lambda functions using the AWS Lambda Deploy plugin with alias management and rollback. - [Deploying to Kubernetes](https://buildkite.com/docs/pipelines/deployments/to-kubernetes.md): Tutorial for deploying to Kubernetes using kubectl, Docker image builds, and trigger steps between test and deploy pipelines. - [Deploying with Argo](https://buildkite.com/docs/pipelines/deployments/with-argo-cd.md): Integrating Buildkite Pipelines with Argo CD for GitOps-based Kubernetes deployments. - [Deploying with Heroku](https://buildkite.com/docs/pipelines/deployments/with-heroku.md): Deploying Heroku applications from Buildkite pipelines using git push or Heroku's automatic deploys feature. - [Deployment visibility with Backstage](https://buildkite.com/docs/pipelines/deployments/deployment-visibility-with-backstage.md): Monitoring Buildkite deployment pipelines in Backstage developer portals with real-time status and build management. - [Deployment plugins](https://buildkite.com/docs/pipelines/deployments/deployment-plugins.md): Directory of Buildkite plugins for deployment automation. ### Insights - [Waterfall view](https://buildkite.com/docs/pipelines/insights/waterfall.md): Waterfall chart view for visualizing build job timing, wait times, agent assignment, and execution durations. - [Cluster insights](https://buildkite.com/docs/pipelines/insights/clusters.md): Enterprise dashboard showing real-time cluster metrics: queue wait time, agent utilization, and job pass rate. - [Queue metrics](https://buildkite.com/docs/pipelines/insights/queue-metrics.md): Real-time queue statistics showing connected agents, running/waiting/scheduled jobs, and agent utilization. ### Integrations - [Overview](https://buildkite.com/docs/pipelines/integrations.md): Landing page for Buildkite Pipelines integrations with third-party tools and services. #### Plugins - [Overview](https://buildkite.com/docs/pipelines/integrations/plugins.md): How plugins extend build steps using job lifecycle hooks, including open source, private, and vendored plugin types. - [Plugins directory](https://buildkite.com/docs/pipelines/integrations/plugins/directory.md): Searchable directory of all Buildkite-maintained and third-party plugins. - [Using plugins](https://buildkite.com/docs/pipelines/integrations/plugins/using.md): Adding plugins to command steps, configuring plugin parameters, pinning versions, and plugin source types. - [Writing plugins](https://buildkite.com/docs/pipelines/integrations/plugins/writing.md): Tutorial and reference for creating custom Buildkite plugins with hooks, plugin.yml schema, and testing tools. #### Notifications - [PagerDuty](https://buildkite.com/docs/pipelines/integrations/notifications/pagerduty.md): Sending PagerDuty change events when builds finish, with integration setup and pipeline YAML configuration. - [Slack](https://buildkite.com/docs/pipelines/integrations/notifications/slack.md): Setting up per-channel Slack notification services for build and job status updates. - [Slack Workspace](https://buildkite.com/docs/pipelines/integrations/notifications/slack-workspace.md): Workspace-level Slack integration for configuring notifications using YAML notify attributes to any channel or user. - [CCMenu and CCTray](https://buildkite.com/docs/pipelines/integrations/notifications/cc-menu.md): Using the cctray.xml feed to display build status in CCMenu, CCTray, and build dashboards. - [Notification plugins](https://buildkite.com/docs/pipelines/integrations/notifications/plugins.md): Directory of Buildkite plugins for delivering notifications. #### Observability - [Overview](https://buildkite.com/docs/pipelines/integrations/observability/overview.md): Overview of observability integrations: Datadog, Honeycomb, OpenTelemetry, Amazon EventBridge, and community plugins. - [Datadog](https://buildkite.com/docs/pipelines/integrations/observability/datadog.md): Configuring Datadog APM tracing and CI Pipeline Visibility for Buildkite Pipelines. - [Honeycomb](https://buildkite.com/docs/pipelines/integrations/observability/honeycomb.md): Integrating Honeycomb with Buildkite using buildevents binary, OpenTelemetry tracing, or the Markers plugin. - [OpenTelemetry](https://buildkite.com/docs/pipelines/integrations/observability/opentelemetry.md): Sending OpenTelemetry traces from Buildkite agents and the dashboard to your OTLP endpoint. - [Amazon EventBridge](https://buildkite.com/docs/pipelines/integrations/observability/amazon-eventbridge.md): Streaming real-time build, job, and agent events to Amazon EventBridge with full event schema reference. - [Observability plugins](https://buildkite.com/docs/pipelines/integrations/observability/plugins.md): Directory of Buildkite plugins for observability. #### Security and compliance - [Security and compliance plugins](https://buildkite.com/docs/pipelines/integrations/security-and-compliance/plugins.md): Directory of Buildkite plugins for security, governance, and compliance. - [SonarScanner CLI tutorial](https://buildkite.com/docs/pipelines/integrations/security-and-compliance/sonar.md): Tutorial for integrating SonarScanner CLI with Buildkite pipelines for static code analysis using SonarQube or SonarCloud. #### Secrets - [Secrets plugins](https://buildkite.com/docs/pipelines/integrations/secrets/plugins.md): Directory of Buildkite plugins for secrets management. #### Artifacts and packages - [Artifactory](https://buildkite.com/docs/pipelines/integrations/artifacts-and-packages/artifactory.md): Configuring the Buildkite agent to upload and download artifacts directly from JFrog Artifactory. - [Artifact plugins](https://buildkite.com/docs/pipelines/integrations/artifacts-and-packages/artifact-plugins.md): Directory of Buildkite plugins for managing or uploading build artifacts. - [Package plugins](https://buildkite.com/docs/pipelines/integrations/artifacts-and-packages/package-plugins.md): Directory of Buildkite plugins for publishing or retrieving packages. #### Other integrations - [Build status badges](https://buildkite.com/docs/pipelines/integrations/other/build-status-badges.md): Embedding build status badge images in READMEs and dashboards, with branch, step, and style options. - [Docker Hub](https://buildkite.com/docs/pipelines/integrations/other/docker-hub.md): Handling Docker Hub rate limits in Buildkite builds with authentication, mirroring, and caching strategies. - [Backstage](https://buildkite.com/docs/pipelines/integrations/other/backstage.md): Installing and configuring the Buildkite plugin for Backstage developer portals with build monitoring and management. ## Platform - [Overview](https://buildkite.com/docs/platform.md): Overview of platform-level features: team management, audit log, emojis, CLI, SSO, security, and integrations. ### Team management - [Overview](https://buildkite.com/docs/platform/team-management.md): Overview of team management features: permissions, 2FA enforcement, system banners, and API token management. - [User and team permissions](https://buildkite.com/docs/platform/team-management/permissions.md): Configuring user and team permissions at organization, team, pipeline, suite, and registry levels. - [Enforce 2FA](https://buildkite.com/docs/platform/team-management/enforce-2fa.md): Enforcing two-factor authentication for all users in a Buildkite organization. - [System banners](https://buildkite.com/docs/platform/team-management/system-banners.md): Creating organization-wide announcement banners visible to all members (Enterprise plan). - [Inactive user list](https://buildkite.com/docs/platform/team-management/inactive-user-list.md): Identifying and managing inactive organization members using the Buildkite UI or GraphQL API. ### Tutorials - [Two-factor authentication (2FA)](https://buildkite.com/docs/platform/tutorials/2fa.md): Step-by-step guide to enabling two-factor authentication on your Buildkite account. - [Audit log](https://buildkite.com/docs/platform/audit-log.md): Viewing and exporting organization activity events in the audit log (Enterprise plan). - [Emojis](https://buildkite.com/docs/platform/emojis.md): Using 300+ custom Buildkite emojis in pipelines, test suites, and registries, plus adding your own. ### CLI - [Overview](https://buildkite.com/docs/platform/cli.md): Overview of the Buildkite CLI (bk) for managing agents, builds, jobs, artifacts, and packages. - [Installation](https://buildkite.com/docs/platform/cli/installation.md): Installing the Buildkite CLI on Debian/Ubuntu, Red Hat, macOS (Homebrew), and Windows. - [Configuration](https://buildkite.com/docs/platform/cli/configuration.md): Creating and configuring API access tokens for the Buildkite CLI. - [Preflight](https://buildkite.com/docs/platform/cli/preflight.md): Running uncommitted local changes against a Buildkite pipeline using bk preflight (experimental): snapshots staged, unstaged, and untracked files to a temporary branch, triggers a build, monitors failures in real time, integrates with Buildkite Test Engine, and exposes flags, environment variables (PREFLIGHT, PREFLIGHT_SOURCE_COMMIT, PREFLIGHT_SOURCE_BRANCH), and exit codes for use with AI coding agents. #### Command-line reference - [Overview](https://buildkite.com/docs/platform/cli/reference.md): Index of all bk CLI command categories: agent, api, build, cluster, job, package, pipeline, and more. - [agent](https://buildkite.com/docs/platform/cli/reference/agent.md): CLI reference for bk agent: list, pause, resume, stop, and view agents. - [api](https://buildkite.com/docs/platform/cli/reference/api.md): CLI reference for bk api: interact with REST and GraphQL APIs from the command line. - [artifacts](https://buildkite.com/docs/platform/cli/reference/artifacts.md): CLI reference for bk artifacts: download and list build artifacts. - [auth](https://buildkite.com/docs/platform/cli/reference/auth.md) - [build](https://buildkite.com/docs/platform/cli/reference/build.md): CLI reference for bk build: create, cancel, view, list, and rebuild builds. - [cluster](https://buildkite.com/docs/platform/cli/reference/cluster.md): CLI reference for bk cluster: list and view cluster information. - [config](https://buildkite.com/docs/platform/cli/reference/config.md) - [configure](https://buildkite.com/docs/platform/cli/reference/configure.md): CLI reference for bk configure: add configuration for new organizations. - [init](https://buildkite.com/docs/platform/cli/reference/init.md): CLI reference for bk init: initialize a pipeline.yaml file. - [job](https://buildkite.com/docs/platform/cli/reference/job.md): CLI reference for bk job: cancel, list, log, reprioritize, retry, and view jobs. - [maintainer](https://buildkite.com/docs/platform/cli/reference/maintainer.md) - [organization](https://buildkite.com/docs/platform/cli/reference/organization.md) - [package](https://buildkite.com/docs/platform/cli/reference/package.md): CLI reference for bk package: push packages to a Buildkite registry. - [pipeline](https://buildkite.com/docs/platform/cli/reference/pipeline.md): CLI reference for bk pipeline: create, copy, list, convert, and view pipelines. - [secret](https://buildkite.com/docs/platform/cli/reference/secret.md) - [user](https://buildkite.com/docs/platform/cli/reference/user.md): CLI reference for bk user: invite users to your organization. - [version](https://buildkite.com/docs/platform/cli/reference/version.md): CLI reference for bk version: display the installed CLI version. ### Terraform provider - [Overview](https://buildkite.com/docs/platform/terraform-provider.md) - [Getting started with managing pipelines](https://buildkite.com/docs/platform/terraform-provider/getting-started-with-managing-pipelines.md) - [Manage clusters and queues](https://buildkite.com/docs/platform/terraform-provider/manage-clusters-and-queues.md) - [Manage teams](https://buildkite.com/docs/platform/terraform-provider/manage-teams.md) - [Manage Buildkite organizations](https://buildkite.com/docs/platform/terraform-provider/manage-buildkite-organizations.md) - [Import existing Buildkite resources to Terraform](https://buildkite.com/docs/platform/terraform-provider/import-existing-resources.md) ### SSO - [Overview](https://buildkite.com/docs/platform/sso.md): Overview of SSO support, listing providers (Okta, ADFS, GitHub, Google, Azure AD, OneLogin, custom SAML). - [Okta](https://buildkite.com/docs/platform/sso/okta.md): Configuring Okta as an SSO provider with SAML and optional SCIM user provisioning. - [ADFS](https://buildkite.com/docs/platform/sso/adfs.md): Step-by-step setup of Active Directory Federation Services (ADFS) as an SSO provider. - [Google Workspace](https://buildkite.com/docs/platform/sso/google-workspace.md): Setting up Google Workspace (G Suite) as an SSO provider using OpenID. - [Google Workspace (SAML)](https://buildkite.com/docs/platform/sso/google-workspace-saml.md): Setting up Google Workspace as an SSO provider using SAML instead of OpenID. - [GitHub](https://buildkite.com/docs/platform/sso/github-sso.md): Configuring GitHub as an SSO provider for your Buildkite organization. - [OneLogin](https://buildkite.com/docs/platform/sso/onelogin.md): Step-by-step setup of OneLogin as an SSO provider. - [Azure AD](https://buildkite.com/docs/platform/sso/azure-ad.md): Configuring Microsoft Entra ID (Azure AD) as an SSO provider using custom SAML. - [Custom SAML](https://buildkite.com/docs/platform/sso/custom-saml.md): Setting up any SAML 2.0 identity provider as an SSO provider for Buildkite. - [Set up with GraphQL](https://buildkite.com/docs/platform/sso/sso-setup-with-graphql.md): Programmatically setting up SSO providers using the GraphQL API. ### Security - [Token security](https://buildkite.com/docs/platform/security/tokens.md): Buildkite token types (API, agent, registry) and GitHub secret scanning integration. ### Integrations - [Slack Workspace](https://buildkite.com/docs/platform/integrations/slack-workspace.md): Connecting a Slack workspace for pipeline build and Test Engine workflow notifications. - [Accessibility](https://buildkite.com/docs/platform/accessibility.md): Accessibility features in the Buildkite web application, including theme options, keyboard navigation, screen reader support, and reduced motion preferences. - [Pricing and plans](https://buildkite.com/docs/platform/pricing-and-plans.md): Overview of Buildkite plans (Personal, Pro, Enterprise) with links to detailed pricing and usage limits. - [Limits](https://buildkite.com/docs/platform/limits.md): Default usage limits by plan tier for builds, pipelines, agents, webhooks, and API requests. Includes how to view your Buildkite organization's actual service quotas in settings. - [Service level agreement](https://buildkite.com/docs/platform/service-level-agreement.md): Buildkite SLA availability commitments, links to the status page for uptime data, and the full SLA document. - [Legal and policies](https://buildkite.com/docs/platform/legal-and-policies.md): Buildkite legal documents including terms of service, privacy policies, and data processing agreements. ## APIs - [Overview](https://buildkite.com/docs/apis.md): Overview of Buildkite APIs: REST, GraphQL, webhooks, MCP server, agent API, and authentication. - [Managing API access tokens](https://buildkite.com/docs/apis/managing-api-tokens.md): Creating, editing, auditing, and securing API access tokens with scopes and IP restrictions. ### REST - [Overview](https://buildkite.com/docs/apis/rest-api.md): REST API overview: schema, authentication, pagination, endpoints, and response conventions. #### Pipelines - [Overview](https://buildkite.com/docs/apis/rest-api/pipelines.md): REST endpoints to create, list, get, update, archive, and delete pipelines. - [Agents](https://buildkite.com/docs/apis/rest-api/agents.md): REST endpoints to list, get, stop, pause, and resume agents. - [Annotations](https://buildkite.com/docs/apis/rest-api/annotations.md): REST endpoints to list and create Markdown annotations on builds. - [Artifacts](https://buildkite.com/docs/apis/rest-api/artifacts.md): REST endpoints to list and download build artifacts by build or job. - [Builds](https://buildkite.com/docs/apis/rest-api/builds.md): REST endpoints to list, get, create, cancel, and rebuild builds with filtering options. ##### Clusters - [Overview](https://buildkite.com/docs/apis/rest-api/clusters.md): REST endpoints to create, list, get, update, and delete clusters. - [Queues](https://buildkite.com/docs/apis/rest-api/clusters/queues.md): REST endpoints to create, list, get, update, pause, resume, and delete cluster queues. - [Agent tokens](https://buildkite.com/docs/apis/rest-api/clusters/agent-tokens.md): REST endpoints to create, list, get, update, and revoke cluster agent tokens. - [Cluster maintainers](https://buildkite.com/docs/apis/rest-api/clusters/maintainers.md): REST endpoints to list, create, get, and delete cluster maintainer assignments. - [Buildkite secrets](https://buildkite.com/docs/apis/rest-api/clusters/secrets.md): REST endpoints to create, list, get, update, and delete secrets in a cluster. - [Jobs](https://buildkite.com/docs/apis/rest-api/jobs.md): REST endpoints to retry, unblock, get log output, get environment variables, and delete jobs. - [Pipeline templates](https://buildkite.com/docs/apis/rest-api/pipeline-templates.md): REST endpoints to create and manage pipeline templates (Enterprise plan). - [Rules](https://buildkite.com/docs/apis/rest-api/rules.md): REST endpoints to create, list, get, and delete organization rules. - [Schedules](https://buildkite.com/docs/apis/rest-api/pipeline-schedules.md): REST endpoints to list, get, create, update, and delete pipeline schedules that automatically trigger builds at specified intervals. ### GraphQL - [Overview](https://buildkite.com/docs/apis/graphql-api.md): GraphQL API overview: endpoint, authentication, explorer console, introspection, and IDs. #### Cookbook - [Overview](https://buildkite.com/docs/apis/graphql/graphql-cookbook.md): Index of GraphQL recipe collections for agents, builds, clusters, pipelines, teams, and more. - [Agents](https://buildkite.com/docs/apis/graphql/cookbooks/agents.md): GraphQL recipes for listing agent tokens, searching agents, revoking tokens, and stopping agents. - [Artifacts](https://buildkite.com/docs/apis/graphql/cookbooks/artifacts.md): GraphQL recipes for listing artifact download URLs from builds. - [Builds](https://buildkite.com/docs/apis/graphql/cookbooks/builds.md): GraphQL recipes for querying builds by ID, listing builds, creating, canceling, and rebuilding. - [Clusters](https://buildkite.com/docs/apis/graphql/cookbooks/clusters.md): GraphQL recipes for listing, creating, updating, and deleting clusters and their queues. - [Jobs](https://buildkite.com/docs/apis/graphql/cookbooks/jobs.md): GraphQL recipes for querying jobs by queue, concurrency group, and other criteria. - [Pipelines](https://buildkite.com/docs/apis/graphql/cookbooks/pipelines.md): GraphQL recipes for creating, listing, updating, archiving, and deleting pipelines. - [Pipeline templates](https://buildkite.com/docs/apis/graphql/cookbooks/pipeline-templates.md): GraphQL recipes for listing, creating, updating, and deleting pipeline templates. ### Webhooks #### Pipelines - [Overview](https://buildkite.com/docs/apis/webhooks/pipelines.md): Setting up pipeline webhooks, configuring tokens/signatures, and available HTTP headers. - [Build events](https://buildkite.com/docs/apis/webhooks/pipelines/build-events.md): Webhook event payloads for build.scheduled, build.running, build.failing, build.finished, build.skipped. - [Job events](https://buildkite.com/docs/apis/webhooks/pipelines/job-events.md): Webhook event payloads for job lifecycle events: scheduled, started, finished, activated. - [Agent events](https://buildkite.com/docs/apis/webhooks/pipelines/agent-events.md): Webhook event payloads for agent connection, disconnection, lost, and stop events. - [Ping events](https://buildkite.com/docs/apis/webhooks/pipelines/ping-events.md): Webhook ping event payload sent when notification settings change. - [Agent token events](https://buildkite.com/docs/apis/webhooks/pipelines/agent-token-events.md): Webhook event payload for blocked agent registration attempts due to IP restrictions. ## See also - [Buildkite Pipeline Configuration Documentation](https://buildkite.com/docs/llms-pipeline-configurations.txt): Buildkite documentation for configuring pipelines, including step types, dynamic pipelines, environment variables, workflows, artifacts, and build settings. - [Buildkite Best Practices Documentation](https://buildkite.com/docs/llms-best-practices.txt): Buildkite documentation for CI/CD best practices, covering pipeline design and structure, agent management, Docker-based builds, parallelization, monorepos, dependency management, secrets, infrastructure as code, caching, monitoring, and security controls. - [Buildkite APIs Documentation](https://buildkite.com/docs/llms-buildkite-apis.txt): Buildkite documentation for APIs, covering the REST API, GraphQL API, webhooks, MCP server, agent API, model providers, API token management, portals, and rate limits.