feat: placeholder runners.yml to group_vars

Author: jackhodgkiss

doc/source/configuration/ci-cd.rst

@@ -72,7 +72,7 @@ Runner Deployment
     * `network-interfaces`
     * `python-interpreter.yml` ensuring that `ansible_python_interpreter: /usr/bin/python3` has been set
 
-5. Create `${KAYOBE_CONFIG_PATH}/environments/${KAYOBE_ENVIRONMENT}/inventory/group_vars/github-runners/runner.yml` file which will contain the variables required to deploy a series of runners
+5. Create or edit `${KAYOBE_CONFIG_PATH}/inventory/group_vars/github-runners/runners.yml` file which will contain the variables required to deploy a series of runners
 
 .. code-block:: yaml
 

etc/kayobe/inventory/group_vars/github-runners/runners.yml

@@ -0,0 +1,38 @@
+---
+runner_user: VM_USER_NAME_HERE
+github_account: ORG_NAME_HERE
+github_repo: KAYOBE_CONFIG_REPO_NAME_HERE
+access_token: "{{ secrets_github_access_token }}"
+
+base_runner_dir: /opt/actions-runner
+
+default_runner_labels:
+  - kayobe
+  - openstack
+  - "{{ kayobe_environment | default(omit) }}"
+
+# Dictionary of runners to be deployed using the role.
+# Each dict item can be provided with optional attributes
+# * labels - provide a list of labels for a specific runner
+#   overriding the contents of `default_runner_labels`
+# * state - either `started`` or `absent`. By default it will
+#   be started if however the runner needs to be removed
+#   then setting it to `absent` will unregister the runner with
+#   GitHub and remove it from the system.
+# Example
+# github_runners:
+#  runner_01: {}
+#  runner_02:
+#    labels: ['foo', 'bar', 'baz']
+#  runner_03:
+#    state: absent
+github_runners:
+  runner_01: {}
+  runner_02: {}
+  runner_03: {}
+
+docker_users:
+  - "{{ runner_user }}"
+
+pip_install_packages:
+  - name: docker