Skip to content

Add Runner Provisioner preview documentation#10311

Open
nathanfishcircleci wants to merge 25 commits intomainfrom
runner-provisioner-fish
Open

Add Runner Provisioner preview documentation#10311
nathanfishcircleci wants to merge 25 commits intomainfrom
runner-provisioner-fish

Conversation

@nathanfishcircleci
Copy link
Copy Markdown
Contributor

Adds a new page covering Runner Provisioner (preview v0.1.0), a Kubernetes controller that auto-scales CircleCI runner VMs via KubeVirt. Includes quick start, cluster setup for GKE/AKS/EKS, configuration reference, scaling behavior, observability, upgrading, troubleshooting, and limitations. Also updates the self-hosted runner overview to introduce Runner Provisioner alongside container and machine runners.

Description

What did you change?

Reasons

Why did you make these changes? What problem does this solve?

Content checks

Please follow our style when contributing to CircleCI docs. View our style guide or check out our CONTRIBUTING.md for more information.

Preview your changes:

  • View the Vale linter results, select the ci/circleci: lint job at the bottom of your PR. You will be redirected to the vale/lint job output in CircleCI.
  • Preview your changes, select the ci/circleci: build job at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and select index.html to open a preview version of the docs site built for your latest commit.

Take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):

Content structure:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Include relevant backlinks to other CircleCI docs/pages.

Formatting:

  • Keep the title between 20 and 70 characters.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).

Adds a new page covering Runner Provisioner (preview v0.1.0), a
Kubernetes controller that auto-scales CircleCI runner VMs via KubeVirt.
Includes quick start, cluster setup for GKE/AKS/EKS, configuration
reference, scaling behavior, observability, upgrading, troubleshooting,
and limitations. Also updates the self-hosted runner overview to
introduce Runner Provisioner alongside container and machine runners.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nathanfishcircleci nathanfishcircleci requested review from a team as code owners May 6, 2026 12:26
nathanfishcircleci and others added 6 commits May 6, 2026 05:27
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ooting

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…isioner docs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc
Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated
Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated

Runner Provisioner is available to invited preview participants only. To request access, fill out the link:https://forms.gle/7W8z12EBdjuiTQJWA[Runner Provisioner preview access request form].

Once access is granted, you will receive credentials for the image registry referenced in the <<quick-start,Quick Start>>.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you also get added to the Slack channel at this point, the one described in the next section?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated

[#upgrading]
== Upgrading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we give some context around when people should follow these upgrade instructions?

Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated
* Metrics endpoint (Prometheus-compatible).
* Windows guest OS support for runner VMs (the cloud-init startup script is Linux-only).

If any of these are blocking your use case, post in the `#runner-provisioner-preview` Slack channel or reach out via the preview Slack channel.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

post in the #runner-provisioner-preview Slack channel or reach out via the preview Slack channel

Aren't they the same thing?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are.

Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated
Comment thread docs/guides/modules/execution-runner/pages/runner-provisioner.adoc Outdated
nathanfishcircleci and others added 13 commits May 7, 2026 05:24
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
Copy link
Copy Markdown
Contributor

@marcospereira-circleci marcospereira-circleci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions

Comment thread docs/guides/modules/execution-runner/pages/runner-overview.adoc Outdated
[#runner-provisioner-use-case]
=== Runner Provisioner (preview)

Runner Provisioner is a Kubernetes controller that automatically scales CircleCI runner VMs using KubeVirt. Rather than running jobs in containers, each job runs inside a full virtual machine that is provisioned on demand and shut down after the job completes. This approach provides stronger isolation than container runner and is suited for workloads that require a full OS environment, hardware-level isolation, or privileged access that is impractical inside a container.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Runner Provisioner is a Kubernetes controller that automatically scales CircleCI runner VMs using KubeVirt. Rather than running jobs in containers, each job runs inside a full virtual machine that is provisioned on demand and shut down after the job completes. This approach provides stronger isolation than container runner and is suited for workloads that require a full OS environment, hardware-level isolation, or privileged access that is impractical inside a container.
Runner Provisioner is a Kubernetes controller that automatically scales CircleCI runner VMs using link:https://github.com/kubevirt/kubevirt[KubeVirt]. Rather than running jobs in containers, each job runs inside a full virtual machine that is provisioned on demand and shut down after the job completes. This approach provides stronger isolation than container runner and is suited for workloads that require a full OS environment, hardware-level isolation, or privileged access that is impractical inside a container.

nathanfishcircleci and others added 4 commits May 8, 2026 07:45
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
…adoc

Co-authored-by: Rosie Yohannan <rosie@circleci.com>
Co-authored-by: Marcos Pereira <marcos.pereira@circleci.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants