Glasslabs Yocto Runner image recipe

Docker Image recipe for generating a self-hosted Github organization runner capable of building a Yocto Linux rootfs

Using this Docker image

This image can be retrived from Docker hub and used to create a new container.

sudo docker pull ghcr.io/glassboard-dev/yocto-runner:latest

The yocto-runner image utilizes a GitHub PAT to request a runner token from Github. A PAT can be generated by going to Settings > Developer Settings > Personal access tokens on Github. The token needs to have repo, workflow and admin:org access rights. Record the token and keep it in a safe place.

Once you have your token, we can spool up our container using the newly retrieved docker image. You can set the name to whatever you'd like to call your container.

sudo docker run -d --env ORGANIZATION=<YOUR-GITHUB-ORGANIZATION> --env ACCESS_TOKEN=<YOUR-GITHUB-ACCESS-TOKEN> --name runner ghcr.io/glassboard-dev/yocto-runner

You can verify the status of the runner by executing the following.

sudo docker logs runner -f

You should see something similar to the output below:

--------------------------------------------------------------------------------
|        ____ _ _   _   _       _          _        _   _                      |
|       / ___(_) |_| | | |_   _| |__      / \   ___| |_(_) ___  _ __  ___      |
|      | |  _| | __| |_| | | | | '_ \    / _ \ / __| __| |/ _ \| '_ \/ __|     |
|      | |_| | | |_|  _  | |_| | |_) |  / ___ \ (__| |_| | (_) | | | \__ \     |
|       \____|_|\__|_| |_|\__,_|_.__/  /_/   \_\___|\__|_|\___/|_| |_|___/     |
|                                                                              |
|                       Self-hosted runner registration                        |
|                                                                              |
--------------------------------------------------------------------------------

# Authentication


√ Connected to GitHub

# Runner Registration

Enter the name of the runner group to add this runner to: [press Enter for Default]
Enter the name of runner: [press Enter for 332d0614b5e9]
This runner will have the following labels: 'self-hosted', 'Linux', 'X64'
Enter any additional labels (ex. label-1,label-2): [press Enter to skip]
√ Runner successfully added
√ Runner connection is good

# Runner settings

Enter name of work folder: [press Enter for _work]
√ Settings Saved.


√ Connected to GitHub

2021-10-23 22:36:01Z: Listening for Jobs

You are now ready to utilize your Yocto build runner in your own repositories/workflows. See here for more information on how to use a self-hosted runner in your repository workflow files

Building this image

To begin building this image you will need to have Docker installed. You can find setup guides for various platforms here. Once installed we can begin the build process. To build the docker image execute the following the command below - You can replace runner-image with whatever name you would like to call your image

sudo docker build --tag runner-image .