Quick Setup of GitHub Runner
In just a few steps, you'll have a GitHub Runner up and running. Let's get started!
Step 1: Installing Puzl's GitHub app into your GitHub organization
- Log in to the Puzl dashboard.
- Navigate to the GitHub Integrations section.
- Press "Install app" button and follow instructions.
Once you have Puzl's app successfully installed to your GitHub organization, the runner with the default configuration and base label puzl-any will be automatically created for you.
Step 2: Checking Runner Status
After creating the runner, you'll want to monitor the status of your runner to know when it's operational and ready to process GitHub jobs.
- Cloud Dashboard
- kubectl
- Navigate to the GitHub Runners section in the Puzl Cloud Dashboard.
- Find the runner you have just created. The status will be displayed alongside and should be
Running.
Execute the following command to retrieve the status of your GitHubRunnerClaim.
kubectl get ghaclaim -n <Your_Integration_claimNamespaceRef> my-first-runner
If the returned status is Ready, your runner is operational and is serving GitHub jobs associated with it.
Typically, transitioning to the Ready phase takes less than a minute after the GitHubRunnerClaim creation.
If the claim is not Ready, you might want to wait a couple of minutes or check its status for any potential issues.
Step 3: Changing runs-on Value in Your GitHub Workflows
To run your jobs on Puzl, set the runs-on property in your workflow job definition:
jobs:
custom-app-job:
runs-on: puzl-ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: ./run-custom-app.sh
Please follow the link GitHub Runner Labels to find the detailed information on how to use runner labels more precisely.
Conclusion
You're all set! Your GitHub runner is configured and ready to serve hundreds of GitHub jobs in parallel.
To explore all available runner settings and gain a detailed understanding of the runner's lifecycle on Puzl, including its various phases and statuses, refer to the GitHubRunnerClaim docs.