Hosted Control Plane

Overview

A Hosted Control Plane enables you to manage and run your jobs, pipelines, and builds efficiently in a scalable environment. This guide walks you through the steps to set up your Hosted Control Plane, create queues for runners, and integrate BuildKit if needed.

Prerequisites

  • Ensure that your Connector setup is complete before proceeding.

Steps to Set Up Hosted Control Plane

1. Create the Control Plane

Once your connector is ready, you can proceed to create the control plane. This serves as the central management hub for your jobs and pipelines.

2. Check Control Plane Details

After the control plane is created, verify its status and details to ensure it’s operational.

3. Create a Queue for Runners

Now that the control plane is ready, you need to create a queue for the runner. This queue will manage the execution of tasks. Depending on your use cases, you can create multiple queues.

4. Monitor Queue Health

Once the queue is created, monitor its health status. A healthy queue will automatically register available runners.

5. Create a Pipeline Using the Queue

Next, create a pipeline and assign it to the queue by specifying the queue’s name in the runs_on field.

6. (Optional) Set Up BuildKit for Multi-Arch Builds

If your project requires BuildKit for Docker builds, especially for multi-architecture support, you'll need to create a BuildKit instance. Note that multi-architecture BuildKit is available only for enterprise users.

Conclusion

With the Hosted Control Plane, queues for runners, and optional BuildKit setup, your system is now ready to efficiently manage and run jobs. You can easily scale by adding more queues, runners, or BuildKit instances depending on your project needs.

If you have any issues or require further assistance, please refer to the support documentation or contact your system administrator.

Last updated