telefonica-github_actions_runner

In This Repository you can find a module that will setup all of the files and configuration needed for GitHub Actions runner to work on any Debian 9 hosts.


Keywords
github, github-action, github-actions-runner, puppet, puppet-module
License
Apache-2.0
Install
puppet module install telefonica-github_actions_runner --version 0.2.4

Documentation

PDK Test Unit

GitHub Actions Runner

Automatic configuration for running GitHub Actions on Debian hosts as a service

Table of Contents

  1. Description
  2. Limitations - OS compatibility, etc.
  3. Development - Guide for contributing to the module

Description

This module will setup all of the files and configuration needed for GitHub Actions runner to work on any Debian 9 hosts.

hiera configuration

This module supports configuration through hiera. The following example creates repository level Actions runners.

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.272.0'
github_actions_runner::repository_url: 'https://github.com/actions/runner/releases/download'
github_actions_runner::org_name: 'github_org'
github_actions_runner::personal_access_token: 'PAT'
github_actions_runner::user: 'root'
github_actions_runner::group: 'root'
github_actions_runner::instances:
  first_instance:
    labels:
      - self-hosted-custom

You can also override some of the keys on the instance level

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.272.0'
github_actions_runner::repository_url: 'https://github.com/actions/runner/releases/download'
github_actions_runner::org_name: 'github_org'
github_actions_runner::personal_access_token: 'PAT'
github_actions_runner::user: 'root'
github_actions_runner::group: 'root'
github_actions_runner::instances:
  first_instance:
    labels:
      - self-hosted-custom1
  second_instance:
    ensure: absent
  third_instance:
    labels:
      - self-hosted-custom3
    repo_name: myrepo
    org_name: other_org
    personal_access_token: other_secret

Limitations

Tested on Debian 9 stretch hosts only. full list of operating systems support and requirements are described in metadata.json file.

If you don't specify repository name , make sure you Personal Access Token is org level admin.

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.