github_actions_runner

Module to configure our GitHub Actions runner on Debian hosts

Project URL RSS Feed Report issues

Module Stats

280 downloads

204 latest version

5.0 quality score

Version information

released Aug 27th 2024

This version is compatible with:

Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
Puppet >= 7.0.0 < 9.0.0
, ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppet-github_actions_runner', '1.1.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-github_actions_runner

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-github_actions_runner --version 1.1.0

Documentation

puppet/github_actions_runner — version 1.1.0 Aug 27th 2024

GitHub Actions Runner

Automatic configuration for running GitHub Actions as a service

Description
Hiera configuration examples
Github Enterprise examples
Update PATH used by Github Runners
Adding environment variables to runner
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module
Transfer Notice

Description

This module will setup all of the files and configuration needed for GitHub Actions runner to work on Debian (Stretch and Buster) and CentOS7 hosts.

hiera configuration examples

This module supports configuration through hiera.

Creating an organization level Actions runner

github_actions_runner::ensure: present
github_actions_runner::base_dir_name: '/data/actions-runner'
github_actions_runner::package_name: 'actions-runner-linux-x64'
github_actions_runner::package_ensure: '2.277.1'
github_actions_runner::repository_url: 'https://github.com/actions/runner/releases/download'
github_actions_runner::org_name: 'my_github_organization'
github_actions_runner::personal_access_token: 'PAT'
github_actions_runner::user: 'root'
github_actions_runner::group: 'root'
github_actions_runner::instances:
  example_org_instance:
    labels:
      - self-hosted-custom
    runner_group: 'MyRunners'

Note, your personal_access_token has to contain the admin:org permission.

Creating an additional repository level Actions runner

github_actions_runner::instances:
  example_org_instance:
    labels:
      - self-hosted-custom1
  example_repo_instance:
    repo_name: myrepo
    labels:
      - self-hosted-custom2

Note, your personal_access_token has to contain the repo permission.

Instance level overwrites

github_actions_runner::instances:
  example_org_instance:
    ensure: absent
    labels:
      - self-hosted-custom1
  example_repo_instance:
    org_name: overwritten_orgnization
    repo_name: myrepo
    labels:
      - self-hosted-custom2

Adding a global proxy and overwriting an instance level proxy

github_actions_runner::http_proxy: http://proxy.local
github_actions_runner::https_proxy: http://proxy.local
github_actions_runner::instances:
  example_org_instance:
    http_proxy: http://instance_specific_proxy.local
    https_proxy: http://instance_specific_proxy.local
    no_proxy: example.com
    labels:
      - self-hosted-custom1

Github Enterprise examples

To use the module with Github Enterprise Server, you have to define these parameters:

github_actions_runner::github_domain: "https://git.example.com"
github_actions_runner::github_api: "https://git.example.com/api/v3"

In addition to the runner configuration examples above, you can also configure runners on the enterprise level by setting a value for enterprise_name, for example:

github_actions_runner::ensure: present
github_actions_runner::base_dir_name: '/data/actions-runner'
github_actions_runner::package_name: 'actions-runner-linux-x64'
github_actions_runner::package_ensure: '2.277.1'
github_actions_runner::repository_url: 'https://github.com/actions/runner/releases/download'
github_actions_runner::enterprise_name: 'enterprise_name'
github_actions_runner::personal_access_token: 'PAT'
github_actions_runner::user: 'root'
github_actions_runner::group: 'root'
github_actions_runner::instances:

Note, your personal_access_token has to contain the admin:enterprise permission.

Update PATH used by Github Runners

By default, puppet will not modify the values that the runner scripts create when the runner is set.

In case you need to use another value of paths in the environment variable PATH, you can define through hiera. For example:

For all runners defined:

github_actions_runner::path:
  - /usr/local/bin
  - /usr/bin
  - /bin
  - /my/own/path

For just a specific runner:

github_actions_runner::instances:
  example_org_instance:
    path:
      - /usr/local/bin
      - /usr/bin
      - /bin
      - /my/own/path
    labels:
      - self-hosted-custom

Adding environment variables to runner

The runner uses environment variables to decide pre/post-run scripts: https://docs.github.com/en/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job#triggering-the-scripts

github_actions_runner::env:
  ACTIONS_RUNNER_HOOK_JOB_STARTED: "/cleanup_script"
  FOO: "bar"

Limitations

Tested on Debian 9 (stretch), Debian 10 (buster) and CentOS7 hosts. Full list of operating systems support and requirements are described in metadata.json file.

Development

There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see Puppet Forge module contribution guide.

License

GitHub Actions Runner is available under the Apache License, Version 2.0. See LICENSE file for more info.

Transfer Notice

This module was originally written by Telefonica:

https://github.com/Telefonica/puppet-github-actions-runner

They archived the repository and Vox Pupuli forked it in August 2024.

Reference

Classes

github_actions_runner: Manages actions_runner service and configuration

Defined types

github_actions_runner::instance: Configure and deploy actions runners instances

Classes

`github_actions_runner`

Manages actions_runner service and configuration

Parameters

The following parameters are available in the github_actions_runner class:

ensure
base_dir_name
org_name
enterprise_name
personal_access_token
package_name
package_ensure
repository_url
user
group
instances
github_domain
github_api
http_proxy
https_proxy
no_proxy
disable_update
path
env

`ensure`

Data type: Enum['present', 'absent']

Determine if to add or remove the resource.

Default value: 'present'

`base_dir_name`

Data type: Stdlib::Absolutepath

Location of the base directory for actions runner to be installed.

Default value: '/some_dir/actions-runner'

`org_name`

Data type: Optional[String[1]]

actions runner org name.

Default value: undef

`enterprise_name`

Data type: Optional[String[1]]

enterprise name for global runners

Default value: undef

`personal_access_token`

Data type: String[1]

GitHub PAT with admin permission on the repositories or the origanization.

Default value: 'PAT'

`package_name`

Data type: String[1]

GitHub Actions runner offical package name.

Default value: $facts['os']['architecture'] ? { /x86_64|amd64/ => 'actions-runner-linux-x64', 'aarch64' => 'actions-runner-linux-arm64'

`package_ensure`

Data type: String[1]

GitHub Actions runner version to be used.

Default value: '2.319.1'

`repository_url`

Data type: String[1]

URL to download GitHub actions runner.

Default value: 'https://github.com/actions/runner/releases/download'

`user`

Data type: String[1]

User to be used in Service and directories.

Default value: 'root'

`group`

Data type: String[1]

Group to be used in Service and directories.

Default value: 'root'

`instances`

Data type: Hash[String[1], Hash]

Github Runner Instances to be managed.

Default value: {}

`github_domain`

Data type: String[1]

Base URL for Github Domain.

Default value: 'https://github.com'

`github_api`

Data type: String[1]

Base URL for Github API.

Default value: 'https://api.github.com'

`http_proxy`

Data type: Optional[String[1]]

Proxy URL for HTTP traffic. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.

Default value: undef

`https_proxy`

Data type: Optional[String[1]]

Proxy URL for HTTPS traffic. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners

Default value: undef

`no_proxy`

Data type: Optional[String[1]]

Comma separated list of hosts that should not use a proxy. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners

Default value: undef

`disable_update`

Data type: Boolean

toggle for disabling automatic runner updates.

Default value: false

`path`

Data type: Optional[Array[String]]

List of paths to be used as PATH env in the instance runner. If not defined, file ".path" will be kept as created by the runner scripts. Default value: undef

Default value: undef

`env`

Data type: Optional[Hash[String, String]]

List of variables to be used as env variables in the instance runner. If not defined, file ".env" will be kept as created by the runner scripts. (Default: Value set by github_actions_runner Class)

Default value: undef

Defined types

`github_actions_runner::instance`

Configure and deploy actions runners instances

Parameters

The following parameters are available in the github_actions_runner::instance defined type:

ensure
org_name
enterprise_name
personal_access_token
user
group
hostname
instance_name
github_domain
github_api
http_proxy
https_proxy
no_proxy
disable_update
repo_name
labels
path
env
runner_group
repo_token

`ensure`

Data type: Enum['present', 'absent']

Determine if to add or remove the resource.

Default value: 'present'

`org_name`

Data type: Optional[String[1]]

org name for organization level runners. (Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::org_name

`enterprise_name`

Data type: Optional[String[1]]

enterprise name for global runners. (Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::enterprise_name

`personal_access_token`

Data type: String[1]

GitHub PAT with admin permission on the repositories or the origanization.(Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::personal_access_token

`user`

Data type: String[1]

User to be used in Service and directories.(Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::user

`group`

Data type: String[1]

Group to be used in Service and directories.(Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::group

`hostname`

Data type: String[1]

actions runner name.

Default value: $facts['networking']['hostname']

`instance_name`

Data type: String[1]

The instance name as part of the instances Hash.

Default value: $title

`github_domain`

Data type: String[1]

domain for GitHub, needs to be adjusted for GitHub Enterprise

Default value: $github_actions_runner::github_domain

`github_api`

Data type: String[1]

URL for the GitHub API

Default value: $github_actions_runner::github_api

`http_proxy`

Data type: Optional[String[1]]

Proxy URL for HTTP traffic. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.

Default value: $github_actions_runner::http_proxy

`https_proxy`

Data type: Optional[String[1]]

Proxy URL for HTTPS traffic. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners

Default value: $github_actions_runner::https_proxy

`no_proxy`

Data type: Optional[String[1]]

Comma separated list of hosts that should not use a proxy. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners

Default value: $github_actions_runner::no_proxy

`disable_update`

Data type: Optional[Boolean]

toggle for disabling automatic runner updates.

Default value: $github_actions_runner::disable_update

`repo_name`

Data type: Optional[String[1]]

actions runner repository name.

Default value: undef

`labels`

Data type: Optional[Array[String[1]]]

A list of costum lables to add to a runner.

Default value: undef

`path`

Data type: Optional[Array[String]]

List of paths to be used as PATH env in the instance runner. If not defined, file ".path" will be kept as created by the runner scripts. (Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::path

`env`

Data type: Optional[Hash[String, String]]

List of variables to be used as env variables in the instance runner. If not defined, file ".env" will be kept as created by the runner scripts. (Default: Value set by github_actions_runner Class)

Default value: $github_actions_runner::env

`runner_group`

Data type: Optional[String[1]]

The github runner group to add the runner to.

Default value: undef

`repo_token`

Data type: Optional[Variant[Sensitive[String[1]],String[1]]]

if set, the runner will be registed to a specific repo. repo_name is than required.

Default value: undef


                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "{}"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright 2018 Puppet, Inc.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

github_actions_runner

Version information

This version is compatible with:

Start using this module

Documentation

GitHub Actions Runner

Table of Contents

Description

hiera configuration examples

Creating an organization level Actions runner

Creating an additional repository level Actions runner

Instance level overwrites

Adding a global proxy and overwriting an instance level proxy

Github Enterprise examples

Update PATH used by Github Runners

Adding environment variables to runner

Limitations

Development

License

Transfer Notice

Reference

Table of Contents

Classes

Defined types

Classes

github_actions_runner

Parameters

ensure

base_dir_name

org_name

enterprise_name

personal_access_token

package_name

package_ensure

repository_url

user

group

instances

github_domain

github_api

http_proxy

https_proxy

no_proxy

disable_update

path

env

Defined types

github_actions_runner::instance

Parameters

ensure

org_name

enterprise_name

personal_access_token

user

group

hostname

instance_name

github_domain

github_api

http_proxy

https_proxy

no_proxy

disable_update

repo_name

labels

path

env

runner_group

repo_token

Changelog

v1.1.0 (2024-08-27)

`github_actions_runner`

`ensure`

`base_dir_name`

`org_name`

`enterprise_name`

`personal_access_token`

`package_name`

`package_ensure`

`repository_url`

`user`

`group`

`instances`

`github_domain`

`github_api`

`http_proxy`

`https_proxy`

`no_proxy`

`disable_update`

`path`

`env`

`github_actions_runner::instance`

`ensure`

`org_name`

`enterprise_name`

`personal_access_token`

`user`

`group`

`hostname`

`instance_name`

`github_domain`

`github_api`

`http_proxy`

`https_proxy`

`no_proxy`

`disable_update`

`repo_name`

`labels`

`path`

`env`

`runner_group`

`repo_token`