├── spawn ├── AUTHORS ├── prepare-instance ├── CONTRIBUTING.md ├── README.md └── COPYING /spawn: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | for i in $(seq ${2}) 3 | do 4 | NAME=$(mktemp -u github-XXXXXXXX) 5 | lxc copy ${1} "${NAME}" --ephemeral 6 | lxc start "${NAME}" 7 | done 8 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Unless mentioned otherwise in a specific file's header, all code in this 2 | project is released under the Apache 2.0 license. 3 | 4 | The list of authors and contributors can be retrieved from the git 5 | commit history and in some cases, the file headers. 6 | -------------------------------------------------------------------------------- /prepare-instance: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | ( 3 | cat << EOF 4 | #!/bin/sh 5 | set -eu 6 | 7 | apt-get install curl git --yes 8 | ARCH=x64 9 | [ "\$(uname -m)" = "aarch64" ] && ARCH=arm64 10 | curl -o /tmp/runner.tar.gz -L https://github.com/actions/runner/releases/download/v2.283.1/actions-runner-linux-\${ARCH}-2.283.1.tar.gz 11 | 12 | # Create directory for the runner 13 | mkdir /srv/github-actions/ 14 | cd /srv/github-actions/ 15 | chown ubuntu:ubuntu /srv/github-actions/ 16 | 17 | # Unpack the code 18 | sudo -u ubuntu -i tar zxf /tmp/runner.tar.gz -C /srv/github-actions/ 19 | 20 | # Setup the systemd unit 21 | ( 22 | cat << EOG 23 | [Unit] 24 | Description=github - Actions runner 25 | Requires=network-online.target 26 | After=network-online.target 27 | 28 | [Service] 29 | Type=oneshot 30 | WorkingDirectory=/srv/github-actions/ 31 | ExecStartPre=/usr/bin/sudo -u ubuntu -i /srv/github-actions/config.sh --url ${2} --token ${3} --unattended --ephemeral --labels=${4} 32 | ExecStart=-/usr/bin/sudo -u ubuntu -i /srv/github-actions/run.sh 33 | ExecStartPost=/usr/sbin/poweroff 34 | 35 | [Install] 36 | WantedBy=multi-user.target 37 | EOG 38 | ) > /etc/systemd/system/github-actions.service 39 | systemctl enable github-actions 40 | 41 | # Cleanup 42 | rm /tmp/runner.tar.gz 43 | EOF 44 | ) | lxc exec $1 /bin/sh 45 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | ## Pull requests 3 | Changes to this project should be proposed as pull requests on Github 4 | at: 5 | 6 | Proposed changes will then go through code review there and once acked, 7 | be merged in the main branch. 8 | 9 | ## License and copyright 10 | By default, any contribution to this project is made under the Apache 11 | 2.0 license. 12 | 13 | The author of a change remains the copyright holder of their code 14 | (no copyright assignment). 15 | 16 | 17 | ## Developer Certificate of Origin 18 | To improve tracking of contributions to this project we use the DCO 1.1 19 | and use a "sign-off" procedure for all changes going into the branch. 20 | 21 | The sign-off is a simple line at the end of the explanation for the 22 | commit which certifies that you wrote it or otherwise have the right 23 | to pass it on as an open-source contribution. 24 | 25 | > Developer Certificate of Origin 26 | > Version 1.1 27 | > 28 | > Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 29 | > 660 York Street, Suite 102, 30 | > San Francisco, CA 94110 USA 31 | > 32 | > Everyone is permitted to copy and distribute verbatim copies of this 33 | > license document, but changing it is not allowed. 34 | > 35 | > Developer's Certificate of Origin 1.1 36 | > 37 | > By making a contribution to this project, I certify that: 38 | > 39 | > (a) The contribution was created in whole or in part by me and I 40 | > have the right to submit it under the open source license 41 | > indicated in the file; or 42 | > 43 | > (b) The contribution is based upon previous work that, to the best 44 | > of my knowledge, is covered under an appropriate open source 45 | > license and I have the right under that license to submit that 46 | > work with modifications, whether created in whole or in part 47 | > by me, under the same open source license (unless I am 48 | > permitted to submit under a different license), as indicated 49 | > in the file; or 50 | > 51 | > (c) The contribution was provided directly to me by some other 52 | > person who certified (a), (b) or (c) and I have not modified 53 | > it. 54 | > 55 | > (d) I understand and agree that this project and the contribution 56 | > are public and that a record of the contribution (including all 57 | > personal information I submit with it, including my sign-off) is 58 | > maintained indefinitely and may be redistributed consistent with 59 | > this project or the open source license(s) involved. 60 | 61 | An example of a valid sign-off line is: 62 | 63 | ``` 64 | Signed-off-by: Random J Developer 65 | ``` 66 | 67 | Use your real name and a valid e-mail address. 68 | Sorry, no pseudonyms or anonymous contributions are allowed. 69 | 70 | We also require each commit be individually signed-off by their author, 71 | even when part of a larger set. You may find `git commit -s` useful. 72 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | This repository contains some scripts to create LXD instances suitable 3 | to be used as Github Actions runners as well as tools to spawn a set of 4 | such instances. 5 | 6 | Self-hosted Github Actions runners allow for more powerful test runners, 7 | testing with physical hardware attached (USB, serial, GPU, ...), testing 8 | on otherwise unavailable architectures and more. 9 | 10 | This will use LXD with a set of ephemeral instances which will then be 11 | added as Github Runners. Each of those will process exactly one job and 12 | then self-destroy. This is to avoid running jobs in unclean 13 | environments, preventing one job from impacting or attacking the next. 14 | 15 | https://www.youtube.com/watch?v=c40BPKcSr4E 16 | 17 | # Creating a suitable base instance 18 | Either containers or VMs can be use for this. 19 | 20 | For example, for an Ubuntu 20.04 container, you'd use: 21 | ``` 22 | lxc launch images:ubuntu/20.04 base-container 23 | ``` 24 | 25 | For a VM: 26 | ``` 27 | lxc launch images:ubuntu/20.04 base-vm 28 | ``` 29 | 30 | (From this point on, I'll refer to that instance as `base-XYZ`) 31 | 32 | You'll then use `lxc exec base-XYZ bash` to get a shell inside of the 33 | environment and customize it in whatever way you see fit for your use. 34 | This can be automated with the likes of a shell script, Ansible or Packer. 35 | 36 | Now you'll need to fetch the action token from: 37 | https://github.com/ORG/REPO/settings/actions/runners/new 38 | 39 | Once you're done, you need to get it ready for use with Github, for that, run: 40 | 41 | ``` 42 | ./prepare-instance base-XYZ https://github.com/ORG/REPO TOKEN 43 | ``` 44 | 45 | You can also pass additional labels like this: 46 | 47 | ``` 48 | ./prepare-instance base-XYZ https://github.com/ORG/REPO TOKEN vm,gpu 49 | ``` 50 | 51 | Then stop the instance with `lxc stop base-XYZ`. 52 | 53 | And before it's ready for use, let's set some limits and security options on it: 54 | - lxc config set base-XYZ security.idmap.isolated=true (only useful for containers) 55 | - lxc config set base-XYZ limits.cpu=2 limits.memory=4GiB 56 | - lxc config device override base-XYZ root size=20GiB 57 | 58 | This restricts resources to 2 vCPU, 4GB of RAM and 20GB of disk. Adapt this to whatever makes sense for you. 59 | 60 | # Starting some runners 61 | Lastly, you need a set of instances to start and register with Github: 62 | 63 | ``` 64 | ./spawn base-XYZ 10 65 | ``` 66 | 67 | This will start an initial set of 10 instances. 68 | 69 | # What's next 70 | Currently, the instances will just go away once they're done processing 71 | a job, so you'll have to keep adding more with `./spawn`. 72 | This isn't ideal but can be scripted around easily enough. 73 | 74 | There's also the issue of the TOKEN being somewhat short lived, so 75 | eventually, you'll have to run `./prepare` again with a new token. 76 | 77 | To address that, it'd be great to: 78 | - Write a daemon process that manages all this 79 | - Have the daemon ensure a pool of available instances up to a maximum 80 | - Move the registration logic to the daemon, have it use the Github API 81 | to generate one-time tokens and pass those into the instance 82 | - Have the daemon enforce maximum job run time and cleanup any instance 83 | that exceeds it or that's otherwise broken in some way 84 | 85 | Other future improvements could include: 86 | - Automatic update/re-generation of the base instances 87 | - Ability to pull in standard Github Actions images 88 | 89 | This initial work was really all done in a few hours to see how easy it 90 | is to run some self-hosted Github Actions runners now that the Actions 91 | API properly support ephemeral test runners (was blocked on 92 | https://github.com/actions/runner/issues/510 for a long time). 93 | 94 | Anyone interested is very much encouraged to get in touch and contribute! 95 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------