refactor to enable multirepository runners

Author: Shimon Ohayon

README.md

@@ -12,11 +12,11 @@ Automatic configuration for running GitHub Actions on Debian hosts as a service
 
 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. 
+creates repository level Actions runners.
+
 ```yaml
 github_actions_runner::ensure: present
 github_actions_runner::base_dir_name: '/data/actions-runner'
@@ -27,10 +27,38 @@ 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::labels:
-  - self-hosted-custom
+github_actions_runner::instances:
+  first_instance:
+    labels:
+      - self-hosted-custom
 ```
 
+You can also override some of the keys on the instance level
+```yaml
+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.

REFERENCE.md

@@ -5,9 +5,10 @@
 **Classes**
 
 * [`github_actions_runner`](#github_actions_runner)
-* [`github_actions_runner::install`](#github_actions_runner_install)
-* [`github_actions_runner::config`](#github_actions_runner_config)
-* [`github_actions_runner::service`](#github_actions_runner_service)
+
+**Defines**
+
+* [`github_actions_runner::instance`](#github_actions_runner_instance)
 
 ## Classes
 
@@ -31,27 +32,12 @@ Enum, Determine if to add or remove the resource.
 Data type: `Absolutepath`
 Location of the base directory for actions runner to be installed.
 
-##### `repo_name`
-
-Data type: `Optional[String]`
-
-actions runner github repository name to serve.
-Default value: `undef`
-
 ##### `org_name`
 
 Data type: `String`
 
 actions runner github organization name.
 
-##### `labels`
-
-Data type: `Optional[Array[String]]`
-
-A list of costum lables to add to a actions runner host.
-
-Default value: `undef`
-
 ##### `hostname`
 
 Data type: `String`
@@ -118,14 +104,61 @@ Data type: `String`
 
 Group to be used in Service and directories.
 
-### github_actions_runner::install
+### github_actions_runner::instance
+
+#### Parameters
+
+##### `ensure`
+
+Data type: `Enum`
+
+Determine if to add or remove the resource
+Default value: `undef`
+
+##### `org_name`
+
+Data type: `String`
+
+actions runner github organization name.
 
-Install the files and packages for the module.
+Default value: `github_actions_runner::org_name`
 
-### github_actions_runner::config
+##### `personal_access_token`
 
-Main path configuration of the module installation.
+Data type: `String`
 
-### github_actions_runner::service
+GitHub Personal Access Token with admin permission on the repositories or the organization.
+
+Default value: `github_actions_runner::personal_access_token`
+
+##### `user`
+
+Data type: `String`
+
+User to be used in Service and directories.
+
+Default value: `github_actions_runner::user`
+
+##### `group`
+
+Data type: `String`
+
+Group to be used in Service and directories.
+
+Default value: `github_actions_runner::group`
+
+##### `repo_name`
+
+Data type: `Optional[String]`
+
+actions runner github repository name to serve.
+Default value: `undef`
+
+##### `labels`
+
+Data type: `Optional[Array[String]]`
+
+A list of costum lables to add to a actions runner host.
+
+Default value: `undef`
 
-The service setup for this module.

data/common.yaml

@@ -8,5 +8,5 @@ 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::labels:
-  - self-hosted-custom
+github_actions_runner::instances: {}
+

manifests/config.pp

@@ -22,9 +22,6 @@
 # * labels
 #  Optional[Array[String]], A list of costum lables to add to a runner.
 #
-# * hostname
-#  String, actions runner name.
-#
 # * personal_access_token
 # String, GitHub PAT with admin permission on the repositories or the origanization.
 #
@@ -54,33 +51,24 @@
   String                    $repository_url,
   String                    $user,
   String                    $group,
-  String                    $hostname = $::facts['hostname'],
-  Optional[Array[String]]   $labels = undef,
-  Optional[String]          $repo_name = undef,
-
+  Hash[String, Hash]        $instances,
 ) {
 
   $root_dir = "${github_actions_runner::base_dir_name}-${github_actions_runner::package_ensure}"
 
-  if $github_actions_runner::labels {
-    $flattend_labels_list=join($github_actions_runner::labels, ',')
-    $assured_labels="--labels ${flattend_labels_list}"
-  } else {
-    $assured_labels = undef
-  }
-
-  $url = $github_actions_runner::repo_name ? {
-    undef => "https://github.com/${github_actions_runner::org_name}",
-    default => "https://github.com/${github_actions_runner::org_name}/${github_actions_runner::repo_name}",
+  $ensure_directory = $github_actions_runner::ensure ? {
+    'present' => directory,
+    'absent'  => absent,
   }
 
-  $token_url = $github_actions_runner::repo_name ? {
-    undef => "https://api.github.com/repos/${github_actions_runner::org_name}/actions/runners/registration-token",
-    default => "https://api.github.com/repos/${github_actions_runner::org_name}/${github_actions_runner::repo_name}/actions/runners/registration-token",
+  file { $github_actions_runner::root_dir:
+    ensure => $ensure_directory,
+    mode   => '0644',
+    owner  => $github_actions_runner::user,
+    group  => $github_actions_runner::group,
+    force  => true,
   }
 
-  class { '::github_actions_runner::config': }
-  -> class { '::github_actions_runner::install': }
-  ~> class { '::github_actions_runner::service': }
+  create_resources(github_actions_runner::instance, $github_actions_runner::instances)
 
 }