Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs on how to use local runners #417

Merged
merged 9 commits into from
Dec 19, 2022
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions content/docs/self-hosted-runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -452,17 +452,30 @@ The same credentials can also be used for

The `cml runner` command can also be used to manually set up a local machine,
on-premise GPU cluster, or any other cloud compute resource as a self-hosted
runner. Simply [install CML](/doc/install) and then run:
runner. To do this:

- remove the `cml runner launch ... --cloud=aws --labels=cml-gpu` command from
casperdcl marked this conversation as resolved.
Show resolved Hide resolved
[your CI workflow](#allocating-cloud-compute-resources-with-cml)
- [install CML](/doc/install) on your local machine, and run:

```cli
$ cml runner launch \
--repo="$REPOSITORY_URL" \
--token="$PERSONAL_ACCESS_TOKEN" \
--labels="local,runner" \
--idle-timeout=180
--labels="cml-gpu" \
--idle-timeout="never" # or "3min", "1h", etc..
```

The machine will listen for jobs from your repository and execute them locally.
Your machine will wait for and run CI jobs from your repository (note that the
`--cloud` option is removed).

<admon type="info">

If your CI workflow uses a Docker `image`, you will need to have Docker
installed on your local machine. The CML runner will automatically pull images
onto your local machine and run workflow in temporary containers.
casperdcl marked this conversation as resolved.
Show resolved Hide resolved

</admon>

<admon type="warn">

Expand Down