Merge pull request #15 from Telefonica/add_proxy_support

Add proxy support

Author: mrodm

.github/workflows/pdk-test-unit.yml

@@ -5,14 +5,31 @@ on:
   - pull_request
 
 jobs:
+  validating:
+    runs-on: self-hosted-novum
+    steps:
+    - name: Clone repository
+      uses: actions/checkout@v2
+
+    - name: Run pdk validate
+      uses: puppets-epic-show-theatre/action-pdk-validate@v1
+      with:
+        # [optional]
+        # A string indicating the Puppet version to validate against, such as "5.4.2" or "5.5".
+        puppet-version: "5.5"
+
   testing:
     runs-on: self-hosted-novum
+    if: always()
+    needs:
+    - validating
     steps:
     - name: Clone repository
       uses: actions/checkout@v2
 
     - name: Run unit tests
       uses: puppets-epic-show-theatre/action-pdk-test-unit@v1
+      # added because there are open ended dependencies version requirements in metadata.json
       with:
         # [optional]
         # A string indicating the Puppet version to validate against, such as "5.4.2" or "5.5".

.gitignore

@@ -0,0 +1,27 @@
+.git/
+.*.sw[op]
+.metadata
+.yardoc
+.yardwarns
+*.iml
+/.bundle/
+/.idea/
+/.vagrant/
+/coverage/
+/bin/
+/doc/
+/Gemfile.local
+/Gemfile.lock
+/junit/
+/log/
+/pkg/
+/spec/fixtures/manifests/
+/spec/fixtures/modules/
+/tmp/
+/vendor/
+/convert_report.txt
+/update_report.txt
+.DS_Store
+.project
+.envrc
+/inventory.yaml

README.md

@@ -60,6 +60,25 @@ github_actions_runner::instances:
     personal_access_token: other_secret
 ```
 
+In case you need to set proxy in one instance:
+```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:
+    http_proxy: http://proxy.local
+    https_proxy: http://proxy.local
+    no_proxy: example.com
+    labels:
+      - self-hosted-custom1
+```
 
 ## Limitations
 

manifests/init.pp

@@ -34,6 +34,18 @@
 # * group
 # String, Group to be used in Service and directories.
 #
+# * instances
+# Hash[String, Hash], Github Runner Instances to be managed.
+#
+# * http_proxy
+# Optional[String], 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.
+#
+# * https_proxy
+# Optional[String], 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
+#
+# * no_proxy
+# Optional[String], 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
+#
 
 class github_actions_runner (
   Enum['present', 'absent'] $ensure,
@@ -46,6 +58,9 @@
   String                    $user,
   String                    $group,
   Hash[String, Hash]        $instances,
+  Optional[String]          $http_proxy = undef,
+  Optional[String]          $https_proxy = undef,
+  Optional[String]          $no_proxy = undef,
 ) {
 
   $root_dir = "${github_actions_runner::base_dir_name}-${github_actions_runner::package_ensure}"

manifests/instance.pp

@@ -23,6 +23,15 @@
 # * instance_name
 # String, The instance name as part of the instances Hash.
 #
+# * http_proxy
+# Optional[String], 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.
+#
+# * https_proxy
+# Optional[String], 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
+#
+# * no_proxy
+# Optional[String], 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
+#
 # * repo_name
 # Optional[String], actions runner repository name.
 #
@@ -38,6 +47,9 @@
   String                    $group                 = $github_actions_runner::group,
   String                    $hostname              = $::facts['hostname'],
   String                    $instance_name         = $title,
+  Optional[String]          $http_proxy            = $github_actions_runner::http_proxy,
+  Optional[String]          $https_proxy           = $github_actions_runner::https_proxy,
+  Optional[String]          $no_proxy              = $github_actions_runner::no_proxy,
   Optional[Array[String]]   $labels                = undef,
   Optional[String]          $repo_name             = undef,
 
@@ -110,7 +122,7 @@
 
   exec { "${instance_name}-ownership":
     user        => $user,
-    cwd         => "${github_actions_runner::root_dir}",
+    cwd         => $github_actions_runner::root_dir,
     command     => "/bin/chown -R ${user}:${group} ${github_actions_runner::root_dir}/${instance_name}",
     refreshonly => true,
     path        => "/tmp/${instance_name}-${archive_name}",
@@ -131,6 +143,9 @@
       root_dir      => $github_actions_runner::root_dir,
       user          => $user,
       group         => $group,
+      http_proxy    => $http_proxy,
+      https_proxy   => $https_proxy,
+      no_proxy      => $no_proxy,
     }),
     require => [File["${github_actions_runner::root_dir}/${instance_name}/configure_install_runner.sh"],
                 Exec["${instance_name}-run_configure_install_runner.sh"]],

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "telefonica-github_actions_runner",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "author": "Shimon Ohayon",
   "summary": "Module to configure our GitHub Actions runner on Debian hosts",
   "license": "Apache-2.0",
@@ -10,15 +10,15 @@
   "dependencies": [
     {
       "name": "puppetlabs-stdlib",
-      "version_requirement": ">= 1.0.0"
+      "version_requirement": ">= 1.0.0 < 7.0.0"
     },
     {
       "name": "camptocamp/systemd",
-      "version_requirement": ">= 1.1.1"
+      "version_requirement": ">= 1.1.1 < 3.0.0"
     },
     {
       "name": "puppet-archive",
-      "version_requirement": ">= 1.1.2"
+      "version_requirement": ">= 1.1.2 < 5.0.0"
     }
   ],
   "data_provider": "hiera",