Machine runner 3 manual installation for Windows
This page describes how to manually install CircleCI’s machine runner 3 on Windows Server.
Prerequisites
-
The CircleCI CLI if you wish to install runners from the command line.
Self-hosted runner terms agreement
-
Web app installation
-
CLI installation
Before you can install self-hosted runners through the web app, you will need to agree to the CircleCI Runner Terms. To access the Runners section of the CircleCI web app an organization admin must agree to the terms at menu:Org[Runners].
Once the terms have been accepted, Runners will appear permanently in the side navigation.
Your role within your org is determined differently depending on how you integrate with your code, as follows:
-
If you have a
githuborbitbuckettype organization, CircleCI mirrors VCS permissions for organizations. If you are an admin on your organization’s VCS, you are an admin on CircleCI. If you are unsure, check the admin permissions on your VCS. -
If you have a
circlecitype organization, you can check roles by navigating to menu:Org[People]. Full details on roles and permissions are available in the Roles and Permissions Overview.
| Find out about organization types in the Users, Organizations and Integrations Guide. |
If you are installing and using self-hosted runners through the CLI, you are agreeing to the CircleCI Runner Terms.
1. Create namespace and resource class
If you are installing self-hosted runners for server, the CircleCI CLI needs to be configured using your server API key. Run circleci setup to configure the CLI and access the option to supply a new API token if required.
|
To install self-hosted runners, you need to create a CircleCI namespace and resource class. Once set up you will receive a resource class token. You must be an organization admin to complete this process. View your installed runners on the inventory page in the web app by selecting Runners from the sidebar.
| If you already create orb in your organization you will already have a namespace configured. You must use this same namespace for runners. Each organization can only create a single namespace. |
-
Create a namespace for your organization’s self-hosted runners if you do not already have one configured. We suggest using a lowercase representation of your CircleCI organization’s account name.
Use the following command to create your CircleCI organization’s namespace:
$ circleci namespace create <name> --org-id <your-organization-id> -
Create a resource class for your runner using the following command. You will configure jobs to use this resource class when you want them to run on your slef-hosted runner:
$ circleci runner resource-class create <namespace>/<resource-class> <description> --generate-tokenMake sure to replace
<namespace>and<resource-class>with your org namespace and desired resource class name, respectively. You can add a description but this is optional.Resource class names must follow specific naming conventions.
-
The namespace can contain lowercase letters, numbers, underscores, and dashes.
-
The resource class name can contain uppercase and lowercase letters, numbers, colons, underscores, dashes, and plus signs.
The resource class token is returned after the runner resource class is successfully created.
The token is only displayed once, so be sure to store it safely.
-
2. Download the CircleCI machine runner
Using PowerShell, download the current version of CircleCI machine runner and verify the download.
The current CircleCI machine runner binary can always be found by using current as the version. To install a specific previous version of the CircleCI runner, the $runnerVersion variable can be changed from the value of current to the specific preferred version.
|
$runnerVersion = "current"
$availableAgents = (Invoke-WebRequest "https://circleci-binary-releases.s3.amazonaws.com/circleci-runner/manifest.json" -UseBasicParsing).Content.Trim() | ConvertFrom-Json
$agentURL = $availableAgents.releases.$runnerVersion.windows.amd64.url
$agentHash = $availableAgents.releases.$runnerVersion.windows.amd64.sha256
$agentFile = $agentURL.Split("/")[-1]
Invoke-WebRequest $agentURL -OutFile $agentFile -UseBasicParsing
if ((Get-FileHash "$agentFile" -Algorithm SHA256).Hash.ToLower() -ne $agentHash.ToLower()) {
throw "Invalid checksum for CircleCI Machine Runner, please try download again"
}
tar -zxvf $agentFile
del $agentFile3. Create the CircleCI machine runner configuration and working directory
Using PowerShell, create the CircleCI machine runner configuration file and working directory.
The runner token created in Step 1 will need to be substituted in for the auth_token
|
New-Item -Name Workdir -ItemType Directory
@"
api:
auth_token: "<< YOUR RUNNER TOKEN >>"
url: https://runner.circleci.com
runner:
name: "$env:COMPUTERNAME"
mode: single-task
working_directory: "./Workdir"
cleanup_working_directory: true
logging:
file: circleci-runner.log
"@ -replace "([^`r])`n", "`$1`r`n" | Out-File machine-runner-config.yaml -Encoding ascii