feat: add suggestions

Co-authored-by: Mark Goddard <[email protected]>

Author: jackhodgkiss

doc/source/configuration/ci-cd.rst

@@ -75,7 +75,7 @@ Runner Deployment
     * `network-interfaces`
     * `python-interpreter.yml` ensuring that `ansible_python_interpreter: /usr/bin/python3` has been set
 
-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
+5. Edit the ``${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

@@ -1,5 +1,5 @@
 ---
-runner_user: stack
+runner_user: "{{ kayobe_ansible_user }}"
 github_account: stackhpc
 github_repo: stackhpc-kayobe-config
 access_token: "{{ secrets_github_access_token }}"
@@ -9,9 +9,9 @@ base_runner_dir: /opt/actions-runner
 default_runner_labels:
   - kayobe
   - openstack
-  - "{{ kayobe_environment | default(omit) }}"
+  - "{{ kayobe_environment }}"
 
-# Dictionary of runners to be deployed using the role.
+# Dictionary of GitHub runners to be deployed to each runner host.
 # 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`