# Buildkite Hosted Agent Documentation

> Buildkite documentation for Buildkite hosted agents, covering Linux and macOS instances, cache volumes, internal container registry, remote Docker builders, network security, code access, pipeline migration, and terminal access.

## Pipelines

### 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.

### Best practices

- [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.
- [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.
- [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.

### Agent

- [Overview](https://buildkite.com/docs/agent.md): Overview of the Buildkite agent, comparing self-hosted and Buildkite hosted agents, architecture, lifecycle, and CLI usage.

#### Buildkite hosted agents

- [Overview](https://buildkite.com/docs/agent/buildkite-hosted.md): Overview of Buildkite hosted agents: fully-managed, ephemeral build runners with autoscaling, caching, and per-second pricing.

##### Linux hosted agents

- [Overview](https://buildkite.com/docs/agent/buildkite-hosted/linux.md): Linux hosted agent instance sizes, architectures (AMD64/ARM64), agent images, concurrency, and security details.
- [Custom agent images](https://buildkite.com/docs/agent/buildkite-hosted/linux/custom-agent-images.md)
- [Remote Docker builders](https://buildkite.com/docs/agent/buildkite-hosted/linux/remote-docker-builders.md): How remote Docker builders offload docker build commands to dedicated machines with layer caching (Enterprise).

##### macOS hosted agents

- [Overview](https://buildkite.com/docs/agent/buildkite-hosted/macos.md): macOS hosted agent sizes, Apple silicon support, pre-installed software (Xcode, Homebrew), and configuration.
- [Getting started with iOS](https://buildkite.com/docs/agent/buildkite-hosted/macos/getting-started-with-ios.md): Tutorial for building iOS apps using Buildkite macOS hosted agents with the FlappyKite sample project.
- [Troubleshooting fastlane](https://buildkite.com/docs/agent/buildkite-hosted/macos/troubleshooting-fastlane.md): Troubleshooting fastlane issues on Buildkite hosted macOS agents: code signing, provisioning profiles, and keychains.
- [Code access](https://buildkite.com/docs/agent/buildkite-hosted/code-access.md): Configuring hosted agents to access private GitHub repositories and other providers using SSH or HTTPS.
- [Pipeline migration](https://buildkite.com/docs/agent/buildkite-hosted/pipeline-migration.md): Steps to migrate existing pipelines to Buildkite hosted agent queues, including repository checkout changes.
- [Terminal access](https://buildkite.com/docs/agent/buildkite-hosted/terminal-access.md): Accessing a live terminal on running hosted agent jobs for debugging and environment inspection.
- [Cache volumes](https://buildkite.com/docs/agent/buildkite-hosted/cache-volumes.md): Configuring NVMe cache volumes on hosted agents for build dependencies, Docker images, and Git mirrors.
- [Internal container registry](https://buildkite.com/docs/agent/buildkite-hosted/internal-container-registry.md): Using the cluster-scoped internal container registry to store and share Docker images built by hosted agents.
- [Network security](https://buildkite.com/docs/agent/buildkite-hosted/network-security.md): IP allowlisting, OIDC-based authentication, and network security configuration for Buildkite hosted agents.

#### Queues

- [Overview](https://buildkite.com/docs/agent/queues.md): How queues route jobs to specific agents, targeting queues from pipeline YAML, and self-hosted vs hosted queue types.
- [Managing](https://buildkite.com/docs/agent/queues/managing.md): Creating, configuring, pausing, and deleting self-hosted and Buildkite hosted queues within clusters.
- [Agent lifecycle](https://buildkite.com/docs/agent/lifecycle.md): Agent lifecycle stages, signal handling (SIGTERM/SIGQUIT), exit codes, and troubleshooting common issues.
- [Hooks](https://buildkite.com/docs/agent/hooks.md): Agent hook types, scopes (agent, repository, plugin), lifecycle events, and polyglot hook support.

### Configure pipelines

#### Step types

- [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.

### Security

#### 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.

#### 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.

## Platform

### Team 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.

## See also

- [Buildkite Self-Hosted Agent Documentation](https://buildkite.com/docs/llms-self-hosted-agents.txt): Buildkite documentation for self-hosted agents, covering installation on Linux, macOS, Windows, and Docker, running on AWS, GCP, and Kubernetes, agent configuration, security, monitoring, and the CLI reference.
- [Buildkite Agent Documentation](https://buildkite.com/docs/llms-agent.txt): Buildkite documentation for the Buildkite agent, covering self-hosted and Buildkite hosted agents, installation, configuration, CLI reference, queues, hooks, and lifecycle.