gitpod.v1.RunnerService
CreateRunner
Creates a new runner registration with the server. Registrations are very short-lived and must be renewed every 30 seconds.
Use this method to:
- Register organization runners
- Set up runner configurations
- Initialize runner credentials
- Configure auto-updates
Examples
-
Create an AWS runner:
Creates a new runner in AWS EC2.
name: "AWS Runner" provider: RUNNER_PROVIDER_AWS_EC2 spec: desiredPhase: RUNNER_PHASE_ACTIVE configuration: region: "us-west" releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE autoUpdate: true -
Create a GCP runner:
Creates a new runner on Google Cloud Platform.
name: "GCP Runner" provider: RUNNER_PROVIDER_GCP spec: desiredPhase: RUNNER_PHASE_ACTIVE configuration: region: "us-central1" releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE autoUpdate: true -
Create local runner (deprecated):
Creates a new local runner on Linux. Local runners are deprecated; use RUNNER_PROVIDER_AWS_EC2 or RUNNER_PROVIDER_GCP instead.
name: "Local Development Runner" provider: RUNNER_PROVIDER_LINUX_HOST spec: desiredPhase: RUNNER_PHASE_ACTIVE configuration: releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST autoUpdate: true
post/gitpod.v1.RunnerService/CreateRunner
Request body
Response
Success